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/zh_cn/mse/2019-05-31/api-docs.php | 81363 ++++++++++--------------------- 1 file changed, 26592 insertions(+), 54771 deletions(-) (limited to 'data/zh_cn/mse/2019-05-31/api-docs.php') diff --git a/data/zh_cn/mse/2019-05-31/api-docs.php b/data/zh_cn/mse/2019-05-31/api-docs.php index 7006c7c..4f9bad2 100644 --- a/data/zh_cn/mse/2019-05-31/api-docs.php +++ b/data/zh_cn/mse/2019-05-31/api-docs.php @@ -1,513 +1,223 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'mse', - 'version' => '2019-05-31', - ], + 'info' => ['style' => 'RPC', 'product' => 'mse', 'version' => '2019-05-31'], 'directories' => [ [ - 'id' => 365620, - 'title' => '标签', - 'type' => 'directory', - 'children' => [ - 'ListTagResources', - 'UntagResources', - 'TagResources', - ], - ], - [ - 'id' => 365624, - 'title' => '注册配置中心', - 'type' => 'directory', 'children' => [ [ - 'id' => 365625, - 'title' => '迁移上云', + 'children' => ['UpdateMigrationTask', 'AddMigrationTask', 'ListMigrationTask', 'DeleteMigrationTask'], 'type' => 'directory', - 'children' => [ - 'UpdateMigrationTask', - 'AddMigrationTask', - 'ListMigrationTask', - 'DeleteMigrationTask', - ], + 'title' => '迁移上云', + 'id' => 25603, ], [ - 'id' => 365630, - 'title' => '风险评估', + 'children' => ['PutClusterHealthCheckTask', 'OrderClusterHealthCheckRiskNotice', 'ListClusterHealthCheckTask'], 'type' => 'directory', - 'children' => [ - 'PutClusterHealthCheckTask', - 'OrderClusterHealthCheckRiskNotice', - 'ListClusterHealthCheckTask', - ], + 'title' => '风险评估', + 'id' => 25599, ], [ - 'id' => 365634, + 'children' => ['ListConfigTrack', 'CreateNacosConfig', 'DeleteNacosConfig', 'DeleteNacosConfigs', 'UpdateNacosConfig', 'ListListenersByConfig', 'ListListenersByIp', 'GetNacosConfig', 'GetNacosHistoryConfig', 'ListNacosConfigs', 'ListNacosHistoryConfigs', 'CloneNacosConfig', 'ExportNacosConfig', 'GetImportFileUrl', 'ImportNacosConfig'], + 'type' => 'directory', 'title' => 'Nacos配置', + 'id' => 25521, + ], + [ + 'children' => ['ListNamingTrack', 'CreateNacosService', 'ListAnsServices', 'DeleteNacosService', 'UpdateNacosService', 'UpdateNacosCluster', 'ListAnsServiceClusters', 'CreateNacosInstance', 'DeleteNacosInstance', 'UpdateNacosInstance', 'ListAnsInstances', 'GetServiceListeners'], 'type' => 'directory', - 'children' => [ - 'ListConfigTrack', - 'CreateNacosConfig', - 'DeleteNacosConfig', - 'DeleteNacosConfigs', - 'UpdateNacosConfig', - 'ListListenersByConfig', - 'ListListenersByIp', - 'GetNacosConfig', - 'GetNacosHistoryConfig', - 'ListNacosConfigs', - 'ListNacosHistoryConfigs', - 'CloneNacosConfig', - 'ExportNacosConfig', - 'GetImportFileUrl', - 'ImportNacosConfig', - ], - ], - [ - 'id' => 365650, 'title' => 'Nacos服务', + 'id' => 25537, + ], + [ + 'children' => ['ListEurekaServices', 'ListEurekaInstances'], 'type' => 'directory', - 'children' => [ - 'ListNamingTrack', - 'CreateNacosService', - 'ListAnsServices', - 'DeleteNacosService', - 'UpdateNacosService', - 'UpdateNacosCluster', - 'ListAnsServiceClusters', - 'CreateNacosInstance', - 'DeleteNacosInstance', - 'UpdateNacosInstance', - 'ListAnsInstances', - 'GetServiceListeners', - ], - ], - [ - 'id' => 365663, 'title' => 'Eureka服务', - 'type' => 'directory', - 'children' => [ - 'ListEurekaServices', - 'ListEurekaInstances', - ], + 'id' => 25550, ], [ - 'id' => 365666, - 'title' => '监控管理', + 'children' => ['QueryMonitor'], 'type' => 'directory', - 'children' => [ - 'QueryMonitor', - ], + 'title' => '监控管理', + 'id' => 25553, ], [ - 'id' => 365668, - 'title' => '公网白名单管理', + 'children' => ['UpdateAcl'], 'type' => 'directory', - 'children' => [ - 'UpdateAcl', - ], + 'title' => '公网白名单管理', + 'id' => 25555, ], [ - 'id' => 365670, + 'children' => ['QueryInstancesInfo', 'QueryClusterInfo', 'QueryClusterDetail', 'UpdateCluster', 'ListClusterTypes', 'ListClusterVersions', 'QueryClusterSpecification', 'QueryClusterDiskSpecification', 'ListInstanceCount', 'QueryConfig', 'GetMseFeatureSwitch', 'QueryBusinessLocations', 'ListClusterConnectionTypes', 'QuerySlbSpec', 'UpdateClusterSpec', 'RestartCluster', 'RetryCluster'], + 'type' => 'directory', 'title' => '集群管理', + 'id' => 74237, + ], + [ + 'children' => ['CreateEngineNamespace', 'DeleteEngineNamespace', 'UpdateEngineNamespace', 'GetEngineNamepace', 'ListEngineNamespaces'], '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' => '命名空间', - 'type' => 'directory', - 'children' => [ - 'CreateEngineNamespace', - 'DeleteEngineNamespace', - 'UpdateEngineNamespace', - 'GetEngineNamepace', - 'ListEngineNamespaces', - ], + 'id' => 74262, ], [ - 'id' => 365701, - 'title' => 'Zookeeper数据节点', + 'children' => ['ImportZookeeperData', 'GetZookeeperDataImportUrl', 'ExportZookeeperData', 'ListExportZookeeperData', 'CreateZnode', 'DeleteZnode', 'UpdateZnode', 'ListZnodeChildren', 'QueryZnodeDetail', 'ListZkTrack'], 'type' => 'directory', - 'children' => [ - 'ImportZookeeperData', - 'GetZookeeperDataImportUrl', - 'ExportZookeeperData', - 'ListExportZookeeperData', - 'CreateZnode', - 'DeleteZnode', - 'UpdateZnode', - 'ListZnodeChildren', - 'QueryZnodeDetail', - 'ListZkTrack', - ], + 'title' => 'Zookeeper数据节点', + 'id' => 25588, ], ], + 'type' => 'directory', + 'title' => '注册配置中心', + 'id' => 25520, ], [ - 'id' => 365712, - 'title' => '微服务治理中心', - 'type' => 'directory', 'children' => [ [ - 'id' => 365713, + 'children' => ['ListSentinelBlockFallbackDefinitions', 'BindSentinelBlockFallbackDefinition', 'ListIsolationRules', 'CreateIsolationRule', 'DeleteIsolationRules', 'UpdateIsolationRule', 'DeleteCircuitBreakerRules', 'DeleteFlowRules', 'UpdateFlowRule', 'ListFlowRules', 'CreateFlowRule', 'CreateCircuitBreakerRule', 'ListCircuitBreakerRules', 'UpdateCircuitBreakerRule', 'ListWebFlowRules', 'CreateWebFlowRule', 'DeleteWebFlowRules', 'UpdateWebFlowRule'], + 'type' => 'directory', 'title' => '流量防护', + 'id' => 25658, + ], + [ + 'children' => ['ListAuthPolicy', 'UpdateAuthPolicy', 'AddAuthPolicy', 'RemoveAuthPolicy'], 'type' => 'directory', - 'children' => [ - 'ListSentinelBlockFallbackDefinitions', - 'BindSentinelBlockFallbackDefinition', - 'ListIsolationRules', - 'CreateIsolationRule', - 'DeleteIsolationRules', - 'UpdateIsolationRule', - 'DeleteCircuitBreakerRules', - 'DeleteFlowRules', - 'UpdateFlowRule', - 'ListFlowRules', - 'CreateFlowRule', - 'CreateCircuitBreakerRule', - 'ListCircuitBreakerRules', - 'UpdateCircuitBreakerRule', - 'ListWebFlowRules', - 'CreateWebFlowRule', - 'DeleteWebFlowRules', - 'UpdateWebFlowRule', - ], - ], - [ - 'id' => 365732, 'title' => '服务鉴权', - 'type' => 'directory', - 'children' => [ - 'ListAuthPolicy', - 'UpdateAuthPolicy', - 'AddAuthPolicy', - 'RemoveAuthPolicy', - ], + 'id' => 25653, ], [ - 'id' => 365737, - 'title' => '服务查询', + 'children' => ['GetServiceMethodPage', 'GetServiceListPage', 'GetServiceList'], 'type' => 'directory', - 'children' => [ - 'GetServiceMethodPage', - 'GetServiceListPage', - 'GetServiceList', - ], + 'title' => '服务查询', + 'id' => 25639, ], [ - 'id' => 365741, - 'title' => '全链路灰度', + 'children' => ['CreateOrUpdateSwimmingLaneGroup', 'DeleteSwimmingLaneGroup', 'CreateOrUpdateSwimmingLane', 'DeleteSwimmingLane', 'QueryAllSwimmingLaneGroup', 'QueryAllSwimmingLane', 'GetTagsBySwimmingLaneGroupId', 'QuerySwimmingLaneById', 'ListAppBySwimmingLaneGroupTags', 'ListAppBySwimmingLaneGroupTag'], 'type' => 'directory', - 'children' => [ - 'CreateOrUpdateSwimmingLaneGroup', - 'DeleteSwimmingLaneGroup', - 'CreateOrUpdateSwimmingLane', - 'DeleteSwimmingLane', - 'QueryAllSwimmingLaneGroup', - 'QueryAllSwimmingLane', - 'GetTagsBySwimmingLaneGroupId', - 'QuerySwimmingLaneById', - 'ListAppBySwimmingLaneGroupTags', - 'ListAppBySwimmingLaneGroupTag', - ], + 'title' => '全链路灰度', + 'id' => 25628, ], [ - 'id' => 365752, - 'title' => '无损上下线', + 'children' => ['GetLosslessRuleByApp', 'ModifyLosslessRule', 'FetchLosslessRuleList'], 'type' => 'directory', - 'children' => [ - 'GetLosslessRuleByApp', - 'ModifyLosslessRule', - 'FetchLosslessRuleList', - ], + 'title' => '无损上下线', + 'id' => 25649, ], [ - 'id' => 365756, - 'title' => '同可用区优先', + 'children' => ['GetLocalityRule', 'UpdateLocalityRule'], 'type' => 'directory', - 'children' => [ - 'GetLocalityRule', - 'UpdateLocalityRule', - ], + 'title' => '同可用区优先', + 'id' => 296900, ], [ - 'id' => 365759, - 'title' => '应用治理', + 'children' => ['GetApplicationList', 'CreateMseServiceApplication', 'RemoveApplication', 'GetApplicationInstanceList'], 'type' => 'directory', - 'children' => [ - 'GetApplicationList', - 'CreateMseServiceApplication', - 'CreateApplication', - 'GetOverview', - 'RemoveApplication', - 'GetApplicationInstanceList', - ], + 'title' => '应用治理', + 'id' => 25611, ], [ - 'id' => 365766, - 'title' => '运维中心', - 'type' => 'directory', 'children' => [ [ - 'id' => 365767, - 'title' => 'K8s集群管理', + 'children' => ['QueryGovernanceKubernetesCluster', 'ModifyGovernanceKubernetesCluster', 'GetGovernanceKubernetesCluster'], 'type' => 'directory', - 'children' => [ - 'QueryGovernanceKubernetesCluster', - 'ModifyGovernanceKubernetesCluster', - 'GetGovernanceKubernetesCluster', - ], + 'title' => 'K8s集群管理', + 'id' => 296647, ], [ - 'id' => 365771, - 'title' => '微服务命名空间管理', + 'children' => ['QueryNamespace'], 'type' => 'directory', - 'children' => [ - 'ListNamespaces', - 'CreateNamespace', - 'DeleteNamespace', - 'QueryNamespace', - ], + 'title' => '微服务命名空间管理', + 'id' => 296651, ], ], + 'type' => 'directory', + 'title' => '运维中心', + 'id' => 296646, ], [ - 'id' => 365776, - 'title' => '标签路由', + 'children' => ['ApplyTagPolicies', 'ListApplicationsWithTagRules'], 'type' => 'directory', - 'children' => [ - 'ApplyTagPolicies', - 'ListApplicationsWithTagRules', - ], + 'title' => '标签路由', + 'id' => 25643, ], [ - 'id' => 365779, - 'title' => '消息灰度', + 'children' => ['GetAppMessageQueueRoute', 'UpdateMessageQueueRoute'], 'type' => 'directory', - 'children' => [ - 'GetAppMessageQueueRoute', - 'UpdateMessageQueueRoute', - ], + 'title' => '消息灰度', + 'id' => 25646, ], [ - 'id' => 365782, - 'title' => 'Mock规则', + 'children' => ['AddMockRule'], 'type' => 'directory', - 'children' => [ - 'AddMockRule', - ], + 'title' => 'Mock规则', + 'id' => 234158, ], ], + 'type' => 'directory', + 'title' => '微服务治理中心', + 'id' => 25608, ], [ - 'id' => 365784, - 'title' => '云原生网关', - 'type' => 'directory', 'children' => [ [ - 'id' => 365785, - 'title' => '插件市场', + 'children' => ['GetPlugins', 'GetPluginConfig', 'CreatePluginConfig', 'UpdatePluginConfig', 'DeletePluginConfig'], 'type' => 'directory', - 'children' => [ - 'GetPlugins', - 'GetPluginConfig', - 'CreatePluginConfig', - 'UpdatePluginConfig', - 'DeletePluginConfig', - ], + 'title' => '插件市场', + 'id' => 25763, ], [ - 'id' => 365791, - 'title' => '域名证书', + 'children' => ['AddSSLCert', 'AddGatewayDomain', 'DeleteGatewayDomain', 'UpdateSSLCert', 'UpdateGatewayDomain', 'ListSSLCert', 'ListGatewayDomain', 'GetGatewayDomainDetail'], 'type' => 'directory', - 'children' => [ - 'AddSSLCert', - 'AddGatewayDomain', - 'DeleteGatewayDomain', - 'UpdateSSLCert', - 'UpdateGatewayDomain', - 'ListSSLCert', - 'ListGatewayDomain', - 'GetGatewayDomainDetail', - ], + 'title' => '域名证书', + 'id' => 25681, ], [ - 'id' => 365800, + 'children' => ['AddGateway', 'ListGatewayZone', 'AddGatewaySlb', 'AddSecurityGroupRule', 'DeleteGatewaySlb', 'DeleteSecurityGroupRule', 'UpdateGatewayOption', 'QueryGatewayRegion', 'QueryGatewayType', 'ListGatewaySlb', 'GetGatewayOption', 'ListSecurityGroupRule', 'ListSecurityGroup', 'UpdateGatewaySpec', 'SelectGatewaySlb'], + 'type' => 'directory', 'title' => '网关管理', + 'id' => 25690, + ], + [ + 'children' => ['AddServiceSource', 'AddGatewayServiceVersion', 'DeleteServiceSource', 'DeleteGatewayServiceVersion', 'DeleteGatewayService', 'UpdateGatewayServiceTrafficPolicy', 'UpdateGatewayServiceVersion', 'ListServiceSource', 'ListGatewayService', 'GetMseSource', 'GetKubernetesSource', 'GetGatewayServiceDetail', 'UpdateServiceSource', 'ImportServices', 'UpdateGatewayService', 'PullServices', 'UpdateGatewayServiceCheck'], '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' => '服务管理', + 'id' => 25710, + ], + [ + 'children' => ['UpdateGatewayRouteAuth', 'ListGatewayAuthConsumerResource', 'UpdateGatewayAuthConsumer', 'ListGatewayRouteOnAuth', 'ListGatewayAuthConsumer', 'UpdateGatewayAuthConsumerResource', 'UpdateGatewayAuthConsumerStatus', 'AddGatewayAuthConsumer', 'DeleteGatewayAuthConsumerResource', 'UpdateGatewayAuthConsumerResourceStatus', 'DeleteGatewayAuthConsumer', 'GetGatewayAuthConsumerDetail', 'AddBlackWhiteList', 'UpdateBlackWhiteList', 'GatewayBlackWhiteList', 'GetBlackWhiteList', 'AddGatewayAuth', 'GetGatewayAuthDetail', 'AddAuthResource', 'DeleteAuthResource'], 'type' => 'directory', - 'children' => [ - 'AddServiceSource', - 'AddGatewayServiceVersion', - 'DeleteServiceSource', - 'DeleteGatewayServiceVersion', - 'DeleteGatewayService', - 'UpdateGatewayServiceTrafficPolicy', - 'UpdateGatewayServiceVersion', - 'ListServiceSource', - 'ListGatewayService', - 'GetMseSource', - 'GetKubernetesSource', - 'GetGatewayServiceDetail', - 'UpdateServiceSource', - 'ImportServices', - 'UpdateGatewayService', - 'PullServices', - 'UpdateGatewayServiceCheck', - ], - ], - [ - 'id' => 365838, 'title' => '安全能力', + 'id' => 25728, + ], + [ + 'children' => ['AddGatewayRoute', 'DeleteGatewayRoute', 'UpdateGatewayRouteHTTPRewrite', 'UpdateGatewayRoute', 'UpdateGatewayRouteCORS', 'UpdateGatewayRouteHeaderOp', 'UpdateGatewayRouteTimeout', 'UpdateGatewayRouteRetry', 'GetGatewayRouteDetail', 'ListGatewayRoute', 'UpdateGatewayRouteWafStatus', 'ApplyGatewayRoute', 'OfflineGatewayRoute'], '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' => '路由配置', + 'id' => 25749, + ], + [ + 'children' => ['GetGatewayConfig', 'EnableProxyProtocol', 'EnableHttp2', 'PreserveHeaderFormat'], 'type' => 'directory', - 'children' => [ - 'AddGatewayRoute', - 'DeleteGatewayRoute', - 'UpdateGatewayRouteHTTPRewrite', - 'UpdateGatewayRoute', - 'UpdateGatewayRouteCORS', - 'UpdateGatewayRouteHeaderOp', - 'UpdateGatewayRouteTimeout', - 'UpdateGatewayRouteRetry', - 'GetGatewayRouteDetail', - 'ListGatewayRoute', - 'UpdateGatewayRouteWafStatus', - 'ApplyGatewayRoute', - 'OfflineGatewayRoute', - ], - ], - [ - 'id' => 365877, 'title' => '参数配置', - 'type' => 'directory', - 'children' => [ - 'GetGatewayConfig', - 'EnableProxyProtocol', - 'EnableHttp2', - 'PreserveHeaderFormat', - ], + 'id' => 25782, ], [ - 'id' => 365882, - 'title' => '策略配置', + 'children' => ['CreateGatewayFlowRule', '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' => '策略配置', + 'id' => 25769, ], ], + 'type' => 'directory', + 'title' => '云原生网关', + 'id' => 25680, ], [ - 'id' => 365895, - 'title' => '其他', - 'type' => 'directory', 'children' => [ - 'InitializeServiceLinkRole', - 'CloneSentinelRuleFromAhas', - 'ChangeResourceGroup', - 'UpdateNacosGrayConfig', - 'UpdateGatewayConfig', - 'CreateSentinelBlockFallbackDefinition', - 'CreateNacosMcpServer', - 'DeleteNacosMcpServer', - 'GetNacosMcpServer', - 'ListNacosMcpServers', - 'QueryNacosGrayConfig', + 'InitializeServiceLinkRole', 'CloneSentinelRuleFromAhas', 'UpdateNacosGrayConfig', 'UpdateGatewayConfig', 'CreateSentinelBlockFallbackDefinition', 'AddZooKeeperSaslUser', 'ChangeResourceGroup', 'CreateApplication', 'CreateCluster', 'CreateNamespace', 'DeleteCluster', 'DeleteGateway', 'DeleteNamespace', 'GetGateway', 'GetImage', 'GetOverview', 'ListClusters', 'ListGateway', 'ListNamespaces', 'ListTagResources', + 'ListZooKeeperSaslUser', 'RemoveZooKeeperSaslUser', 'TagResources', 'UntagResources', 'UpdateConfig', 'UpdateGatewayName', 'UpdateImage', 'UpdateZooKeeperSaslUser', 'UpgradeCluster', ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 25791, ], ], 'components' => [ @@ -515,237 +225,112 @@ 'GatewayDomain' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'Domain Id', - 'description' => 'Domain Id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36', - ], - 'Name' => [ - 'title' => 'Domain Name', - 'description' => 'Domain Name', - 'type' => 'string', - 'example' => 'test.com', - ], - 'Protocol' => [ - 'title' => 'domainn的协议', - 'description' => 'domainn的协议', - 'type' => 'string', - 'example' => 'HTTPS', - ], - 'MustHttps' => [ - 'title' => '是否强制跳转', - 'description' => '是否强制HTTPS', - 'type' => 'string', - 'example' => 'true', - ], - 'CertIdentifier' => [ - 'title' => '使用的证书Id', - 'description' => '使用的证书Id', - 'type' => 'string', - 'example' => '595xx36-cn-hangzhou', - ], - 'GatewayId' => [ - 'title' => '网关ID', - 'description' => '网关ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayUniqueId' => [ - 'title' => '网关唯一标识', - 'description' => '网关唯一标识', - 'type' => 'string', - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-07-31 10:16:46', - ], - 'GmtModified' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2022-08-11 15:28:47', - ], - 'GatewayName' => [ - 'title' => '网关名称', - 'description' => '网关名称', - 'type' => 'string', - 'example' => 'test', - ], + 'Id' => ['title' => 'Domain Id', 'description' => 'Domain Id', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '36', 'backendName' => 'id'], + 'Name' => ['title' => 'Domain Name', 'description' => 'Domain Name', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test.com', 'backendName' => 'name'], + 'Protocol' => ['title' => 'domainn的协议', 'description' => 'domainn的协议', 'visibility' => 'Public', 'type' => 'string', 'example' => 'HTTPS', 'backendName' => 'protocol'], + 'MustHttps' => ['title' => '是否强制跳转', 'description' => '是否强制HTTPS', 'visibility' => 'Public', 'type' => 'string', 'example' => 'true', 'backendName' => 'mustHttps'], + 'CertIdentifier' => ['title' => '使用的证书Id', 'description' => '使用的证书Id', 'visibility' => 'Public', 'type' => 'string', 'example' => '595xx36-cn-hangzhou', 'backendName' => 'certIdentifier'], + 'GatewayId' => ['title' => '网关ID', 'description' => '网关ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'gatewayId'], + 'GatewayUniqueId' => ['title' => '网关唯一标识', 'description' => '网关唯一标识', 'visibility' => 'Public', 'type' => 'string', 'example' => 'gw-c9bc5afd61014165bd58f621b491****', 'backendName' => 'gatewayUniqueId'], + 'GmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-07-31 10:16:46', 'backendName' => 'gmtCreate'], + 'GmtModified' => ['title' => '修改时间', 'description' => '修改时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-08-11 15:28:47', 'backendName' => 'gmtModified'], + 'GatewayName' => ['title' => '网关名称', 'description' => '网关名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'gatewayName'], ], ], 'GatewayOption' => [ 'title' => 'A short description of struct', 'description' => '网关选项描述。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TraceDetails' => [ 'title' => 'xtrace config option', 'description' => '数据结构。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TraceEnabled' => [ 'title' => 'trace是否开启', 'description' => '是否开通XTrace。', + 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, - 'enumValueTitles' => [ - 'false' => '关闭xtrace', - 'true' => '开启xtrace', - ], + 'enumValueTitles' => ['false' => '关闭xtrace', 'true' => '开启xtrace'], 'example' => 'true', + 'backendName' => 'traceOn', ], 'Sample' => [ 'title' => 'trace采样率，默认为10', 'description' => 'XTrace的采样率。', + 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'enumValueTitles' => [], 'example' => '10', + 'backendName' => 'sample', 'default' => '10', ], - 'TraceType' => [ - 'title' => 'trace类型，可选XTRACE和SKYWALKING', - 'description' => 'trace类型，可选XTRACE和SKYWALKING', - 'type' => 'string', - 'example' => 'XTRACE', - 'default' => 'XTRACE', - ], - 'ServiceId' => [ - 'title' => 'SkyWalking服务Id，trace类型为SKYWALKING时必填', - 'description' => 'SkyWalking服务Id，trace类型为SKYWALKING时必填', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10458', - ], - 'ServicePort' => [ - 'title' => 'SkyWalking服务端口，trace类型为SKYWALKING时必填', - 'description' => 'SkyWalking服务端口，trace类型为SKYWALKING时必填', - 'type' => 'string', - 'example' => '80', - ], + 'TraceType' => ['title' => 'trace类型，可选XTRACE和SKYWALKING', 'description' => 'trace类型，可选XTRACE和SKYWALKING', 'visibility' => 'Public', 'type' => 'string', 'example' => 'XTRACE', 'backendName' => 'traceType', 'default' => 'XTRACE'], + 'ServiceId' => ['title' => 'SkyWalking服务Id，trace类型为SKYWALKING时必填', 'description' => 'SkyWalking服务Id，trace类型为SKYWALKING时必填', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10458', 'backendName' => 'serviceId'], + 'ServicePort' => ['title' => 'SkyWalking服务端口，trace类型为SKYWALKING时必填', 'description' => 'SkyWalking服务端口，trace类型为SKYWALKING时必填', 'visibility' => 'Public', 'type' => 'string', 'example' => '80', 'backendName' => 'servicePort'], ], + 'backendName' => 'xtraceDetails', ], 'LogConfigDetails' => [ 'title' => '日志配置详情', 'description' => '日志投递服务描述。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'LogEnabled' => [ 'title' => '是否开启日志投递', 'description' => '是否开启日志投递SLS服务。', + 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, - 'enumValueTitles' => [ - 'true' => '开启日志投递', - 'false' => '关闭日志投递', - ], + 'enumValueTitles' => ['true' => '开启日志投递', 'false' => '关闭日志投递'], 'example' => 'true', + 'backendName' => 'logOn', ], - 'ProjectName' => [ - 'title' => '投递的目标project', - 'description' => '日志投递的目的。', - 'type' => 'string', - 'example' => 'project', - ], - 'LogStoreName' => [ - 'title' => '投递的目标logstore', - 'description' => '日志存储名称。', - 'type' => 'string', - 'example' => 'name', - ], + 'ProjectName' => ['title' => '投递的目标project', 'description' => '日志投递的目的。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'project', 'backendName' => 'projectName'], + 'LogStoreName' => ['title' => '投递的目标logstore', 'description' => '日志存储名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'name', 'backendName' => 'logStoreName'], ], + 'backendName' => 'slsConfigDetails', ], - 'EnableHardwareAcceleration' => [ - 'title' => '是否开启硬件加速', - 'description' => '是否开启硬件加速', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DisableHttp2Alpn' => [ - 'title' => '是否禁用http', - 'description' => '是否关闭HTTP 2.0协议', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableWaf' => [ - 'title' => '是否开启waf', - 'description' => '是否开启waf', - 'type' => 'boolean', - 'example' => 'true', - ], + 'EnableHardwareAcceleration' => ['title' => '是否开启硬件加速', 'description' => '是否开启硬件加速', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enableHardwareAcceleration'], + 'DisableHttp2Alpn' => ['title' => '是否禁用http', 'description' => '是否关闭HTTP 2.0协议', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'disableHttp2Alpn'], + 'EnableWaf' => ['title' => '是否开启waf', 'description' => '是否开启waf', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enableWaf'], ], ], 'GatewayService' => [ 'title' => 'A short description of struct', 'description' => '网关服务描述', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '服务id', - 'description' => '服务id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'title' => '服务名', - 'description' => '服务名', - 'type' => 'string', - 'example' => 'test', - ], - 'SourceType' => [ - 'title' => '服务来源', - 'description' => '服务来源', - 'type' => 'string', - 'example' => 'MSE', - ], - 'GatewayTrafficPolicy' => [ - 'title' => '服务的策略', - 'description' => '服务的策略', - '$ref' => '#/components/schemas/TrafficPolicy', - ], - 'GatewayUniqueId' => [ - 'title' => '网关uniqueId', - 'description' => '网关实例id', - 'type' => 'string', - 'example' => 'gw-913a49bab6c5461187a3305fb8da****', - ], - 'MetaInfo' => [ - 'title' => '元信息', - 'description' => '服务地址信息（当服务来源为DNS或固定地址时）', - 'type' => 'string', - 'example' => '[\\"192.168.0.xxx:80\\"]', - ], - 'Namespace' => [ - 'title' => '服务所属namesapce', - 'description' => '服务所属namesapce', - 'type' => 'string', - 'example' => 'public', - ], - 'GroupName' => [ - 'title' => '服务所属group', - 'description' => '服务所属group', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], + 'Id' => ['title' => '服务id', 'description' => '服务id', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'id'], + 'Name' => ['title' => '服务名', 'description' => '服务名', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'name'], + 'SourceType' => ['title' => '服务来源', 'description' => '服务来源', 'visibility' => 'Public', 'type' => 'string', 'example' => 'MSE', 'backendName' => 'sourceType'], + 'GatewayTrafficPolicy' => ['title' => '服务的策略', 'description' => '服务的策略', 'visibility' => 'Public', 'backendName' => 'gatewayTrafficPolicy', '$ref' => '#/components/schemas/TrafficPolicy'], + 'GatewayUniqueId' => ['title' => '网关uniqueId', 'description' => '网关实例id', 'visibility' => 'Public', 'type' => 'string', 'example' => 'gw-913a49bab6c5461187a3305fb8da****', 'backendName' => 'gatewayUniqueId'], + 'MetaInfo' => ['title' => '元信息', 'description' => '服务地址信息（当服务来源为DNS或固定地址时）', 'visibility' => 'Public', 'type' => 'string', 'example' => '[\\"192.168.0.xxx:80\\"]', 'backendName' => 'metaInfo'], + 'Namespace' => ['title' => '服务所属namesapce', 'description' => '服务所属namesapce', 'visibility' => 'Public', 'type' => 'string', 'example' => 'public', 'backendName' => 'namespace'], + 'GroupName' => ['title' => '服务所属group', 'description' => '服务所属group', 'visibility' => 'Public', 'type' => 'string', 'example' => 'DEFAULT_GROUP', 'backendName' => 'groupName'], ], ], 'TrafficPolicy' => [ 'title' => 'A short description of struct', 'description' => '服务流量管理。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TlsSetting' => [ 'title' => 'tls相关配置', 'description' => '数据结构。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TlsMode' => [ @@ -754,34 +339,23 @@ .'- DISABLE（明文，不使用TLS）。'."\n" .'- SIMPLE（开启TLS）。'."\n" .'- MUTUAL（双向TLS）。', + 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'SIMPLE', + 'backendName' => 'mode', ], - 'CertId' => [ - 'title' => '使用的证书id，仅当为mutual时需要填写', - 'description' => '在云盾托管的证书ID。', - 'type' => 'string', - 'example' => '6456988-cn-hangzhou', - ], - 'CaCertContent' => [ - 'title' => 'ca证书内容', - 'description' => '信任的CA证书链，在双向TLS中，如果后端证书为私有CA签发，需要将其CA证书添加到该信任链中。', - '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-----', - ], - 'Sni' => [ - 'title' => '到后端服务些带', - 'description' => '建立TLS链接时使用的SNI。', - 'type' => 'string', - 'example' => 'www.aliyun.com', - ], + 'CertId' => ['title' => '使用的证书id，仅当为mutual时需要填写', 'description' => '在云盾托管的证书ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => '6456988-cn-hangzhou', 'backendName' => 'certId'], + 'CaCertContent' => ['title' => 'ca证书内容', 'description' => '信任的CA证书链，在双向TLS中，如果后端证书为私有CA签发，需要将其CA证书添加到该信任链中。', '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' => '建立TLS链接时使用的SNI。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'www.aliyun.com', 'backendName' => 'sni'], ], + 'backendName' => 'tls', ], 'LoadBalancerSettings' => [ 'title' => '负载均衡相关配置', 'description' => '负载均衡相关配置。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'LoadbalancerType' => [ @@ -792,45 +366,30 @@ .'- LEAST_CONN：最少连接数。'."\n" .'- RANDOM：随机。'."\n" .'- CONSISTENT_HASH：一致性Hash。', + 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'RANDOM', + 'backendName' => 'loadbalancerType', ], 'ConsistentHashLBConfig' => [ 'title' => '一致性hash相关配置', 'description' => '数据结构。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ParameterName' => [ - 'title' => '使用根据header和参数路由时生效', - 'description' => '使用一致性Hash时的基于参数，如果是基于参数则为URL参数名，如果是基于Header则是Header名。', - 'type' => 'string', - 'example' => 'test', - ], + 'ParameterName' => ['title' => '使用根据header和参数路由时生效', 'description' => '使用一致性Hash时的基于参数，如果是基于参数则为URL参数名，如果是基于Header则是Header名。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'parameterName'], 'HttpCookie' => [ 'title' => '使用cookie时配置', 'description' => '仅当ConsistentHashLBType需要填写Cookie相关的详细配置。', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'cookie名', - 'description' => 'Cookie名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Path' => [ - 'title' => 'cookie path', - 'description' => 'Cookie所在Path路径。', - 'type' => 'string', - 'example' => '/path', - ], - 'TTL' => [ - 'title' => 'cookie生命周期', - 'description' => 'Cookie设置的生命周期。', - 'type' => 'string', - 'example' => '10s', - ], + 'Name' => ['title' => 'cookie名', 'description' => 'Cookie名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'name'], + 'Path' => ['title' => 'cookie path', 'description' => 'Cookie所在Path路径。', 'visibility' => 'Public', 'type' => 'string', 'example' => '/path', 'backendName' => 'path'], + 'TTL' => ['title' => 'cookie生命周期', 'description' => 'Cookie设置的生命周期。', 'visibility' => 'Public', 'type' => 'string', 'example' => '10s', 'backendName' => 'ttl'], ], + 'backendName' => 'httpCookie', ], 'ConsistentHashLBType' => [ 'title' => 'HEADER, COOKIE, SOURCE_IP, QUERY_PARAMETER', @@ -840,644 +399,434 @@ .'- COOKIE：Cookie。'."\n" .'- SOURCE_IP：源IP。'."\n" .'- HEADER：请求头。', + 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'QUERY_PARAMETER', + 'backendName' => 'consistentHashLBType', ], ], + 'backendName' => 'consistentHashLBConfig', ], - 'WarmupDuration' => [ - 'title' => '预热时间(单位/s)', - 'description' => '预热时间（单位/s）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'WarmupDuration' => ['title' => '预热时间(单位/s)', 'description' => '预热时间（单位/s）。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'backendName' => 'warmupDuration'], ], 'enumValueTitles' => [], + 'backendName' => 'loadBalancerSettings', ], ], ], ], ], 'apis' => [ - 'ListTagResources' => [ - 'summary' => '查标签接口。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddAuthPolicy' => [ + 'summary' => '通过 AddAuthPolicy 接口创建服务鉴权规则。', + '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' => '地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ - 'name' => 'NextToken', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kywps2Ezza3n8HAAzCCqsi', - ], + 'schema' => ['description' => '来源。可选值为：edasmsc。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'edasmsc'], ], [ - 'name' => 'ResourceType', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型：'."\n" - ."\n" - .'- CLUSTER注册配置中心。'."\n" - ."\n" - .'- GATEWAY云原生网关。', - 'type' => 'string', - 'required' => true, - 'example' => 'CLUSTER', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceId', + 'name' => 'Enable', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '资源ID，最多 50个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-7pp2st29t16', - ], - 'required' => false, - 'maxItems' => 51, - ], + 'schema' => ['description' => '鉴权规则的启用状态。取值：'."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：禁用。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ - 'name' => 'Tag', + 'name' => 'AppId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => '标签列表，最多包含20个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '标签组合。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'prd', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'e9clba2xlc@***'], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => '协议类型。取值：'."\n" + ."\n" + .'- **SPRING_CLOUD**。'."\n" + .'- **DUBBO**。'."\n" + .'- **istio**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SPRING_CLOUD'], + ], + [ + 'name' => 'AuthRule', + 'in' => 'query', + 'schema' => ['description' => '服务鉴权规则内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"all":true,"black":false,"appIds":["dez4qt7weh@***"]}]'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '应用所属的MSE命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => '规则类型。'."\n" + ."\n" + .'- 0， 按照应用维度。'."\n" + .'- 1，按照命名空间维度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'K8sNamespace', + 'in' => 'query', + 'schema' => ['description' => 'k8s集群的命名空间ID。', 'type' => 'string', 'required' => false, 'example' => 'c19c6c500e1ff4d7abc7***'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', - 'description' => '下一个查询开始Token，NextToken为空说明没有下一个。', - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '92ED7C9C-84A2-595F-87FE-354F84C0F739', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TagResources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagResource' => [ - 'title' => '资源列表', - 'description' => '资源列表。', - 'type' => 'array', - 'items' => [ - 'description' => '由资源及其标签组成的集合，包含了资源ID、资源类型和标签键值等信息。', - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'title' => '资源ID', - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'mse-cn-7pp2st29t16', - ], - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'cluster', - ], - 'TagValue' => [ - 'title' => '标签值', - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'prd', - ], - 'TagKey' => [ - 'title' => '标签键', - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'env', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'dc63-465d-8ef5-20dc18af****'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '数据概览。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => 'Code仅仅用来和Success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建服务鉴权规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:AddAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取标签列表', ], - 'UntagResources' => [ - 'summary' => '删标签接口。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddAuthResource' => [ + 'summary' => '网关鉴权-创建授权信息。', + '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' => '地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '授权ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '13'], ], [ - 'name' => 'ResourceType', + 'name' => 'DomainId', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型：'."\n" - ."\n" - .'- CLUSTER注册配置中心。'."\n" - ."\n" - .'- GATEWAY云原生网关。', - 'type' => 'string', - 'required' => true, - 'example' => 'CLUSTER', - ], + 'schema' => ['description' => '域名ID。', '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' => '是否全部删除，只针对TagKey.N为空时有效。 '."\n" - .'取值范围：'."\n" - .'- true'."\n" - .'- false'."\n" - ."\n" - .'默认取值为false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '路径。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '/abc'], ], [ - 'name' => 'ResourceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID，最多50个子项', - 'description' => '资源ID，最多50个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '实例ID。'."\n" - .'>表示传入第几个实例ID。例如： '."\n" - .'- **ResourceId.0**表示传入第一个实例ID。'."\n" - .' - **ResourceId.1**表示传入第二个实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-7pp2st29t16', - ], - 'required' => true, - 'maxItems' => 51, - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****'], ], [ - 'name' => 'TagKey', + 'name' => 'MatchType', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => '匹配类型。'."\n" + ."\n" + .'- 精确匹配：EQUAL'."\n" + ."\n" + .'- 前缀匹配：PRE'."\n" + ."\n" + .'- 正则匹配：ERGULAR', 'type' => 'string', 'required' => false, 'example' => 'PRE'], + ], + [ + 'name' => 'IgnoreCase', + 'in' => 'query', + 'schema' => ['description' => '是否忽略大小写。（默认为true）', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AuthResourceHeaderList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '标签键，最多20个子项', - 'description' => '标签键，最多20个子项。', + 'description' => '鉴权资源头列表', 'type' => 'array', 'items' => [ - 'description' => '资源的标签键。N的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含***http://*** 或者 ***https://***。', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => ['description' => 'HTTP头参数。', 'type' => 'string', 'required' => false, 'example' => 'Access-Control-Allow-Origin'], + 'HeaderMethod' => [ + 'description' => 'Header匹配方式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['SUFFIX' => '后缀', 'EXIST' => '存在', 'PREFIX' => '前缀', 'EQUAL' => '等于', 'EXCLUDE' => '不包含', 'NOT_EQUAL' => '不等于', 'NOT_EXIST' => '不存在', 'REGREX' => '正则', 'INCLUDE' => '包含'], + 'example' => 'EQUAL', + ], + 'HeaderValue' => ['description' => 'HTTP头参数的取值。', 'type' => 'string', 'required' => false, 'example' => '*'], + ], 'required' => false, - 'example' => 'env', ], 'required' => false, - 'maxItems' => 21, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4BBCF560-4DD7-5DBD-B849-CCB135BBBAB7'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '403'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '数据结构。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '添加鉴权资源', + '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' => '删除标签', ], - 'TagResources' => [ - 'summary' => '为指定的资源打上标签。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddBlackWhiteList' => [ + 'summary' => '添加黑白名单。', + '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' => '地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0fe488252dc44d55a9dd57875193****'], ], [ 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型：'."\n" - ."\n" - .'- CLUSTER 注册配置中心。'."\n" - .'- GATEWAY 云原生网关。'."\n" - .'- GOVERNANCEAPPLICATION 微服务治理应用', - 'type' => 'string', - 'required' => true, - 'example' => 'CLUSTER、GATEWAY、GOVERNANCEAPPLICATION', - ], + 'schema' => ['description' => '生效粒度：'."\n" + .'- GATEWAY：网关全局'."\n" + .'- DOMAIN：域名'."\n" + .'- ROUTE：路由', 'type' => 'string', 'required' => false, 'example' => 'GATEWAY'], ], [ - 'name' => 'ResourceId', + 'name' => 'Type', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '资源ID。'."\n" - ."\n" - .'- *注册配置中心*：实例ID'."\n" - .'- *云原生网关*：网关唯一ID'."\n" - .'- *微服务治理应用*：微服务治理应用AppID（注意不是LicenseKey）'."\n" - ."\n" - .'>表示传入第几个实例ID。例如： '."\n" - .'- **ResourceId.0**表示传入第一个实例ID。'."\n" - .' - **ResourceId.1**表示传入第二个实例ID。', - 'type' => 'array', - 'items' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-7pp2st29t16'."\n" - .'hkhon1****@0932f4959f8****', - ], - 'required' => false, - 'maxItems' => 51, - ], + 'schema' => ['description' => '黑白名单类型。', 'type' => 'string', 'required' => false, 'example' => 'IP'], ], [ - 'name' => 'Tag', + 'name' => 'Content', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => '标签列表，最多包含20个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '标签信息集合。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '资源的标签键。N的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'prd', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 21, - ], + 'schema' => ['description' => '黑名单内容。', 'type' => 'string', 'required' => false, 'example' => '1.117.115.51'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '黑名单状态描述。'."\n" + ."\n" + .'- on 开启'."\n" + .'- off 关闭', 'type' => 'string', 'required' => false, 'example' => 'off'], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => ['description' => '是否白名单（默认为否）。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ResourceIdJsonList', + 'in' => 'query', + 'schema' => ['description' => '资源ID列表JSON。', 'type' => 'string', 'required' => false, 'example' => '[123]'], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => ['description' => '备注。', 'type' => 'string', 'required' => false, 'example' => 'this is a note'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'name'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E0A79810-9396-521C-A09D-E757B3E2BAF4', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '966F6CA7-16D0-50AB-AB02-E140934F90C1'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '记录ID。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '添加黑白名单', + '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' => '添加标签', ], - 'UpdateMigrationTask' => [ - 'summary' => '调用接口更新迁移上云任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddGateway' => [ + 'summary' => '添加网关。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -1486,1901 +835,1592 @@ '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' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => '网关名称', 'description' => '网关名称。', 'type' => 'string', 'required' => false, 'example' => 'test-ceshi'], ], [ - 'name' => 'Id', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '地域', 'description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ClusterType', + 'name' => 'Vpc', 'in' => 'query', - 'schema' => [ - 'description' => '集群类型。'."\n" - ."\n" - .'- Nacos-Ans'."\n" - .'- ZooKeeper'."\n" - .'- Eureka', - 'type' => 'string', - 'required' => false, - 'example' => 'Nacos-Ans', - ], + 'schema' => ['title' => '专有网络ID', 'description' => '专有网络ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp15mncnrtm83uauxd1xb'], ], [ - 'name' => 'OriginInstanceAddress', + 'name' => 'ZoneInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '源实例节点地址。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.1:8848', + 'description' => '可用区信息。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区信息。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e'], + 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp*****'], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, ], ], [ - 'name' => 'OriginInstanceName', + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['title' => '主交换机ID', 'description' => '主交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1q8th57frl5khj2li43'], + ], + [ + 'name' => 'VSwitchId2', + 'in' => 'query', + 'schema' => ['title' => '备交换机ID', 'description' => '备交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-wz9bu6o5vsvitt5mrxo6s'], + ], + [ + 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'description' => '源实例名称。', + 'description' => '付费类型（购买传统实例时指定）。', 'type' => 'string', 'required' => false, - 'example' => '来源集群', + 'enumValueTitles' => ['PREPAY' => '包年包月', 'POSTPAY' => '按量付费'], + 'example' => 'POSTPAY', + 'enum' => ['PREPAY', 'POSTPAY'], ], ], [ - 'name' => 'OriginInstanceNamespace', + 'name' => 'MserVersion', 'in' => 'query', 'schema' => [ - 'description' => '命名空间列表，当来源集群是Nacos时选填。', + 'title' => '网关产品类型：'."\n" + .'- mse_pro：传统实例'."\n" + .'- mse_serverless：Serverless', + 'description' => '网关产品类型：'."\n" + .'- mse_premium：普通实例专业版'."\n" + .'- mse_pro：普通实例标准版'."\n" + .'- mse_serverless：Serverless', 'type' => 'string', 'required' => false, - 'example' => 'namesapceId1,namesapceId2', + 'example' => 'mse_pro', + 'default' => 'mse_pro', + 'enum' => ['mse_premium', 'mse_pro', 'mse_serverless'], ], ], [ - 'name' => 'TargetInstanceId', + 'name' => 'Spec', 'in' => 'query', 'schema' => [ - 'description' => '目标实例ID。', + 'title' => '节点规格', + 'description' => '节点规格（购买传统实例时指定）。'."\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)', 'type' => 'string', 'required' => false, - 'example' => 'mse-cn-ud82*****', + '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'], ], ], [ - 'name' => 'TargetClusterName', + 'name' => 'Replica', + 'in' => 'query', + 'schema' => ['title' => '节点数量', 'description' => '节点数量（购买传统实例时指定）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'ManagedEntryNetworkType', 'in' => 'query', 'schema' => [ - 'description' => '目标实例名称。', + 'title' => '网关入口类型（普通实例专业版适用）', + 'description' => '网关入口类型（普通实例专业版适用）'."\n" + ."\n" + .'- pubnet：公网'."\n" + .'- privatenet：私网'."\n" + .'- privatepubnet：公网+私网', 'type' => 'string', 'required' => false, - 'example' => '目标集群', + 'example' => 'pubnet', + 'enum' => ['pubnet', 'privatenet', 'privatepubnet'], ], ], [ - 'name' => 'TargetClusterUrl', + 'name' => 'NlbNetworkType', 'in' => 'query', 'schema' => [ - 'description' => '目标实例Url。', + 'title' => '代购NLB的网络类型：'."\n" + .'- pubnet：公网'."\n" + .'- privatenet：私网'."\n" + .'- privatepubnet：公网+私网', + 'description' => '代购的NLB网络类型：'."\n" + .'- pubnet：公网'."\n" + .'- privatenet：私网'."\n" + .'- privatepubnet：公网+私网'."\n" + ."\n" + .'> 传统实例：创建时只能在NLB、按LCU计费的CLB、按规格的CLB中选择一种代购'."\n" + ."\n" + .'> Serverless实例：创建时只能在NLB、按LCU计费的CLB中选择一种代购', 'type' => 'string', 'required' => false, - 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848', + 'example' => 'pubnet', + 'enum' => ['pubnet', 'privatenet', 'privatepubnet'], ], ], [ - 'name' => 'ProjectDesc', + 'name' => 'ClbNetworkType', 'in' => 'query', 'schema' => [ - 'description' => '描述。', + 'title' => '代购按LCU计费的CLB的网络类型：'."\n" + .'- pubnet：公网'."\n" + .'- privatenet：私网'."\n" + .'- privatepubnet：公网+私网', + 'description' => '代购按LCU计费的CLB的网络类型：'."\n" + .'- pubnet：公网'."\n" + .'- privatenet：私网'."\n" + .'- privatepubnet：公网+私网'."\n" + ."\n" + .'> 传统实例：创建时只能在NLB、按LCU计费的CLB、按规格的CLB中选择一种代购'."\n" + ."\n" + .'> Serverless实例：创建时只能在NLB、按LCU计费的CLB中选择一种代购', 'type' => 'string', 'required' => false, - 'example' => '这是一段描述', + 'example' => 'pubnet', + 'enum' => ['pubnet', 'privatenet', 'privatepubnet'], ], ], [ - 'name' => 'SyncType', + 'name' => 'SlbSpec', + 'in' => 'query', + 'schema' => ['title' => '内网SLB规格', 'description' => '私网SLB规格（适用于传统实例）。'."\n" + ."\n" + .'- 简约型 (slb.s1.small)'."\n" + .'- 标准型1 (slb.s2.small)'."\n" + .'- 标准型I(slb.s2.medium)'."\n" + .'- 高阶型1 (slb.s3.small)'."\n" + .'- 高阶型I(slb.s3.medium)'."\n" + .'- 超强型I (slb.s3.large)'."\n" + ."\n" + .'> 传统实例：创建时只能在NLB、按LCU计费的CLB、按规格的CLB中选择一种代购'."\n" + ."\n" + .'> Serverless实例：创建时只能在NLB、按LCU计费的CLB中选择一种代购', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'slb.s2.small'], + ], + [ + 'name' => 'InternetSlbSpec', + 'in' => 'query', + 'schema' => ['title' => '外网SLB规格', 'description' => '公网SLB规格（适用于传统实例）。'."\n" + ."\n" + .'- 简约型 (slb.s1.small)'."\n" + .'- 标准型1 (slb.s2.smal)'."\n" + .'- 标准型I(slb.s2.medium)'."\n" + .'- 高阶型1 (slb.s3.small)'."\n" + .'- 高阶型I(slb.s3.medium)'."\n" + .'- 超强型I (slb.s3.large)'."\n" + ."\n" + .'> 传统实例：创建时只能在NLB、按LCU计费的CLB、按规格的CLB中选择一种代购'."\n" + ."\n" + .'> Serverless实例：创建时只能在NLB、按LCU计费的CLB中选择一种代购', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'slb.s2.small'], + ], + [ + 'name' => 'EnterpriseSecurityGroup', + 'in' => 'query', + 'schema' => ['title' => '是否企业安全组类型', 'description' => '是否企业安全组类型。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'EnableHardwareAcceleration', + 'in' => 'query', + 'schema' => ['title' => '是否开启硬件加速', 'description' => '是否开启硬件加速。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'EnableXtrace', + 'in' => 'query', + 'schema' => ['title' => '是否开启xtrace', 'description' => '是否启用链路追踪。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'XtraceRatio', + 'in' => 'query', + 'schema' => ['title' => 'xtrace采样率，取值[0,100]', 'description' => '链路追踪采样率，取值[1,100]。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'EnableSls', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '是否开启SLS日志投递', 'description' => '是否启用SLS日志投递。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '同步类型', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'All' => 'All', - 'Config' => 'Config', - 'Service' => 'Service', + 'title' => '标签列表，最多包含20个子项', + 'description' => '网关标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签Key。', 'type' => 'string', 'required' => false, 'example' => 'key'], + 'Value' => ['title' => '标签值', 'description' => '标签Value。', 'type' => 'string', 'required' => false, 'example' => 'value'], + ], + 'required' => false, ], - 'example' => 'All', + 'required' => false, + 'maxItems' => 21, ], ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm34x43l*****'], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => '扩展字段。', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'Succ'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据结构。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '1', - ], - 'UserId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '183876217*****', - ], - 'ClusterType' => [ - 'description' => '集群类型。'."\n" - ."\n" - .'- Nacos-Ans'."\n" - .'- ZooKeeper'."\n" - .'- Eureka', - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'OriginInstanceAddress' => [ - 'description' => '源实例节点地址。', - 'type' => 'string', - 'example' => '192.168.100.2:2181', - ], - 'OriginInstanceName' => [ - 'description' => '源实例名称。', - 'type' => 'string', - 'example' => 'src', - ], - 'OriginInstanceNamespace' => [ - 'description' => '命名空间列表，当来源集群是Nacos时选填。', - 'type' => 'string', - 'example' => 'fsdfsdfdsf', - ], - 'TargetInstanceId' => [ - 'description' => '目标实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-zvp2u*****', - ], - 'TargetClusterName' => [ - 'description' => '目标实例名称。', - 'type' => 'string', - 'example' => 'multiple-nacos', - ], - 'TargetClusterUrl' => [ - 'description' => '目标实例Url。', - 'type' => 'string', - 'example' => 'mse-0b*****-nacos-ans.mse.aliyuncs.com:8848', - ], - 'ProjectDesc' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => '1232345', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '修改日期。'."\n" - ."\n", - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'SyncType' => [ - 'description' => '同步类型', - 'type' => 'string', - 'example' => 'All', - ], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。'."\n", 'type' => 'string', 'example' => 'gw-5017305290e14cebbrvec4a5****'], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '添加网关', + '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 \\"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' => '更新迁移上云任务', ], - 'AddMigrationTask' => [ - 'summary' => '调用接口添加迁移任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddGatewayAuth' => [ + 'summary' => '创建网关鉴权。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '155122', - 'abilityTreeNodes' => [ - 'FEATUREmseKDDXNL', - ], + 'abilityTreeCode' => '37105', + 'abilityTreeNodes' => ['FEATUREmseFZIQVY'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '鉴权名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'ClusterType', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '集群类型。'."\n" - ."\n" - .'- Nacos-Ans'."\n" - .'- ZooKeeper'."\n" - .'- Eureka', - 'type' => 'string', - 'required' => false, - 'example' => 'Nacos-Ans', - ], + 'schema' => ['description' => '鉴权类型：'."\n" + ."\n" + .'- JWT'."\n" + .'- OIDC'."\n" + .'- IDaaS'."\n" + .'- ExternalAuthZ（自建的鉴权服务）', 'type' => 'string', 'required' => false, 'example' => 'JWT'], ], [ - 'name' => 'OriginInstanceAddress', + 'name' => 'Issuer', 'in' => 'query', - 'schema' => [ - 'description' => '源实例节点地址。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.1:8848', - ], + 'schema' => ['description' => '鉴权类型为JWT/OIDC时使用：'."\n" + ."\n" + .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" + .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/auth'], ], [ - 'name' => 'OriginInstanceName', + 'name' => 'Jwks', 'in' => 'query', - 'schema' => [ - 'description' => '源实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => '来源集群', - ], + 'schema' => ['description' => 'JWT公钥，支持JSON格式。', '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"}]}'], ], [ - 'name' => 'OriginInstanceNamespace', + 'name' => 'TokenPosition', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间列表，当来源集群是Nacos时选填。', - 'type' => 'string', - 'required' => false, - 'example' => 'namesapceId1,namesapceId2', - ], + 'schema' => ['description' => 'JWT Token类型：'."\n" + ."\n" + .'- HEADER：通过Header传输'."\n" + ."\n" + .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：Authorization: Bearer token。', 'type' => 'string', 'required' => false, 'example' => 'HEADER'], ], [ - 'name' => 'TargetInstanceId', + 'name' => 'TokenName', 'in' => 'query', - 'schema' => [ - 'description' => '目标实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-ud82*****', - ], + 'schema' => ['description' => 'JWT Token保存的位置。'."\n" + ."\n" + .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'required' => false, 'example' => 'Authorization'], ], [ - 'name' => 'TargetClusterName', + 'name' => 'TokenNamePrefix', 'in' => 'query', - 'schema' => [ - 'description' => '目标实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => '目标集群', - ], + 'schema' => ['description' => 'JWT Token的前缀。'."\n" + ."\n" + .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'required' => false, 'example' => 'Bearer '], ], [ - 'name' => 'TargetClusterUrl', + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => ['description' => '是否透传Token。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'IsWhite', 'in' => 'query', + 'schema' => ['description' => '授权黑白名单模式：'."\n" + ."\n" + .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" + .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '未开放参数，无需传递（鉴权创建后默认为关闭状态）。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'RedirectUrl', + 'in' => 'query', + 'schema' => ['description' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', 'type' => 'string', 'required' => false, 'example' => 'https://test-.com/oauth2/callback'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => '服务注册的应用ID（OIDC/IDaaS使用）。', 'type' => 'string', 'required' => false, 'example' => '23460e2fdd9bf9ad106****'], + ], + [ + 'name' => 'ClientSecret', + 'in' => 'query', + 'schema' => ['description' => '服务注册的应用Secret（OIDC/IDaaS使用）。', 'type' => 'string', 'required' => false, 'example' => '123****'], + ], + [ + 'name' => 'CookieDomain', + 'in' => 'query', + 'schema' => ['description' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态。'."\n" + ."\n" + .'例如：设置`Cookie-domain=a.example.com`，则Cookie会发送到域名`a.example.com`；设置`Cookie-domain=.example.com`，则Cookie会发送到`example.com`的所有子域名。', 'type' => 'string', 'required' => false, 'example' => 'test.com'], + ], + [ + 'name' => 'ScopesList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '目标实例Url。', - 'type' => 'string', + 'description' => 'OIDC授权作用域（OIDC使用）。', + 'type' => 'array', + 'items' => ['description' => 'OIDC授权作用域', 'type' => 'string', 'required' => false, 'example' => 'openid'], 'required' => false, - 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848', ], ], [ - 'name' => 'ProjectDesc', + 'name' => 'LoginUrl', + 'in' => 'query', + 'schema' => ['description' => 'IDaaS实例用户登录页地址（IDaaS使用）。', 'type' => 'string', 'required' => false, 'example' => 'https://daxxxxcn.aliyunidaas.com/'], + ], + [ + 'name' => 'Sub', + 'in' => 'query', + 'schema' => ['description' => '鉴权类型为JWT时使用；JWT claims 的sub（subject），即主体，请确保JWT的Payload中的sub字段的值与此处配置的值一致。如果该参数未设置或者为空，那么默认与Issuer参数设置的值一致', 'type' => 'string', 'required' => false, 'example' => 'testing@secure.istio.io'], + ], + [ + 'name' => 'ExternalAuthZJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '描述。', - 'type' => 'string', + 'description' => '自定义鉴权信息。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '鉴权服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1343'], + 'PrefixPath' => ['description' => '鉴权服务提供的鉴权API的Path，API的Path需是前缀匹配。', 'type' => 'string', 'required' => false, 'example' => '/auth'], + 'TokenKey' => ['description' => 'Token处于请求报文中哪个Header中，常见的有Authorization和Cookie。', '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' => '自定义鉴权模式：'."\n" + ."\n" + .'- true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关拒绝客户端请求'."\n" + .'- false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关放过客户端请求', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'WithRequestBody' => ['description' => '是否允许携带Body。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'BodyMaxBytes' => ['description' => 'Body的最大字节数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4000000'], + 'WithRematchRoute' => ['description' => '是否在鉴权完成后重新匹配路由。', 'type' => 'boolean', 'required' => false], + ], 'required' => false, - 'example' => '这是一段描述', ], ], [ - 'name' => 'SyncType', + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'example' => 'gw-*****9b04bb4474cae9d645be850e3d7'], + ], + [ + 'name' => 'AuthResourceMode', + 'in' => 'query', + 'schema' => ['title' => '授权资源模式：'."\n" + ."\n" + .'- 0：简单模式'."\n" + .'- 1：复杂模式', 'description' => '授权资源模式：'."\n" + ."\n" + .'- 0：简单模式'."\n" + .'- 1：复杂模式', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AuthResourceConfig', 'in' => 'query', + 'schema' => ['title' => '复杂模式的YAML配置', 'description' => '复杂模式的YAML配置', 'type' => 'string', 'required' => false], + ], + [ + 'name' => 'AuthResourceList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '同步类型，配置同步，服务同步，或者全部同步', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'All' => 'All', - 'Config' => 'Config', - 'Service' => 'Service', + 'description' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'DomainId' => ['description' => '规则内域名的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1765'], + 'Path' => ['description' => '规则的匹配路径。', 'type' => 'string', 'required' => false, 'example' => '/test'], + 'MatchType' => ['description' => '请求Path的匹配类型：'."\n" + ."\n" + .'- EQUAL：精确匹配'."\n" + .'- PRE：前缀匹配'."\n" + .'- ERGULAR：正则匹配', 'type' => 'string', 'required' => false, 'example' => 'EQUAL'], + 'IgnoreCase' => ['description' => '路径是否开启大小写敏感（创建自定义鉴权时使用，其他鉴权类型默认开启大小写敏感）'."\n" + ."\n" + .'- true：开启大小写敏感'."\n" + .'- false：关闭大小写敏感', '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' => '匹配条件：'."\n" + ."\n" + .'- EQUAL：等于'."\n" + .'- NOT_EQUAL：不等于'."\n" + .'- EXIST：存在'."\n" + .'- NOT_EXIST：不存在'."\n" + .'- INCLUDE：包含'."\n" + .'- EXCLUDE：不包含'."\n" + .'- PREFIX：前缀'."\n" + .'- SUFFIX：后缀'."\n" + .'- REGREX：正则', 'type' => 'string', 'required' => false, 'example' => 'EQUAL'], + 'HeaderValue' => ['description' => '请求头的值。', 'type' => 'string', 'required' => false, 'example' => '123'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => false, ], - 'example' => 'Service', + 'required' => false, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '12', - ], - 'UserId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '183876217*****', - ], - 'ClusterType' => [ - 'description' => '集群类型。'."\n" - ."\n" - .'- Nacos-Ans'."\n" - .'- ZooKeeper'."\n" - .'- Eureka', - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'OriginInstanceAddress' => [ - 'description' => '源实例节点地址。', - 'type' => 'string', - 'example' => '192.168.1.1:8848'."\n", - ], - 'OriginInstanceName' => [ - 'description' => '源实例名称。', - 'type' => 'string', - 'example' => '来源集群', - ], - 'OriginInstanceNamespace' => [ - 'description' => '命名空间列表，当来源集群是Nacos时选填。', - 'type' => 'string', - 'example' => 'namesapceId1,namesapceId2', - ], - 'TargetInstanceId' => [ - 'description' => '目标实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-7pp2w*****', - ], - 'TargetClusterName' => [ - 'description' => '目标实例名称。', - 'type' => 'string', - 'example' => '目标集群', - ], - 'TargetClusterUrl' => [ - 'description' => '目标实例Url。', - 'type' => 'string', - 'example' => 'mse-94d****-nacos-ans.mse.aliyuncs.com:8848', - ], - 'ProjectDesc' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => 'testsdfsdfsd', - ], - 'SyncType' => [ - 'description' => '同步类型', - 'type' => 'string', - 'example' => 'Service', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => 'The request is processed successfully.', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4279C00F-A5E1-53C6-A43B-751C1C524D0B'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Code' => ['description' => '用于和Success同步，当Success为true时，Code为200。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '创建的鉴权ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '333'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": \\"来源集群\\",\\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' => '添加迁移上云任务', - ], - 'ListMigrationTask' => [ - 'summary' => '调用接口查询迁移上云任务。', - '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' => '创建网关鉴权', + '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' => '新增网关鉴权消费者。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '155119', - 'abilityTreeNodes' => [ - 'FEATUREmseKDDXNL', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], ], [ - 'name' => 'OriginInstanceName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '源实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'whdc', - ], + 'schema' => ['description' => '鉴权消费者名称。', 'type' => 'string', 'required' => true, 'example' => 'name'], ], [ - 'name' => 'PageSize', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '鉴权类型：'."\n" + ."\n" + .'- JWT', 'type' => 'string', 'required' => true, 'example' => 'JWT'], ], [ - 'name' => 'PageNum', + 'name' => 'EncodeType', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '加密类型：'."\n" + ."\n" + .'- RSA'."\n" + ."\n" + .'- OCT', 'type' => 'string', 'required' => false, 'example' => 'RSA'], + ], + [ + 'name' => 'Jwks', + 'in' => 'query', + 'schema' => ['description' => 'JWT公钥，支持JSON格式。', '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"}]}'], + ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => ['description' => '要校验的Token参数信息的名称，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'required' => false, 'example' => 'Authorization'], + ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => ['description' => '是否透传。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'TokenPosition', + 'in' => 'query', + 'schema' => ['description' => '要校验的Token参数信息的位置，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'required' => false, 'example' => 'HEADER'], + ], + [ + 'name' => 'TokenPrefix', + 'in' => 'query', + 'schema' => ['description' => '要校验的Token参数信息的前缀，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'required' => false, 'example' => 'Bearer '], + ], + [ + 'name' => 'KeyName', + 'in' => 'query', + 'schema' => ['description' => 'JWT内身份标识KeyName。', 'type' => 'string', 'required' => false, 'example' => 'iss'], + ], + [ + 'name' => 'KeyValue', + 'in' => 'query', + 'schema' => ['description' => 'JWT内身份标识KeyValue。', 'type' => 'string', 'required' => false, 'example' => 'abcd'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '鉴权消费者描述。', 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '数组结构。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'UserId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '2', - ], - 'ClusterType' => [ - 'description' => '集群类型。'."\n" - ."\n" - .'- Nacos-Ans'."\n" - .'- ZooKeeper'."\n" - .'- Eureka', - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'OriginInstanceAddress' => [ - 'description' => '源实例节点地址。', - 'type' => 'string', - 'example' => '192.168.1.1:8848', - ], - 'OriginInstanceName' => [ - 'description' => '源实例名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'OriginInstanceNamespace' => [ - 'description' => '命名空间列表，当来源集群是Nacos时选填。', - 'type' => 'string', - 'example' => 'fsdfsdfdsf', - ], - 'TargetInstanceId' => [ - 'description' => '目标实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-zv*****', - ], - 'TargetClusterName' => [ - 'description' => '目标实例名称。', - 'type' => 'string', - 'example' => 'multiple-nacos', - ], - 'TargetClusterUrl' => [ - 'description' => '目标实例Url。', - 'type' => 'string', - 'example' => 'mse-f1******-nacos-ans.mse.aliyuncs.com:8848', - ], - 'ProjectDesc' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-30T06:41:52.000+0000', - ], - 'SyncType' => [ - 'description' => '同步类型', - 'type' => 'string', - 'example' => 'Service', - ], - ], - ], - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '451EBE59-5F33-5B15-83C1-78593B9*****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP返回码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数 `ErrMessage` 错误信息中的 `%s`。'."\n" + ."\n" + .'> 如果`ErrMessage`返回`The Value of Input Parameter %s is not valid`，且`DynamicMessage`返回`DtsJobId`，则代表所传入的请求参数`DtsJobId`不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '鉴权消费者ID。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '新增网关鉴权消费者', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayAuthConsumer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询迁移上云任务', ], - 'DeleteMigrationTask' => [ - 'summary' => '调用接口删除迁移上云任务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddGatewayDomain' => [ + 'summary' => '添加网关关联域名。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'MustHttps', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '是否开启HTTPS。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'Id', + 'name' => 'CertIdentifier', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '证书ID。', 'type' => 'string', 'required' => false, 'example' => '6828169-cn-hangzhou'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '域名名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test.com'], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => '协议类型：'."\n" + .'- `HTTP`'."\n" + .'- `HTTPS`', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HTTP'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****'], + ], + [ + 'name' => 'Http2', + 'in' => 'query', + 'schema' => ['description' => '是否开启`Http2`：'."\n" + .'- `open`：开启`Http2`。'."\n" + .'- `close`：关闭`Http2`。'."\n" + .'- `globalConfig`：使用全局配置。', 'type' => 'string', 'required' => false, 'example' => 'close'], + ], + [ + 'name' => 'TlsMax', + 'in' => 'query', + 'schema' => ['description' => 'Tls最大版本。', 'type' => 'string', 'required' => false, 'example' => 'TLS 1.3'], + ], + [ + 'name' => 'TlsMin', + 'in' => 'query', + 'schema' => ['description' => 'Tls最小版本。', 'type' => 'string', 'required' => false, 'example' => 'TLS 1.0'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '删除结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '16BA802F-B848-55DF-9F57-CD71B7272D1F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除迁移上云任务', - ], - 'PutClusterHealthCheckTask' => [ - 'summary' => '对当前集群发起一次风险评估的检查任务。', - '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' => '添加网关关联域名', + 'changeSet' => [ + ['createdAt' => '2026-03-12T02:35:25.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2026-03-03T08:16:53.000Z', 'description' => 'OpenAPI 下线'], ], - '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' => '添加网关路由。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '25612', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-2r42o83h506', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '526'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => '路由名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'RouteOrder', + 'in' => 'query', + 'schema' => ['description' => '路由顺序。（数值越小优先级越高）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Predicates', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '匹配规则。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因，例如：TaskId not found。', - 'type' => 'string', - 'example' => '请求处理成功', + 'PathPredicates' => [ + 'description' => '路由匹配。', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => '路径。', 'type' => 'string', 'required' => false, 'example' => '/test'], + 'Type' => [ + 'description' => '路由匹配：'."\n" + ."\n" + .'- 前缀：PRE。'."\n" + .'- 精确：EQUAL。'."\n" + .'- 正则：ERGULAR。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'PRE', + ], + 'IgnoreCase' => ['description' => '忽略大小写。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + 'required' => false, ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符', - 'type' => 'string', - 'example' => 'code', + 'MethodPredicates' => [ + 'description' => '方法匹配。', + 'type' => 'array', + 'items' => ['description' => '具体方法。', 'type' => 'string', 'required' => false, 'example' => 'GET'], + 'required' => false, ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', + 'HeaderPredicates' => [ + 'description' => '请求头匹配。', + 'type' => 'array', + 'items' => [ + 'description' => '请求头。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '请求头Key。', 'type' => 'string', 'required' => false, 'example' => 'debug'], + 'Value' => ['description' => '对应的Value。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'required' => false, 'example' => 'PRE'], + ], + 'required' => false, + ], + 'required' => false, ], - 'Data' => [ - 'description' => '执行结果信息。', - 'type' => 'boolean', - 'example' => 'true', + 'QueryPredicates' => [ + 'description' => 'URL参数匹配。', + 'type' => 'array', + 'items' => [ + 'description' => 'URL参数。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '参数名。', 'type' => 'string', 'required' => false, 'example' => 'userid'], + 'Value' => ['description' => '匹配值。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'required' => false, 'example' => 'PRE'], + ], + 'required' => false, + ], + 'required' => false, ], ], - ], - ], - ], - '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', + 'required' => false, ], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + 'name' => 'Services', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '服务列表（路由指向为单服务、多服务、标签路由时填写）。', + 'type' => 'array', + 'items' => [ + 'description' => '服务列表。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '353'], + 'Percent' => ['description' => '当前服务/服务版本分流百分比（只在使用多服务、标签路由时填写）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], + 'Version' => ['description' => '服务版本（只在使用标签路由时填写）。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'user'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'required' => false, 'example' => 'MSE'], + 'Namespace' => ['description' => '服务所在命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'GroupName' => ['description' => '服务分组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'AgreementType' => ['description' => '协议类型。', 'type' => 'string', 'required' => false, 'example' => 'DUBBO'], + 'HttpDubboTranscoder' => [ + 'description' => 'Dubbo协议转换体。', + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => ['description' => 'Dubbo服务名称。', 'type' => 'string', 'required' => false, 'example' => 'org.apache.dubbo.samples.basic.api.DemoService'], + 'DubboServiceVersion' => ['description' => 'Dubbot服务版本。', 'type' => 'string', 'required' => false, 'example' => '0.0.0'], + 'DubboServiceGroup' => ['description' => '服务组。', 'type' => 'string', 'required' => false, 'example' => 'group'], + 'MothedMapList' => [ + 'description' => 'Dubbo转发规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '方法映射。', + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => ['description' => 'Dubbo方法名。', 'type' => 'string', 'required' => false, 'example' => 'sayHello'], + 'HttpMothed' => ['description' => 'HTTP方法。'."\n" + .'> 支持HTTP方法参数值。'."\n" + .'> - ALL_GET。'."\n" + .'> - ALL_POST。'."\n" + .'> - ALL_PUT。'."\n" + .'> - ALL_DELETE。'."\n" + .'> - ALL_PATCH。', 'type' => 'string', 'required' => false, 'example' => 'ALL_GET'], + 'Mothedpath' => ['description' => '方法匹配路径。', 'type' => 'string', 'required' => false, 'example' => '/mytestzbk/sayhello'], + 'PassThroughAllHeaders' => ['description' => 'Header透传类型。'."\n" + .'> 透传类型枚举值。'."\n" + .'> - 透传所有：PASS_ALL。'."\n" + .'> - 不透传：PASS_NOT。'."\n" + .'> - 指定参数：PASS_ASSIGN。'."\n", 'type' => 'string', 'required' => false, 'example' => 'PASS_NOT'], + 'PassThroughList' => [ + 'description' => '指定透传Header列表', + 'type' => 'array', + 'items' => ['description' => '指定Header透传值。', 'type' => 'string', 'required' => false, 'example' => 'x-forward'], + 'required' => false, + ], + 'ParamMapsList' => [ + 'description' => '参数映射列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数映射体。', + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => ['description' => '入参位置。'."\n" + .'> 入参位置枚举值。'."\n" + .'> - 请求参数：`ALL_QUERY_PARAMETER`'."\n" + .'- 请求头：`ALL_HEADER`'."\n" + .'- 请求路径：`ALL_PATH`'."\n" + .'- 请求体：`ALL_BODY`'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL_QUERY_PARAMETER'], + 'ExtractKey' => ['description' => '入参位提取Key。', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'MappingType' => ['description' => '后端参数类型。', 'type' => 'string', 'required' => false, 'example' => 'java.lang.String'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443'], + ], + 'required' => false, + ], + 'required' => false, ], ], - ], - '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' => '发起风险评估检查任务', - ], - 'OrderClusterHealthCheckRiskNotice' => [ - 'summary' => '是否订阅风险项通知功能。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '150983', - 'abilityTreeNodes' => [ - 'FEATUREmseZDUZ1K', + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => ['description' => '域名ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], ], - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'DestinationType', 'in' => 'query', 'schema' => [ - 'description' => '实例ID。', + 'description' => '目标服务类型。'."\n" + .'- Single：单服务'."\n" + .'- Multiple：多服务'."\n" + .'- VersionOriented：标签路由'."\n" + .'- Mock：Mock'."\n" + .'- Redirect：重定向', 'type' => 'string', 'required' => false, - 'example' => 'mse-cn-st21ri2****', + 'enumValueTitles' => ['VersionOriented' => 'VersionOriented', 'Multiple' => 'Multiple', 'Single' => 'Single', 'Redirect' => 'Redirect', 'Mock' => 'Mock'], + 'example' => 'Multiple', ], ], [ - 'name' => 'RiskCode', + 'name' => 'DirectResponseJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '风险编码。', - 'type' => 'string', + 'description' => 'Mock响应配置。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Mock返回码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '403'], + 'Body' => ['description' => 'Mock返回值。', 'type' => 'string', 'required' => false, 'example' => 'hello'], + ], 'required' => false, - 'example' => '30010010001', ], ], [ - 'name' => 'Mute', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '是否禁用此风险项通知功能。'."\n" - ."\n" - .'- true 禁用风险项通知'."\n" - .'- false 开启风险项通知', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-492af9b04bb4474cae9d645be8*****'], ], [ - 'name' => 'NoticeType', + 'name' => 'DomainIdListJSON', 'in' => 'query', - 'schema' => [ - 'description' => '预留参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '域名列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[0,94]'], ], [ - 'name' => 'RegionId', + 'name' => 'RedirectJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '集群所在地域。', - 'type' => 'string', + 'description' => '重定向配置。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '302'], + 'Host' => ['description' => '重定向主机名。', 'type' => 'string', 'required' => false, 'example' => 'test.com'], + 'Path' => ['description' => '重定向路径。', 'type' => 'string', 'required' => false, 'example' => '/test'], + ], 'required' => false, - 'example' => 'cn-hangzhou', ], ], [ - 'name' => 'RequestPars', + 'name' => 'EnableWaf', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '已废弃，请使用UpdateGatewayRouteWafStatus更新路由WAF状态。', 'type' => 'boolean', 'deprecated' => true, 'required' => false, 'example' => 'true'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Fallback', + 'in' => 'query', + 'schema' => ['description' => '是否开启Fallback服务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'FallbackServices', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型。'."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', + 'description' => 'Fallback服务。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '353'], + 'Percent' => ['description' => '权重百分比。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], + 'Version' => ['description' => '服务版本。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'user'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'required' => false, 'example' => 'MSE'], + 'Namespace' => ['description' => '服务所在命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'GroupName' => ['description' => '服务分组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'AgreementType' => ['description' => '协议类型。', 'type' => 'string', 'required' => false, 'example' => 'DUBBO'], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'RouteType', + 'in' => 'query', + 'schema' => ['description' => '路由类型：'."\n" + ."\n" + .'Op：管控路由。', 'type' => 'string', 'required' => false, 'example' => 'Op'], + ], + [ + 'name' => 'Policies', + 'in' => 'query', + 'schema' => ['description' => '路由策略JSON字符串。', '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\\"}]}"}'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '路由描述', 'description' => '路由描述', 'type' => 'string', 'required' => false, 'example' => 'a route for xxx'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因，例如：TaskId not found。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '是否订阅成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回代码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '创建的路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '555'], + 'ErrorCode' => ['description' => '错误码。'."\n" + ."\n" + .'- InvalidParameter：参数错误：缺失、格式不对'."\n" + .'- IllegalRequest：请求非法：参数越权'."\n" + .'- NoPermission：权限专用'."\n" + .'- NotFound：资源404'."\n" + .'- InternalError：内部错误', 'type' => 'string', 'example' => 'InvalidParameter'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '添加网关路由', + '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 \\"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' => '订阅风险项通知', ], - 'ListClusterHealthCheckTask' => [ - 'summary' => '获取历史风险评估任务列表。', - 'methods' => [ - 'get', - 'post', + 'AddGatewayServiceVersion' => [ + 'summary' => '添加服务版本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '90280', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '33'], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => ['description' => '服务版本。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{\\"name\\":\\"v1\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v1\\"}]}'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-913a49bab6c5461187a3305fb8da****'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA4046B6-CFC6-583C-B608-DD75011A590F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '403'], + 'Message' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '状态码。说明：200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '网关服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '330'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], ], - 'tags' => [ - 'cluster', + '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' => '添加网关服务版本', + 'changeSet' => [], + 'ramActions' => [ + [ + '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' => '关联SLB。', + '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' => '71795', + 'abilityTreeNodes' => ['FEATUREmseMNDRFM'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'SlbId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-7pp2o4wfx01', - ], + 'schema' => ['description' => 'SLB ID。', 'type' => 'string', 'required' => true, 'example' => 'lb-bp18t6jjskwxh6wy1****'], ], [ - 'name' => 'PageNum', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '查询第几页', - 'description' => '查询第几页', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '类型。'."\n" + ."\n" + .'- PUB_NET: 公网。'."\n" + ."\n" + .'- PRIVATE_NET: 私网。', 'type' => 'string', 'required' => false, 'example' => 'PUB_NET'], ], [ - 'name' => 'PageSize', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示条数', - 'description' => '每页展示条数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****'], ], [ - 'name' => 'RegionId', + 'name' => 'VServerGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'http虚拟服务组ID。', 'type' => 'string', 'required' => false, 'example' => '353'], ], [ - 'name' => 'RequestPars', + 'name' => 'ServiceWeight', + 'in' => 'query', + 'schema' => ['description' => '服务权重。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], + ], + [ + 'name' => 'HttpPort', 'in' => 'query', + 'schema' => ['description' => 'HTTP端口（虚拟服务组）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], + ], + [ + 'name' => 'HttpsPort', + 'in' => 'query', + 'schema' => ['description' => 'HTTPS端口（虚拟服务组）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443'], + ], + [ + 'name' => 'HttpsVServerGroupId', + 'in' => 'query', + 'schema' => ['description' => 'https虚拟服务组ID。', 'type' => 'string', 'required' => false, 'example' => '353'], + ], + [ + 'name' => 'VServiceList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', + 'description' => 'SLB监听信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VServerGroupId' => ['description' => '虚拟服务器组ID。', 'type' => 'string', 'required' => false, 'example' => 'rsp-bp1j**t0fyl**'], + 'VServerGroupName' => ['description' => ' 虚拟服务器组名称。', 'type' => 'string', 'required' => false, 'example' => 'k8s/31**0/***/istio-system/clusterid'], + 'Port' => ['description' => '端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '443'], + 'Protocol' => ['description' => '协议类型：'."\n" + .'- HTTP'."\n" + .'- HTTPS', 'type' => 'string', 'required' => false, 'example' => 'HTTPS'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => '{}', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'Code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。取值说明如下：'."\n" - ."\n" - .'- 请求成功：不返回**ErrorCode**字段。'."\n" - .'- 请求失败：返回**ErrorCode**字段。具体信息，请参见本文的**错误码**目录。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => '列表的页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalSize' => [ - 'title' => '查询到的实例总数', - 'description' => '查询到的总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => '输入时设置的每页行数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => '风险评估任务列表。', - 'type' => 'array', - 'items' => [ - 'description' => '风险评估任务。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Score' => [ - 'description' => '总得分。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'TotalItem' => [ - 'description' => '总检查项数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalRisk' => [ - 'description' => '总风险项数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse_ingresspost-cn-0jbvrcex****', - ], - 'ClusterType' => [ - 'description' => '集群类型。', - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'Type' => [ - 'description' => '冗余字段。', - 'type' => 'string', - 'example' => 'null'."\n", - ], - 'Status' => [ - 'description' => '任务状态。', - 'type' => 'string', - 'example' => 'FINISH', - ], - 'PrimaryUser' => [ - 'description' => '集群归属用户ID。', - 'type' => 'string', - 'example' => '123456', - ], - 'Spec' => [ - 'description' => '规格。', - 'type' => 'string', - 'example' => 'MSE_SC_2_4_200_c', - ], - 'Replica' => [ - 'description' => '集群节点数量。', - 'type' => 'string', - 'example' => '3', - ], - 'VersionCode' => [ - 'description' => '版本号。', - 'type' => 'string', - 'example' => 'NACOS_ANS_1_2_1_3', - ], - 'AppVersion' => [ - 'description' => '完整版本号。', - 'type' => 'string', - 'example' => '1.2.1', - ], - 'ImageVersion' => [ - 'description' => '冗余字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'CreateTime' => [ - 'description' => '任务创建时间。', - 'type' => 'string', - 'example' => '2022-06-20T06:51:46Z', - ], - 'UpdateTime' => [ - 'description' => '最后更新时间。', - 'type' => 'string', - 'example' => '2022-11-12 15:07:55', - ], - 'RiskList' => [ - 'description' => '风险项列表。', - 'type' => 'array', - 'items' => [ - 'description' => '风险项信息。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3426', - ], - 'TaskId' => [ - 'description' => '关联的父任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RiskName' => [ - 'description' => '风险名称。', - 'type' => 'string', - 'example' => '引擎版本过低', - ], - 'RiskCode' => [ - 'description' => '风险编码。', - 'type' => 'string', - 'example' => '22020010001', - ], - 'PrimaryUser' => [ - 'description' => '集群归属用户ID。', - 'type' => 'string', - 'example' => '123456', - ], - 'Type' => [ - 'description' => '冗余字段。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'Values' => [ - 'description' => '冗余字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'Module' => [ - 'description' => '冗余字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'RiskType' => [ - 'description' => '风险类型。', - 'type' => 'string', - 'example' => '版本风险', - ], - 'RiskLevel' => [ - 'title' => 'HIGH, MID, LOW, NONE', - 'description' => '风险等级，取值：'."\n" - .'- HIGH 高风险'."\n" - .'- MID 中风险'."\n" - .'- LOW 低风险', - 'type' => 'string', - 'example' => 'MID', - ], - 'Suggestion' => [ - 'description' => '建议。', - 'type' => 'string', - 'example' => '{\\"desc\\":\\"请尽快升级至最新版本\\",\\"links\\":[{\\"type\\":\\"upgrade\\",\\"desc\\":\\"点击升级\\"}]}', - ], - 'Situation' => [ - 'description' => '现状。', - 'type' => 'string', - 'example' => '{\\"desc\\":\\"当前引擎版本过低，有大量功能缺失\\",\\"links\\":[{\\"type\\":\\"url\\",\\"value\\":\\"https://xxxx"\\",\\"desc\\":\\"版本说明\\"}]}', - ], - 'Description' => [ - 'description' => '描述说明。', - 'type' => 'string', - 'example' => '{\\"desc\\":\\"引擎版本过低，有大量功能缺失，请尽快升级至最新版本！\\"}', - ], - 'Mute' => [ - 'description' => '是否禁用此风险项通知功能。'."\n" - ."\n" - .'- true 禁用风险项通知'."\n" - .'- false 开启风险项通知', - 'type' => 'boolean', - 'example' => 'false', - ], - 'NoticeFeature' => [ - 'description' => '冗余字段。', - 'type' => 'boolean', - 'example' => 'null', - ], - 'RiskNameEn' => [ - 'description' => '风险英文名', - 'type' => 'string', - 'example' => 'Low engine version', - ], - 'SuggestionEn' => [ - 'description' => '建议的英文描述', - 'type' => 'string', - 'example' => 'Upgrade to the latest version', - ], - 'SituationEn' => [ - 'description' => '现状的英文描述', - 'type' => 'string', - 'example' => 'The current engine version is low, and there are many missing features', - ], - 'DescriptionEn' => [ - 'description' => '风险描述的英文描述', - 'type' => 'string', - 'example' => 'Upgrade to the latest version to ensure that all features are available!', - ], - ], - ], - ], - 'ChargeType' => [ - 'description' => '付费类型。', - 'type' => 'string', - 'example' => 'PREPAY', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'type' => 'string', 'example' => 'lb-uf6dqr4ondqi5w3df7hdf'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '关联网关SLB', + '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 \\"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' => '获取风险评估任务列表', ], - 'ListConfigTrack' => [ - 'summary' => '获取Nacos配置中心的轨迹数据。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddMigrationTask' => [ + 'summary' => '调用接口添加迁移任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '139046', - 'abilityTreeNodes' => [ - 'FEATUREmseU19WQV', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '155122', + 'abilityTreeNodes' => ['FEATUREmseKDDXNL'], ], 'parameters' => [ [ 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'mse_prepaid_public_cn-i7m2ne****', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'DataId', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'description' => '查询的配置的dataId，默认为不按照dataId进行筛选查询', - 'type' => 'string', - 'required' => false, - 'example' => 'ballot', - ], + 'schema' => ['description' => '集群类型。'."\n" + ."\n" + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', 'type' => 'string', 'required' => false, 'example' => 'Nacos-Ans'], ], [ - 'name' => 'Group', + 'name' => 'OriginInstanceAddress', 'in' => 'query', - 'schema' => [ - 'description' => '配置分组，默认为不按照配置分组进行筛选查询', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => '源实例节点地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1:8848'], ], [ - 'name' => 'NamespaceId', + 'name' => 'OriginInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，默认为public', - 'type' => 'string', - 'required' => false, - 'example' => 'f3a510e2-df52-4fad-9815-42d8bc40****', - ], + 'schema' => ['description' => '源实例名称。', 'type' => 'string', 'required' => false, 'example' => 'Source cluster'], ], [ - 'name' => 'StartTs', + 'name' => 'OriginInstanceNamespace', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间戳，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1671010148', - ], + 'schema' => ['description' => '命名空间列表，当来源集群是Nacos时选填。', 'type' => 'string', 'required' => false, 'example' => 'namesapceId1,namesapceId2'], ], [ - 'name' => 'EndTs', + 'name' => 'TargetInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间戳，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1657178373', - ], + 'schema' => ['description' => '目标实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-ud82*****'], ], [ - 'name' => 'PageSize', + 'name' => 'TargetClusterName', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => '目标实例名称。', 'type' => 'string', 'required' => false, 'example' => 'Target cluster'], ], [ - 'name' => 'PageNum', + 'name' => 'TargetClusterUrl', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '目标实例Url。', 'type' => 'string', 'required' => false, 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848'], ], [ - 'name' => 'Reverse', + 'name' => 'ProjectDesc', 'in' => 'query', - 'schema' => [ - 'description' => '是否倒序，默认为false'."\n" - ."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description.'], ], [ - 'name' => 'Ip', + 'name' => 'SyncType', 'in' => 'query', 'schema' => [ - 'description' => '监听IP地址，默认为不按照ip进行筛选查询', + 'description' => '同步类型，配置同步，服务同步，或者全部同步', 'type' => 'string', 'required' => false, - 'example' => '192.168.22.2', + 'enumValueTitles' => ['All' => 'All', 'Config' => 'Config', 'Service' => 'Service'], + 'example' => 'Service', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -3389,191 +2429,72 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Traces' => [ - 'description' => '信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'LogDate' => [ - 'description' => '记录时间。', - 'type' => 'string', - 'example' => '2022-11-28 15:09:15', - ], - 'Ts' => [ - 'description' => '监控指标值对应的时间戳。'."\n" - ."\n" - .'单位：秒。', - 'type' => 'string', - 'example' => '1659666529', - ], - 'RequestIp' => [ - 'description' => '请求来源IP。', - 'type' => 'string', - 'example' => '192.168.1.2', - ], - 'ResponseIp' => [ - 'description' => '响应节点。', - 'type' => 'string', - 'example' => 'mse-1973b9a0-1670834*****-reg-center-0-2', - ], - 'DataId' => [ - 'description' => '配置ID。', - 'type' => 'string', - 'example' => 'eir-server.properties', - ], - 'Group' => [ - 'description' => '配置组。', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'Event' => [ - 'description' => '事件。'."\n" - ."\n" - .'- 配置获取事件：pull'."\n" - .'- 持久化事件：persist', - 'type' => 'string', - 'example' => 'pull', - ], - 'Result' => [ - 'description' => '结果。', - 'type' => 'string', - 'example' => 'ok', - ], - 'Delay' => [ - 'description' => '延迟，单位为ms。', - 'type' => 'string', - 'example' => '0', - ], - 'Md5' => [ - 'description' => '配置MD5值。', - 'type' => 'string', - 'example' => 'd21c9091c60daa0ff7ee2f420141e5a0', - ], - 'Type' => [ - 'description' => '发布类型。'."\n" - ."\n" - .'- beta发布：beta'."\n" - .'- 灰度发布：tag'."\n" - .'- 分批发布：batch', - 'type' => 'string', - 'example' => 'beta', - ], - 'Push' => [ - 'description' => '是否是服务端推送。'."\n" - ."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Client' => [ - 'description' => '是否是客户端的请求。'."\n" - ."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + 'Data' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '12'], + 'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '183876217*****'], + 'ClusterType' => ['description' => '集群类型。'."\n" + ."\n" + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', 'type' => 'string', 'example' => 'Nacos-Ans'], + 'OriginInstanceAddress' => ['description' => '源实例节点地址。', 'type' => 'string', 'example' => '192.168.1.1:8848'."\n"], + 'OriginInstanceName' => ['description' => '源实例名称。', 'type' => 'string', 'example' => 'Source cluster'], + 'OriginInstanceNamespace' => ['description' => '命名空间列表，当来源集群是Nacos时选填。', 'type' => 'string', 'example' => 'namesapceId1,namesapceId2'], + 'TargetInstanceId' => ['description' => '目标实例ID。', 'type' => 'string', 'example' => 'mse-cn-7pp2w*****'], + 'TargetClusterName' => ['description' => '目标实例名称。', 'type' => 'string', 'example' => 'Target cluster'], + 'TargetClusterUrl' => ['description' => '目标实例Url。', 'type' => 'string', 'example' => 'mse-94d****-nacos-ans.mse.aliyuncs.com:8848'], + 'ProjectDesc' => ['description' => '描述。', 'type' => 'string', 'example' => 'testsdfsdfsd'], + 'SyncType' => ['description' => '同步类型', 'type' => 'string', 'example' => 'Service'], ], ], - 'PageSize' => [ - 'description' => '当前页的大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0CE3ABD2-1E04-561F-A9B4-0423D50****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '添加迁移上云任务', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '获取Nacos配置中心推送轨迹', ], - 'CreateNacosConfig' => [ - 'summary' => '创建一个Nacos配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddMockRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3581,136 +2502,78 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17005', - 'abilityTreeNodes' => [ - 'FEATUREmse0BR2XQ', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-tl32****', - ], + 'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent-auto-test-sc'], ], [ - 'name' => 'DataId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'common.yaml', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Group', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'alime-bridge-aliyun', - ], + 'schema' => ['description' => '规则来源。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'edasmsc'], ], [ - 'name' => 'AppName', + 'name' => 'ProviderAppId', 'in' => 'query', - 'schema' => [ - 'description' => '应用名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'saledatacenter-task', - ], + 'schema' => ['description' => '服务提供者应用ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dcqtkuhnc4@66e5235415****'], ], [ - 'name' => 'Tags', + 'name' => 'ProviderAppName', 'in' => 'query', - 'schema' => [ - 'description' => '配置的标签。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '基本配置', - ], + 'schema' => ['description' => '服务提供者应用名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'demo-cartservice'], ], [ - 'name' => 'Desc', + 'name' => 'ExtraJson', 'in' => 'query', - 'schema' => [ - 'description' => '配置的描述信息。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '基础模块配置', - ], + 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{}'], ], [ - 'name' => 'Type', + 'name' => 'ScMockItems', 'in' => 'query', - 'schema' => [ - 'description' => '配置格式，包括text、json、xml等。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'text', - ], + 'schema' => ['description' => '入参数，支持JSON格式。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[]'], ], [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => '配置的内容。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'text', - ], + 'name' => 'DubboMockItems', + 'in' => 'query', + 'schema' => ['description' => '回收站中的项目。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[]'], ], [ - 'name' => 'NamespaceId', + 'name' => 'ConsumerAppIds', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，默认为public。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '547fd2a0-d0d6-****-80db2a1afb82', - ], + 'schema' => ['description' => '用户自定义应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{\\"appName\\":\\"provide\\",\\"appId\\":\\"bst8l6o735@f6d8aaf6e56e67d\\"}]'], ], [ - 'name' => 'BetaIps', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'Beta发布的IP列表。', - 'type' => 'string', - 'required' => false, - 'example' => '100.117.XX.XX,100.117.XX.XX', - ], + 'schema' => ['description' => '报警规则的启用状态。取值：'."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'MockType', + 'in' => 'query', + 'schema' => ['description' => '慢调用RT。取值如下：'."\n" + ."\n" + .'- 15：15ms'."\n" + .'- 30：30ms'."\n" + .'- 60：60ms'."\n" + .'- 120：120ms', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -3719,94 +2582,81 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '673DBD43-569E-510F-B3DE-20BB8DFEB20A', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '返回代码。', - 'type' => 'string', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Succ'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'NamespaceId' => ['description' => '命名空间ID。', 'type' => 'string', 'example' => 'cn-shanghai'], + 'ScMockItemJson' => ['description' => 'HTTP协议Mock规则。', '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' => '需查询的应用名称。', 'type' => 'string', 'example' => 'demo-xxxx'], + 'ConsumerAppId' => ['description' => '服务消费者应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@a000601b265xxxx'], + 'AccountId' => ['description' => '账户ID。', 'type' => 'string', 'example' => '178432728867xxxx'], + 'ExtraJson' => ['description' => '描述。', 'type' => 'string', 'example' => 'desc'], + 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'edasmsc'], + 'Region' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-shanghai'], + 'ProviderAppId' => ['description' => '服务提供者应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@a000601b265xxxx'], + 'ProviderAppName' => ['description' => '服务提供者应用名称。', 'type' => 'string', 'example' => 'demo-xxxx'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1'], + 'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '275'], + 'Enable' => ['description' => '开启或关闭。'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', 'type' => 'boolean', 'example' => 'true'], + 'MockType' => ['description' => '模型类型，取值如下：'."\n" + ."\n" + .'- `[unk]0[unk]`：桌面模型'."\n" + .'- `[unk]1[unk]`：移动端模型', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建Mock规则', + 'summary' => '创建Mock规则。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:AddMockRule', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '创建Nacos配置', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'DeleteNacosConfig' => [ - 'summary' => '删除Nacos配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddSSLCert' => [ + 'summary' => '网关域名关联证书，证书可托管在云盾服务。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -3815,174 +2665,93 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17011', - 'abilityTreeNodes' => [ - 'FEATUREmse0BR2XQ', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '35701', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-tl32epfyu18', - ], - ], - [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'description' => '配置ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'user-ds.yml', - ], - ], - [ - 'name' => 'Group', + 'name' => 'DomainId', 'in' => 'query', - 'schema' => [ - 'description' => '分组类型。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HALVIE_MICRO_GROUP', - ], + 'schema' => ['description' => '域名ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'NamespaceId', + 'name' => 'CertIdentifier', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。默认为public', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0e9d849b-****-8435da6c21ad', - ], + 'schema' => ['description' => '证书ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5213641-cn-hangzhou'], ], [ - 'name' => 'Beta', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '是否Beta发布。默认为false'."\n" - ."\n" - .'- `true`：是'."\n" - .'- `false`：否', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '网关唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E1CC74F0-5BDE-5220-A031-5CA622D80723'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => ' '."\n" + .'返回结果码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据结构，关联是否成功。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '添加网关域名关联证书', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddSSLCert', + '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\\": \\"4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '删除Nacos配置', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'DeleteNacosConfigs' => [ - 'summary' => '批量删除多个Nacos配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddSecurityGroupRule' => [ + 'summary' => '添加网关安全组规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -3990,153 +2759,93 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17012', - 'abilityTreeNodes' => [ - 'FEATUREmse0BR2XQ', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'SecurityGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-i7m2e32pd0n', - ], + 'schema' => ['title' => '安全组ID', 'description' => '安全组ID', 'type' => 'string', 'required' => true, 'example' => 'sg-wz929kxhcdpw9z8idqd8'], ], [ - 'name' => 'Ids', + 'name' => 'PortRange', 'in' => 'query', - 'schema' => [ - 'description' => '配置列表ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '20024,20025,20026,20027,20034,20104,20394', - ], + 'schema' => ['title' => '端口范围', 'description' => '端口范围', 'type' => 'string', 'required' => true, 'example' => '1/65535'], ], [ - 'name' => 'NamespaceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1ef93a21-3487-4367-a859-857d8****', - ], + 'schema' => ['title' => '网关ID', 'description' => '网关ID', 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '数据结构。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '73EB5563-CBB3-5F48-999D-512F4EFB7377', - ], - 'Message' => [ - 'description' => '请求消息。', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'type' => 'string', 'example' => '12'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '添加网关安全组规则', + '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 \\"RequestId\\": \\"73EB5563-CBB3-5F48-999D-512F4EFB7377\\",\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '批量删除Nacos配置', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'UpdateNacosConfig' => [ - 'summary' => '更新一个Nacos配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddServiceSource' => [ + 'summary' => '创建Nacos服务来源。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -4144,1350 +2853,891 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17102', - 'abilityTreeNodes' => [ - 'FEATUREmse0BR2XQ', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-7pp2a****', - ], - ], - [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'description' => '配置ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ky-check-****.yml', - ], - ], - [ - 'name' => 'Group', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '分组。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'resource', - ], + 'schema' => ['description' => '服务注册类型，按来源类型填写对应的值：'."\n" + .'- 容器服务：K8S'."\n" + .'- MSE Nacos：NACOS'."\n" + .'- MSE ZooKeeper：ZOOKEEPER'."\n" + .'- SAE 注册中心：NACOS'."\n" + .'- EDAS 注册中心：NACOS', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'NACOS'."\n"], ], [ - 'name' => 'AppName', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'postoffice', - ], + 'schema' => ['description' => '服务来源类型：'."\n" + .'- 容器服务：K8S'."\n" + .'- MSE Nacos：MSE'."\n" + .'- MSE ZooKeeper：MSE_ZK'."\n" + .'- SAE 注册中心：SAE'."\n" + .'- EDAS 注册中心：EDAS', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'MSE'], ], [ - 'name' => 'Tags', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'Tag列表。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2021-10-20', - ], + 'schema' => ['description' => '访问地址（必填）：'."\n" + .'* 容器服务：对应容器服务集群ID'."\n" + .'* MSE Nacos：实例内网访问地址'."\n" + .'* MSE ZooKeeper：实例内网访问地址'."\n" + .'* SAE 注册中心：命名空间TID'."\n" + .'* EDAS 注册中心：微服务空间Namespace', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-********-nacos-ans.mse.aliyuncs.com:8848'], ], [ - 'name' => 'Desc', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '配置的描述信息。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '基础配置', - ], + 'schema' => ['description' => '名称。'."\n" + ."\n\n" + .'> 不同来源类型描述。'."\n" + .'- 类型为K8s时入参为名称。'."\n" + .'- 类型为NACOS时入参为实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'nacos'], ], [ - 'name' => 'Type', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '配置格式，包括text、json、xml、html等。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'text', - ], - ], - [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => '配置内容', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '网关唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], ], [ - 'name' => 'NamespaceId', + 'name' => 'IngressOptionsRequest', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '命名空间ID，默认为public', - 'type' => 'string', + 'description' => 'Ingress配置（服务来源类型为K8s时使用）。', + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => ['description' => '是否开启Ingress。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'IngressClass' => ['description' => '监听Ingress Class。', 'type' => 'string', 'required' => false, 'example' => 'com.test.xxx'], + 'WatchNamespace' => ['description' => '监听目标命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'EnableStatus' => ['description' => '是否更新Ingress Status。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], 'required' => false, - 'docRequired' => false, - 'example' => '78b7af66-d15f-4541-b886-11ed81ecb6c0', ], ], [ - 'name' => 'Md5', + 'name' => 'ToAuthorizeSecurityGroups', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'md5信息。', - 'type' => 'string', + 'description' => '待授权安全组列表，用于在创建来源时打通后端服务的安全组限制', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'required' => false, 'example' => 'sg-bp1acepclex0vmi1****'], + 'PortRange' => ['description' => '安全组的授权端口范围，可多选，使用,分隔。', 'type' => 'string', 'required' => false, 'example' => '8080/8080,9000/10000'], + 'Description' => ['description' => '授权记录描述。', 'type' => 'string', 'required' => false, 'example' => 'rule for xxx'], + ], + 'required' => false, + ], 'required' => false, - 'docRequired' => false, - 'example' => '045439703a273a94306422b****', ], ], [ - 'name' => 'BetaIps', + 'name' => 'GroupList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Beta发布的IP列表。', - 'type' => 'string', + 'description' => '服务分组列表。', + 'type' => 'array', + 'items' => ['description' => '服务分组。', 'type' => 'string', 'required' => false, 'example' => 'NACOS'], 'required' => false, - 'docRequired' => false, - 'example' => '196.168.XX.XX', ], ], [ - 'name' => 'EncryptedDataKey', + 'name' => 'PathList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '加密密钥。', - 'type' => 'string', + 'description' => '服务根路径数组。', + 'type' => 'array', + 'items' => ['description' => '服务根路径。', 'type' => 'string', 'required' => false, 'example' => '/test'], 'required' => false, - 'example' => '122wdwe****', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '支持的语言。包括以下取值：'."\n" + ."\n" + .'- 中文：zh-CN（默认值）。'."\n" + .'- 英文：en-US。'."\n" + .'- 日文：ja。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', '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' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '63'], ], ], ], ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '创建服务来源', + '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\\": \\"200\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '更新Nacos配置', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'ListListenersByConfig' => [ - 'summary' => '根据配置信息查询监听者。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'AddZooKeeperSaslUser' => [ + 'summary' => '增加ZooKeeper Sasl 用户', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17070', - 'abilityTreeNodes' => [ - 'FEATUREmseHU6B10', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217281', + 'abilityTreeNodes' => ['FEATUREmse2TF2YB'], ], 'parameters' => [ - [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '参数弃用，无需填写', - 'type' => 'string', - 'required' => false, - 'example' => '...', - ], - ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例的ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-m7r1yurp00e', - ], + 'schema' => ['title' => '实例id', 'description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'DataId', + 'name' => 'SaslUser', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '数据ID。', - 'type' => 'string', + 'title' => '要增加的Sasl用户列表', + 'description' => '要增加的Sasl用户列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserName' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'required' => false, 'example' => 'user'], + 'Password' => ['title' => '用户密码', 'description' => '用户密码', 'type' => 'string', 'required' => false, 'example' => 'traaqwrasdf'], + 'Description' => ['title' => '用户描述', 'description' => '用户描述', 'type' => 'string', 'required' => false, 'example' => 'description', 'maxLength' => 128], + ], + 'required' => false, + 'description' => '', + ], 'required' => true, - 'docRequired' => true, - 'example' => 'zeekr-clueboss.yml', ], ], [ - 'name' => 'Group', + 'name' => 'Reload', 'in' => 'query', + 'schema' => ['description' => '是否重启集群立刻加载sasl用户', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分组。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], + 'Data' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '增加 zookeeper Sasl 用户', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，默认为public', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - [ - 'name' => 'ExtGrayRules', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '额外的灰度规则列表，在进行listener匹配时会将额外的灰度规则和现有的规则合并进行匹配', - 'type' => 'array', - 'items' => [ - 'description' => '灰度规则项', - 'type' => 'object', - 'properties' => [ - 'GrayRuleType' => [ - 'description' => '灰度规则类型', - 'type' => 'string', - 'required' => false, - 'example' => 'Tags', - 'enum' => [ - 'Tags', - 'Beta', - ], - ], - 'GrayRuleName' => [ - 'description' => '灰度版本名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'GrayRule' => [ - 'description' => '灰度规则，如果是Beta灰度，此处是灰度的客户端的ip，使用逗号分隔；如果是标签灰度，此处是 标签名=标签值，多个标签值使用逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], - 'GrayRulePriority' => [ - 'description' => '灰度版本优先级', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => '数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'Listeners' => [ - 'description' => '监听者信息。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Ip' => [ - 'description' => 'IP。', - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'Md5' => [ - 'description' => '校验串。', - 'type' => 'string', - 'example' => '23sdfdf', - ], - 'Status' => [ - 'description' => '是否推送成功', - 'type' => 'string', - 'example' => 'true', - ], - 'Labels' => [ - 'description' => '监听者所带的标签', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '标签的键值对', - 'example' => 'a=b', - ], - ], - 'Version' => [ - 'description' => '监听者当前的版本，gray（灰度版本）或者nromal（正式版本）', - 'type' => 'string', - 'example' => 'gray', - ], - 'MatchRuleName' => [ - 'title' => '当前Listener匹配的灰度规则名称', - 'description' => '当前Listener匹配的灰度规则名称', - 'type' => 'string', - 'example' => '匹配到的灰度规则的名称', - ], - 'MatchRuleType' => [ - 'description' => '匹配到的灰度规则的类型', - 'type' => 'string', - 'example' => 'Beta', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '75E1442F-11EC-567A-9CF0-5A36F7904F39', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'PageSize' => [ - 'description' => '当前页的大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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', - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], ], - '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' => '查询配置监听者', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"Data\\": true\\n}","type":"json"}]', ], - 'ListListenersByIp' => [ - 'summary' => '根据IP查询监听者列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ApplyGatewayRoute' => [ + 'summary' => '发布网关路由。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17071', - 'abilityTreeNodes' => [ - 'FEATUREmseHU6B10', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '28369', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-i7m2cecji09', - ], - ], - [ - 'name' => 'Ip', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => '监听IP地址。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '172.22.0.240', - ], + 'schema' => ['description' => '路由条目ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '950'], ], [ - 'name' => 'NamespaceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，默认为public', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ea02a522-9482-4255-bb65-dc0636d783f2', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => '实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Listeners' => [ - 'description' => '监听信息。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Md5' => [ - 'description' => '校验串。', - 'type' => 'string', - 'example' => '23sdfdf', - ], - 'DataId' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Group' => [ - 'description' => '分组。', - 'type' => 'string', - 'example' => 'default', - ], - 'NamespaceId' => [ - 'description' => '命名空间ID', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '当前页的大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MSE-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1DB1AB36-8395-540E-AACC-7571D6B2057A'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '节点数据。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '发布网关路由', + '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 \\"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' => '根据IP查询监听者列表', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'GetNacosConfig' => [ - 'summary' => '获取Nacos配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ApplyTagPolicies' => [ + 'summary' => '修改标签路由规则。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17035', - 'abilityTreeNodes' => [ - 'FEATUREmseEUE1FY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '16993', + 'abilityTreeNodes' => ['FEATUREmseW9QIF2'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-i7m2h0****', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DataId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'halvie-mp-item****', - ], + 'schema' => ['title' => '应用所属的MSE命名空间', 'description' => '应用所属的MSE命名空间', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'Group', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '配置组信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'common', - ], + 'schema' => ['title' => '应用名字', 'description' => '应用名字', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 64], ], [ - 'name' => 'NamespaceId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，默认为public', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b', - ], + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'deprecated' => true, 'required' => true, 'docRequired' => true, 'example' => 'h5pohqu3gd@xxx'], ], [ - 'name' => 'Beta', + 'name' => 'Rules', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '是否Beta发布，默认为false'."\n" - ."\n" - .'- `true`：是'."\n" - .'- `false`：否', - 'type' => 'boolean', + 'title' => 'key为标签名。', + 'description' => '路由规则。', + 'type' => 'object', 'required' => false, - 'example' => 'true', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => '状态。', + 'enumValueTitles' => ['未生效', '生效', '失效'], + 'example' => '0', + ], + 'Rate' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'description' => '百分比。'], + 'Enable' => ['type' => 'boolean', 'required' => false, 'example' => 'true', 'description' => '是否开启。'], + 'Tag' => ['type' => 'string', 'required' => false, 'description' => '这个路由规则的环境。', 'example' => 'gray'], + 'Name' => ['title' => '路由规则名称。', 'description' => '路由规则名称。', 'type' => 'string', 'required' => false, 'example' => 'gray'], + 'Id' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'description' => '规则ID。'], + 'InstanceNum' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '实例数量。', 'example' => '10'], + 'Rules' => [ + 'title' => '规则信息。', + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'springcloud' => [ + 'title' => 'springcloud规则。', + 'description' => 'springcloud规则。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'condition' => ['title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', 'description' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', 'type' => 'string', 'required' => false, 'example' => 'AND'], + 'restItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'datum' => ['type' => 'string', 'required' => false, 'example' => '10', 'description' => 'rawvalue 等操作符需要比较的值。'], + 'operator' => ['title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', 'description' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', 'type' => 'string', 'required' => false, 'example' => 'rawvalue'], + 'nameList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'description' => '名称。', 'example' => 'test1'], + 'required' => false, + 'description' => 'list 操作符需要的字段。', + ], + 'cond' => ['title' => '比较符号，可取 >=, <=, >, <, == 。', 'description' => '比较符号，可取 >=, <=, >, <, == 。', 'type' => 'string', 'required' => false, 'example' => '=='], + 'divisor' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'description' => 'mod 操作符需要的字段，除数。'], + 'remainder' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '百分比操作需要的字段，百分比值。', 'example' => '30'], + 'rate' => ['title' => '比例规则，20% 的流量路由到该标签对应的节点。', 'description' => '比例规则，20% 的流量路由到该标签对应的节点。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + 'type' => ['type' => 'string', 'required' => false, 'example' => 'test', 'description' => '类型。'], + 'name' => ['type' => 'string', 'required' => false, 'example' => 'key', 'description' => '名称。'], + 'value' => ['type' => 'any', 'required' => false, 'example' => 'test', 'description' => '值。'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'triggerPolicy' => [ + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PERCENT' => '比例规则', 'CONTENT' => '内容匹配规则'], + 'example' => 'CONTENT', + 'description' => '策略类型。', + ], + 'enable' => ['type' => 'boolean', 'required' => false, 'description' => '是否开启。', 'example' => 'true'], + 'appId' => ['type' => 'string', 'required' => false, 'example' => '***@***', 'description' => '应用ID。'], + 'priority' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '优先级。', 'example' => '1'], + 'tags' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'example' => 'gray', 'description' => '标签。'], + 'required' => false, + 'description' => '标签列表。', + ], + 'paths' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'example' => '/hello', 'description' => '路径。'], + 'required' => false, + 'description' => '路径列表。', + ], + 'path' => ['type' => 'string', 'required' => false, 'description' => '路径。', 'example' => '/hello'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'dubbo' => [ + 'title' => 'dubbo 规则。', + 'description' => 'dubbo 规则。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appId' => ['type' => 'string', 'required' => false, 'description' => '应用ID。', 'example' => '***@***'."\n"], + 'tags' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'example' => 'gray', 'description' => '标签。'], + 'required' => false, + 'description' => '标签列表。', + ], + 'triggerPolicy' => ['type' => 'string', 'required' => false, 'description' => '策略类型。', 'example' => 'CONTENT'], + 'serviceName' => ['title' => '服务名（接口）。', 'description' => '服务名（接口）。', 'type' => 'string', 'required' => false, 'example' => 'HelloService'], + 'group' => ['title' => 'dubbo服务分组。', 'description' => 'dubbo服务分组。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'version' => ['title' => 'dubbo服务版本。', 'description' => 'dubbo服务版本。', 'type' => 'string', 'required' => false, 'example' => '1.0.0'], + 'methodName' => ['title' => 'dubbo服务的方法名。', 'description' => 'dubbo服务的方法名。', 'type' => 'string', 'required' => false, 'example' => 'hello'], + 'paramTypes' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'example' => 'int', 'description' => '参数类型。'], + 'required' => false, + 'description' => '参数类型列表。', + ], + 'condition' => ['title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', 'description' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', 'type' => 'string', 'required' => false, 'example' => 'AND'], + 'argumentItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'operator' => ['title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', 'description' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', 'type' => 'string', 'required' => false, 'example' => 'rawvalue'], + 'nameList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'description' => '名称。', 'example' => 'demo'], + 'required' => false, + 'description' => '名称列表。', + ], + 'datum' => ['type' => 'string', 'required' => false, 'description' => 'rawvalue 等操作符需要比较的值。', 'example' => '30'."\n"], + 'cond' => ['title' => '比较符号，可取 >=, <=, >, <, == 。', 'description' => '比较符号，可取 >=, <=, >, <, == 。', 'type' => 'string', 'required' => false, 'example' => '=='], + 'divisor' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => 'mod 操作符需要的字段，除数。', 'example' => '30'."\n"], + 'remainder' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'."\n", 'description' => '百分比操作需要的字段，百分比值。'], + 'rate' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '比例规则，20% 的流量路由到该标签对应的节点。', 'example' => '10'], + 'index' => ['title' => '参数位置，从0开始。', 'description' => '参数位置，从0开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'expr' => ['title' => '表达式，见其他字段解释。', 'description' => '表达式，见其他字段解释。', 'type' => 'string', 'required' => false], + 'value' => ['title' => '比较的值。表达式得到的值会跟这个值比较。如果 operator 是 list 白名单，value 的值用 \\",\\" 分隔，比如 1,2,3。', 'description' => '比较的值。表达式得到的值会跟这个值比较。如果 operator 是 list 白名单，value 的值用 \\",\\" 分隔，比如 1,2,3。', 'type' => 'any', 'required' => false, 'example' => '1,2,3'], + ], + 'required' => false, + 'description' => '参数内容。', + ], + 'required' => false, + 'description' => '参数内容列表。', + ], + ], + 'required' => false, + 'description' => '规则内容。', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], ], ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID，可以不填。', 'type' => 'string', 'required' => false, 'example' => '12233****'], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => '是否开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD', - ], - 'Configuration' => [ - 'description' => '配置信息。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '配置内容的格式。', - 'type' => 'string', - 'example' => 'text', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Tags' => [ - 'description' => '配置的标签。', - 'type' => 'string', - 'example' => 'context', - ], - 'Md5' => [ - 'description' => '配置的消息摘要。', - 'type' => 'string', - 'example' => '123rfsdf3', - ], - 'DataId' => [ - 'description' => '配置ID。', - 'type' => 'string', - 'example' => 'log.yaml', - ], - 'Content' => [ - 'description' => '配置内容。', - 'type' => 'string', - 'example' => 'log.level=error', - ], - 'Group' => [ - 'description' => '配置组名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Desc' => [ - 'description' => '配置描述。', - 'type' => 'string', - 'example' => '测试专用', - ], - 'EncryptedDataKey' => [ - 'description' => '加密密钥。', - 'type' => 'string', - 'example' => 'key', - ], - 'BetaIps' => [ - 'description' => 'Beta发布的IP列表。', - 'type' => 'string', - 'example' => '1.1.XX.XX，2.2.XX.XX', - ], - 'GrayVersions' => [ - 'title' => '当前配置的灰度版本信息', - 'description' => '当前配置的灰度版本信息', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '灰度类型', - 'description' => '灰度类型', - 'type' => 'string', - 'enumValueTitles' => [ - 'Tags' => 'Tags', - 'Beta' => 'Beta', - ], - 'example' => 'Beta', - ], - 'Name' => [ - 'title' => '灰度版本名称', - 'description' => '灰度版本名称', - 'type' => 'string', - 'example' => 'test', - ], - 'Rule' => [ - 'title' => '当前灰度版本的规则', - 'description' => '当前灰度版本的规则', - 'type' => 'string', - 'example' => 'a=b', - ], - 'Priority' => [ - 'title' => '当前灰度规则的优先级', - 'description' => '当前灰度规则的优先级', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Data' => [ + 'description' => '数据概览', + 'type' => 'array', + 'items' => [ + 'description' => '数据概览', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '生效状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'InstanceNum' => ['description' => '实例数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Remove' => ['description' => '是否删除成功。', 'type' => 'boolean'], + 'CarryData' => ['description' => '是否为主键。', 'type' => 'boolean', 'example' => 'true'], + 'Tag' => ['description' => '标签。', 'type' => 'string', 'example' => 'gray'], + 'Name' => ['description' => '策略名称', 'type' => 'string', 'example' => 'test'], + 'Rules' => ['description' => '标签规则', 'type' => 'string', 'example' => '{\\"_base\\": {\\"rate\\": 100, \\"remove\\": true}, \\"blue\\": {\\"rate\\": 0}}'], + 'Id' => ['description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'Rate' => ['description' => '比例', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Enable' => ['description' => '开启或关闭。'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', 'type' => 'boolean', 'example' => 'true'], ], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => '请求结果', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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\\": 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' => '修改标签路由规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ApplyTagPolicies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取Nacos配置', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'GetNacosHistoryConfig' => [ - 'summary' => '查询Nacos配置变更历史列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'BindSentinelBlockFallbackDefinition' => [ + 'summary' => '绑定流量防护行为。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '164017', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-st220g9ka02', - ], + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'DataId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'msg-center.main.yaml', - ], + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'required' => true, 'example' => 'prod'], ], [ - 'name' => 'Group', + 'name' => 'FallbackId', 'in' => 'query', - 'schema' => [ - 'description' => '分组。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['title' => '行为ID。', 'description' => '行为ID，其中0表示默认行为。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21'], ], [ - 'name' => 'NamespaceId', + 'name' => 'TargetType', 'in' => 'query', 'schema' => [ - 'description' => '命名空间ID。', + 'title' => '目标规则类型。', + 'description' => '目标规则类型。', 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba', + 'required' => true, + 'enumValueTitles' => [1 => '接口流控', '熔断规则', 4 => '热点参数防护（RPC）', 6 => '并发隔离', 11 => '热点参数防护（HTTP 请求）'], + 'example' => '1', ], ], [ - 'name' => 'Nid', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => '配置单ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40****', - ], + 'schema' => ['title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'type' => 'string', 'required' => true, 'example' => '/a'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Configuration' => [ - 'description' => '配置信息。', - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Md5' => [ - 'description' => '配置的消息摘要。', - 'type' => 'string', - 'example' => '23sdf32f****', - ], - 'DataId' => [ - 'description' => '配置ID。', - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Content' => [ - 'description' => '配置内容。', - 'type' => 'string', - 'example' => 'test', - ], - 'Group' => [ - 'description' => '配置组名称。', - 'type' => 'string', - 'example' => 'public', - ], - 'OpType' => [ - 'description' => '配置类型。', - 'type' => 'string', - 'example' => 'text', - ], - 'EncryptedDataKey' => [ - 'description' => '加密密钥。', - 'type' => 'string', - 'example' => '23fds****', - ], - ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['title' => '响应信息。', 'description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Data' => ['title' => '返回详情。', 'description' => '返回详情。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => '状态码。', 'description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '请求结果。', 'description' => '请求结果。', 'type' => 'string', 'example' => 'true'], + 'HttpStatusCode' => ['title' => '状态码。', 'description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '绑定流量防护行为', + '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 \\"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' => '查询Nacos配置历史', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'ListNacosConfigs' => [ - 'summary' => '查询Nacos配置列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ChangeResourceGroup' => [ + 'summary' => '资源转组', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['common'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17072', - 'abilityTreeNodes' => [ - 'FEATUREmse8153EN', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'update', + 'abilityTreeCode' => '150111', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'title' => '参数弃用，无需填写', - 'description' => '扩展请求参数，支持JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"appGroup\\":\\"sm_zk_asi_na610\\",\\"appName\\":\\"sm-zk\\",\\"appStage\\":\\"PUBLISH\\",\\"appUnit\\":\\"center\\",\\"bucId\\":\\"193554\\",\\"bucName\\":\\"阿里移动事业群-UC\\",\\"provider\\":\\"aliyun\\"}', - ], + 'schema' => ['title' => '资源类型', 'description' => '资源类型，例如注册配置中心集群、网关实例', 'type' => 'string', 'required' => false, 'example' => 'Cluster,Gateway', 'default' => 'Cluster'], ], [ - 'name' => 'PageNum', + 'name' => 'ResourceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '5', - ], + 'schema' => ['title' => '资源Id', 'description' => '资源Id，即注册配置中心实例ID或网关唯一ID', 'type' => 'string', 'required' => true, 'example' => 'mse-cn-xxxxxxxxxxx，'."\n" + .'gw-xxxxxxxxxxxxxxxxxxxx'], ], [ - 'name' => 'PageSize', + 'name' => 'ResourceRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '每页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '200', - ], + 'schema' => ['title' => '地域Id', 'description' => '地域Id', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InstanceId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-7mz2fj****', - ], + 'schema' => ['title' => '目标资源组', 'description' => '目标资源组', 'type' => 'string', 'required' => true, 'example' => 'rg-acfm34x43l*****'], ], [ - 'name' => 'RegionId', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群所在地域，MSE支持的地域。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'zeekr-*', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\"\\n}","type":"json"}]', + 'title' => '更改实例所在资源组', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CloneNacosConfig' => [ + 'summary' => '将已有的Nacos配置克隆到其他命名空间。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '76154', + 'abilityTreeNodes' => ['FEATUREmseYJ44D3'], + ], + 'parameters' => [ [ - 'name' => 'Group', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分组类型，默认为`default`。', - 'type' => 'string', - 'required' => false, - 'example' => 'crm', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-i7m25igg403'], ], [ - 'name' => 'AppName', + 'name' => 'OriginNamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '应用名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'fpx-pds-pns', - ], + 'schema' => ['description' => '源命名空间ID。', 'type' => 'string', 'required' => false, 'example' => 'be821963-6d48-4ea5-9910-6057d****'], ], [ - 'name' => 'Tags', + 'name' => 'TargetNamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '标签。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'billing', - ], + 'schema' => ['description' => '目标命名空间ID。', 'type' => 'string', 'required' => false, 'example' => '08be4b5d-2d1c-4e6e-aa85-83b9****'], ], [ - 'name' => 'NamespaceId', + 'name' => 'Policy', 'in' => 'query', 'schema' => [ - 'description' => '命名空间ID。', + 'description' => '当写入冲突时，使用的策略。'."\n" + ."\n" + .'- ABORT'."\n" + .'- SKIP'."\n" + .'- OVERWRITE', 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'fad732a7-ff1a-4f21-8126-4edd4****', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => ['ABORT' => '终止', 'OVERWRITE' => '覆盖', 'SKIP' => '跳过'], + 'example' => 'OVERWRITE', ], ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => ['description' => '配置ID列表。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => '253661,253662'], + ], + [ + 'name' => 'DataIds', + 'in' => 'query', + 'schema' => ['title' => '需要克隆的配置项，格式为 dataId+group，多个配置项使用 , 分隔', 'description' => '需要克隆的配置项，格式为 dataId+group，多个配置项使用 , 分隔', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test+test,test1+test1'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -5496,92 +3746,48 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'TotalCount' => [ - 'description' => '实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4081087F-3429-5873-A1E7-D4B5479D0B84', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Configurations' => [ - 'description' => '配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'DataId' => [ - 'description' => '配置ID。', - 'type' => 'string', - 'example' => 'log.yaml', - ], - 'Id' => [ - 'description' => '应用ID', - 'type' => 'string', - 'example' => '132****', - ], - 'Group' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'example' => 'public', - ], - 'Description' => [ - 'type' => 'string', - ], - 'ConfigTags' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Code' => [ - 'description' => '返回代码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6678DBA9-5600-5948-ACF8-ED3105B288A3'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'Clone Completed Successfully'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'SuccCount' => ['description' => '成功数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'SkipCount' => ['description' => '跳过数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SkipData' => [ + 'description' => '跳过配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'DataId' => ['description' => '数据ID。', 'type' => 'string', 'example' => 'test.yaml'], + 'Group' => ['description' => '分组ID。', 'type' => 'string', 'example' => 'public '], + ], + ], + ], + 'FailData' => [ + 'description' => '配置失败信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'DataId' => ['description' => '数据ID。', 'type' => 'string', 'example' => 'test2.yaml'], + 'Group' => ['description' => '分组ID。', 'type' => 'string', 'example' => 'test'], + 'Reason' => ['description' => '错误原因。', 'type' => 'string', 'example' => 'The current import configuration format is invalid.'], + ], + ], + ], + ], ], ], ], @@ -5589,272 +3795,104 @@ ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => '查询Nacos配置列表', + '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' => '克隆Nacos配置', 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', - ], - 'ListNacosHistoryConfigs' => [ - 'summary' => '查询Nacos配置历史列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CloneNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CloneSentinelRuleFromAhas' => [ + 'summary' => 'AHAS规则迁移。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17073', - 'abilityTreeNodes' => [ - 'FEATUREmseEUE1FY', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '209225', + 'abilityTreeNodes' => ['FEATUREmseHJJ9Z1'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"appGroup\\":\\"aliyun-phecda-service-staging\\",\\"appName\\":\\"aliyun-phecda-service\\",\\"appStage\\":\\"DAILY\\",\\"appUnit\\":\\"center\\",\\"bucId\\":\\"250858\\",\\"bucName\\":\\"阿里云\\",\\"provider\\":\\"aliyun\\"}', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页显示记录条数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-2r42e3bk20n', - ], + 'schema' => ['title' => '命名空间', 'description' => '命名空间', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'RegionId', + 'name' => 'MseAppName', 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，MSE支持的地域。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '迁移后目标 mse 应用名。未填写的情况下默认和 ahas 应用名一致。', 'type' => 'string', 'required' => false, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'DataId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'user-prod.yaml', - ], + 'schema' => ['title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'Group', + 'name' => 'AhasNamespace', 'in' => 'query', - 'schema' => [ - 'description' => '配置组。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'fc-dev-cluster-1', - ], + 'schema' => ['title' => 'AHAS侧命名空间（环境）。', 'description' => 'AHAS侧命名空间（环境）。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'NamespaceId', + 'name' => 'IsAHASPublicRegion', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，默认为public', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'fc0f6e40-****-946b-45e3af313707', - ], + 'schema' => ['title' => 'AHAS侧是否为公网地域。', 'description' => 'AHAS侧是否为公网地域。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult>>', + 'description' => 'RestResult>>', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'TotalCount' => [ - 'description' => '实例配置信息总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '53338ECA-F880-54D8-A9B3-5606355A1B89', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HistoryItems' => [ - 'description' => '配置项列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => '应用标签。', - 'type' => 'string', - 'example' => 'gateway', - ], - 'DataId' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Group' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'example' => 'default', - ], - 'LastModifiedTime' => [ - 'description' => '最后更新时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1643440066000', - ], - 'Id' => [ - 'description' => '配置ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23fdsf', - ], - 'OpType' => [ - 'description' => '配置文本类型。', - 'type' => 'string', - 'example' => 'yaml', - ], - 'SrcUser' => [ - 'description' => '此版本对应的修改用户', - 'type' => 'string', - 'example' => 'test', - ], - ], + 'RequestId' => ['title' => '请求Id。', 'description' => '请求Id。', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Data' => [ + 'title' => '返回结果。', + 'description' => '返回结果。', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '执行结果。', + 'description' => '执行结果。', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => '"完成 AHAS prod:spring-cloud-b -> MSE prod:spring-cloud-b 应用的流控规则迁移。AHAS 侧总规则数: 14 ；成功迁移的规则数: 7 ；完成迁移但存在异常的规则数: 2 ；迁移失败的规则数: 5"', 'description' => '执行结果详情'], ], ], ], @@ -5863,154 +3901,119 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => 'AHAS规则迁移', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CloneSentinelRuleFromAhas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询Nacos配置历史列表', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'CloneNacosConfig' => [ - 'summary' => '将已有的Nacos配置克隆到其他命名空间。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateApplication' => [ + 'summary' => '创建应用。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '76154', - 'abilityTreeNodes' => [ - 'FEATUREmseYJ44D3', - ], + 'abilityTreeCode' => '17001', + 'abilityTreeNodes' => ['FEATUREmse3O985H'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-i7m25igg403', - ], + 'schema' => ['title' => '地域。', 'description' => '应用所属的区域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'OriginNamespaceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '源命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'be821963-6d48-4ea5-9910-6057d****', - ], + 'schema' => ['title' => '应用所属的MSE命名空间。', 'description' => 'MSE命名空间名字。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod', 'maxLength' => 64], ], [ - 'name' => 'TargetNamespaceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '目标命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '08be4b5d-2d1c-4e6e-aa85-83b9****', - ], + 'schema' => ['title' => '应用名。', 'description' => '应用名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'Policy', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '当写入冲突时，使用的策略。'."\n" - ."\n" - .'- ABORT'."\n" - .'- SKIP'."\n" - .'- OVERWRITE', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ABORT' => '终止', - 'OVERWRITE' => '覆盖', - 'SKIP' => '跳过', - ], - 'example' => 'OVERWRITE', - ], + 'schema' => ['description' => '应用的部署方式，ACK表示阿里云容器服务K8s。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ACK', 'default' => 'edasmsc'], ], [ - 'name' => 'Ids', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => '配置ID列表。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - 'example' => '253661,253662', - ], + 'schema' => ['description' => '应用的编程语言。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'JAVA', 'default' => 'JAVA'], ], [ - 'name' => 'DataIds', + 'name' => 'SentinelEnable', 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '是否开启Sentinel。', 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'SwitchEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '是否开始Switch。', 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '需要克隆的配置项，格式为 dataId+group，多个配置项使用 , 分隔', - 'description' => '需要克隆的配置项，格式为 dataId+group，多个配置项使用 , 分隔', - 'type' => 'string', + 'description' => '阿里云标签。', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '用户输入的自定义标签键。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'tagKey'], + 'Value' => ['description' => '标签值。最多支持128个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'tagKey'], + ], + 'required' => false, + ], 'required' => false, - 'docRequired' => true, - 'example' => 'test+test,test1+test1', + 'minItems' => 0, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -6019,641 +4022,624 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6678DBA9-5600-5948-ACF8-ED3105B288A3', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'Clone Completed Successfully', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '68D91223-CCE9-5F9C-B538-20F617DA48B1'], 'Data' => [ - 'description' => '数据概览。', + 'description' => '节点数据。', 'type' => 'object', 'properties' => [ - 'SuccCount' => [ - 'description' => '成功数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'SkipCount' => [ - 'description' => '跳过数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SkipData' => [ - 'description' => '跳过配置信息。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'DataId' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Group' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'example' => 'public ', - ], - ], - ], - ], - 'FailData' => [ - 'description' => '配置失败信息。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'DataId' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'example' => 'test2.yaml', - ], - 'Group' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'example' => 'test', - ], - 'Reason' => [ - 'description' => '错误原因。', - 'type' => 'string', - 'example' => '当前导入配置格式非法', - ], - ], - ], - ], + 'Status' => ['description' => '应用状态，1表示正常。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExtraInfo' => ['description' => '额外信息。', 'type' => 'string', 'example' => '{\\"rpcTypes\\":[\\"dubbo\\",\\"springCloud\\"]}'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'UpdateTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1632979237663'], + 'LicenseKey' => ['description' => '用户的对应的LicenseKey。', 'type' => 'string', 'example' => 'xxxxxxxx@xxxxxxxxxx'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631001140913'], + 'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'xxxxxxxx@xxxxxxxxxx'], + 'UserId' => ['description' => '阿里云用户ID。', 'type' => 'string', 'example' => '1888888888'], + 'Source' => ['description' => '应用的部署方式。'."\n" + ."\n" + .'- ACK：表示阿里云容器服务K8s。'."\n" + .'- Normal：表示其他接入方式。', 'type' => 'string', 'example' => 'ACK'], + 'Language' => ['description' => '应用的编程语言。', 'type' => 'string', 'example' => 'JAVA'], + 'RegionId' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Namespace' => ['description' => 'MSE命名空间名字。', 'type' => 'string', 'example' => 'prod'], + 'Version' => ['description' => '版本号。', 'type' => 'string', 'example' => '1.0.0'], ], + 'example' => 'data', ], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'string', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建应用', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '克隆Nacos配置', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'ExportNacosConfig' => [ - 'summary' => '导出指定的Nacos配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateCircuitBreakerRule' => [ + 'summary' => '创建熔断规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '76155', - 'abilityTreeNodes' => [ - 'FEATUREmse8153EN', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '167810', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-2r42ddc****', - ], + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'], ], [ - 'name' => 'NamespaceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，默认为public', - 'type' => 'string', - 'required' => false, - 'example' => 'ae77c258-4d4f-478f-baaa-084aee0****', - ], + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'Ids', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '配置项主键ID。'."\n" - ."\n" - .'>'."\n" - .'- 支持多种导出方式。当选择导出多个配置时，此参数必填。'."\n" - .'- 此参数可通过ListNacosConfigs接口获取。'."\n" - .'- 当配置此参数时，表示选择导出多个配置，DataId和Group参数无效。'."\n" - .'>'."\n" - ."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '1709,1710', - ], + 'schema' => ['title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '0.8'], ], [ - 'name' => 'DataId', + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => '待导出的数据ID。'."\n" - ."\n" - .''."\n" - ."\n" - .'- 支持多种导出方式。'."\n" - .'- 当选择导出单个配置时，参数Ids必须为空，DataID以及Group必填。>', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - 'example' => 'demo-develop', + 'title' => '规则的启用状态。', + 'description' => '规则的启用状态。', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => ['true' => '启用', 'false' => '关闭'], + 'example' => 'true', ], ], [ - 'name' => 'Group', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => '配置组名称。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'COMMON_GROUP', - ], + 'schema' => ['title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/a'], ], [ - 'name' => 'AppName', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '应用标签。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'gateway-openapi', - ], + 'schema' => ['title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], ], [ - 'name' => 'DataIds', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '集群所在地域。', 'description' => '集群所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Strategy', 'in' => 'query', 'schema' => [ - 'description' => '需要导出的数据的 dataId+groupName， 多个配置使用 "," 分隔', - 'type' => 'string', + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'type' => 'integer', + 'format' => 'int32', 'required' => true, - 'docRequired' => true, - 'example' => 'testDataId1+testGroup1,testDataId2+testGroup', + 'enumValueTitles' => ['慢调用比例', '异常比例'], + 'example' => '0', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'RetryTimeoutMs', + 'in' => 'query', + 'schema' => ['title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'], + ], + [ + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => ['title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20000'], + ], + [ + 'name' => 'MaxAllowedRtMs', + 'in' => 'query', + 'schema' => ['title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', 'description' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => ['title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'HalfOpenBaseAmountPerStep', + 'in' => 'query', + 'schema' => ['title' => '熔断恢复每步最小通过数目，默认值为1。', 'description' => '熔断恢复每步最小通过数目，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'HalfOpenRecoveryStepNum', + 'in' => 'query', + 'schema' => ['title' => '熔断恢复阶段数，默认值为1。', 'description' => '熔断恢复阶段数，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', + 'description' => '资源类型。', + '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' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '92245803-49B7-54CF-8D49-01A34A0E1CD6', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的 **%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'Message' => ['title' => '响应信息。', 'description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Code' => ['title' => '响应码。', 'description' => '响应码。', 'type' => 'string', 'example' => '200'], 'Data' => [ - 'description' => '数据概览。', + 'title' => '规则信息。', + 'description' => '规则信息。', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => '导出配置的下载地址。', - 'type' => 'string', - 'example' => 'http://xxxxxxxxx', + 'Namespace' => ['title' => '应用所属的微服务命空间。', 'description' => '应用所属的微服务命空间。', 'type' => 'string', 'example' => 'default'], + 'Id' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AppName' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'type' => 'string', 'example' => '/a'], + 'StatIntervalMs' => ['title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '20000'], + 'Threshold' => ['title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', 'type' => 'number', 'format' => 'float', 'example' => '0.8'], + 'Enable' => ['title' => '规则的启用状态。', 'description' => '规则的启用状态。', 'type' => 'boolean', 'example' => 'true'], + 'Strategy' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['慢调用比例', '异常比例'], + 'example' => '0', ], + 'RetryTimeoutMs' => ['title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'AppId' => ['title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@c3df23522bXXXXX'], + 'RegionId' => ['title' => '集群所在地域。', 'description' => '集群所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'MaxAllowedRtMs' => ['title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', 'description' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'MinRequestAmount' => ['title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'HalfOpenBaseAmountPerStep' => ['title' => '熔断恢复每步最小通过数目。', 'description' => '熔断恢复每步最小通过数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'HalfOpenRecoveryStepNum' => ['title' => '熔断恢复阶段数。', 'description' => '熔断恢复阶段数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => '请求结果。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '请求成功', 'false' => '请求失败'], + 'example' => 'true', + ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxxxx\\"\\n }\\n}","type":"json"}]', - 'title' => '导出Nacos配置', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', - ], - 'GetImportFileUrl' => [ - 'summary' => '获取Nacos配置导入时获取文件的上传地址。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - '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' => '创建熔断规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateCluster' => [ + 'summary' => '创建一个注册配置中心（ZooKeeper、Nacos等）集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '76156', - 'abilityTreeNodes' => [ - 'FEATUREmseEPOTV0', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '17002', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'ContentType', + 'name' => 'PubNetworkFlow', + 'in' => 'query', + 'schema' => ['title' => 'ConnectionType为`slb`时有效，0表示不创建公网接入SLB，1以上值表示公网接入SLB的带宽固定值；单位Mbps', 'description' => 'ConnectionType为`slb`时有效，0表示不创建公网接入SLB，1以上值表示公网接入SLB的带宽固定值；单位Mbps。'."\n" + ."\n" + .'取值范围：0~5000。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0'], + ], + [ + 'name' => 'PubSlbSpecification', + 'in' => 'query', + 'schema' => ['title' => '不再使用', 'description' => '不再使用', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false], + ], + [ + 'name' => 'DiskType', + 'in' => 'query', + 'schema' => ['title' => '不再使用', 'description' => '不再使用', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-bp1t50e045b5g7i3p****'], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => ['description' => '网络类型，取值如下：'."\n" + .'- `privatenet`：表示专有网络。'."\n" + .'- `pubnet`：表示公网。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'privatenet'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vsw-bp17opt4v18sto39k****'], + ], + [ + 'name' => 'InstanceCount', + 'in' => 'query', + 'schema' => ['title' => '实例节点数，开发版仅支持1节点，其它版本支持3-9单数节点', 'description' => '实例节点数，范围限制：1~9个。'."\n" + ."\n" + .'[专业版] '."\n" + .'- 实例数大于等于3，且必须为奇数。'."\n" + ."\n" + .'[开发版] '."\n" + .'- 实例数只能为1。'."\n" + ."\n" + .'[Serverless版]'."\n" + ."\n" + .'忽略该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3'], + ], + [ + 'name' => 'ClusterSpecification', + 'in' => 'query', + 'schema' => ['description' => '引擎规格，取值如下：'."\n" + ."\n" + .'[专业版] '."\n" + ."\n" + .'- `MSE_SC_2_4_60_c`：2核4G'."\n" + .'- `MSE_SC_1_2_60_c`：1核2G'."\n" + .'- `MSE_SC_4_8_60_c`：4核8G'."\n" + .'- `MSE_SC_8_16_60_c`：8核16G'."\n" + .'- `MSE_SC_16_32_60_c`：16核32G'."\n" + ."\n" + .'[开发版] '."\n" + ."\n" + .'- `MSE_SC_1_2_60_c`：1核2G'."\n" + .'- `MSE_SC_2_4_60_c`：2核4G'."\n" + ."\n" + .'[Serverless版]'."\n" + ."\n" + .'忽略该参数，也可填`MSE_SC_SERVERLESS`。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MSE_SC_2_4_60_c'], + ], + [ + 'name' => 'ClusterVersion', + 'in' => 'query', + 'schema' => ['description' => '集群版本，取值如下：'."\n" + ."\n" + .'[专业版] '."\n" + ."\n" + .'- `NACOS_2_0_0`：表示Nacos 2.x.x 版本。'."\n" + .'- `ZooKeeper_3_8_0`：表示ZooKeeper 3.8.x 版本。'."\n" + ."\n" + .'[开发版] '."\n" + ."\n" + .'- `NACOS_2_0_0`：表示Nacos 2.x 版本。'."\n" + .'- `ZooKeeper_3_8_0`：表示ZooKeeper 3.8.x 版本。'."\n" + ."\n" + .'[Serverless版]'."\n" + ."\n" + .'- `NACOS_2_0_0`：表示Nacos 2.x 版本。'."\n" + .'- `ZooKeeper_3_8_0`：表示ZooKeeper 3.8.x 版本。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NACOS_2_0_0'], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => ['description' => '集群类型，包括ZooKeeper、Nacos-Ans。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Nacos-Ans'], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => '集群所在地域，包括但不限于如下地域：'."\n" + .'- `cn-hangzhou`：杭州'."\n" + .'- `cn-beijing`：北京'."\n" + .'- `cn-shanghai`：上海'."\n" + .'- `cn-zhangjiakou`：张家口'."\n" + .'- `cn-shenzhen`：深圳', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'PrivateSlbSpecification', + 'in' => 'query', + 'schema' => ['title' => '不再使用', 'description' => '不再使用', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => ['title' => '网络接入类型，`slb`或`single_eni`；部分Region开发版只支持`single_eni`类型', 'description' => '网络接入类型，`slb`或`single_eni`；部分Region开发版只支持`single_eni`类型。', 'type' => 'string', 'required' => false], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + [ + 'name' => 'MseVersion', 'in' => 'query', 'schema' => [ - 'description' => '文件类型。', + 'title' => '实例版本：开发版mse_dev、基础版mse_basic、专业版mse_pro', + 'description' => '非特殊情况必填，取值如下：'."\n" + ."\n" + .'- `mse_pro`：表示专业版。'."\n" + .'- `mse_dev`：表示开发版。'."\n" + .'- `mse_serverless`：表示Serverless版。', 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'application/zip', + 'enumValueTitles' => ['mse_dev' => '开发版', 'mse_serverless' => 'Serverless版', 'mse_pro' => '专业版'], + 'example' => 'mse_pro', ], ], [ - 'name' => 'InstanceId', + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['title' => '实例别名', 'description' => '实例自定义名称', 'type' => 'string', 'required' => false, 'example' => 'tanshuyingtest001'], + ], + [ + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '资源组ID。资源组详情请参见查看[资源组基本信息](~~457230~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzcqmoay3dlyq'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-7pp2b****', + 'title' => '标签列表，最多包含20个子项', + 'description' => '待添加的标签列表。最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签KEY。', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'prd'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, ], ], [ - 'name' => 'NamespaceId', + 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'description' => '命名空间ID。', + 'title' => '付费类型', + 'description' => '付费模式，包括PREPAY（包年包月）和POSTPAY（按量付费）。'."\n" + ."\n" + .'Serverless版忽略该参数。', 'type' => 'string', 'required' => false, - 'example' => '12788f73-9848-4388-98f1-507778f2****', + 'enumValueTitles' => ['PREPAY' => '包年包月', 'POSTPAY' => '按量付费'], + 'example' => 'POSTPAY', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'SecurityGroupType', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', + 'title' => 'ConnectionType为`single_eni`时有效，表示实例所在的安全组类型', + 'description' => 'ConnectionType为`single_eni`时有效，表示实例所在的安全组类型', 'type' => 'string', 'required' => false, - 'example' => 'zh', + 'example' => 'enterprise', + 'default' => 'enterprise', + 'enum' => ['enterprise', 'normal'], + ], + ], + [ + 'name' => 'EipEnabled', + 'in' => 'query', + 'schema' => [ + 'title' => 'ConnectionType为`single_eni`时有效，表示是否开启公网访问（弹性公网IP）', + 'description' => 'ConnectionType为`single_eni`时有效，表示是否开启公网访问（弹性公网IP）', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'default' => 'false', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '字符串对象。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '19488A00-4AF5-55E1-A689-98BA9F5E7441', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => '文件上传地址。', - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'dc63-465d-8ef5-20dc18af****'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '20574710974****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'responseDemo' => '[{"type":"json","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}","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' => '创建注册配置中心集群', + 'description' => '请确保在使用该接口前，已充分了解MSE（Microservice Engine）产品的收费方式和价格。', + '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 \\"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' => '获取文件上传地址', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'ImportNacosConfig' => [ - 'summary' => '使用配置文件导入Nacos配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateEngineNamespace' => [ + 'summary' => '创建一个Nacos命名空间。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '76157', - 'abilityTreeNodes' => [ - 'FEATUREmseEPOTV0', - ], + 'abilityTreeCode' => '17003', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-98s****'], ], [ - 'name' => 'NamespaceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，默认为public', - 'type' => 'string', - 'required' => false, - 'example' => 'f5cdc80a-****-8094-282f5650fc00', - ], + 'schema' => ['description' => '命名空间展示名字。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dev'], ], [ - 'name' => 'Policy', + 'name' => 'Desc', 'in' => 'query', - 'schema' => [ - 'description' => '策略。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ABORT' => 'ABORT', - 'OVERWRITE' => 'OVERWRITE', - 'SKIP' => 'SKIP', - ], - 'example' => 'OVERWRITE', - ], + 'schema' => ['description' => '命名空间描述。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Development environment'], ], [ - 'name' => 'FileUrl', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '导入文件地址必须为MSE生成的地址（否则提示无权限）。'."\n" - .'获取步骤：'."\n" - ."\n" - .'1.GetImportFileUrl API获取到地址。'."\n" - ."\n" - .'2.通过标准的HTTP PUT方法将文件上传到上述API返回的HTTP地址。'."\n" - ."\n" - .'3.调用ImportNacosConfig API导入。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'http://mse-shared.oss-xxx.aliyuncs.com/cfg/import/xxxx/2021/01/11/xxxx.zip', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-cn-st21ri2****'], + ], + [ + 'name' => 'ServiceCount', + 'in' => 'query', + 'schema' => ['description' => '当前命名空间下运行的最大服务数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '命名空间自定义ID，如果填写，将返回填写的namespaceId， 如果不填写，则自动生成，但是返回中将不包含namespaceId。', 'type' => 'string', 'required' => false, 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -6662,1465 +4648,875 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-100', - ], - 'Code' => [ - 'description' => '代码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的 **%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F6092602-C357-4750-89D9-E572FBEA****'], + 'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'mse-892k****'], 'Data' => [ 'description' => '数据概览。', 'type' => 'object', 'properties' => [ - 'SuccCount' => [ - 'description' => '导入成功的实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'SkipCount' => [ - 'description' => '跳过消息数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SkipData' => [ - 'description' => '跳过的配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'DataId' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Group' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'example' => 'public ', - ], - ], - ], - ], - 'FailData' => [ - 'description' => '导入失败列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'DataId' => [ - 'description' => '数据ID。', - 'type' => 'string', - 'example' => 'test2.yaml', - ], - 'Group' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'example' => 'test', - ], - 'Reason' => [ - 'description' => '失败原因', - 'type' => 'string', - 'example' => '导入配置格式错误', - ], - ], - ], - ], + 'Type' => ['description' => '命名空间类型，取值如下：'."\n" + .'- `0`：全局配置'."\n" + .'- `1`：默认命名空间'."\n" + .'- `2`：自定义命名空间', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NamespaceShowName' => ['description' => '命名空间展示名称。', 'type' => 'string', 'example' => 'dev'], + 'Quota' => ['description' => '配额。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Namespace' => ['description' => '命名空间ID。', 'type' => 'string', 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2'], + 'NamespaceDesc' => ['description' => '命名空间描述。', 'type' => 'string', 'example' => 'mytest'], + 'ConfigCount' => ['description' => '配置数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ServiceCount' => ['description' => '活跃服务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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":"\\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' => '创建引擎命名空间', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '导入Nacos配置', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'ListNamingTrack' => [ - 'summary' => '获取Nacos注册中心的轨迹数据。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateFlowRule' => [ + 'summary' => '创建流控规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '137915', - 'abilityTreeNodes' => [ - 'FEATUREmseN8I3PF', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '163217', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'], ], [ - 'name' => 'InstanceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'mse_prepaid_public_cn-tl32d*****', - ], + 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'ServiceName', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'fpx-xms-baseinfo', - ], + 'schema' => ['description' => '流控规则阈值。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20'], ], [ - 'name' => 'Group', + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => '分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'group', + 'description' => '规则的启用状态。', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => ['true' => '启用', 'false' => '禁用'], + 'example' => 'false', ], ], [ - 'name' => 'NamespaceId', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cd4d3703-e2a6-46b5-85c6-4447e4f****', - ], + 'schema' => ['description' => '接口资源名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/b'], ], [ - 'name' => 'Ip', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端IP。', - 'type' => 'string', - 'required' => false, - 'example' => '172.16.183.232', - ], + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'ib09eblv6p@c3df23522******'], ], [ - 'name' => 'StartTs', + 'name' => 'ControlBehavior', 'in' => 'query', 'schema' => [ - 'description' => '开始时间戳，单位秒。', + 'description' => '流控效果。', 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1660238450', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => ['快速失败', 2 => '排队等待'], + 'example' => '0', + 'default' => '0', ], ], [ - 'name' => 'EndTs', + 'name' => 'MaxQueueingTimeMs', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间戳，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1665299698', - ], + 'schema' => ['description' => '超时时间，流控效果为排队等待时需要设置，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '当前页的大小。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => '集群所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PageNum', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => '当前页。', + 'description' => '接口资源分类。', 'type' => 'integer', - 'format' => 'int64', - 'required' => true, + 'format' => 'int32', + 'required' => false, 'example' => '1', + 'enum' => ['0', '1', '2', '4', '3'], ], ], [ - 'name' => 'Reverse', + 'name' => 'LimitApp', 'in' => 'query', - 'schema' => [ - 'description' => '按照时间正序或者倒序排列。默认值为`false`。'."\n" - ."\n" - .'- `true`：表示倒序'."\n" - .'- `false`：表示正序'."\n" - ."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '请求来源应用。', 'type' => 'string', 'required' => false, 'example' => 'spring-cloud-a'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Traces' => [ - 'description' => '信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'PushTime' => [ - 'description' => '推送时间。', - 'type' => 'string', - 'example' => '2022-12-16 11:48:07', - ], - 'NodeName' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => 'mse-197*****-167083******-reg-center-0-0', - ], - 'ClientIp' => [ - 'description' => '客户端IP。', - 'type' => 'string', - 'example' => '120.40.32.235', - ], - 'ServerName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'fpx-xms-baseinfo', - ], - 'Group' => [ - 'description' => '分组。', - 'type' => 'string', - 'example' => 'prod', - ], - 'InstanceSize' => [ - 'description' => '实例个数。', - 'type' => 'string', - 'example' => '1', - ], - 'PushTimeAll' => [ - 'description' => '总推送耗时。', - 'type' => 'string', - 'example' => '628ms', - ], - 'PushTimeNetwork' => [ - 'description' => '推送网络耗时。', - 'type' => 'string', - 'example' => '37ms', - ], - 'SlaTime' => [ - 'description' => 'SLA时间。', - 'type' => 'string', - 'example' => '628ms', - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => '接口资源名。', 'type' => 'string', 'example' => 'app'], + 'ControlBehavior' => [ + 'description' => '流控效果。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['快速失败', 2 => '排队等待'], + 'example' => '0', + ], + 'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'Threshold' => ['description' => '流控规则阈值。', 'type' => 'number', 'format' => 'float', 'example' => '200'], + 'Enable' => [ + 'description' => '规则的启用状态。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', ], + 'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@54e1f42f3******'], + 'RegionId' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'LimitApp' => ['description' => '请求来源应用。', 'type' => 'string', 'example' => 'spring-cloud-a'], ], ], - 'PageSize' => [ - 'description' => '当前页的大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '总记录条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9916CBED-B2D5-5685-9129-4592FE1*****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', + 'description' => '请求结果。', 'type' => 'boolean', + 'enumValueTitles' => ['true' => '请求成功', 'false' => '请求失败'], 'example' => 'true', ], ], + 'description' => '', ], ], ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '创建流控规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '获取Nacos注册中心推送轨迹', ], - 'CreateNacosService' => [ - 'summary' => '创建Nacos服务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateGatewayCircuitBreakerRule' => [ + 'summary' => '创建网关熔断规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '104937', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407'], ], [ - 'name' => 'ServiceName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'com.alibabacloud.hipstershop.cartserviceapi.service.CartService', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491*****'], ], [ - 'name' => 'GroupName', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '645'], ], [ - 'name' => 'NamespaceId', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'production', - ], + 'schema' => ['description' => '路由名称。', 'type' => 'string', 'required' => true, 'example' => 'routeName'], ], [ - 'name' => 'ProtectThreshold', + 'name' => 'Strategy', 'in' => 'query', - 'schema' => [ - 'description' => '保护阈值。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '阈值类型。'."\n" + ."\n" + .'0：慢调用类型。'."\n" + ."\n" + .'1：异常类型。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ - 'name' => 'Ephemeral', + 'name' => 'TriggerRatio', 'in' => 'query', - 'schema' => [ - 'description' => '是否临时节点标志，取值如下：'."\n" - .'- `true`：是。'."\n" - .'- `false`：否。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '触发熔断百分比。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], [ - 'name' => 'ClusterId', + 'name' => 'StatDurationSec', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-3691a080', - ], + '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' => 'Web fallbac行为类型。'."\n" + ."\n" + .'0：返回指定文本。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本。'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429'], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'HTTP返回文本。', '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' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => '节点数据。', - 'type' => 'string', - 'example' => 'data', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], + 'Data' => ['description' => '返回规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '28'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": 28\\n}","type":"json"}]', + 'title' => '创建网关熔断规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '创建Nacos服务', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'ListAnsServices' => [ - 'summary' => '查询Nacos服务详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateGatewayFlowRule' => [ + 'summary' => '创建网关流控规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '17058', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ServiceName', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'title' => '查询指定的服务名信息', - 'description' => '服务名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407'], ], [ - 'name' => 'GroupName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '服务所在的分组', - 'description' => '联系人组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], ], [ - 'name' => 'NamespaceId', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'title' => '服务所在的 namespace', - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '12233****', - ], + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '52853'], ], [ - 'name' => 'ClusterName', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'title' => '查询服务下某个集群的实例列表是所需要的参数', - 'description' => '查询服务下某个集群的实例列表时所需要的参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], + 'schema' => ['description' => '路由名称。', 'type' => 'string', 'required' => true, 'example' => 'routeName'], ], [ - 'name' => 'HasIpCount', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询服务实例数量。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'false' => '不需要', - 'true' => '需要', - ], - 'example' => 'true', - ], + 'schema' => ['description' => '总体QPS阈值。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], [ - 'name' => 'ClusterId', + 'name' => 'BehaviorType', 'in' => 'query', - 'schema' => [ - 'title' => '不推荐使用，请使用 InstanceId', - 'description' => '集群ID。'."\n" - ."\n" - .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'Web fallbac行为类型。'."\n" + ."\n" + .'0：返回指定文本。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ - 'name' => 'InstanceId', + 'name' => 'BodyEncoding', 'in' => 'query', - 'schema' => [ - 'title' => '集群实例Id', - 'description' => '实例ID。'."\n" - ."\n" - .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21v5****', - ], + 'schema' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本。'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'PageNum', + 'name' => 'ResponseStatusCode', 'in' => 'query', - 'schema' => [ - 'title' => '查询第几页', - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429'], ], [ - 'name' => 'PageSize', + 'name' => 'ResponseContentBody', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示条数', - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'HTTP返回文本。', 'type' => 'string', 'required' => false, 'example' => 'text'], ], [ - 'name' => 'RegionId', + 'name' => 'ResponseRedirectUrl', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '跳转地址。', 'type' => 'string', 'required' => false, 'example' => 'www.******.com'], ], [ - 'name' => 'RequestPars', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => '实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'HealthyInstanceCount' => [ - 'description' => '健康心跳的服务实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GroupName' => [ - 'description' => '联系人组名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'IpCount' => [ - 'description' => '当前服务的实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'ClusterCount' => [ - 'description' => '集群总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Source' => [ - 'description' => '服务类型，取值如下：'."\n" - .'* console：控制台注册。'."\n" - .'* sdk：SDK注册。'."\n" - .'* governance：服务治理注册。', - 'type' => 'string', - 'example' => 'console', - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '72FC625E-9629-591B-9C01-3F0BFDAB****'], + 'Data' => ['description' => '返回规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '608'], ], ], ], ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72FC625E-9629-591B-9C01-3F0BFDAB****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', + 'title' => '创建网关流控规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询Nacos服务详情', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteNacosService' => [ - 'summary' => '删除一个Nacos服务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateGatewayIsolationRule' => [ + 'summary' => '创建网关并发规则。', + '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' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-123456', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407'], ], [ - 'name' => 'ServiceName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello_service', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], ], [ - 'name' => 'GroupName', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '52853'], ], [ - 'name' => 'NamespaceId', + 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0****', - ], + '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' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本。'."\n" + ."\n" + .'1：JSON。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429'], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'HTTP返回文本。', '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' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '字符串对象。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求成功', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '成功标志', - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '删除服务的结果', - 'description' => '删除结果。', - 'type' => 'string', - 'example' => 'ok', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****'], + 'Data' => ['description' => '返回规则ID。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', + 'title' => '创建网关并发规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除Nacos服务', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'UpdateNacosService' => [ - 'summary' => '更新Nacos服务。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateIsolationRule' => [ + 'summary' => '创建隔离规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '105086', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '163570', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。'."\n" - .'>', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'], ], [ - 'name' => 'ServiceName', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'com.dingtalk.doc.thumbnails.pdf.ThumbnailService', - ], + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'GroupName', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['title' => '隔离规则并发数阈值。', 'description' => '隔离规则并发数阈值。', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '3'], ], [ - 'name' => 'NamespaceId', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', - ], + 'schema' => ['title' => '规则的启用状态。', 'description' => '规则的启用状态。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ - 'name' => 'ProtectThreshold', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => '保护阈值。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/a'], ], [ - 'name' => 'ClusterId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。'."\n" - .'>', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '应用所在地域。', 'description' => '集群所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'LimitApp', + 'in' => 'query', + 'schema' => ['description' => '请求来源应用。', 'type' => 'string', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '响应信息。', 'description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Code' => ['title' => '响应码。', 'description' => '响应码。', 'type' => 'string', 'example' => '200'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'string', - 'example' => '6', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', + 'title' => '规则信息。', + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命空间。', 'type' => 'string', 'example' => 'default'], + 'Id' => ['title' => '规则ID。', 'description' => '规则ID。', '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' => '应用ID。', 'type' => 'string', 'example' => 'hpn9ac29kz@e31a4b871******'], + 'RegionId' => ['title' => '集群所在地域。', 'description' => '集群所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'LimitApp' => ['description' => '请求来源应用。', 'type' => 'string'], + ], ], + 'Success' => ['title' => '请求结果。', 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '创建隔离规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '更新Nacos服务', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'UpdateNacosCluster' => [ - 'summary' => '更新Nacos集群信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateMseServiceApplication' => [ + 'summary' => '创建应用。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '105189', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], - ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '实例id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-123456', - ], + 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bsd-xxyp-open-goods-server'], ], [ - 'name' => 'ServiceName', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '服务名', - 'description' => '服务名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello_service', - ], + 'schema' => ['description' => '集群所在地域，包括但不限于如下地域：'."\n" + ."\n" + .'- cn-hangzhou：杭州'."\n" + .'- cn-beijing：北京'."\n" + .'- cn-shanghai：上海'."\n" + .'- cn-zhangjiakou：张家口'."\n" + .'- cn-shenzhen：深圳', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen'], ], [ - 'name' => 'GroupName', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'title' => '分组名', - 'description' => '分组名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => '来源。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'edasmsc', 'default' => 'edasmsc'], ], [ - 'name' => 'NamespaceId', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间id', - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], + 'schema' => ['description' => '应用的编程语言。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'JAVA'], ], [ - 'name' => 'ClusterName', + 'name' => 'ExtraInfo', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos集群名', - 'description' => 'Nacos集群名。', - 'type' => 'string', - 'required' => true, - 'example' => 'DEFAULT', - ], + 'schema' => ['description' => '其他信息。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{}'], ], [ - 'name' => 'CheckPort', + 'name' => 'SentinelEnable', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查端口', - 'description' => '健康检查端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '是否开启Sentinel。', 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ - 'name' => 'UseInstancePortForCheck', + 'name' => 'SwitchEnable', 'in' => 'query', - 'schema' => [ - 'title' => '是否使用实例端口进行健康检查', - 'description' => '是否使用实例端口进行健康检查。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '是否开始Switch', 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ - 'name' => 'HealthChecker', + 'name' => 'MseVersion', 'in' => 'query', - 'schema' => [ - 'title' => '健康检查类型', - 'description' => '健康检查类型。', - 'type' => 'string', - 'required' => false, - 'example' => '{"type":"none"}', - ], + 'schema' => ['description' => '待开通的MSE集群版本。'."\n" + ."\n" + .'- mse_pro：表示专业版。'."\n" + .'- mse_dev：表示开发版。', 'type' => 'string', 'required' => false, 'example' => 'mse_pro'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型。'."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -8129,210 +5525,144 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求成功', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '成功标志', - 'description' => '成功标志。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '904F6C04-1284-****-8ED2-FFC57E507A72'], 'Data' => [ - 'title' => '修改结果', - 'description' => '返回结果。', - 'type' => 'string', - 'example' => 'ok', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。1表示可用状态，2表示删除状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExtraInfo' => ['description' => '额外信息。', 'type' => 'string', 'example' => '{}'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'UpdateTime' => ['description' => '最后更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1632979237663'], + 'LicenseKey' => ['description' => '用户的对应的LicenseKey。', 'type' => 'string', 'example' => 'xxxxxxxx@xxxxxxxxxx'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631001140913'], + 'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'xxxxxxxx@xxxxxxxxxx'], + 'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '1234567890'], + 'Source' => ['description' => '来源类型。', 'type' => 'string', 'example' => 'edasmsc'], + 'Language' => ['description' => '应用的编程语言。', 'type' => 'string', 'example' => 'JAVA'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Version' => ['description' => '版本信息。', 'type' => 'string', 'example' => '1.0.0'], + ], ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新Nacos集群', - ], - 'ListAnsServiceClusters' => [ - 'summary' => '查询Nacos服务的集群列表。', - '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' => '创建应用', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateMseServiceApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateNacosConfig' => [ + 'summary' => '创建一个Nacos配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '17057', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17005', + 'abilityTreeNodes' => ['FEATUREmse0BR2XQ'], ], 'parameters' => [ [ - 'name' => 'PageNum', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-tl32****'], ], [ - 'name' => 'PageSize', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '数据ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'common.yaml'], ], [ - 'name' => 'ClusterId', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'description' => 'MSE集群ID。'."\n" - .'> 此处的集群与nacos服务下的集群概念不同，勿混淆。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'mse-09k1q110q01', - ], + 'schema' => ['description' => '分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alime-bridge-aliyun'], ], [ - 'name' => 'ServiceName', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'nacos.test.3', - ], + 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'saledatacenter-task'], ], [ - 'name' => 'GroupName', + 'name' => 'Tags', 'in' => 'query', - 'schema' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => '配置的标签。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Basic configuration'], ], [ - 'name' => 'NamespaceId', + 'name' => 'Desc', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '12233****', - ], + 'schema' => ['description' => '配置的描述信息。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Base module configuration'], ], [ - 'name' => 'ClusterName', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '集群别名。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-7413****', - ], + 'schema' => ['description' => '配置格式，包括text、json、xml等。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'text'], ], [ - 'name' => 'InstanceId', + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => '配置的内容。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'text'], + ], + [ + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl32a6****', - ], + 'schema' => ['description' => '命名空间ID，默认为public。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '547fd2a0-d0d6-****-80db2a1afb82'], + ], + [ + 'name' => 'BetaIps', + 'in' => 'query', + 'schema' => ['description' => 'Beta发布的IP列表。', 'type' => 'string', 'required' => false, 'example' => '100.117.XX.XX,100.117.XX.XX'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -8341,245 +5671,61 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'ProtectThreshold' => [ - 'description' => '保护阈值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'GroupName' => [ - 'description' => '服务所属服务组。', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'Clusters' => [ - 'description' => '集群信息。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'DefaultCheckPort' => [ - 'description' => '默认检查端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'HealthCheckerType' => [ - 'description' => '健康检查类型。', - 'type' => 'string', - 'example' => 'connection：链接存活检查'."\n" - .'tcp: TCP连接检查'."\n" - .'http：HTTP连接检查', - ], - 'UseIPPort4Check' => [ - 'description' => '服务端是否主动发起端到端健康状态检查，当服务为非临时服务时此值有效。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ServiceName' => [ - 'description' => '全量服务名。', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP@@nacos.test.3', - ], - 'Name' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'DefaultPort' => [ - 'description' => '默认端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Metadata' => [ - 'description' => '集群元数据。', - 'type' => 'object', - 'example' => '111', - ], - ], - ], - ], - 'Name' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'nacos.test.3', - ], - 'SelectorType' => [ - 'description' => '选举模式。', - 'type' => 'string', - 'example' => 'none', - ], - 'Metadata' => [ - 'description' => '服务元数据。', - 'type' => 'object', - 'example' => '111', - ], - 'Ephemeral' => [ - 'description' => '是否临时节点，取值如下：'."\n" - .'- `true`：是。'."\n" - .'- `false`：否。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Source' => [ - 'description' => '服务类型，取值如下：'."\n" - .'* console：控制台注册。'."\n" - .'* sdk：SDK注册。'."\n" - .'* governance：服务治理注册。', - 'type' => 'string', - 'example' => 'console', - ], - 'AppDetail' => [ - 'description' => '服务类型为服务治理注册时，服务所关联的服务治理应用信息。', - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => '服务治理应用id。', - 'type' => 'string', - 'example' => 'hkhon1po62@904cba2c0xxxxxx', - ], - 'AppName' => [ - 'description' => '服务治理应用名。', - 'type' => 'string', - 'example' => 'spring-cloud-b', - ], - 'Port' => [ - 'description' => '服务治理应用端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6001', - ], - 'CheckType' => [ - 'description' => '健康检查协议，取值如下：'."\n" - .'* connection：链接存活检查。'."\n" - .'* tcp: TCP连接检查。'."\n" - .'* http：HTTP连接检查。', - 'type' => 'string', - 'example' => 'connection', - ], - 'CheckPath' => [ - 'description' => '健康检查路径（健康检查类型为http时携带）。', - 'type' => 'string', - 'example' => '/health', - ], - 'CheckTimeout' => [ - 'description' => '健康检查响应超时时间，单位：秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CheckInternal' => [ - 'description' => '健康检查间隔，单位：秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'HealthyCheckTimes' => [ - 'description' => '健康检查健康阈值，指实例从不健康变为健康过程中健康探测重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UnhealthyCheckTimes' => [ - 'description' => '健康检查不健康阈值，指实例从健康变为不健康过程中健康探测重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '673DBD43-569E-510F-B3DE-20BB8DFEB20A'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '返回代码。', 'type' => 'string', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => '查询集群服务详情', + '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' => '创建Nacos配置', 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'CreateNacosInstance' => [ 'summary' => '创建Nacos实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -8590,154 +5736,71 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '105182', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-123456', - ], + 'schema' => ['title' => '实例id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-123456'], ], [ 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '服务名', - 'description' => '服务名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello_service', - ], + 'schema' => ['title' => '服务名', 'description' => '服务名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello_service'], ], [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '分组名', - 'description' => '分组名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['title' => '分组名', 'description' => '分组名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP'], ], [ 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间id', - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****', - ], + 'schema' => ['title' => '命名空间id', 'description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****'], ], [ 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos集群名', - 'description' => 'Nacos集群名。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], + 'schema' => ['title' => 'Nacos集群名', 'description' => 'Nacos集群名。', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], ], [ 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos实例ip', - 'description' => 'Nacos实例IP。', - 'type' => 'string', - 'required' => true, - 'example' => '1.2.xx.xx', - ], + 'schema' => ['title' => 'Nacos实例ip', 'description' => 'Nacos实例IP。', 'type' => 'string', 'required' => true, 'example' => '1.2.xx.xx'], ], [ 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos实例端口', - 'description' => 'Nacos实例端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '65535', - 'exclusiveMaximum' => true, - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '12281', - ], + 'schema' => ['title' => 'Nacos实例端口', 'description' => 'Nacos实例端口。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65535', 'exclusiveMaximum' => true, 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '12281'], ], [ 'name' => 'Ephemeral', 'in' => 'query', - 'schema' => [ - 'title' => '临时节点标志', - 'description' => '临时节点标志。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'schema' => ['title' => '临时节点标志', 'description' => '临时节点标志。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], ], [ 'name' => 'Weight', 'in' => 'query', - 'schema' => [ - 'title' => '权重', - 'description' => '权重，为范围0～10000的整数。值越大，访问到该实例的频率越高。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '权重', 'description' => '权重，为范围0～10000的整数。值越大，访问到该实例的频率越高。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'Enabled', 'in' => 'query', - 'schema' => [ - 'title' => '服务禁用标志', - 'description' => '服务禁用标志。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['title' => '服务禁用标志', 'description' => '服务禁用标志。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'Metadata', 'in' => 'formData', - 'schema' => [ - 'title' => '节点元数据', - 'description' => '节点元数据。', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"grayversion\\":\\"1.0\\",\\"preserved.register.source\\":\\"SPRING_CLOUD\\",\\"management.context-path\\":\\"\\"}', - ], + 'schema' => ['title' => '节点元数据', 'description' => '节点元数据。', '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' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -8746,871 +5809,585 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求成功', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '成功标志', - 'description' => '成功标志。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '修改结果', - 'description' => '返回结果。', - 'type' => 'string', - 'example' => 'ok', - ], + 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'Message' => ['title' => '响应信息', 'description' => '响应信息。', 'type' => 'string', 'example' => 'Request succeeded.'], + 'Code' => ['title' => '响应码', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '成功标志', 'description' => '成功标志。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '修改结果', 'description' => '返回结果。', 'type' => 'string', 'example' => 'ok'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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"}]', + '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' => '创建Nacos实例', 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', - ], - 'DeleteNacosInstance' => [ - 'summary' => '删除Nacos服务下持久化实例。', - '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' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateNacosService' => [ + 'summary' => '创建Nacos服务。', + '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' => '104937', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-st21v5****', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21ri2****'], ], [ 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'hello_service', - ], - ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****', - ], + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => true, 'example' => 'com.alibabacloud.hipstershop.cartserviceapi.service.CartService'], ], [ 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'DEFAULT_GROUP', - ], + 'schema' => ['description' => '分组名称。', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'ClusterName', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群别名。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - 'default' => 'DEFAULT', - ], + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'example' => 'production'], ], [ - 'name' => 'Ip', + 'name' => 'ProtectThreshold', 'in' => 'query', - 'schema' => [ - 'description' => 'Nacos实例IP。', - 'type' => 'string', - 'required' => true, - 'example' => '10.237.1.32', - ], + 'schema' => ['description' => '保护阈值。', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'Port', + 'name' => 'Ephemeral', 'in' => 'query', - 'schema' => [ - 'description' => 'Nacos实例端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '8080', - ], + 'schema' => ['description' => '是否临时节点标志，取值如下：'."\n" + .'- `true`：是。'."\n" + .'- `false`：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'Ephemeral', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '是否临时节点标志，取值如下：'."\n" - .'- `true`：是。'."\n" - .'- `false`：否。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。', 'type' => 'string', 'required' => false, 'example' => 'mse-3691a080'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'Code仅仅用来和Success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '节点数据。', - 'type' => 'string', - 'example' => 'OK', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => '节点数据。', 'type' => 'string', 'example' => 'data'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], + 'Message' => ['description' => '返回信息。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除Nacos实例', + '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' => '创建Nacos服务', 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', - ], - 'UpdateNacosInstance' => [ - 'summary' => '更新注册在Nacos中的实例信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateNamespace' => [ + 'summary' => '创建微服务治理命名空间。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '18554', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '187065', + 'abilityTreeNodes' => ['FEATUREmseSXV85E'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '实例id', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-123456', - ], + 'schema' => ['title' => '要搜索的命名空间名字', 'description' => '微服务治理命名空间名称。', 'type' => 'string', 'required' => false, 'example' => 'myNamespace', 'maxLength' => 64], ], [ - 'name' => 'ServiceName', + 'name' => 'Describe', 'in' => 'query', - 'schema' => [ - 'title' => '服务名', - 'description' => '服务名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello_service', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '分组名', - 'description' => '分组名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DEFAULT_GROUP', - ], - ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间id', - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9e78a671-4b9b-4dd4-99c1-0****', - ], - ], - [ - 'name' => 'ClusterName', - 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos集群名', - 'description' => 'Nacos集群名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], - ], - [ - 'name' => 'Ip', - 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos实例ip', - 'description' => 'Nacos实例IP。', - 'type' => 'string', - 'required' => true, - 'example' => '1.2.X.X', - ], - ], - [ - 'name' => 'Port', - 'in' => 'query', - 'schema' => [ - 'title' => 'Nacos实例端口', - 'description' => 'Nacos实例端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12281', - ], - ], - [ - 'name' => 'Ephemeral', - 'in' => 'query', - 'schema' => [ - 'title' => '临时节点标志', - 'description' => '是否为非持久化节点，取值如下：'."\n" - .'- `true`：是。'."\n" - .'- `false`：否。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - ], - [ - 'name' => 'Weight', - 'in' => 'query', - 'schema' => [ - 'title' => '权重', - 'description' => '权重，为范围0～10000的整数。值越大，访问到该实例的频率越高。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '微服务治理命名空间描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Test namespace 1.'], ], [ - 'name' => 'Enabled', + 'name' => 'Tag', 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'title' => '服务禁用标志', - 'description' => '是否启用此服务，取值如下：'."\n" - ."\n" - .'- `true`：是。'."\n" - .'- `false`：否。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'Metadata', - 'in' => 'formData', - 'schema' => [ - 'title' => '节点元数据', - 'description' => '节点元数据。', - 'type' => 'string', + 'description' => '阿里云标签。', + 'type' => 'array', + 'items' => [ + 'description' => '待添加的标签列表。最多包含20个子项。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '资源的标签键。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。', 'type' => 'string', 'required' => false, 'example' => 'namespaceTagKey'], + 'Value' => ['description' => '标签值。最多支持128个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'namespaceTagValue'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '[int]', + 'minItems' => 0, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '字符串对象。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'http状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求成功', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '成功标志', - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['title' => '错误时的提示信息', 'description' => '错误时的提示信息', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC'], + 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'title' => '修改结果', - 'description' => '修改结果。', - 'type' => 'string', - 'example' => 'ok', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Region' => ['title' => '命名空间所属的地域', 'description' => '命名空间所属的地域', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Namespace' => ['title' => '命名空间名字', 'description' => '命名空间名字', 'type' => 'string', 'example' => 'myNamespace'], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建微服务治理命名空间', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '更新Nacos实例信息', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', ], - 'ListAnsInstances' => [ - 'summary' => '查询Nacos服务实例列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateOrUpdateSwimmingLane' => [ + 'summary' => '用于创建或者更新全链路灰度泳道。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '17056', - 'abilityTreeNodes' => [ - 'FEATUREmseAPH368', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '116127', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => 'region', 'description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'PageNum', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'PageSize', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['title' => '泳道ID。-1时为创建泳道，大于0时为修改指定泳道。', 'description' => '主键ID。-1时为创建泳道，大于0时为修改指定泳道。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'], ], [ - 'name' => 'ClusterId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。>此接口同时有InstanceId与ClusterId，则其中一项必填。>'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['title' => '名称', 'description' => '泳道名称。', 'type' => 'string', 'required' => true, 'example' => 'gray', 'maxLength' => 64], ], [ - 'name' => 'ServiceName', + 'name' => 'Tag', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'name', - ], + 'schema' => ['title' => '匹配到后的目标机器标签', 'description' => '标识。', 'type' => 'string', 'required' => false, 'example' => 'gray', 'maxLength' => 64], ], [ - 'name' => 'GroupName', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '联系人组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '是否开启。', 'description' => '是否开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'NamespaceId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '12233****', - ], + 'schema' => ['title' => '所属泳道组', 'description' => '所属泳道组。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '115'], ], [ - 'name' => 'ClusterName', + 'name' => 'EnableRules', 'in' => 'query', - 'schema' => [ - 'description' => '集群别名。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], + 'schema' => ['title' => '是否开启规则', 'description' => '是否配置泳道的路由规则，Ingress为网关暂时不需要配置。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true'], ], [ - 'name' => 'InstanceId', + 'name' => 'PathIndependentPercentageEnable', 'in' => 'query', + 'schema' => ['description' => '已废弃。Java网关相关配置，Path按比例路由', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'EntryRules', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '实例ID。>此接口同时有InstanceId与ClusterId，则其中一项必填。>'."\n", - 'type' => 'string', + 'title' => 'SwimmingLane', + 'description' => '泳道规则集合', + 'type' => 'array', + 'items' => [ + 'description' => '泳道规则', + 'type' => 'object', + 'properties' => [ + 'Paths' => [ + 'title' => '路径列表', + 'description' => '路径列表', + 'type' => 'array', + 'items' => ['description' => '路径', 'type' => 'string', 'required' => false, 'example' => '/'], + 'required' => false, + 'maxItems' => 50, + ], + 'Condition' => [ + 'title' => '指示RestItems如何组合成最终的条件', + 'description' => '指示RestItems如何组合成最终的条件', + 'type' => 'string', + 'required' => false, + 'example' => 'AND', + 'default' => 'AND', + 'enum' => ['AND', 'OR'], + ], + 'RestItems' => [ + 'title' => '匹配列表', + 'description' => '匹配列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Rest匹配信息', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '匹配类型', 'description' => '匹配类型', 'type' => 'string', 'required' => false, 'example' => 'header'], + 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'x-mse-tag'], + 'Operator' => ['title' => '操作符', 'description' => '操作符', 'type' => 'string', 'required' => false, 'example' => 'rawvalue'], + 'NameList' => [ + 'title' => '匹配列表', + 'description' => '匹配列表', + 'type' => 'array', + 'items' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => false, + 'maxItems' => 10, + ], + 'Datum' => ['title' => '数值', 'description' => '数值', 'type' => 'string', 'required' => false, 'example' => 'x'], + 'Cond' => ['title' => '匹配符', 'description' => '匹配符', 'type' => 'string', 'required' => false, 'example' => '=='."\n"], + 'Divisor' => ['title' => '除数', 'description' => '除数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Remainder' => ['title' => '余数', 'description' => '余数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Rate' => ['title' => '百分比', 'description' => '百分比', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + 'Value' => ['title' => '值', 'description' => '值', 'type' => 'string', 'required' => false, 'example' => 'gray'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + 'Priority' => ['title' => '优先级', 'description' => '优先级', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl327w****', + 'maxItems' => 10, ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'EntryRule', + 'in' => 'query', + 'schema' => ['title' => 'json string', 'description' => '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' => 'GatewaySwimmingLaneRouteJson', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', + 'title' => '网关路由信息（使用云原生网关为入口时使用）', + 'description' => '网关路由信息（使用云原生网关为入口时使用）', + 'type' => 'object', + 'properties' => [ + 'GatewayId' => ['title' => '网关ID', 'description' => '网关ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'GatewayUniqueId' => ['title' => '网关唯一ID', 'description' => '网关唯一ID', 'type' => 'string', 'required' => false, 'example' => 'gw-84efde2ee1464260bdb17a5b****'], + 'RouteIdList' => [ + 'title' => '路由ID列表', + 'description' => '路由ID列表', + 'type' => 'array', + 'items' => ['description' => '路由ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => false, + ], + 'CanaryModel' => ['title' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', 'description' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Conditions' => [ + 'title' => '匹配条件列表（按内容路由使用）', + 'description' => '匹配条件列表', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '条件项', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'xiaoming'], + 'Type' => ['title' => '参数类型：'."\n" + .'- header：Header'."\n" + .'- param：Parameter', 'description' => '参数类型：'."\n" + .'- header：Header'."\n" + .'- param：Parameter', 'type' => 'string', 'required' => false, 'example' => 'header'], + 'Cond' => ['title' => '条件：'."\n" + .'- PRE：前缀匹配'."\n" + .'- EQUAL：精确匹配'."\n" + .'- ERGULAR：正则匹配', 'description' => '如果您使用老版本的全链路灰度（swimversion为0，使用标签路由和灰度路由），支持：'."\n" + .'- PRE：前缀匹配'."\n" + .'- ERGULAR：正则匹配'."\n" + .'- EQUAL：精准匹配'."\n" + ."\n" + .'如果您使用新版本的全链路灰度（swiminversion为1或2，使用单服务路由），支持：'."\n" + .'- PRE：前缀匹配'."\n" + .'- regexp：正则匹配'."\n" + .'- =='."\n" + .'- !='."\n" + .'- list ：in'."\n" + .'- % ：百分比'."\n" + ."\n" + .'新版全链路灰度和旧版全链路灰度功能一样，性能更强、配置更简单，请您迁移至新版全链路灰度', 'type' => 'string', 'required' => false, 'example' => 'PRE'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Percentage' => ['title' => '流量比例（按比例路由使用，取值0-100）', 'description' => '流量比例（按比例路由使用，取值0-100）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + 'RouteIndependentPercentageEnable' => ['description' => '已废弃。MSE云原生网关为入口时使用该参数指定按照路由进行百分比设置', 'type' => 'boolean', 'required' => false], + 'RouteIndependentPercentageList' => [ + 'description' => '已废弃。按照路由独立进行百分比灰度的路由列表', + 'type' => 'array', + 'items' => [ + 'description' => '路由与百分比列表', + 'type' => 'object', + 'properties' => [ + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'], + 'Percentage' => ['description' => '流量比例（按比例路由使用，取值0-100）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Condition' => ['description' => '灰度条件同时满足:AND;'."\n" + .'灰度条件任意满足:OR', 'type' => 'string', 'required' => false, 'example' => 'AND'], + ], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => '实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'Code仅仅用来和Success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Succ'], 'Data' => [ 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DefaultKey' => [ - 'description' => '缺省键。', - 'type' => 'string', - 'example' => '30.5.XX.XX:unknown', - ], - 'Ephemeral' => [ - 'description' => '临时节点，取值如下：'."\n" - .'- `true`：获取成功。'."\n" - .'- `false`：获取失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Marked' => [ - 'description' => '标记，取值如下：'."\n" - .'- `true`：标记成功。'."\n" - .'- `false`：标记失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Ip' => [ - 'description' => '公网IP。', - 'type' => 'string', - 'example' => '30.5.XX.XX', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => '30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService', - ], - 'Port' => [ - 'description' => '端口号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - 'LastBeat' => [ - 'description' => '最近一次的心跳时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20201010', - ], - 'OkCount' => [ - 'description' => '成功计数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Weight' => [ - 'description' => '权重。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'InstanceHeartBeatInterval' => [ - 'description' => '实例心跳间隔，单位：秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5000', - ], - 'IpDeleteTimeout' => [ - 'description' => 'IP删除超时。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30000', - ], - 'App' => [ - 'description' => '应用名。', - 'type' => 'string', - 'example' => 'app', - ], - 'FailCount' => [ - 'description' => '失败计数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Healthy' => [ - 'description' => '实例健康状态，取值如下：'."\n" - .'- `true`：实例健康。'."\n" - .'- `false`：实例不健康。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Enabled' => [ - 'description' => '生效状态，取值如下：'."\n" - .'- `true`：生效。'."\n" - .'- `false`：不生效。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DatumKey' => [ - 'description' => '基准键。', - 'type' => 'string', - 'example' => '30.5.XX.XX:unknown:DEFAULT', - ], - 'ClusterName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'InstanceHeartBeatTimeOut' => [ - 'description' => '实例心跳超时。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15000', - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::', - ], - 'Metadata' => [ - 'description' => '元数据。', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '泳道名称', 'type' => 'string', 'example' => 'test'], + 'id' => ['description' => '泳道ID', 'type' => 'integer', 'format' => 'int64', 'example' => '94765'], + 'tag' => ['description' => '泳道对应的标签。', 'type' => 'string', 'example' => 'release'], + 'status' => ['description' => '泳道状态', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'enable' => ['description' => '泳道开关', 'type' => 'boolean', 'example' => 'true'], + 'regionId' => ['description' => '应用所在的区域。', 'type' => 'string', 'example' => 'cn-beijing'], + 'groupId' => ['description' => '泳道组Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '72586'], + 'entryRule' => ['description' => '入口应用规则', 'type' => 'string', 'example' => '{}'], + 'entryRules' => [ + 'description' => '名称', + 'type' => 'array', + 'items' => [ + 'description' => '入口应用规则详情', 'type' => 'object', - 'example' => '[int]', + 'properties' => [ + 'paths' => [ + 'description' => '路径列表', + 'type' => 'array', + 'items' => ['description' => '路径列表', 'type' => 'string', 'example' => '/'], + ], + 'path' => ['title' => '', 'description' => '代码组路径', 'type' => 'string', 'example' => '/adump/wxb/prod'], + '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' => 'test'], + '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' => '9'], + ], + ], + ], + ], ], ], + 'enableRules' => ['description' => '是否开启规则。', 'type' => 'boolean', 'example' => 'true'], + 'gmtCreate' => ['description' => '泳道创建时间。', 'type' => 'string', 'example' => '1545726028000'], + 'gmtModified' => ['description' => '泳道更新时间。', 'type' => 'string', 'example' => '1565701886000'], + 'gatewaySwimmingLaneRouteJson' => ['description' => 'MSE网关路由规则', 'type' => 'string', 'example' => '{}'], + 'pathIndependentPercentageEnable' => ['description' => '已废弃。Java网关为入口时使用，该参数标识是否开启按照path百分比灰度。', 'type' => 'boolean', 'example' => 'false'], ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '{}', ], ], ], @@ -9618,326 +6395,234 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建或者更新全链路灰度泳道', + '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' => '[{"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' => '查询Nacos服务实例列表', - 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetServiceListeners' => [ - 'summary' => '获取目标服务的监听者列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateOrUpdateSwimmingLaneGroup' => [ + 'summary' => '用于创建或者更新全链路灰度泳道组。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '137871', - 'abilityTreeNodes' => [ - 'FEATUREmseXDLQRG', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '116107', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], ], 'parameters' => [ [ - 'name' => 'ServiceName', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '查询指定的服务名信息', - 'description' => '查询指定的服务名信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'zeekr-orderboss', - ], + 'schema' => ['title' => 'region', 'description' => 'Region。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], [ - 'name' => 'GroupName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '服务所在的分组', - 'description' => '服务所在的分组。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WEB_GROUP', - ], + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'NamespaceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '服务所在的 namespace', - 'description' => '服务所在的 namespace。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b', - ], + 'schema' => ['title' => '泳道组ID。-1时为创建泳道组，大于0时为修改指定泳道组。', 'description' => '泳道组ID。-1时为创建泳道组，大于0时为修改指定泳道组。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '120'], ], [ - 'name' => 'ClusterName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '查询服务下某个集群的实例列表是所需要的参数', - 'description' => '服务所属集群名字。'."\n" - .'> 此处集群为nacos服务中的概念，非MSE集群。', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], + 'schema' => ['title' => '名称', 'description' => '泳道组名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'group1'], ], [ - 'name' => 'HasIpCount', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '保留字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'none', - ], + 'schema' => ['title' => '0 未生效', 'description' => '取值为0表示未生效，取值为1表示生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'ClusterId', + 'name' => 'EntryApp', + 'in' => 'query', + 'schema' => ['title' => '入口应用。格式 "来源系统:id"。比如：'."\n" + .'- mse:${mse应用id}'."\n" + .'- mse-gw:${mse云原生网关id}', 'description' => '入口应用。格式 "来源系统:id"。比如：'."\n" + .'- mse:${mse应用id}'."\n" + .'- mse-gw:${mse云原生网关id}'."\n" + .'- apig:${云原生API网关id}', 'type' => 'string', 'required' => false, 'example' => 'mse-gw:gw-2b1407e050f1446xxxcd2a65fd9xxxx'], + ], + [ + 'name' => 'AppIds', + 'in' => 'query', + 'schema' => ['title' => '应用集合。以 "," 分割应用 id', 'description' => '应用集合。以 "," 分割应用 id', 'type' => 'string', 'required' => false, 'example' => 'xxxxn1po62@492b8f98d4bxxxx,xxxxn1po62@2d8f5d1b7f2xxxx'], + ], + [ + 'name' => 'MessageQueueGrayEnable', 'in' => 'query', 'schema' => [ - 'title' => '当前查询服务的集群标识', - 'description' => '待查询服务所属的MSE集群ID。'."\n" - .'> InstanceId与ClusterId其中一个必填。', - 'type' => 'string', - 'deprecated' => true, + 'title' => '是否开启消息灰度', + 'description' => '是否开启消息灰度。', + 'type' => 'boolean', 'required' => false, - 'example' => 'mse-09k1q11****', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', + 'default' => 'false', ], ], [ - 'name' => 'InstanceId', + 'name' => 'MessageQueueFilterSide', 'in' => 'query', 'schema' => [ - 'title' => '当前查询服务的集群标识', - 'description' => '当前查询服务的集群ID。'."\n" - .'> InstanceId与ClusterId其中一个必填。', + 'title' => '消息灰度过滤侧', + 'description' => '消息灰度过滤侧。', 'type' => 'string', 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl32odtt20j', + 'example' => 'Server', + 'default' => 'Server', + 'enum' => ['Server', 'Client'], ], ], [ - 'name' => 'PageNum', + 'name' => 'DbGrayEnable', 'in' => 'query', 'schema' => [ - 'title' => '查询第几页', - 'description' => '查询第几页。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '是否开启数据库灰度', + 'description' => '已废弃，是否开启数据库灰度。', + 'type' => 'boolean', 'required' => false, - 'example' => '1', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', ], ], [ - 'name' => 'PageSize', + 'name' => 'RecordCanaryDetail', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示条数', - 'description' => '每页展示条数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '是否开启记录请求详情', 'description' => '是否开启记录请求详情。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'RegionId', + 'name' => 'Paths', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', + 'description' => '已废弃，java网关为入口时填写该参数', + 'type' => 'array', + 'items' => ['description' => '已废弃，path', 'type' => 'string', 'required' => false, 'example' => 'a'], 'required' => false, - 'example' => 'cn-hangzhou', ], ], [ - 'name' => 'RequestPars', + 'name' => 'RouteIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', + 'title' => '路由ID列表（以云原生网关为入口时，在创建泳道组的泳道前，需调用本接口传入选择的云原生网关路由ID列表）', + 'description' => '路由ID列表（以云原生网关为入口时，在创建泳道组的泳道前，需调用本接口传入选择的云原生网关路由ID列表）', + 'type' => 'array', + 'items' => ['description' => '路由Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'], 'required' => false, - 'example' => '{}', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'CanaryModel', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SwimVersion', + 'in' => 'query', + 'schema' => ['description' => '全链路灰度版本，取值范围：0（不推荐使用，需要指定路由）,2(推荐使用，无需指定路由)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RegCenterOperatorResult', - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult。', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => '请求ID。'."\n" + ."\n", 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'true：请求成功。'."\n" + .'false：请求失败。'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。'."\n" + ."\n", 'type' => 'string', 'example' => 'Success'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n", 'type' => 'string', 'example' => 'Succ'], 'Data' => [ - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'Addr' => [ - 'title' => '地址', - 'description' => '监听者的地址。', - 'type' => 'string', - 'example' => '119.23.84.102', - ], - 'Agent' => [ - 'title' => '客户端版本', - 'description' => '监听者客户端版本。', - 'type' => 'string', - 'example' => 'Nacos-Java-Client:v2.1.1', - ], - 'App' => [ - 'title' => '应用', - 'description' => '监听者的应用名称。', - 'type' => 'string', - 'example' => 'app', - ], - 'IP' => [ - 'title' => 'ip地址', - 'description' => '被监听服务的IP地址。', - 'type' => 'string', - 'example' => '172.16.1.5', - ], - 'Port' => [ - 'title' => '端口号', - 'description' => '被监听服务的端口号。', - 'type' => 'string', - 'example' => '8080', - ], - 'NamespaceId' => [ - 'title' => '命名空间id', - 'description' => '命名空间ID。', - 'type' => 'string', - 'example' => '0ba53825-b183-414f-a6a0-288e4f1c467e', - ], - 'ServiceName' => [ - 'title' => '服务名称', - 'description' => '被监听服务的名称。', - 'type' => 'string', - 'example' => 'zeekr-orderboss', - ], - 'Cluster' => [ - 'title' => '集群名称', - 'description' => '被监听服务所属集群名字。', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - ], + 'description' => '数据概览。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '应用名', 'description' => '应用名', 'type' => 'string', 'example' => 'example-app'], + 'DbGrayEnable' => ['title' => '是否开启数据库灰度', 'description' => '是否开启数据库灰度', 'type' => 'string', 'example' => 'true'], + 'UserId' => ['title' => '应用所属的用户id。', 'description' => '应用所属的用户id。', 'type' => 'string', 'example' => '12345'], + 'MessageQueueFilterSide' => ['title' => '消息灰度过滤侧', 'description' => '消息灰度过滤侧。', 'type' => 'string', 'example' => 'Client'], + 'AppIds' => ['title' => '应用id列表，逗号分隔。', 'description' => '应用id列表，逗号分隔。', 'type' => 'string', 'example' => 'abcd1@abcde123,abcd1@abcde124'], + 'Namespace' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字。', 'type' => 'string', 'example' => 'prod'], + 'RecordCanaryDetail' => ['title' => '是否开启记录请求详情。', 'description' => '是否开启记录请求详情。', 'type' => 'boolean', 'example' => 'true'], + 'Id' => ['title' => '泳道组id。', 'description' => '泳道组id。', 'type' => 'integer', 'format' => 'int64', 'example' => '2047', 'default' => '123'], + 'EntryApp' => ['title' => '入口应用。格式 "来源系统:id"。比如：'."\n" + .'mse:${mse应用id}'."\n" + .'mse-gw:${mse云原生网关id}', 'description' => '入口应用。', 'type' => 'string', 'example' => 'mse:abcd1@a2345'], + 'Region' => ['title' => '应用所属地域。', 'description' => '应用所属地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'MessageQueueGrayEnable' => ['title' => '是否开启消息灰度。', 'description' => '是否开启消息灰度。', 'type' => 'boolean', 'example' => 'true'], + 'paths' => ['description' => '已废弃，java网关为入口时该参数为Path列表', 'type' => 'string', 'example' => '["/a"]'], + 'Paths' => ['description' => '已废弃，java网关为入口时该参数为Path列表', 'type' => 'string', 'example' => '["/a"]'], + 'canaryModel' => ['description' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'CanaryModel' => ['description' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], - ], - 'PageNumber' => [ - 'title' => '实例列表的页码', - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'title' => '查询到的实例总数', - 'description' => '查询到的监听者数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'title' => '输入时设置的每页行数', - 'description' => '每页行数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', + 'example' => '{}', ], ], ], @@ -9945,770 +6630,532 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建或者更新全链路灰度泳道组', + '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' => '[{"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' => '获取nacos服务监听者', ], - 'ListEurekaServices' => [ - 'summary' => '查询Eureka服务列表。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreatePluginConfig' => [ + 'summary' => '创建插件配置。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17068', - 'abilityTreeNodes' => [ - 'FEATUREmseKQ13CA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '219339', + 'abilityTreeNodes' => ['FEATUREmseKZMVG1'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => '网关唯一ID', 'description' => '网关唯一ID', 'type' => 'string', 'required' => true, 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'], ], [ - 'name' => 'PageNum', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['title' => '网关插件ID', 'description' => '网关插件ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], ], [ - 'name' => 'PageSize', + 'name' => 'ConfigLevel', 'in' => 'query', - 'schema' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['title' => '插件应用范围。'."\n" + ."\n" + .'- 全局：0'."\n" + .'- 路由：1'."\n" + .'- 域名：2', 'description' => '插件应用范围。'."\n" + ."\n" + .'- 全局：0'."\n" + .'- 路由：1'."\n" + .'- 域名：2', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'ClusterId', + 'name' => 'Config', + 'in' => 'formData', + 'schema' => ['title' => '插件配置。Wasm 插件配置内容是 YAML 格式，Lua 插件配置内容是 Lua 代码。', 'description' => '插件配置。Wasm 插件配置内容是 YAML 格式，Lua 插件配置内容是 Lua 代码。', 'type' => 'string', 'required' => false], + ], + [ + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['title' => '是否开启。', 'description' => '是否开启。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', + 'title' => '域名ID/路由ID列表（根据ConfigLevel区分）', + 'description' => '域名ID/路由ID列表（根据ConfigLevel区分）', + 'type' => 'array', + 'items' => ['title' => 'ID值', 'description' => 'ID值', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'], 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => '实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'InstancesId' => [ - 'description' => '实例信息。', - 'type' => 'array', - 'items' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - ], - 'Name' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'CONTACTINFO', - ], - 'UpStatus' => [ - 'description' => '服务提供者数量，健康实例数/总实例数。', - 'type' => 'string', - 'example' => '1/1', - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'], + 'PluginConfigID' => ['title' => '插件配置ID', 'description' => '插件配置ID', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"PluginConfigID\\": 10\\n}","type":"json"}]', + 'title' => '创建插件配置', + '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 \\"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' => '查询Eureka服务列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListEurekaInstances' => [ - 'summary' => '查询Eureka实例列表。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateSentinelBlockFallbackDefinition' => [ + 'summary' => '创建行为管理', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17067', - 'abilityTreeNodes' => [ - 'FEATUREmseKQ13CA', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '163988', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example-app'], ], [ - 'name' => 'PageNum', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PageSize', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '冗余参数，暂时忽略', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'edasmsc'], ], [ - 'name' => 'ClusterId', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => '语言，如 Java、Go。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'JAVA'], ], [ - 'name' => 'ServiceName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'name', - ], + 'schema' => ['title' => '', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => '应用id，可省略', 'type' => 'string', 'required' => false, 'example' => 'abcde@12345'], + ], + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => ['description' => '场景，统一填写 default', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'ResourceClassification', + 'in' => 'query', + 'schema' => ['description' => '针对的资源类型', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1 Web'."\n" + .'2 Rpc'], + ], + [ + 'name' => 'FallbackBehavior', + 'in' => 'query', + 'schema' => ['description' => '行为详情', 'type' => 'string', 'required' => false, 'example' => '{"webFallbackMode":0,"webRespMessage":"{}","webRespStatusCode":429,"webRespContentType":0}'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '行为名称', 'type' => 'string', 'required' => false, 'example' => 'MyFallback'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => '实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '服务提供者数量，健康实例数/总实例数。', - 'type' => 'string', - 'example' => '1/1', - ], - 'LastDirtyTimestamp' => [ - 'description' => '实例属性最后更新的时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20201009115543', - ], - 'IpAddr' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '30.5.XX.XX', - ], - 'HomePageUrl' => [ - 'description' => '主页地址。', - 'type' => 'string', - 'example' => 'http://30.5.XX.XX:8091/', - ], - 'HostName' => [ - 'description' => '主机名。', - 'type' => 'string', - 'example' => '30.5.XX.XX', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'L-PC1A6A28-****.hz.ali.com:contactinfo:8091', - ], - 'Port' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8091', - ], - 'SecurePort' => [ - 'description' => '安全端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '443', - ], - 'App' => [ - 'description' => '应用名。', - 'type' => 'string', - 'example' => 'CONTACTINFO', - ], - 'DurationInSecs' => [ - 'description' => '实例超时时间。 '."\n" - .'超过这个时间后，服务默认不可用，将会被删除。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'LastUpdatedTimestamp' => [ - 'description' => '最近一次心跳时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20201010071203', - ], - 'RenewalIntervalInSecs' => [ - 'description' => '心跳执行器在续约过程中超时后再次执行续约的最大延迟倍数。 '."\n" - .'默认最大延迟倍数为10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'VipAddress' => [ - 'description' => 'VIP地址。', - 'type' => 'string', - 'example' => 'contactinfo', - ], - 'Metadata' => [ - 'description' => '元数据。', - 'type' => 'object', - 'example' => '[string]', - ], - ], + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ResourceClassification' => ['description' => '针对的资源类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'UserId' => ['description' => '用户id', 'type' => 'string', 'example' => '123456'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Id' => ['description' => '行为ID。', '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}'], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'string', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建流量防护自定义行为', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateSentinelBlockFallbackDefinition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询Eureka实例列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryMonitor' => [ - 'summary' => '查询监控信息。此接口只支持查询基础版实例的监控信息，专业版，开发版，serverless 版本监控数据已经投递到用户自己的云产品多租prometheus实例中，可以直接通过prometheus接口进行访问。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateWebFlowRule' => [ + 'summary' => '创建热点参数防护规则（HTTP 请求）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17082', - 'abilityTreeNodes' => [ - 'FEATUREmseZAXYAZ', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '164156', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['title' => '命名空间', 'description' => '命名空间', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'default', 'default' => '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' => '20'], + ], + [ + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', + 'title' => '规则状态', + 'description' => '规则状态'."\n" + .'- true(开启)'."\n" + .'- false(关闭)', + 'type' => 'boolean', 'required' => false, - 'example' => '{}', + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', ], ], [ - 'name' => 'MonitorType', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => '监控类型如下：'."\n" - ."\n" - .'[基础系统指标]'."\n" - .'- cpu使用量 cpuUsage'."\n" - .'- 内存使用量 memoryUsage'."\n" - .'- 磁盘使用量 diskUsage'."\n" - .'- gc次数（每分钟） gcCount'."\n" - .'- gc时间（每分钟） gcTime'."\n" - ."\n" - .'[nacos 注册中心]'."\n" - .'- 服务数 serviceCount'."\n" - .'- 写接口的平均请求耗时 writeCostTime'."\n" - .'- 读接口的平均请求耗时 readCostTime'."\n" - .'- TPS regCenterTps'."\n" - .'- QPS regCenterQps'."\n" - ."\n" - .'[nacos 配置中心]'."\n" - .'- 配置数 publish'."\n" - .'- 配置监听者数 getConfig'."\n" - ."\n" - .'[zookeeper]'."\n" - .'- TPS zk_TpsCount'."\n" - .'- QPS zk_QpsCount'."\n" - .'- 平均RT zookeeper_AvgRequestLatency', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'regCenterQps', - ], + 'schema' => ['title' => '资源名（接口名）', 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/flow'], ], [ - 'name' => 'StartTime', + 'name' => 'Burst', + 'in' => 'query', + 'schema' => ['title' => '针对突发请求额外允许的请求数目', 'description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => '应用Id', 'type' => 'string', 'required' => false, 'example' => 'hkhon1****@c3df23522******'], + ], + [ + 'name' => 'ControlBehavior', 'in' => 'query', 'schema' => [ - 'description' => '监控开始时间戳。', + 'title' => '流控方式', + 'description' => '流控方式'."\n" + .'- 0(快速失败)'."\n" + .'- 2(排队等待)', 'type' => 'integer', - 'format' => 'int64', - 'required' => true, + 'format' => 'int32', + 'required' => false, 'docRequired' => true, - 'example' => '1666678376', + 'enumValueTitles' => ['快速失败', 2 => '排队等待'], + 'example' => '0', + 'default' => '0', + 'enum' => ['0', '2'], ], ], [ - 'name' => 'EndTime', + 'name' => 'MaxQueueingTimeMs', + 'in' => 'query', + 'schema' => ['title' => '超时时间', 'description' => '超时时间，流控效果为排队等待时需要设置，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'], + ], + [ + 'name' => 'ResourceMode', 'in' => 'query', 'schema' => [ - 'description' => '监控结束时间戳。', + 'title' => '资源模式', + 'description' => '资源模式'."\n" + .'- 0(资源名模式)', 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', 'required' => true, - 'docRequired' => true, - 'example' => '1666678376', + 'enumValueTitles' => ['资源名模式'], + 'example' => '0', + 'enum' => ['0'], ], ], [ - 'name' => 'Step', + 'name' => 'ParamItem', + 'in' => 'query', + 'schema' => ['title' => '参数描述项', 'description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" + .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" + .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" + .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" + .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', 'type' => 'string', 'required' => false, 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}'], + ], + [ + 'name' => 'MetricType', 'in' => 'query', 'schema' => [ - 'description' => '数据点间隔，单位：s。 ', + 'title' => '指标类型', + 'description' => '阈值类型'."\n" + .'- 1(请求数)', 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', 'required' => false, - 'docRequired' => true, - 'example' => '7', + 'enumValueTitles' => [1 => '请求数'], + 'example' => '1', + 'enum' => ['1'], ], ], [ - 'name' => 'InstanceId', + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => ['title' => '统计间隔', 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，默认值为1秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', + 'title' => '资源类型', + 'description' => '资源类型'."\n" + .'- 0(自定义接口)'."\n" + .'- 1(WEB)'."\n" + .'- 2(RPC)', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-****', + 'enumValueTitles' => ['自定义接口', 'WEB', 'RPC'], + 'example' => '1', + 'enum' => ['0', '1', '2', '4', '3'], ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', - ], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求Id。', 'type' => 'string', 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'podName' => [ - 'description' => 'pod名称。', - 'type' => 'string', - 'example' => 'mse-xxxxxx-xxxxxx-reg-center-0-0', - ], - 'clusterNamePrefix' => [ - 'description' => '名称前缀。', - 'type' => 'string', - 'example' => 'mse-xxxx-xxxxxx', - ], - 'values' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据内容。', - 'type' => 'object', - ], - ], - ], + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'StatIntervalMs' => ['description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'type' => 'string', 'example' => '/flow'], + 'ControlBehavior' => ['description' => '流控方式'."\n" + .'- 0(快速失败)'."\n" + .'- 2(排队等待)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ReourceMode' => ['description' => '资源模式'."\n" + ."\n" + .'0(资源名模式)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Threshold' => ['description' => '阈值。', 'type' => 'number', 'format' => 'float', 'example' => '20'], + 'Enable' => ['description' => '规则状态'."\n" + ."\n" + .'- true(开启)'."\n" + .'- false(关闭)', 'type' => 'boolean', 'example' => 'true'], + 'AppId' => ['description' => '应用Id。', 'type' => 'string', 'example' => 'hkhon1****@c3df23522******'], + 'MetricType' => ['description' => '阈值类型'."\n" + .'- 1(请求数)', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RegionId' => ['description' => '地域Id。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Burst' => ['description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ParamItem' => ['description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" + .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" + .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" + .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" + .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', 'type' => 'string', 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}'], ], - 'example' => '6', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建热点参数防护（HTTP）规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateWebFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询监控信息', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateAcl' => [ - 'summary' => '修改白名单。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'CreateZnode' => [ + 'summary' => '创建Zookeeper数据节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -10716,62 +7163,35 @@ ], 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17096', - 'abilityTreeNodes' => [ - 'FEATUREmse3FEC0V', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '17007', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AclEntryList', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '白名单列表。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '192.168.0.0/XX,192.168.0.0/XX', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'InstanceId', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-78v1l83****', - ], + 'schema' => ['description' => '节点路径。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '/zookeeper'], ], [ - 'name' => 'NetworkType', + 'name' => 'Data', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => 'Public', - 'enum' => [ - 'Private', - 'Public', - ], - ], + 'schema' => ['description' => '节点数据。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'data'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -10780,260 +7200,136 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-100', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '节点数据。', 'type' => 'string', 'example' => 'cluster'], + 'Path' => ['description' => '节点路径。', 'type' => 'string', 'example' => '/'], + 'Dir' => ['description' => '节点列表信息，取值如下：'."\n" + .'- `true`：信息返回成功。'."\n" + .'- `false`：信息返回失败。', 'type' => 'boolean', 'example' => 'true'], + 'Name' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1'], + ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => 'ZooKeeper.IllegalRequest', 'errorMessage' => 'ZooKeeper operation is illegal.', 'description' => '当前ZooKeeper操作非法，请重新检查后进行操作'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', 'errorMessage' => 'No permission to operate current Znode.', 'description' => '无权限操作当前节点。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', 'errorMessage' => 'The current instance already has this Znode.', 'description' => '当前节点已经存在，请检查后重新操作。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => '当前操作的节点不存在，可能已经被删除。'], + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper 操作超时，可能由于当前操作的Znode数据过大，子节点过多，Server处理请求时间消耗过长，或者集群当前正在选主，无法处理请求。'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - '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' => '更新白名单', + '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":"\\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' => '创建ZooKeeper数据节点', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryInstancesInfo' => [ - 'summary' => '查询指定集群的运行时数据。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteAuthResource' => [ + 'summary' => '删除授权资源。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '129092', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '37111', + 'abilityTreeNodes' => ['FEATUREmseFZIQVY'], ], 'parameters' => [ [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl32g1u9k01', - ], - ], - [ - 'name' => 'OrderId', - 'in' => 'query', - 'schema' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'required' => false, - 'example' => '20574710974****', - ], - ], - [ - 'name' => 'RegionId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属地域的ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '目标ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '36'], ], [ - 'name' => 'RequestPars', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '559412D1-BFCE-53CC-B88E-0192C331EF44'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'HealthStatus' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'Role' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'PodName' => [ - 'description' => 'POD名称。', - 'type' => 'string', - 'example' => 'mse-xxxxx-xxxxx-reg-center-0-1', - ], - 'Ip' => [ - 'description' => 'POD的IP。', - 'type' => 'string', - 'example' => '25.24.91.x', - ], - 'InternetIp' => [ - 'description' => '公网IP。', - 'type' => 'string', - 'example' => '120.55.71.x', - ], - 'SingleTunnelVip' => [ - 'description' => '内网IP。', - 'type' => 'string', - 'example' => '172.16.66.x', - ], - 'CreationTimestamp' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-12-15T02:02:15Z', - ], - 'ClientPort' => [ - 'description' => '启用的端口。', - 'type' => 'string', - 'example' => '8848', - ], - 'Zone' => [ - 'description' => '可用区。', - 'type' => 'string', - 'example' => 'cn-hangzhou-k', - ], - 'ZoneDistributed' => [ - 'description' => '所有Pod是否已满足多可用区分布。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'AuthId' => ['description' => '鉴权ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '253'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****'], + 'DomainId' => ['description' => '域ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '235'], + 'DomainName' => ['description' => '域名。', 'type' => 'string', 'example' => 'name'], + 'Path' => ['description' => '路径。', 'type' => 'string', 'example' => '/zookeeper'], + 'IsWhite' => ['description' => '是否为白名单。', 'type' => 'boolean', 'example' => 'true'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '修改日期', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], ], ], ], @@ -11042,141 +7338,170 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除网关授权资源', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteAuthResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - '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' => '查询集群静态信息', ], - 'QueryClusterInfo' => [ - 'summary' => '查询集群的静态信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteCircuitBreakerRules' => [ + 'summary' => '删除熔断规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '129315', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '167824', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'InstanceId', + 'name' => 'Ids', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-7mz2t63ci03', + 'title' => '待删除的规则ID列表。', + 'description' => '待删除的规则ID列表。', + 'type' => 'array', + 'items' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, ], ], [ - 'name' => 'OrderId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'required' => false, - 'example' => '20574710974****', - ], + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'AclSwitch', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询公网白名单配置。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'true', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'RegionId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '完成删除的规则ID列表。', + 'description' => '完成删除的规则ID列表。', + 'type' => 'array', + 'items' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], ], [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除熔断规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteCircuitBreakerRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteCluster' => [ + 'summary' => '删除一个注册配置中心集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17009', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-6ja1rgl****'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -11185,1888 +7510,1093 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '415088B3-A7BE-56F6-9CD9-C42DE895CD41', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => '集群所处的VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp1v5nbauzh8xxxxxxx', - ], - 'CreateTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2022-12-15 10:02:07', - ], - 'IntranetAddress' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'DiskType' => [ - 'description' => '废弃字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'PubNetworkFlow' => [ - 'description' => '公网带宽，单位：Mbps。 '."\n" - .'取值范围：0~5000，其中0表示不接入公网。', - 'type' => 'string', - 'example' => '1', - ], - 'DiskCapacity' => [ - 'description' => '废弃字段。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'MemoryCapacity' => [ - 'description' => '废弃字段。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'ClusterAliasName' => [ - 'description' => '集群别名。', - 'type' => 'string', - 'example' => '开发环境', - ], - 'InstanceCount' => [ - 'description' => '集群实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'IntranetPort' => [ - 'description' => '集群内网开放的端口。', - 'type' => 'string', - 'example' => '8848,6443,9848,8761', - ], - 'InstanceModels' => [ - 'description' => '预留结构。', - 'type' => 'array', - 'items' => [ - 'description' => '预留结构。', - 'type' => 'object', - 'properties' => [ - 'PodName' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'SingleTunnelVip' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'InternetIp' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'Ip' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'Role' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'HealthStatus' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'CreationTimestamp' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'Zone' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - 'IntranetDomain' => [ - 'description' => '内网域名。', - 'type' => 'string', - 'example' => 'mse-xxxxx-nacos-ans.mse.aliyuncs.com', - ], - 'InternetDomain' => [ - 'description' => '公网域名。', - 'type' => 'string', - 'example' => 'mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com', - ], - 'PayInfo' => [ - 'description' => '付费方式。', - 'type' => 'string', - 'example' => '按量付费', - ], - 'InternetAddress' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'AclEntryList' => [ - 'description' => '公网白名单。', - 'type' => 'string', - 'example' => '["127.0.0.0/32"]', - ], - 'HealthStatus' => [ - 'description' => '集群状态。', - 'type' => 'string', - 'example' => 'INIT_SUCCESS', - ], - 'InitCostTime' => [ - 'description' => '集群初始化所用的时间（毫秒）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '53353', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AclId' => [ - 'description' => '公网白名单实例ID', - 'type' => 'string', - 'example' => 'acl-bp144q24cgqvzckmxxxx', - ], - 'Cpu' => [ - 'description' => '废弃字段。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'null', - ], - 'ClusterType' => [ - 'description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'ClusterName' => [ - 'description' => '集群完整名称。', - 'type' => 'string', - 'example' => 'mse-74355150-xxxxxxx', - ], - 'InitStatus' => [ - 'description' => '初始化状态。', - 'type' => 'string', - 'example' => 'INIT_SUCCESS', - ], - 'InternetPort' => [ - 'description' => '公网集群开放端口。', - 'type' => 'string', - 'example' => '8848,6443,9848,8761', - ], - 'AppVersion' => [ - 'description' => '集群版本号。', - 'type' => 'string', - 'example' => '2.1.0', - ], - 'NetType' => [ - 'description' => '集群网络连接类型。', - 'type' => 'string', - 'example' => 'privatenet', - ], - 'ClusterVersion' => [ - 'description' => '订单版本。', - 'type' => 'string', - 'example' => 'NACOS_2_0_0', - ], - 'ClusterSpecification' => [ - 'description' => '引擎规格。', - 'type' => 'string', - 'example' => 'MSE_SC_2_4_60_c', - ], - 'VSwitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-bp1egfakxxxxx', - ], - 'ConnectionType' => [ - 'description' => '废弃字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'MseVersion' => [ - 'description' => '集群版本。', - 'type' => 'string', - 'example' => 'mse_pro', - ], - 'ChargeType' => [ - 'title' => '', - 'description' => '付费模式，包括包年包月和按量付费。', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'Tags' => [ - 'description' => '标签。', - 'type' => 'object', - ], - 'ExpectZones' => [ - 'description' => '当前集群可打散到的可用区列表。', - 'type' => 'array', - 'items' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-k', - ], - ], - 'MaintenancePeriod' => [ - 'description' => '运维时间窗口', - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '运维时间窗口开始时间', - 'type' => 'string', - 'example' => '02:00', - ], - 'StartTime' => [ - 'description' => '运维时间窗口结束时间', - 'type' => 'string', - 'example' => '06:00', - ], - ], - ], - 'EndDate' => [ - 'title' => '到期时间（包年包月）', - 'description' => '到期时间（包年包月）', - 'type' => 'string', - 'example' => '2021-08-01 00:00:00', - ], - 'SecurityGroupId' => [ - 'title' => 'ENI网络接入的安全组ID', - 'description' => 'ENI网络接入的安全组ID', - 'type' => 'string', - 'example' => 'sg-uf6hgwe067prhg68agfa', - ], - 'SecurityGroupType' => [ - 'title' => 'ENI网络接入的安全组类型', - 'description' => 'ENI网络接入的安全组类型', - 'type' => 'string', - 'example' => 'enterprise', - 'enum' => [ - 'enterprise', - 'normal', - ], - ], - 'EipInstanceId' => [ - 'title' => '弹性公网IP（EIP）的实例ID', - 'description' => '弹性公网IP（EIP）的实例ID', - 'type' => 'string', - 'example' => 'eip-bp1uujshd5funmyy8rcl9', - ], - 'CanUpdate' => [ - 'description' => '集群是否有小版本可以升级', - 'type' => 'boolean', - 'example' => 'true', - ], - 'VersionCode' => [ - 'description' => '集群当前版本Code', - 'type' => 'string', - 'example' => 'NACOS_2_1_0_1', - ], - 'VersionLifecycle' => [ - 'type' => 'string', - ], - ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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":"\\n202\\n3369AD10-F1A6-4E6F-B99E-20F51826****\\n请求处理成功\\nmse-100-000\\ntrue\\n","errorExample":""}]', + 'title' => '删除集群', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询集群静态信息', ], - 'QueryClusterDetail' => [ - 'summary' => '接口查询集群详情。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteEngineNamespace' => [ + 'summary' => '删除Nacos命名空间。', + 'methods' => ['post', 'get', 'delete'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17078', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '17010', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '678ca857-****-b1bf-d0a98c5ca84b'], ], [ - 'name' => 'OrderId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '20576750143****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-7pp2d1****'], ], [ - 'name' => 'AclSwitch', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询ACL。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-0c738****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '字符串对象。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9515ACA4-E94D-440D-989E-C379FCED****', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp1hcg467ekqsv0zr****', - ], - 'CreateTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2020-07-31 11:36:08', - ], - 'IntranetAddress' => [ - 'description' => '私网地址。', - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'DiskType' => [ - 'description' => '磁盘类型。', - 'type' => 'string', - 'example' => 'alicloud-disk-ssd-multi-zone', - ], - 'PubNetworkFlow' => [ - 'description' => '公网带宽，单位：Mbps。 '."\n" - .'取值范围：0~5000，其中0表示不接入公网。', - 'type' => 'string', - 'example' => '3', - ], - 'DiskCapacity' => [ - 'description' => '磁盘容量，单位：G。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'MemoryCapacity' => [ - 'description' => '内存大小，单位：G。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ClusterAliasName' => [ - 'description' => '集群别名。', - 'type' => 'string', - 'example' => 'mse-7413****', - ], - 'InstanceCount' => [ - 'description' => '集群实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'IntranetPort' => [ - 'description' => '私网端口。', - 'type' => 'string', - 'example' => '8761', - ], - 'InstanceModels' => [ - 'description' => '实例列表。', - 'type' => 'array', - 'items' => [ - 'description' => '字符串对象。', - 'type' => 'object', - 'properties' => [ - 'PodName' => [ - 'description' => 'Pod名称。', - 'type' => 'string', - 'example' => 'mse-7413****-159616656****-reg-center-0-0', - ], - 'SingleTunnelVip' => [ - 'description' => '单线程IP。', - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'InternetIp' => [ - 'description' => '公网IP。', - 'type' => 'string', - 'example' => '47.98.XX.XX', - ], - 'Ip' => [ - 'description' => '实例IP。', - 'type' => 'string', - 'example' => '10.12.XX.XX', - ], - 'Role' => [ - 'description' => '角色。', - 'type' => 'string', - 'example' => 'Peer', - ], - 'HealthStatus' => [ - 'description' => '实例健康状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'CreationTimestamp' => [ - 'description' => '创建时间戳。', - 'type' => 'string', - 'example' => '1578575377732', - ], - 'Zone' => [ - 'description' => '可用区。', - 'type' => 'string', - 'example' => 'cn-shanghai-f', - ], - ], - ], - ], - 'IntranetDomain' => [ - 'description' => '私网域名。', - 'type' => 'string', - 'example' => 'mse-7413****-eureka.mse.aliyuncs.com', - ], - 'InternetDomain' => [ - 'description' => '公网域名。', - 'type' => 'string', - 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com', - ], - 'PayInfo' => [ - 'description' => '付费类型，包括包年包月和按量付费类型。', - 'type' => 'string', - 'example' => '按量付费', - ], - 'InternetAddress' => [ - 'description' => '公网地址。', - 'type' => 'string', - 'example' => '47.98.XX.XX', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'AclEntryList' => [ - 'description' => '白名单列表。', - 'type' => 'string', - 'example' => '[]', - ], - 'HealthStatus' => [ - 'description' => '集群健康状态。', - 'type' => 'string', - 'example' => 'RESTART_SUCCESS', - ], - 'InitCostTime' => [ - 'description' => '集群创建耗时，单位：ms。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98408', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AclId' => [ - 'description' => '白名单ID。', - 'type' => 'string', - 'example' => 'acl-bp17020kiqvzutwwj****', - ], - 'Cpu' => [ - 'description' => 'CPU数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ClusterType' => [ - 'description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - 'ClusterName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****', - ], - 'InitStatus' => [ - 'description' => '集群创建状态。', - 'type' => 'string', - 'example' => 'RESTART_SUCCESS', - ], - 'InternetPort' => [ - 'description' => '私网端口。', - 'type' => 'string', - 'example' => '8761', - ], - 'AppVersion' => [ - 'description' => 'APP版本。', - 'type' => 'string', - 'example' => '1.2.1', - ], - 'NetType' => [ - 'description' => '网络类型，取值如下：'."\n" - ."\n" - .'- `privatenet`：表示专有网络。'."\n" - .'- `pubnet`：表示公网。', - 'type' => 'string', - 'example' => 'privatenet', - ], - 'ClusterVersion' => [ - 'description' => '集群版本。', - 'type' => 'string', - 'example' => '1.2.1', - ], - 'ClusterSpecification' => [ - 'description' => '引擎规格。', - 'type' => 'string', - 'example' => 'MSE_SC_1_2_200_c', - ], - 'VSwitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-xxx-xxxx', - ], - 'ConnectionType' => [ - 'description' => '网络连接类型，取值如下：'."\n" - ."\n" - .'- slb'."\n" - .'- eni', - 'type' => 'string', - 'example' => 'slb', - ], - 'MseVersion' => [ - 'description' => 'MSE版本号', - 'type' => 'string', - 'example' => 'mse_basic', - ], - 'ChargeType' => [ - 'description' => '付费模式，包括包年包月和按量付费。', - 'type' => 'string', - 'example' => '按量付费', - ], - 'OrderClusterVersion' => [ - 'description' => '原始订单版本号。', - 'type' => 'string', - 'example' => '1.2.0', - ], - 'Tags' => [ - 'description' => '实例所绑定的标签。', - 'type' => 'object', - ], - 'ResourceGroupId' => [ - 'description' => '资源组 ID。', - 'type' => 'string', - 'example' => 'rg-aek2dhgysj*****', - ], - 'VersionLifecycle' => [ - 'type' => 'string', - ], - ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'Message' => ['description' => '响应描述。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除引擎命名空间', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询集群详情', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'CreateCluster' => [ - 'summary' => '创建一个注册配置中心（ZooKeeper、Nacos等）集群。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteFlowRules' => [ + 'summary' => '删除流控规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '17002', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '159871', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'PubNetworkFlow', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => 'ConnectionType为`slb`时有效，0表示不创建公网接入SLB，1以上值表示公网接入SLB的带宽固定值；单位Mbps', - 'description' => 'ConnectionType为`slb`时有效，0表示不创建公网接入SLB，1以上值表示公网接入SLB的带宽固定值；单位Mbps。'."\n" - ."\n" - .'取值范围：0~5000。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0', - ], + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'PubSlbSpecification', + 'name' => 'Ids', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '不再使用', - 'description' => '不再使用', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, + 'title' => '待删除的规则ID列表。', + 'description' => '待删除的规则ID列表。', + 'type' => 'array', + 'items' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'required' => true, + 'docRequired' => true, + 'example' => '[1,2]', ], ], [ - 'name' => 'DiskType', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '不再使用', - 'description' => '不再使用', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'VpcId', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'vpc-bp1t50e045b5g7i3p****', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'title' => '完成删除的规则ID列表。', + 'description' => '完成删除的规则ID列表。', + 'type' => 'array', + 'items' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'NetType', - 'in' => 'query', - 'schema' => [ - 'description' => '网络类型，取值如下：'."\n" - .'- `privatenet`：表示专有网络。'."\n" - .'- `pubnet`：表示公网。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'privatenet', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除流控规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteGateway' => [ + 'summary' => '删除指定网关。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'VSwitchId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '24808', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], + ], + 'parameters' => [ + [ + 'name' => 'DeleteSlb', 'in' => 'query', - 'schema' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'vsw-bp17opt4v18sto39k****', - ], + 'schema' => ['description' => '删除网关时是否同时删除代购的SLB。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'InstanceCount', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '实例节点数，开发版仅支持1节点，其它版本支持3-9单数节点', - 'description' => '实例节点数，范围限制：1~9个。'."\n" - ."\n" - .'[专业版] '."\n" - .'- 实例数大于等于3，且必须为奇数。'."\n" - ."\n" - .'[开发版] '."\n" - .'- 实例数只能为1。'."\n" - ."\n" - .'[Serverless版]'."\n" - ."\n" - .'忽略该参数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '3', - ], + 'schema' => ['description' => '网关唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-0fe488252dc44d55a9dd57875193a1d7'], ], [ - 'name' => 'ClusterSpecification', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '引擎规格，取值如下：'."\n" - ."\n" - .'[专业版] '."\n" - ."\n" - .'- `MSE_SC_2_4_60_c`：2核4G'."\n" - .'- `MSE_SC_1_2_60_c`：1核2G'."\n" - .'- `MSE_SC_4_8_60_c`：4核8G'."\n" - .'- `MSE_SC_8_16_60_c`：8核16G'."\n" - .'- `MSE_SC_16_32_60_c`：16核32G'."\n" - ."\n" - .'[开发版] '."\n" - ."\n" - .'- `MSE_SC_1_2_60_c`：1核2G'."\n" - .'- `MSE_SC_2_4_60_c`：2核4G'."\n" - ."\n" - .'[Serverless版]'."\n" - ."\n" - .'忽略该参数，也可填`MSE_SC_SERVERLESS`。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MSE_SC_2_4_60_c', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'ClusterVersion', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群版本，取值如下：'."\n" - ."\n" - .'[专业版] '."\n" - ."\n" - .'- `NACOS_2_0_0`：表示Nacos 2.x.x 版本。'."\n" - .'- `ZooKeeper_3_8_0`：表示ZooKeeper 3.8.x 版本。'."\n" - ."\n" - .'[开发版] '."\n" - ."\n" - .'- `NACOS_2_0_0`：表示Nacos 2.x 版本。'."\n" - .'- `ZooKeeper_3_8_0`：表示ZooKeeper 3.8.x 版本。'."\n" - ."\n" - .'[Serverless版]'."\n" - ."\n" - .'- `NACOS_2_0_0`：表示Nacos 2.x 版本。'."\n" - .'- `ZooKeeper_3_8_0`：表示ZooKeeper 3.8.x 版本。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'NACOS_2_0_0', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6'], + 'HttpStatusCode' => ['description' => 'http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因，例如：TaskId not found。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '状态码。状态码为200表示成功，其余取值表示失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'Name' => ['description' => '网关名称。', 'type' => 'string', 'example' => 'mse-bc1a29b0-reg-center-0-1'], + 'GatewayUniqueId' => ['description' => '网关唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'Region' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'PrimaryUser' => ['description' => '用户信息。', 'type' => 'string', 'example' => '1231254'], + 'Status' => ['description' => '网关状态：'."\n" + .'0: 创建中'."\n" + .'1: 创建失败'."\n" + .'2: 运行中'."\n" + .'3: 变更中'."\n" + .'4: 缩容中'."\n" + .'6: 扩容中'."\n" + .'8: 删除中'."\n" + .'10: 重启中'."\n" + .'11: 重建中'."\n" + .'12: 升级中'."\n" + .'13: 升级失败', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Vpc' => ['description' => '网关归属的VpcId', 'type' => 'string', 'example' => 'vpc-bp1328cm01m6uel42b5zb'], + 'Vswitch' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bp18zeqxx6mpuq843z4n5'], + 'SecurityGroup' => ['description' => '安全组。', 'type' => 'string', 'example' => 'sg-bp11ufzqn6mmb8dtzz82'], + 'Spec' => ['description' => '网关规格。', 'type' => 'string', 'example' => 'MSE_GTW_16_32_200_c'], + 'Replica' => ['description' => '网关副本数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '最后一次更新网关实例的时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'ClusterType', - 'in' => 'query', - 'schema' => [ - 'description' => '集群类型，包括ZooKeeper、Nacos-Ans。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Nacos-Ans', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除网关信息', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，包括但不限于如下地域：'."\n" - .'- `cn-hangzhou`：杭州'."\n" - .'- `cn-beijing`：北京'."\n" - .'- `cn-shanghai`：上海'."\n" - .'- `cn-zhangjiakou`：张家口'."\n" - .'- `cn-shenzhen`：深圳', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + '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' => '删除网关鉴权消费者。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'PrivateSlbSpecification', - 'in' => 'query', - 'schema' => [ - 'title' => '不再使用', - 'description' => '不再使用', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'ConnectionType', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '网络接入类型，`slb`或`single_eni`；部分Region开发版只支持`single_eni`类型', - 'description' => '网络接入类型，`slb`或`single_eni`；部分Region开发版只支持`single_eni`类型。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], ], [ - 'name' => 'RequestPars', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '网关鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****'], ], [ - 'name' => 'MseVersion', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例版本：开发版mse_dev、基础版mse_basic、专业版mse_pro', - 'description' => '非特殊情况必填，取值如下：'."\n" - ."\n" - .'- `mse_pro`：表示专业版。'."\n" - .'- `mse_dev`：表示开发版。'."\n" - .'- `mse_serverless`：表示Serverless版。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'mse_dev' => '开发版', - 'mse_serverless' => 'Serverless版', - 'mse_pro' => '专业版', + 'title' => 'RestResult>', + 'description' => 'RestResult>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '执行是否成功：'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', 'type' => 'boolean', 'example' => 'true'], ], - 'example' => 'mse_pro', ], ], - [ - 'name' => 'InstanceName', - 'in' => 'query', - 'schema' => [ - 'title' => '实例别名', - 'description' => '实例自定义名称', - 'type' => 'string', - 'required' => false, - 'example' => 'tanshuyingtest001', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。资源组详情请参见查看[资源组基本信息](~~457230~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzcqmoay3dlyq', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除网关鉴权消费者', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => '待添加的标签列表。最多包含20个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签KEY。', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'prd', - ], - ], - 'required' => false, + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayAuthConsumer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], - 'required' => false, - 'maxItems' => 21, ], ], + ], + ], + 'DeleteGatewayAuthConsumerResource' => [ + 'summary' => '删除网关鉴权消费者的授权。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'ChargeType', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '付费类型', - 'description' => '付费模式，包括PREPAY（包年包月）和POSTPAY（按量付费）。'."\n" - ."\n" - .'Serverless版忽略该参数。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PREPAY' => '包年包月', - 'POSTPAY' => '按量付费', - ], - 'example' => 'POSTPAY', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n"], ], [ - 'name' => 'SecurityGroupType', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'title' => 'ConnectionType为`single_eni`时有效，表示实例所在的安全组类型', - 'description' => 'ConnectionType为`single_eni`时有效，表示实例所在的安全组类型', - 'type' => 'string', - 'required' => false, - 'example' => 'enterprise', - 'default' => 'enterprise', - 'enum' => [ - 'enterprise', - 'normal', - ], - ], + 'schema' => ['description' => '网关鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], ], [ - 'name' => 'EipEnabled', + 'name' => 'IdList', 'in' => 'query', - 'schema' => [ - 'title' => 'ConnectionType为`single_eni`时有效，表示是否开启公网访问（弹性公网IP）', - 'description' => 'ConnectionType为`single_eni`时有效，表示是否开启公网访问（弹性公网IP）', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'default' => 'false', - ], + 'schema' => ['description' => '用户删除指定的授权ID列表。', 'type' => 'string', 'required' => true, 'example' => '1,2,3,4'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '字符串对象。', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'dc63-465d-8ef5-20dc18af****', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '20574710974****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoPermission'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '执行是否成功：'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '删除网关鉴权消费者的授权', + '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 \\"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' => '创建注册配置中心集群', - 'description' => '请确保在使用该接口前，已充分了解MSE（Microservice Engine）产品的收费方式和价格。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteCluster' => [ - 'summary' => '删除一个注册配置中心集群。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewayCircuitBreakerRule' => [ + 'summary' => '删除该网关熔断规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17009', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-6ja1rgl****', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-1cef5440bf2d484db419fb264d4f****'], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11151'], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => '熔断规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', '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', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '删除网关熔断规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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":""}]', - 'title' => '删除集群', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateCluster' => [ - 'summary' => '修改集群信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewayDomain' => [ + 'summary' => '删除网关关联域名。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17098', - 'abilityTreeNodes' => [ - 'FEATUREmseY3D6DK', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '35642', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '域名ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '109'], ], [ - 'name' => 'ClusterAliasName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '集群别名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cluster-1', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-90392d768a3847a7b804c505254d****'], ], [ - 'name' => 'InstanceId', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-78v1l83****', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '39016EAC-6EDB-52FE-AE20-4B013DF236FF'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '域名ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'CONTACTINFO'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '253'], + 'Protocol' => ['description' => '协议。', 'type' => 'string', 'example' => 'HTTP'], + 'MustHttps' => ['description' => '是否允许HTTP探测。', 'type' => 'boolean', 'example' => 'true'], + 'CertIdentifier' => ['description' => '证书ID。', 'type' => 'string', 'example' => '243'], + 'GmtCreate' => ['description' => '域名创建时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'MaintenanceStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '运维窗口开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '02:00', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除网关关联域名', + '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}'], + ], ], ], + ], + ], + 'DeleteGatewayFlowRule' => [ + 'summary' => '删除该网关流控规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'MaintenanceEndTime', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '运维窗口结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '06:00', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11151'], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => '流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-100', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['description' => '请求ID。', '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', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B74E7F7-DF54-5AB1-B8F2-67391B83****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '删除网关流控规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '更新集群信息', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateConfig' => [ - 'summary' => '更新集群配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteGatewayIsolationRule' => [ + 'summary' => '删除该网关并发规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '17099', - 'abilityTreeNodes' => [ - 'FEATUREmseY3D6DK', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], ], [ - 'name' => 'ClusterId', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11151'], ], [ - 'name' => 'ConfigType', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => '配置格式，包括TEXT、JSON、XML、HTML等。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'TEXT', - ], + 'schema' => ['description' => '并发规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'TickTime', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'zookeeper配置，时间单元，默认为2000毫秒。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2000', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'InitLimit', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'zookeeper配置，实例最长连接时间，单位：秒。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '100', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****'], + 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'True'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'SyncLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'zookeeper配置，实例连接超时时间，单位：秒。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'MaxClientCnxns', - 'in' => 'query', - 'schema' => [ - 'description' => 'zookeeper配置，单个客户端与单台服务器之间的连接数。 '."\n" - .'如果设置为0，表示不作任何限制。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'OpenSuperAcl', - 'in' => 'formData', - 'schema' => [ - 'description' => 'zookeeper配置，超级权限开关，取值如下：'."\n" - .'- `true`：打开'."\n" - .'- `false`：关闭', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'UserName', - 'in' => 'query', - 'schema' => [ - 'description' => '用户名称。'."\n" - .'> 当OpenSuperAcl为true时，需要填写此值。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - ], - [ - 'name' => 'PassWord', - 'in' => 'query', - 'schema' => [ - 'description' => '用户密码。'."\n" - .'> 当OpenSuperAcl为true时，需要填写此值。', - 'type' => 'string', - 'required' => false, - 'example' => 'password', - ], - ], - [ - 'name' => 'JuteMaxbuffer', - 'in' => 'query', - 'schema' => [ - 'description' => 'zookeeper配置，每个节点最大数据量，默认是1M，单位：字节。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1048575', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], - [ - 'name' => 'AutopurgePurgeInterval', - 'in' => 'query', - 'schema' => [ - 'description' => '保留字段。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'none', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '删除网关并发规则', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'AutopurgeSnapRetainCount', - 'in' => 'query', - 'schema' => [ - 'description' => '保留字段。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'none', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteGatewayRoute' => [ + 'summary' => '删除网关路由。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'ConfigAuthEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'nacos配置，是否开启配置中心ram鉴权：'."\n" - .'- `true`：开启'."\n" - .'- `false`：关闭'."\n" - ."\n" - .'> 设置此值前需要调用QueryConfig接口，获取ConfigAuthSupported参数，以查看当前集群是否支持此功能。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '25970', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], + ], + 'parameters' => [ [ - 'name' => 'NamingAuthEnabled', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'description' => 'nacos配置，是否开启注册中心ram鉴权：'."\n" - .'- `true`：开启'."\n" - .'- `false`：关闭'."\n" - ."\n" - .'> 设置此值前需要调用QueryConfig接口，获取NamingAuthSupporte参数，以查看当前集群是否支持此功能。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '路由条目ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '252'], ], [ - 'name' => 'MCPEnabled', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => 'nacos配置，MCP是否生效，取值如下：'."\n" - .'- `true`：生效'."\n" - .'- `false`：不生效'."\n" - .'> 设置此值前需要调用QueryConfig接口，获取MCPSupported参数，以查看当前集群是否支持此功能。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-492af9b04bb4474cae9d645be850e3d7'], ], [ - 'name' => 'InstanceId', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-st2212****', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'ConfigSecretEnabled', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'nacos配置，是否打开配置中心配置加密功能，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。'."\n" - ."\n" - .'> 设置此值前需要调用QueryConfig接口，获取ConfigSecretSupported参数，以查看当前集群是否支持此功能。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '报错信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-5017305290e14cebbrvec4a5****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '125'], + 'Predicates' => ['description' => '匹配规则', 'type' => 'string', 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}'], + 'DefaultServiceId' => ['description' => '默认服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RouteOrder' => ['description' => '路由顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Status' => ['description' => '路由状态。'."\n" + .'- 未发布：0'."\n" + .'- 发布中：2'."\n" + .'- 已发布：3'."\n" + .'- 编辑中(有更新未发布)：4'."\n" + .'- 下线中：5'."\n" + .'- 不可用：6', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2021-12-30T06:41:52.000+0000'], + ], + ], + ], ], ], - [ - 'name' => 'MinSessionTimeout', - 'in' => 'query', - 'schema' => [ - 'title' => '最小超时时间', - 'description' => 'zookeeper配置，最小超时时间，单位：秒。', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], ], - [ - 'name' => 'MaxSessionTimeout', - 'in' => 'query', - 'schema' => [ - 'title' => '最大超时时间', - 'description' => 'zookeeper配置，最大超时时间，单位：秒。', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], ], [ - 'name' => 'SnapshotCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'zookeeper配置，生成快照的频率', - 'type' => 'string', - 'required' => false, - 'example' => '100000', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], - [ - 'name' => 'ExtendedTypesEnable', - 'in' => 'query', - 'schema' => [ - 'description' => 'zookeeper参数，是否开启TTL配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除网关路由', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'EurekaSupported', - 'in' => 'query', - 'schema' => [ - 'description' => 'Nacos是否开启支持Eurka协议', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'DeleteGatewayService' => [ + 'summary' => '删除网关服务。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'TLSEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'Nacos是否开启TLS传输链路加密', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '25194', + 'abilityTreeNodes' => ['FEATUREmse5GGXKF'], + ], + 'parameters' => [ [ - 'name' => 'ConsoleUIEnabled', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启Nacos开源控制台', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '190'], ], [ - 'name' => 'Enable4lw', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启四字命令访问', - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], ], [ - 'name' => 'AuthEnabled', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '是否启用强制SASL身份认证，启用之后，没有进行SASL身份认证的客户端将无法访问集群', - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '数据结构。', + 'title' => 'Schema of Response', + 'description' => '请求响应结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP返回码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一ID', 'type' => 'string', 'example' => 'B3545F76-6ED1-586F-8DB9-ECE07985F381'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '190'], + 'Name' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SourceType' => ['description' => '服务来源', 'type' => 'string', 'example' => 'MSE'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'GroupName' => ['description' => '分组名称。', 'type' => 'string', 'example' => 'DEFAULT_GROUP'], + 'SourceId' => ['description' => '来源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ServiceNameInRegistry' => ['description' => '服务注册到注册中心的名称。', 'type' => 'string', 'example' => 'test'], + 'MetaInfo' => ['description' => '服务的基本信息。', 'type' => 'string', 'example' => '{}'], + 'Ips' => [ + 'description' => 'IP', + 'type' => 'array', + 'items' => ['description' => 'IP', 'type' => 'string', 'example' => '127.0.1.12'], + ], + 'GmtCreate' => ['description' => '服务创建时间。', 'type' => 'string', 'example' => '2022-01-14 14:39:16'], + 'GmtModified' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + ], ], ], ], @@ -13074,564 +8604,303 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => '更新集群配置', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListClusters' => [ - 'summary' => '查询注册配置中心集群列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'cluster', + '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' => '删除网关服务', + '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' => '删除网关服务版本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17063', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '90283', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '777'], ], [ - 'name' => 'PageNum', + 'name' => 'ServiceVersion', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '服务版本。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"name\\":\\"app\\",\\"labels\\":[{\\"key\\":\\"app\\",\\"value\\":\\"demo-server\\"}]}'], ], [ - 'name' => 'PageSize', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '每页展示集群数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-b6988bd16920479d9104e1729f97****'], ], [ - 'name' => 'ClusterAliasName', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群名字，支持模糊匹配。', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '29D52777-BE96-563E-BC6B-796ACE47A7A5'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因，例如：TaskId not found。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，MSE支持的地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除网关服务版本', + '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}'], + ], ], ], + ], + ], + 'DeleteGatewaySlb' => [ + 'summary' => '取消关联SLB。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'ResourceGroupId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '71802', + 'abilityTreeNodes' => ['FEATUREmseMNDRFM'], + ], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。资源组详情请参见查看资源组基本信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxbzafebvvfa', - ], + 'schema' => ['description' => '关联记录ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '395'], ], [ - 'name' => 'Tag', + 'name' => 'DeleteSlb', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '标签列表，最多包含20个子项', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'prd', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => '删除网关时是否同时删除代购的SLB。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'KeyId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '如果是nacos集群，查询绑定了指定keyId的实例', - 'type' => 'string', - 'required' => false, - 'example' => 'key-hzz67774641bsp21vhj4h', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****'], ], [ - 'name' => 'VpcId', + 'name' => 'SlbId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '待取消关联的SlbId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lb-uf6duug6s13x4abc8****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + ."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '字符串对象。', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => '实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '字符串对象。', - 'type' => 'object', - 'properties' => [ - 'EndDate' => [ - 'description' => '集群截止时间。', - 'type' => 'string', - 'example' => '2021-08-01 00:00:00', - ], - 'IntranetDomain' => [ - 'description' => '私网域名。', - 'type' => 'string', - 'example' => 'mse-7413****-eureka.mse.aliyuncs.com', - ], - 'InternetDomain' => [ - 'description' => '公网域名。', - 'type' => 'string', - 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com', - ], - 'CreateTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2020-07-31 11:36:08', - ], - 'ChargeType' => [ - 'description' => '付费模式，包括包年包月和按量付费。', - 'type' => 'string', - 'example' => '按量付费', - ], - 'IntranetAddress' => [ - 'description' => '私网地址。', - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'InternetAddress' => [ - 'description' => '公网地址。', - 'type' => 'string', - 'example' => '47.98.XX.XX', - ], - 'ClusterAliasName' => [ - 'description' => '集群别名。', - 'type' => 'string', - 'example' => 'mse-7413****', - ], - 'ClusterType' => [ - 'description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', - 'type' => 'string', - 'example' => 'Eureka', - ], - 'InitStatus' => [ - 'description' => '初始化状态。', - 'type' => 'string', - 'example' => 'RESTART_SUCCESS', - ], - 'AppVersion' => [ - 'description' => 'APP版本。', - 'type' => 'string', - 'example' => '1.9.3', - ], - 'CanUpdate' => [ - 'description' => '是否能够升级。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'VersionCode' => [ - 'description' => '版本信息。', - 'type' => 'string', - 'example' => 'EUREKA_1_9_3', - ], - 'InstanceCount' => [ - 'description' => '集群数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ClusterName' => [ - 'description' => '集群名字。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'MseVersion' => [ - 'description' => '集群所使用的版本类别。', - 'type' => 'string', - 'example' => 'mse_pro', - ], - 'Tags' => [ - 'description' => '实例所绑定的标签。', - 'type' => 'object', - ], - 'ResourceGroupId' => [ - 'description' => '实例所属的资源组 ID。', - 'type' => 'string', - 'example' => 'rg-acfmv7jiavm4uxa', - ], - 'VpcId' => [ - 'description' => '集群所处的VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp1hcg467ekqsv0zr****', - ], - 'MaintenancePeriod' => [ - 'description' => '运维时间窗口', - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => '运维时间窗口开始时间', - 'type' => 'string', - 'example' => '02:00', - ], - 'EndTime' => [ - 'description' => '运维时间窗口结束时间', - 'type' => 'string', - 'example' => '06:00', - ], - ], - ], - 'VersionLifecycle' => [ - 'type' => 'string', - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '删除结果。', 'type' => 'string', 'example' => '28'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '取消关联网关SLB', + '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 \\"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' => '查询集群列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListClusterTypes' => [ - 'summary' => '查询支持开通的引擎类型。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteIsolationRules' => [ + 'summary' => '删除隔离规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '163574', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', + ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，MSE支持的地域。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'ConnectType', + 'name' => 'Ids', 'in' => 'query', - 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'title' => '网络连接类型', - 'description' => '网络类型，取值如下：'."\n" - ."\n" - .'- slb'."\n" - .'- eni', - 'type' => 'string', + 'title' => '待删除的规则ID列表。', + 'description' => '待删除的规则ID列表。', + 'type' => 'array', + 'items' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], 'required' => false, - 'example' => 'slb', - 'enum' => [ - 'eni', - 'slb', - ], + 'maxItems' => 100, ], ], [ - 'name' => 'MseVersion', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '待开通的MSE集群版本。'."\n" - ."\n" - .'- mse_pro：表示专业版。'."\n" - .'- mse_dev：表示开发版。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - ], + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '821B5B05-8919-5FBB-BA75-417BFC093EB8', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'Code' => ['title' => '返回码。', 'description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '响应信息。', 'description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Success' => ['title' => '请求结果。', 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['title' => 'HTTP状态码。', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ - 'description' => '返回数据。', + 'title' => '完成删除的规则ID列表。', + 'description' => '完成删除的规则ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '引擎类型Code', - 'type' => 'string', - 'example' => 'ZooKeeper', - ], - 'ShowName' => [ - 'description' => '可开通的MSE引擎类型。', - 'type' => 'string', - 'example' => 'Zookeeper', - ], - ], - ], + 'items' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], @@ -13639,96 +8908,67 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除隔离规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteIsolationRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询引擎类型', ], - 'ListClusterVersions' => [ - 'summary' => '查询支持的集群版本信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteMigrationTask' => [ + 'summary' => '调用接口删除迁移上云任务。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ClusterType', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Nacos-Ans', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'MseVersion', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '取值如下：'."\n" - ."\n" - .'- `mse_dev`：表示开发版。'."\n" - .'- `mse_pro`：表示专业版（默认取值）。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - ], + 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -13737,175 +8977,104 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7717BE5B-C958-5F87-BF49-464AA276EDD1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'description' => '与本次请求相关的动态错误信息。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '集群类型编码。', - 'type' => 'string', - 'example' => 'NACOS_2_0_0', - ], - 'ShowName' => [ - 'description' => '集群版本。', - 'type' => 'string', - 'example' => '2.1.0', - ], - 'ClusterType' => [ - 'description' => '集群类型。', - 'type' => 'string', - 'example' => 'Nacos-Ans', - ], - ], - ], - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Data' => ['description' => '删除结果。', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除迁移上云任务', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询集群版本', ], - 'QueryClusterSpecification' => [ - 'summary' => '查询支持的集群规格列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteNacosConfig' => [ + 'summary' => '删除Nacos配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17011', + 'abilityTreeNodes' => ['FEATUREmse0BR2XQ'], + ], 'parameters' => [ [ - 'name' => 'ConnectType', + 'name' => 'InstanceId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '网络连接类型', - 'description' => '网络类型，取值如下：'."\n" - ."\n" - .'- slb'."\n" - .'- eni', - 'type' => 'string', - 'required' => false, - 'example' => 'slb', - 'pattern' => '', - 'enum' => [ - 'eni', - 'slb', - ], - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-tl32epfyu18'], ], [ - 'name' => 'MseVersion', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => '待开通的MSE集群版本。'."\n" - ."\n" - .'- mse_pro：表示专业版。'."\n" - .'- mse_dev：表示开发版。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'mse_pro', - ], + 'schema' => ['description' => '配置ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user-ds.yml'], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => '分组类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HALVIE_MICRO_GROUP'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID。默认为public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0e9d849b-****-8435da6c21ad'], + ], + [ + 'name' => 'Beta', + 'in' => 'query', + 'schema' => ['description' => '是否Beta发布。默认为false'."\n" + ."\n" + .'- `true`：是'."\n" + .'- `false`：否', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -13914,157 +9083,91 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'ClusterSpecificationName' => [ - 'description' => '可使用的引擎规格。', - 'type' => 'string', - 'example' => 'MSE_SC_1_2_200_c', - ], - 'MemoryCapacity' => [ - 'description' => '此规格下的内存大小，单位：G。', - 'type' => 'string', - 'example' => '2', - ], - 'CpuCapacity' => [ - 'description' => '此规格下的CPU核数。', - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '返回码。', 'type' => 'string', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除Nacos配置', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](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' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询集群规格', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryClusterDiskSpecification' => [ - 'summary' => '查询支持的集群磁盘规格信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteNacosConfigs' => [ + 'summary' => '批量删除多个Nacos配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '76161', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '17012', + 'abilityTreeNodes' => ['FEATUREmse0BR2XQ'], ], 'parameters' => [ [ - 'name' => 'ClusterType', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ZooKeeper', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-i7m2e32pd0n'], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => ['description' => '配置列表ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20024,20025,20026,20027,20034,20104,20394'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1ef93a21-3487-4367-a859-857d8****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -14073,864 +9176,357 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '请求返回码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E13A3A34-7201-50C4-B2D0-0D7DB891811E', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'description' => '磁盘大小步长。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Max' => [ - 'description' => '磁盘允许最大值，单位：GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Min' => [ - 'description' => '磁盘允许最小值，单位：GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '73EB5563-CBB3-5F48-999D-512F4EFB7377'], + 'Message' => ['description' => '请求消息。', 'type' => 'string', 'example' => 'success'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。'."\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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '批量删除Nacos配置', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询集群磁盘规格', ], - 'ListInstanceCount' => [ - 'summary' => '列举集群可开通的节点数。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteNacosInstance' => [ + 'summary' => '删除Nacos服务下持久化实例。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'abilityTreeCode' => '121118', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'ClusterType', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群类型，包括ZooKeeper、Nacos-Ans。', - 'type' => 'string', - 'required' => false, - 'example' => 'Nacos-Ans', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'mse-cn-st21v5****'], ], [ - 'name' => 'MseVersion', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '集群版本类型，取值如下：'."\n" - ."\n" - .'- `mse_dev`：表示开发版。'."\n" - .'- `mse_pro`：表示专业版。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - ], + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => true, 'example' => 'hello_service'], ], [ - 'name' => 'RegionId', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，包括但不限于如下地域：'."\n" - ."\n" - .'- cn-hangzhou：杭州 '."\n" - .'- cn-beijing：北京 '."\n" - .'- cn-shanghai：上海 '."\n" - .'- cn-zhangjiakou：张家口 '."\n" - .'- cn-shenzhen：深圳', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****'], ], [ - 'name' => 'RequestPars', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '分组名称。', 'type' => 'string', 'required' => true, 'example' => 'DEFAULT_GROUP'], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => ['description' => '集群别名。', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT', 'default' => 'DEFAULT'], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['description' => 'Nacos实例IP。', 'type' => 'string', 'required' => true, 'example' => '10.237.1.32'], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => 'Nacos实例端口。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8080'], + ], + [ + 'name' => 'Ephemeral', + 'in' => 'query', + 'schema' => ['description' => '是否临时节点标志，取值如下：'."\n" + .'- `true`：是。'."\n" + .'- `false`：否。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型。'."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。当请求失败，返回ErrorCode字段。具体信息，请参见[本文的错误码列表](~~456441~~)。', - 'type' => 'string', - 'example' => 'mse-100-100', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => '%s', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数 `ErrMessage` 错误信息中的 `%s`。'."\n" - ."\n" - .'> 如果`ErrMessage`返回`The Value of Input Parameter %s is not valid`，且`DynamicMessage`返回`DtsJobId`，则代表所传入的请求参数`DtsJobId`不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'array', - 'items' => [ - 'description' => '当前版本下可开通的节点数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'Code仅仅用来和Success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '节点数据。', 'type' => 'string', 'example' => 'OK'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除Nacos实例', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '集群可开通的节点数', ], - 'QueryConfig' => [ - 'summary' => '查询集群配置信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteNacosService' => [ + 'summary' => '删除一个Nacos服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17081', - 'abilityTreeNodes' => [ - 'FEATUREmseY3D6DK', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '18547', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-123456'], ], [ - 'name' => 'ClusterId', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello_service'], ], [ - 'name' => 'ConfigType', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '预留字段。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '分组名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'InstanceId', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse_prepaid_public_cn-st2212****', - ], + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0****'], ], [ - 'name' => 'NeedRunningConf', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '是否需要运行时配置。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'description' => '字符串对象。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112EC53', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'MaxClientCnxns' => [ - 'description' => 'zookeeper配置，单个客户端与单台服务器之间的连接数。 '."\n" - .'如果设置为0，表示不作任何限制。', - 'type' => 'string', - 'example' => '0', - ], - 'ConfigAuthSupported' => [ - 'description' => 'nacos配置，当前集群的配置中心是否支持RAM鉴权，取值如下：'."\n" - .'- `true`：支持'."\n" - .'- `false`：不支持', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InitLimit' => [ - 'description' => 'zookeeper配置，实例最长连接时间，单位：秒。', - 'type' => 'string', - 'example' => '100', - ], - 'MCPEnabled' => [ - 'description' => 'nacos配置，MCP是否生效，取值如下：'."\n" - .'- `true`：生效'."\n" - .'- `false`：不生效', - 'type' => 'boolean', - 'example' => 'true', - ], - 'OpenSuperAcl' => [ - 'description' => 'zookeeper配置，超级权限开关，取值如下：'."\n" - .'- `true`：打开'."\n" - .'- `false`：关闭', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RestartFlag' => [ - 'description' => '当前集群是否已重启并应用新配置，取值如下：'."\n" - .'- `true`：重启成功。'."\n" - .'- `false`：重启失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'JvmFlagsCustom' => [ - 'description' => '保留字段', - 'type' => 'string', - 'example' => 'none', - ], - 'AutopurgePurgeInterval' => [ - 'description' => '保留字段。', - 'type' => 'string', - 'example' => 'none', - ], - 'AutopurgeSnapRetainCount' => [ - 'description' => '保留字段。', - 'type' => 'string', - 'example' => 'none', - ], - 'SyncLimit' => [ - 'description' => 'zookeeper配置，实例连接超时时间，单位：秒。', - 'type' => 'string', - 'example' => '10', - ], - 'ConfigAuthEnabled' => [ - 'description' => 'nacos配置，是否开启配置中心ram鉴权，取值如下：'."\n" - .'- `true`：生效'."\n" - .'- `false`：未生效', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ClusterName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'MCPSupported' => [ - 'description' => 'nacos配置，MCP是否支持，取值如下：'."\n" - .'- `true`：支持'."\n" - .'- `false`：不支持', - 'type' => 'boolean', - 'example' => 'true', - ], - 'JuteMaxbuffer' => [ - 'description' => 'zookeeper配置，每个节点最大数据量，单位：字节。', - 'type' => 'string', - 'example' => '1', - ], - 'TickTime' => [ - 'description' => 'zookeeper配置，引擎中的一个时间单元，默认为2000毫秒。', - 'type' => 'string', - 'example' => '2000', - ], - 'PassWord' => [ - 'description' => '用户密码。当OpenSuperAcl为true时，展示此值。', - 'type' => 'string', - 'example' => 'password', - ], - 'UserName' => [ - 'description' => '用户名称。当OpenSuperAcl为true时，展示此值。', - 'type' => 'string', - 'example' => 'name', - ], - 'ConfigSecretSupported' => [ - 'description' => 'nacos配置，当前集群是否支持配置中心配置加密，取值如下：'."\n" - .'- `true`：支持'."\n" - .'- `false`：不支持', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ConfigSecretEnabled' => [ - 'description' => 'nacos配置，当前集群是否开启配置中心配置加密，取值如下：'."\n" - .'- `true`：开启'."\n" - .'- `false`：未开启', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NamingAuthEnabled' => [ - 'description' => 'nacos配置，是否开启注册中心ram鉴权：'."\n" - .'- `true`：开启'."\n" - .'- `false`：关闭', - 'type' => 'boolean', - 'example' => 'false', - ], - 'NamingAuthSupported' => [ - 'description' => 'nacos配置，当前集群是否支持服务RAM鉴权，取值如下：'."\n" - .'- `true`：支持'."\n" - .'- `false`：不支持', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NamingCreateServiceSupported' => [ - 'description' => 'nacos配置，当前集群是否支持创建服务，取值如下：'."\n" - .'- `true`：支持'."\n" - .'- `false`：不支持', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MinSessionTimeout' => [ - 'title' => '最小超时时间', - 'description' => 'zookeeper配置，最小超时时间。', - 'type' => 'string', - 'example' => '-1', - ], - 'MaxSessionTimeout' => [ - 'title' => '最大超时时间', - 'description' => 'zookeeper配置，最大超时时间。', - 'type' => 'string', - 'example' => '-1', - ], - 'SnapshotCount' => [ - 'description' => 'zookeeper配置，生成快照的频率', - 'type' => 'string', - 'example' => '100000', - ], - 'ConfigContentLimit' => [ - 'description' => '单个配置的配置内容大小上限（单位：KB）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'NacosRunningEnv' => [ - 'description' => 'nacos运行时配置。', - 'type' => 'object', - 'properties' => [ - 'emptyProtect' => [ - 'description' => '推空保护开关。', - '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' => 'zookeeper参数，是否开启TTL配置。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EurekaSupported' => [ - 'description' => '是否打开Eureka协议的访问端口8761。关闭此端口，应用将无法使用Eureka协议进行服务注册发现。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TLSEnabled' => [ - 'description' => 'MSE Nacos从2.1.2.1版本开始支持TLS传输链路加密，nacos-client需升级至2.2.1及以上版本，开启TLS后，会有10%左右性能下降，请合理评估系统容量水位，操作指引详见Nacos TLS传输加密.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ConsoleUIEnabled' => [ - 'description' => '是否开始Nacos开源控制台', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Enable4lw' => [ - 'description' => '是否开启四字命令', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AuthEnabled' => [ - 'title' => 'ZooKeeper sasl 强制身份认证开关', - 'description' => 'ZooKeeper sasl 强制身份认证开关', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PrometheusSdProtocolEnabled' => [ - 'type' => 'string', - ], - ], - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => ' '."\n" - .'返回结果码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'Message' => ['title' => '响应信息', 'description' => '返回信息。', 'type' => 'string', 'example' => 'Request succeeded.'], + 'Code' => ['title' => '响应码', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '成功标志', 'description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '删除服务的结果', 'description' => '删除结果。', 'type' => 'string', 'example' => 'ok'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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":"\\n 200\\n 9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\n 请求成功\\n 200\\n true\\n ok\\n","errorExample":""}]', + 'title' => '删除Nacos服务', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询集群配置', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetImage' => [ - 'summary' => '查询当前版本可升级的最大版本号。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteNamespace' => [ + 'summary' => '删除MSE命名空间。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '43433', - 'abilityTreeNodes' => [ - 'FEATUREmseLINUSD', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'VersionCode', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '集群版本', - 'description' => '当前集群所在的版本号。', - 'type' => 'string', - 'required' => true, - 'example' => 'ZooKeeper_3_5_5', - ], + 'schema' => ['title' => '操作的地域', 'description' => '操作的地域。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '要删除的MSE命名空间名称', 'description' => '要删除的MSE命名空间名称。', 'type' => 'string', 'required' => false, 'example' => 'prod', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型。'."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '25EA0A83-9007-4E87-808C-637BE1A****', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'CurrentVersionFullShowName' => [ - 'title' => '当前集群镜像版本的4位全名', - 'description' => '当前集群镜像版本的4位全名', - 'type' => 'string', - 'example' => '3.5.5.0', - ], - 'MaxVersionCode' => [ - 'title' => '可升级的增量版本Code', - 'description' => '可升级的增量版本Code', - 'type' => 'string', - 'example' => 'ZooKeeper_3_6_3', - ], - 'MaxVersionFullShowName' => [ - 'title' => '可升级的增量版本全名', - 'description' => '可升级的增量版本全名', - 'type' => 'string', - 'example' => '3.6.3.0', - ], - 'MaxVersionChangelogUrl' => [ - 'title' => '可升级的最大版本变更日志url', - 'description' => '可升级的最大版本变更日志url', - 'type' => 'string', - 'example' => 'https://xxxxx', - ], - ], - ], + 'HttpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '请求信息，错误排查用', 'description' => '请求信息，错误排查用。', 'type' => 'string', 'example' => 'The request is processed successfully.', 'default' => '请求处理成功'], + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'abcde-efg'], + 'Success' => ['title' => '是否成功', 'description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => 'NO_PERMISSION'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除MSE命名空间', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询本地单个镜像信息', ], - 'UpdateImage' => [ - 'summary' => '升级目标集群的版本号。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeletePluginConfig' => [ + 'summary' => '删除插件配置。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -14939,190 +9535,149 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '43431', - 'abilityTreeNodes' => [ - 'FEATUREmseLINUSD', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '217729', + 'abilityTreeNodes' => ['FEATUREmseKZMVG1'], ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '目标集群的id', - 'description' => '目标集群的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'mse-8e8e9060', - ], + 'schema' => ['title' => '网关唯一ID', 'description' => '网关唯一ID', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], ], [ - 'name' => 'VersionCode', + 'name' => 'PluginConfigId', 'in' => 'query', - 'schema' => [ - 'title' => '想修改的镜像版本code', - 'description' => '目标版本号。'."\n" - ."\n" - .'> 需调用GetImage接口获取可升级的版本号MaxVersionCode。', - 'type' => 'string', - 'required' => true, - 'example' => 'ZooKeeper_3_5_5', - ], + 'schema' => ['title' => '插件配置ID', 'description' => '插件配置ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '200'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3855D475-2B66-5CFF-9A51-3D698E52C472', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\"\\n}","type":"json"}]', + 'title' => '删除插件配置', + '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\\": \\"3855D475-2B66-5CFF-9A51-3D698E52C472\\",\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '更新集群镜像', ], - 'GetMseFeatureSwitch' => [ - 'summary' => '获取MSE能力开关。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteSecurityGroupRule' => [ + 'summary' => '删除网关安全组规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '目标ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '93'], + ], + [ + 'name' => 'CascadingDelete', + 'in' => 'query', + 'schema' => ['description' => '是否级联删除。', 'type' => 'boolean', 'required' => false], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6B4653A3-8D9C-5FDC-BB0C-936D40E9794B', - ], - 'Result' => [ - 'description' => '返回结果。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '43E50CB7-258E-5AFF-9B93-ECC19928C699'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '返回数据。', 'type' => 'object', - 'example' => '{\'nacos_config_encrypt\': False}', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'properties' => [ + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-uf6hgwe067prhg68agfa'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'PortRange' => ['description' => '目的端安全组开放的传输层协议相关的端口范围。取值范围： '."\n" + .' '."\n" + .'- TCP/UDP协议：取值范围为1~65535。使用斜线（/）隔开起始端口和终止端口。例如：1/200'."\n" + .'- ICMP协议：-1/-1'."\n" + .'- GRE协议：-1/-1'."\n" + .'- all：-1/-1', 'type' => 'string', 'example' => '8443/8443'], + 'IpProtocol' => ['description' => '传输层协议。不区分大小写。取值范围： '."\n" + .' '."\n" + .'- icmp'."\n" + .'- gre'."\n" + .'- tcp'."\n" + .'- udp'."\n" + .'- all：支持所有协议', 'type' => 'string', 'example' => 'tcp'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '103'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2022-01-11T14:12:55.000+0000'], + 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'auto-description1'], + ], ], ], ], @@ -15130,529 +9685,301 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除网关安全组规则', + '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' => '[{"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' => '获取MSE能力开关', ], - 'QueryBusinessLocations' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'common', - ], + 'DeleteServiceSource' => [ + 'summary' => '删除网关服务来源。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'abilityTreeCode' => '24910', + 'abilityTreeNodes' => ['FEATUREmseQRG9VI'], ], 'parameters' => [ + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['description' => '数据源ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '17'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-492af9b04bb4474cae9d645be850****'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '参数不合法', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '返回集合。', - 'type' => 'object', - 'properties' => [ - 'Ordering' => [ - 'description' => '订购。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'region', - ], - 'DistrictEnName' => [ - 'description' => '地域英语名称。', - 'type' => 'string', - 'example' => 'Asia Pacific', - ], - 'ShowName' => [ - 'description' => '显示名称。', - 'type' => 'string', - 'example' => '华东2（上海）', - ], - 'DistrictCnName' => [ - 'description' => '地域中文名称。', - 'type' => 'string', - 'example' => '亚太', - ], - 'EnName' => [ - 'description' => '英语名称。', - 'type' => 'string', - 'example' => 'China (Shanghai)', - ], - 'DistrictId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'asia-pacific', - ], - 'DistrictShowName' => [ - 'description' => '地域展示名称。', - 'type' => 'string', - 'example' => '亚太', - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => '华东 2', - ], - 'EnDescription' => [ - 'description' => '英语描述。', - 'type' => 'string', - 'example' => 'China East 2 (Shanghai)', - ], - 'CnName' => [ - 'description' => '中文名称。', - 'type' => 'string', - 'example' => '华东2（上海）', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'DistrictOrdering' => [ - 'description' => '地区订购。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '101', - ], - ], - ], - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2CEF593F-D60C-5449-9E98-15CA6ECD9189'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除网关服务来源', + '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' => '[{"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' => '查询地域信息', - 'summary' => '查询地域信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListClusterConnectionTypes' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteSwimmingLane' => [ + 'summary' => '用于删除全链路泳道。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '76158', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'LaneId', + 'in' => 'query', + 'schema' => ['description' => '泳道ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '229'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8625467C-27DD-5711-878E-6857E3074937', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%**s**。'."\n" - ."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则表示所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'ShowName' => [ - 'description' => '连接类型。', - 'type' => 'string', - 'example' => 'slb', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除全链路泳道', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询集群连接信息', - 'summary' => '查询支持的集群连接类型。', ], - 'QuerySlbSpec' => [ - 'summary' => '查询SLB类型。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'DeleteSwimmingLaneGroup' => [ + 'summary' => '用于删除全链路泳道组。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => '全链路泳道组ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '145'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'example-app'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'array', - 'items' => [ - 'description' => '返回集合信息。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '返回数据ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Spec' => [ - 'description' => '规格。', - 'type' => 'string', - 'example' => 'slb.s2.small', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => '标准型I', - ], - 'MaxConnection' => [ - 'description' => '最大连接数。', - 'type' => 'string', - 'example' => '50,000', - ], - 'NewConnectionPerSecond' => [ - 'description' => '每秒连接数。', - 'type' => 'string', - 'example' => '50,000', - ], - 'Qps' => [ - 'description' => '每秒查询率。', - 'type' => 'string', - 'example' => '50,000', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Data' => ['description' => '数据概览。', 'type' => 'any', 'example' => '{}'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '删除全链路泳道组', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:DeleteSwimmingLaneGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询SLB类型', ], - 'UpdateClusterSpec' => [ - 'summary' => '更新注册配置中心集群节点数或规格（支持按量付费和包年包月）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'DeleteWebFlowRules' => [ + 'summary' => '删除热点参数防护规则（HTTP 请求）。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -15661,367 +9988,290 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'chargeType' => 'paid', + 'operationType' => 'delete', + 'abilityTreeCode' => '164288', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '网关名称', - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => 'MSE命名空间名。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ - 'name' => 'InstanceId', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'title' => '节点规格', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => '待删除的规则ID列表。', 'type' => 'string', 'required' => true, 'example' => '[1, 2, 3]'], ], [ - 'name' => 'InstanceCount', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '节点数量', - 'description' => '目标节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'ClusterSpecification', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '目标引擎规格。', - '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', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '354FF159-E9FB-5FBA-BDD5-E99EE440A88D'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => ['description' => '完成删除的规则Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '[1, 2, 3]'], + ], ], - 'example' => 'MSE_SC_2_4_200_c', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'MseVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'MSE版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro'."\n", + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除热点参数防护（HTTP）规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteWebFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteZnode' => [ + 'summary' => '释放Zookeeper数据节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'PubNetworkFlow', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17014', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '公网带宽', - 'description' => '公网带宽', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'AutoPay', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '是否下单之后自动支付，如果此值为false，此接口将会返回订单支付url，可手动确认支付', - 'description' => '是否下单之后自动支付，如果此值为false，此接口将会返回订单支付url，可手动确认支付', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-09k1q11****'], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => ['description' => '节点路径。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/zookeeper'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], 'Data' => [ - 'title' => '如果AutoPay设置为false，则此值为订单支付的URL', - 'description' => '保留字段。', - 'type' => 'string', - 'example' => 'null', - ], - 'ErrorCode' => [ - 'description' => '错误码。取值说明如下：'."\n" - ."\n" - .'- 请求成功：不返回**ErrorCode**字段。'."\n" - .'- 请求失败：返回**ErrorCode**字段。具体信息，请参见本文的**错误码**目录。', - 'type' => 'string', - 'example' => 'mse-100-000', + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '节点数据列表。', 'type' => 'string', 'example' => 'cluster'], + 'Path' => ['description' => '节点路径。', 'type' => 'string', 'example' => '/'], + 'Dir' => ['description' => '节点列表信息，取值如下：'."\n" + .'- `true`：信息返回成功。'."\n" + .'- `false`：信息返回失败。', 'type' => 'boolean', 'example' => 'true'], + 'Name' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1'], + ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper 操作超时，可能由于当前操作的Znode数据过大，子节点过多，Server处理请求时间消耗过长，或者集群当前正在选主，无法处理请求。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => '当前操作的节点不存在，可能已经被删除。'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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":"\\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' => '删除ZooKeeper数据节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '更新集群规格', - 'description' => '更新注册配置中心集群节点数或规格（支持按量付费和包年包月，增加节点或升级规格会产生相应资费，具体详情，请参见[价格说明]（[`~~1806469~~`]））。', ], - 'RestartCluster' => [ - 'summary' => '重启注册配置中心集群。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'EnableHttp2' => [ + 'summary' => '服务端与客户端协商时是否使用http2（修改后1～2分钟后生效）', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '17093', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], + 'abilityTreeCode' => '142072', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-78v1l83****', - ], - ], - [ - 'name' => 'ClusterId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****'], ], [ - 'name' => 'PodNameList', + 'name' => 'EnableHttp2', 'in' => 'query', - 'schema' => [ - 'description' => 'PodName，支持多个podName传入，多个用英文"," 分隔；'."\n" - .'如："mse-a8aba010-1629719288255-reg-center-0-1,mse-a8aba010-1629719288255-reg-center-0-2"'."\n" - ."\n" - .'传入的Pod必须属于当前集群，与instanceId绑定，否则重启异常'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mse-a8aba010-1629719288255-reg-center-0-1', - ], + 'schema' => ['description' => '服务端与客户端协商时是否使用http2。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '是否开启成功。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '开启HTTP 2', + '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' => '[{"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' => '重启集群', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'RetryCluster' => [ - 'summary' => '创建超时时，调用RetryCluster接口重试集群。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'EnableProxyProtocol' => [ + 'summary' => '开启Proxy协议。如果网关入口流量使用NLB接入，如果不开启则无法获取客户端的真实IP，开启后对于非Proxy协议请求没有影响。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -16029,183 +10279,158 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17094', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '网关唯一ID', 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491*****'], ], [ - 'name' => 'InstanceId', + 'name' => 'EnableProxyProtocol', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => '是否使用ProxyProtocol方式开启保持客户端源IP功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源IP功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的 **%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '是否操作成功。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '开启Proxy协议', + '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '重试集群', ], - 'UpgradeCluster' => [ - 'summary' => '升级集群版本。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ExportNacosConfig' => [ + 'summary' => '导出指定的Nacos配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76155', + 'abilityTreeNodes' => ['FEATUREmse8153EN'], + ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-2r42ddc****'], ], [ - 'name' => 'InstanceId', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-nif1w51wi0c', - ], + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'example' => 'ae77c258-4d4f-478f-baaa-084aee0****'], ], [ - 'name' => 'UpgradeVersion', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => '升级目标版本', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1.2.1', - ], + 'schema' => ['description' => '配置项主键ID。'."\n" + ."\n" + .'>'."\n" + .'- 支持多种导出方式。当选择导出多个配置时，此参数必填。'."\n" + .'- 此参数可通过ListNacosConfigs接口获取。'."\n" + .'- 当配置此参数时，表示选择导出多个配置，DataId和Group参数无效。'."\n" + .'>'."\n" + ."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '1709,1710'], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => ['description' => '待导出的数据ID。'."\n" + ."\n" + .''."\n" + ."\n" + .'- 支持多种导出方式。'."\n" + .'- 当选择导出单个配置时，参数Ids必须为空，DataID以及Group必填。>', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => 'demo-develop'], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => '配置组名称。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'COMMON_GROUP'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => '应用标签。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'gateway-openapi'], + ], + [ + 'name' => 'DataIds', + 'in' => 'query', + 'schema' => ['description' => '需要导出的数据的 dataId+groupName， 多个配置使用 "," 分隔', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDataId1+testGroup1,testDataId2+testGroup'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -16214,35 +10439,22 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'HttpCode' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => '202', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8D855418-177B-5FF8-A021-75B930AD890A', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '92245803-49B7-54CF-8D49-01A34A0E1CD6'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的 **%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => '导出配置的下载地址。', 'type' => 'string', 'example' => 'http://xxxxxxxxx'], + ], ], ], ], @@ -16250,373 +10462,266 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '导出Nacos配置', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + '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 \\"Message\\": \\"请求处理成功\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"8D855418-177B-5FF8-A021-75B930AD890A\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '升级集群', ], - 'CreateEngineNamespace' => [ - 'summary' => '创建一个Nacos命名空间。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'ExportZookeeperData' => [ + 'summary' => '发起导出zookeeper数据任务。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '17003', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '161337', + 'abilityTreeNodes' => ['FEATUREmseBQYNCQ'], ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-98s****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-78v1l83****'], ], [ - 'name' => 'Name', + 'name' => 'ExportType', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间展示名字。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dev', - ], + 'schema' => ['description' => '导出类型，取值：'."\n" + ."\n" + .'- transactionLog 事务日志'."\n" + .'- snapshot 快照文件', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'snapshot'], ], [ - 'name' => 'Desc', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间描述。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '开发环境', - ], + 'schema' => ['description' => '集群所在地域，MSE支持的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InstanceId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-cn-st21ri2****', - ], - ], - [ - 'name' => 'ServiceCount', - 'in' => 'query', - 'schema' => [ - 'description' => '当前命名空间下运行的最大服务数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间自定义ID，如果填写，将返回填写的namespaceId， 如果不填写，则自动生成，但是返回中将不包含namespaceId。', - 'type' => 'string', - 'required' => false, - 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'BaseResult', + 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F6092602-C357-4750-89D9-E572FBEA****', - ], - 'ClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'mse-892k****', - ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '25EA0A83-9007-4E87-808C-637BE1A****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'string', 'example' => '200'], 'Data' => [ 'description' => '数据概览。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '命名空间类型，取值如下：'."\n" - .'- `0`：全局配置'."\n" - .'- `1`：默认命名空间'."\n" - .'- `2`：自定义命名空间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NamespaceShowName' => [ - 'description' => '命名空间展示名称。', - 'type' => 'string', - 'example' => 'dev', - ], - 'Quota' => [ - 'description' => '配额。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Namespace' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2', - ], - 'NamespaceDesc' => [ - 'description' => '命名空间描述。', - 'type' => 'string', - 'example' => 'mytest', - ], - 'ConfigCount' => [ - 'description' => '配置数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServiceCount' => [ - 'description' => '活跃服务数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + 'ExportType' => ['description' => '导出类型，取值：'."\n" + ."\n" + .'- transactionLog 事务日志'."\n" + .'- snapshot 快照文件', 'type' => 'string', 'example' => 'snapshot'], + 'ContentMap' => ['description' => '任务内容。', 'type' => 'object'], + 'Extend' => ['description' => '扩展信息。', 'type' => 'string', 'example' => '{}'], + 'Status' => ['description' => '任务状态，取值：'."\n" + .'- CREATE 创建中'."\n" + .' - RUNNING 执行中'."\n" + .' - FINISH 已完成'."\n" + .' - FAILED 失败'."\n" + .' - EXPIRE 已过期', 'type' => 'string', 'example' => 'FINISH'], + 'KubeoneTaskIds' => ['description' => '关联的底层taskId，仅作为失败时的排查使用。', 'type' => 'string', 'example' => '10'], + 'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631001140913'], + 'UpdateTime' => ['description' => '最后更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1632979237663'], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => 'zookeeper发起导出数据任务', + 'description' => '同时只有一个任务在运行中。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ExportZookeeperData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '创建引擎命名空间', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteEngineNamespace' => [ - 'summary' => '删除Nacos命名空间。', - 'methods' => [ - 'post', - 'get', - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'FetchLosslessRuleList' => [ + 'summary' => '获取无损上下线规则列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17010', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '678ca857-****-b1bf-d0a98c5ca84b', - ], + 'schema' => ['title' => 'region id, such as cn-hangzhou', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'InstanceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-7pp2d1****', - ], + 'schema' => ['title' => 'Key word of search lossless list', 'description' => '应用名。', 'type' => 'string', 'required' => false, 'example' => 'spring-boot-sample'], ], [ - 'name' => 'ClusterId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-0c738****', - ], + 'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => 'appId', 'description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hyaziyb6sc@86827c61f5ed***'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => 'current', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => 'limit', 'description' => '每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + .'* zh：中文。'."\n" + .'* en：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => '返回值。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'Message' => [ - 'description' => '响应描述。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '56D9E600-6348-4260-B35F-583413F****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页面大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalSize' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '36'], + 'Results' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['title' => 'appName', 'description' => '应用名称。', 'type' => 'string', 'example' => 'echo-demo'], + 'AppId' => ['title' => 'appId', 'description' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@24810bf4364a***'], + 'Count' => ['title' => 'instance\'s count of app', 'description' => '实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'Enable' => ['title' => 'rule is open or close', 'description' => '无损上线启用状态。取值：'."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：禁用。', 'type' => 'boolean', 'example' => 'true'], + 'WarmupTime' => ['description' => '预热时长（秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'DelayTime' => ['description' => '延迟注册时间（秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'FuncType' => ['title' => 'warmup function type, 2 means f(x)=x^2', 'description' => '预热曲线斜率。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Aligned' => ['title' => 'microservices lifecycle aligns to k8s\'s or NOT', 'description' => '是否开启“通过就绪检查前完成服务注册”。', 'type' => 'boolean', 'example' => 'true'], + 'Related' => ['title' => 'K8s\'s HPA is related to warmup or NOT', 'description' => '是否开启“通过就绪检查前完成服务预热”。', 'type' => 'boolean', 'example' => 'false'], + 'LossLessDetail' => ['title' => 'show lossLess offline&online detail', 'description' => '是否开启上下线处理明细。', 'type' => 'boolean', 'example' => 'false'], + 'Notice' => ['title' => 'enable lossLess offline active notification', 'description' => '是否开启主动通知。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], ], ], ], @@ -16624,267 +10729,209 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取无损上下线规则列表', + 'description' => '调用FetchLosslessRuleList接口来获取无损上下线的配置规则列表。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:FetchLosslessRuleList', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除引擎命名空间', ], - 'UpdateEngineNamespace' => [ - 'summary' => '更新引擎命名空间。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GatewayBlackWhiteList' => [ + 'summary' => '获取网关黑白名单列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17100', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'name', - ], + 'schema' => ['description' => '当前页数。取值范围：大于0的整数。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0'], ], [ - 'name' => 'Desc', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'public', - ], + 'schema' => ['description' => '每页显示条数。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0'], ], [ - 'name' => 'ServiceCount', + 'name' => 'FilterParams', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '活跃服务数。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => 'parse from filterParams', + 'description' => 'parse from filterParams', + 'type' => 'object', + 'properties' => [ + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '81'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID（和GatewayId同时存在时优先使用GatewayId）。', 'type' => 'string', 'required' => false, 'example' => 'gw-5017305290e14centbrveca****'], + 'ResourceType' => ['description' => '暂未开放使用。', 'type' => 'string', 'required' => false, 'example' => '""'], + 'Type' => ['description' => '暂未开放使用。', 'type' => 'string', 'required' => false, 'example' => ' ""'], + 'IsWhite' => ['description' => '暂未开放使用。', 'type' => 'boolean', 'required' => false, 'example' => ' ""'], + 'SearchType' => ['description' => '查询类型：'."\n" + ."\n" + .'- ROUTE：按路由搜索，SearchContent填写路由名'."\n" + ."\n" + .'- DOMAIN：按域名搜索，SearchContent填写域名'."\n" + ."\n" + .'- IP：按指定IP搜索，SearchContent填写IP', 'type' => 'string', 'required' => false, 'example' => 'IP'], + 'SearchContent' => ['description' => '搜索内容。', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1'], + ], 'required' => false, - 'docRequired' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****', ], ], [ - 'name' => 'ClusterId', + 'name' => 'OrderItem', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => '暂未开放使用。', 'type' => 'string', 'required' => false, 'example' => '""'], ], [ - 'name' => 'InstanceId', + 'name' => 'DescSort', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['description' => '暂未开放使用。', 'type' => 'boolean', 'required' => false, 'example' => '""', 'default' => 'false'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', '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' => '数据概览。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '命名空间类型，取值如下：'."\n" - .'- `0`：全局配置'."\n" - .'- `1`：默认命名空间'."\n" - .'- `2`：自定义命名空间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NamespaceShowName' => [ - 'description' => '命名空间描述名称。', - 'type' => 'string', - 'example' => 'mytestshowname', - ], - 'Quota' => [ - 'description' => '配额。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'public', - ], - 'NamespaceDesc' => [ - 'description' => '命名空间描述。', - 'type' => 'string', - 'example' => 'mytest', - ], - 'ConfigCount' => [ - 'description' => '配额数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + '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' => '1'], + 'Result' => [ + 'description' => '返回集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '黑白名单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '549'], + 'ResourceId' => ['description' => '资源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '549'], + 'ResourceType' => ['description' => '生效粒度：'."\n" + .'- GATEWAY：网关全局'."\n" + .'- DOMAIN：域名'."\n" + .'- ROUTE：路由', 'type' => 'string', 'example' => 'GATEWAY'], + 'Content' => ['description' => '黑名单内容。', 'type' => 'string', 'example' => '1.1.1.1'], + 'IsWhite' => ['description' => '是否白名单。', 'type' => 'boolean', 'example' => 'true'], + 'Type' => ['description' => '黑白名单类型，当前固定为IP黑白名单。', 'type' => 'string', 'example' => 'IP'], + 'Status' => ['description' => '黑白名单状态。'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off：关闭', 'type' => 'string', 'example' => 'on'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '81'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-08-02T02:43:40.000+0000'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2024-08-02T02:43:40.000+0000'], + 'ResourceIdJsonList' => ['description' => '资源ID列表JSON。'."\n" + ."\n" + .'- 若ResourceType为ROUTE，则为路由ID列表'."\n" + ."\n" + .'- 若ResourceType为DOMAIN，则为域名ID列表', 'type' => 'string', 'example' => '[234]'], + 'Note' => ['description' => '备注。', 'type' => 'string', 'example' => 'Blocked IP list'], + 'ResourceIdNameJson' => ['description' => '资源名称描述。', 'type' => 'string', 'example' => '{}'], + 'Name' => ['description' => '黑名单名称。', 'type' => 'string', 'example' => 'test'], + ], + 'description' => '', + ], ], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取网关黑白名单列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GatewayBlackWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '更新引擎命名空间', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetEngineNamepace' => [ - 'summary' => '查询Nacos命名空间列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetAppMessageQueueRoute' => [ + 'summary' => '获取应用消息灰度相关的信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -16892,59 +10939,40 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17029', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '目标ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0e958d79-****-b282-b702d66362b5', - ], + 'schema' => ['description' => '集群所在地域，包括但不限于如下地域：'."\n" + .'- `cn-hangzhou`：杭州'."\n" + .'- `cn-beijing`：北京'."\n" + .'- `cn-shanghai`：上海'."\n" + .'- `cn-zhangjiakou`：张家口'."\n" + .'- `cn-shenzhen`：深圳', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InstanceId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse.cn-hangzhou.aliyuncs.com', - ], + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => 'hkhon1po62@c3df23522baa898'], ], [ - 'name' => 'ClusterId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-98s****', - ], + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -16953,446 +10981,353 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'http状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'Type' => [ - 'description' => '命名空间类型，取值如下：'."\n" - ."\n" - .'- 0：全局配置 '."\n" - .'- 1：默认命名空间 '."\n" - .'- 2：自定义命名空间', - 'type' => 'string', - 'example' => '1', - ], - 'Quota' => [ - 'description' => '配额。', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FA8F966F-420C-52F5-B49E-6ED7CCE02697', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'ConfigCount' => [ - 'description' => '配置数量。', - 'type' => 'string', - 'example' => '1', - ], - 'NamespaceShowName' => [ - 'description' => '命名空间展示名称。', - 'type' => 'string', - 'example' => 'public', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NamespaceDesc' => [ - 'description' => '命名空间描述。', - 'type' => 'string', - 'example' => 'mytest', - ], - 'Namespace' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'example' => 'public', + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4B00BCB0-105F-5A2A-B75B-641C8E9B18FC'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'success'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@54e1f42f37cd65a'], + 'Region' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Enable' => ['description' => '开启或关闭。'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', 'type' => 'boolean', 'example' => 'true'], + 'Tags' => [ + 'description' => '此应用的未打标环境，不会消费的标签。', + 'type' => 'array', + 'items' => ['description' => '此应用的未打标环境，不会消费的标签', 'type' => 'string', 'example' => 'gray'], + ], + 'FilterSide' => [ + 'description' => '消息灰度过滤侧。', + 'type' => 'string', + 'example' => 'Server', + 'default' => 'Server', + 'enum' => ['Server', 'Client'], + ], + ], ], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：true：请求成功。 false：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '获取应用消息灰度信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetAppMessageQueueRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询引擎命名空间', ], - 'ListEngineNamespaces' => [ - 'summary' => '查询Nacos命名空间列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetApplicationInstanceList' => [ + 'summary' => '查询微服务应用实例列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '17066', - 'abilityTreeNodes' => [ - 'FEATUREmseL2AGED', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '17021', + 'abilityTreeNodes' => ['FEATUREmseZB84VG'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-cn-st21ri2****', - ], + 'schema' => ['title' => '应用所属的MSE命名空间。', 'description' => '应用所属的MSE命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['title' => '应用名字。', 'description' => '应用名字。', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 100], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '应用Id。', 'description' => '应用Id。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => true, 'example' => 'abcde@12345'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => ['title' => '节点标签。', 'description' => '节点标签。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gray'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '第几页。从1开始。', 'description' => '第几页。从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页大小。', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', 'default' => '10'], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['title' => '所在地域。', 'description' => '所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], - 'TotalCount' => [ - 'description' => '实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '062D13C5-DEA3-4921-8918-C49A0F1B****', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'PageSize' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '命名空间类型，取值如下：'."\n" - .'- `0`：全局配置'."\n" - .'- `1`：默认命名空间'."\n" - .'- `2`：自定义命名空间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'NamespaceShowName' => [ - 'description' => '命名空间名称。', - 'type' => 'string', - 'example' => 'public', - ], - 'Quota' => [ - 'description' => '配额。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'NamespaceDesc' => [ - 'description' => '命名空间描述。', - 'type' => 'string', - 'example' => 'mytest', - ], - 'ConfigCount' => [ - 'description' => '配额数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServiceCount' => [ - 'description' => '活跃服务数。', - 'type' => 'string', - 'example' => '3', - ], - 'SourceType' => [ - 'description' => '创建此空间的来源。', - 'type' => 'string', - 'example' => 'mse', + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '节点列表。', + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'title' => '微服务治理节点列表。', + 'description' => '微服务治理节点列表。', + 'type' => 'object', + 'properties' => [ + 'Ip' => ['title' => '节点ip。', 'description' => '节点ip。', 'type' => 'string', 'example' => '10.1.2.3'], + 'Tags' => [ + 'title' => '节点标签。', + 'description' => '节点标签。', + 'type' => 'array', + 'items' => [ + 'title' => '节点标签结构。', + 'description' => '节点标签结构。', + 'type' => 'object', + 'properties' => [ + 'Tag' => ['title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'gray'], + ], + ], + ], + 'Port' => ['title' => '应用端口。', 'description' => '应用端口。', 'type' => 'string', 'example' => '8080'], + ], ], ], + 'TotalSize' => ['title' => '总共有多少个节点。', 'description' => '总共有多少个节点。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'PageNumber' => ['title' => '第几页，从1开始。', 'description' => '第几页，从1开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '每页多少个。', 'description' => '每页多少个。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '获取应用实例信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetApplicationInstanceList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '查询引擎命名空间列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ImportZookeeperData' => [ - 'summary' => '发起Zookeeper数据导入任务，使Zookeeper集群开始导入目标URL内的数据。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetApplicationList' => [ + 'summary' => '通过GetApplicationList接口获取应用列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '146919', - 'abilityTreeNodes' => [ - 'FEATUREmseBQYNCQ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17022', + 'abilityTreeNodes' => ['FEATUREmseHJJ9Z1'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-u0t2xzvxa06', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'FileUrl', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '源数据链接。'."\n" - .'> 需要使用通过GetZookeeperDataImportUrl接口生成的URL', - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxxxxxxxxx', - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rest-container'], ], [ - 'name' => 'FileName', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '需导入的文件名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'snapshot.5', - ], + 'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'hkhon1po62@c3df23522b*****'], ], [ - 'name' => 'RegionId', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '固定值，默认使用这个值。', 'type' => 'string', 'required' => false, 'example' => 'edasmsc'], ], [ - 'name' => 'RequestPars', + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => '语言，如 Java、Go。', 'type' => 'string', 'required' => false, 'example' => 'Java'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '第几页。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每一页显示多少条数据。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'SwitchEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '是否开始Switch。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'SentinelEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '是否开启Sentinel。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '应用所属的微服务命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64, 'default' => 'default'], + ], + [ + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', + 'description' => '阿里云标签，支持按照阿里云标签进行筛选。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '用户输入的自定义标签键。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'tagKey'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'tagValue'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '{}', + 'maxItems' => 20, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '202', - ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'F55E608F-7C15-****-9CFD-DF832EBC4A0F'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'any', - 'example' => 'null', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '返回集合。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ExtraInfo' => ['description' => '其他信息。', 'type' => 'string', 'example' => '{}'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'finance'], + 'AppId' => ['description' => '应用id。', 'type' => 'string', 'example' => 'hkhon1po62@5f1b08becb*****'], + 'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '1234567890'], + 'InstancesNumber' => ['description' => '实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Source' => ['description' => '应用来源。', 'type' => 'string', 'example' => 'edasmsc'], + 'Language' => ['description' => '应用的编程语言。', 'type' => 'string', 'example' => 'JAVA'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Namespace' => ['title' => '应用所属的MSE命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'example' => 'default'], + 'Tags' => ['description' => '阿里云标签。', 'type' => 'object', 'example' => '{"tagKey1":"tagValue1","tagKey2":"tagValue2"}'], + ], + ], + ], + 'TotalSize' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'PageNumber' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页面大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], ], ], ], @@ -17400,170 +11335,114 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '获取应用列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetApplicationList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '发起Zookeeper数据导入', - 'description' => '>此操作会清空原有数据，请谨慎操作>', ], - 'GetZookeeperDataImportUrl' => [ - 'summary' => '获取上传数据文件的URL，用户能通过此URL上传Zookeeper待导入的数据文件。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - 'wss', - ], - 'tags' => [ - 'cluster', - ], + 'GetBlackWhiteList' => [ + 'summary' => '查询网关黑白名单。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '146920', - 'abilityTreeNodes' => [ - 'FEATUREmseBQYNCQ', - ], + 'abilityTreeCode' => '36934', + 'abilityTreeNodes' => ['FEATUREmseWSG2U5'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-zvp2xzzkk06', - ], + 'schema' => ['description' => '范围类型。', 'type' => 'string', 'required' => false, 'example' => 'GATEWAY'], ], [ - 'name' => 'ContentType', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '文件类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'zip', - ], + 'schema' => ['description' => '类型。', 'type' => 'string', 'required' => false, 'example' => 'IP'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'example' => 'gw-32d5c9769c1842b1a2cc3426c59e****'], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => ['description' => '是否白名单。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E4E2058F-C524-5C29-9BC7-5874EA8D7CE2', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'Code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '89CBC928-4F57-51FA-A413-EE0F4CD87200'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation. '], + 'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '返回数据。', + 'description' => '节点数据。', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => '文件上传地址。', - 'type' => 'string', - 'example' => 'http://xxxxxxxxx', - ], - 'MaxSize' => [ - 'description' => '允许上传文件的最大大小（单位MB）。', - 'type' => 'string', - 'example' => '250000', - ], + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '275'], + 'ResourceId' => ['description' => '资源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ResourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'GATEWAY'], + 'Content' => ['description' => '黑名单内容。', 'type' => 'string', 'example' => 'text'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'IP'], + 'IsWhite' => ['description' => '是否为白名单。', 'type' => 'boolean', 'example' => 'true'], + 'Status' => ['description' => '黑白名单状态。', 'type' => 'string', 'example' => 'on'], + 'GatewayId' => ['description' => '网关id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], ], ], ], @@ -17572,280 +11451,145 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": \\"请求处理成功\\",\\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' => '获取Zookeeper数据导入URL', - ], - 'ExportZookeeperData' => [ - 'summary' => '发起导出zookeeper数据任务。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', + 'staticInfo' => [ + 'substitutions' => ['mse::2019-05-31::GatewayBlackWhiteList'], ], - 'security' => [ + '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' => '查询网关黑白名单', + 'changeSet' => [], + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetBlackWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + ], + ], + 'GetEngineNamepace' => [ + 'summary' => '查询Nacos命名空间列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '161337', - 'abilityTreeNodes' => [ - 'FEATUREmseBQYNCQ', - ], + 'abilityTreeCode' => '17029', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-cn-78v1l83****', - ], - ], - [ - 'name' => 'ExportType', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '导出类型，取值：'."\n" - ."\n" - .'- transactionLog 事务日志'."\n" - .'- snapshot 快照文件', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'snapshot', - ], + 'schema' => ['description' => '目标ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0e958d79-****-b282-b702d66362b5'], ], [ - 'name' => 'RegionId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，MSE支持的地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse.cn-hangzhou.aliyuncs.com'], ], [ - 'name' => 'RequestPars', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-98s****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '25EA0A83-9007-4E87-808C-637BE1A****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'ExportType' => [ - 'description' => '导出类型，取值：'."\n" - ."\n" - .'- transactionLog 事务日志'."\n" - .'- snapshot 快照文件', - 'type' => 'string', - 'example' => 'snapshot', - ], - 'ContentMap' => [ - 'description' => '任务内容。', - 'type' => 'object', - ], - 'Extend' => [ - 'description' => '扩展信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'Status' => [ - 'description' => '任务状态，取值：'."\n" - .'- CREATE 创建中'."\n" - .' - RUNNING 执行中'."\n" - .' - FINISH 已完成'."\n" - .' - FAILED 失败'."\n" - .' - EXPIRE 已过期', - 'type' => 'string', - 'example' => 'FINISH', - ], - 'KubeoneTaskIds' => [ - 'description' => '关联的底层taskId，仅作为失败时的排查使用。', - 'type' => 'string', - 'example' => '10', - ], - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631001140913', - ], - 'UpdateTime' => [ - 'description' => '最后更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632979237663', - ], - ], - ], + 'HttpCode' => ['description' => 'http状态码。', 'type' => 'string', 'example' => '202'], + 'Type' => ['description' => '命名空间类型，取值如下：'."\n" + ."\n" + .'- 0：全局配置 '."\n" + .'- 1：默认命名空间 '."\n" + .'- 2：自定义命名空间', 'type' => 'string', 'example' => '1'], + 'Quota' => ['description' => '配额。', 'type' => 'string', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FA8F966F-420C-52F5-B49E-6ED7CCE02697'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'ConfigCount' => ['description' => '配置数量。', 'type' => 'string', 'example' => '1'], + 'NamespaceShowName' => ['description' => '命名空间展示名称。', 'type' => 'string', 'example' => 'public'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'NamespaceDesc' => ['description' => '命名空间描述。', 'type' => 'string', 'example' => 'mytest'], + 'Namespace' => ['description' => '命名空间ID。', 'type' => 'string', 'example' => 'public'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询引擎命名空间', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetEngineNamepace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => 'zookeeper发起导出数据任务', - 'description' => '同时只有一个任务在运行中。', ], - 'ListExportZookeeperData' => [ - 'summary' => '列出Zookeeper的历史数据导出任务列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetGateway' => [ + 'summary' => '获取网关的所属VPC，所属交换机等基本信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -17854,160 +11598,118 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'abilityTreeCode' => '92862', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-7pp2d1****', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '5', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-685f661467b54f48b7b7a76605ce****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult>', - 'description' => 'BaseResult>', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '请求是否成功的描述信息', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'ExportType' => [ - 'description' => '导出类型，取值：'."\n" - ."\n" - .'- transactionLog 事务日志'."\n" - .'- snapshot 快照文件', - 'type' => 'string', - 'example' => 'snapshot', - ], - 'ContentMap' => [ - 'description' => '任务详情。', - 'type' => 'string', - 'example' => '{}', - ], - 'Extend' => [ - 'description' => '其他扩展信息，JSON结构，方便后续扩展参数。', - 'type' => 'string', - 'example' => '{}', - ], - 'Status' => [ - 'description' => '任务状态，取值：'."\n" - .'- CREATE 创建中'."\n" - .' - RUNNING 执行中'."\n" - .' - FINISH 已完成'."\n" - .' - FAILED 失败'."\n" - .' - EXPIRE 已过期', - 'type' => 'string', - 'example' => 'FINISH', - ], - 'KubeoneTaskIds' => [ - 'description' => '关联的底层taskId，仅作为失败时的排查使用。', - 'type' => 'string', - 'example' => '10', - ], - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'description' => '网关信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'Name' => ['description' => '网关名称。', 'type' => 'string', 'example' => 'DEFAULT'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****'], + 'Region' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'PrimaryUser' => ['description' => '创建主用户User ID。', 'type' => 'string', 'example' => '1231254'], + 'Status' => ['description' => '获取数据集成同步任务的结果状态。取值如下：'."\n" + .'* 0: 创建中'."\n" + .'* 1: 创建失败'."\n" + .'* 2: 运行中'."\n" + .'* 3: 变更中'."\n" + .'* 4: 缩容中'."\n" + .'* 6: 扩容中'."\n" + .'* 8: 删除中'."\n" + .'* 10: 重启中'."\n" + .'* 11: 重建中'."\n" + .'* 12: 升级中'."\n" + .'* 13: 升级失败', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Vpc' => ['description' => 'VPC网络ID。', 'type' => 'string', 'example' => 'vpc-bp1328cm01m6uel42b5zb'], + 'Vswitch' => ['description' => '交换机。', 'type' => 'string', 'example' => 'vsw-bp18zeqxx6mpuq843z4n5'], + 'SecurityGroup' => ['description' => '安全组。', 'type' => 'string', 'example' => 'sg-bp11ufzqn6mmb8dtzz82'], + 'Spec' => ['description' => '网关规格。', 'type' => 'string', 'example' => 'MSE_GTW_16_32_200_c'], + 'Replica' => ['description' => '网关副本数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GmtCreate' => ['description' => '网关设备的创建时间，GMT格式，是用户所在地的当地时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '最后一次更新实例的时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'XtraceDetails' => [ + 'description' => 'XTrace详情。', + 'type' => 'object', + 'properties' => [ + 'Sample' => ['description' => 'XTrace采样率。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TraceOn' => ['description' => '是否开启XTrace采样。', 'type' => 'boolean', 'example' => 'true'], ], - 'CreateTime' => [ - 'description' => '任务创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631001140913', + ], + 'Vswitch2' => ['description' => '交换机2。', 'type' => 'string', 'example' => 'vpc-bp1j6ivhav15ve7q54kq2'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + 'ChargeType' => ['description' => '付费模式，包括包年包月和按量付费。', 'type' => 'string', 'example' => 'POSTPAY'], + 'EndDate' => ['description' => '网关结束时间。', 'type' => 'string', 'example' => '2021-08-01 00:00:00'], + 'StatusDesc' => ['description' => '状态描述。', 'type' => 'string', 'example' => 'Restarting'], + 'LogConfigDetails' => [ + 'description' => '日志配置。', + 'type' => 'object', + 'properties' => [ + 'LogEnabled' => ['description' => '是否开启日志投递', 'type' => 'boolean', 'example' => 'true'], + 'ProjectName' => ['description' => '项目名称。', 'type' => 'string', 'example' => 'k8s-log-c173117256e934a96b7fefdf2ef8a8057'], + 'LogStoreName' => ['description' => 'logstore名称。', 'type' => 'string', 'example' => 'mse_access_log'], ], - 'UpdateTime' => [ - 'description' => '更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632979237663', + ], + 'MseTag' => ['description' => '资源标签。', 'type' => 'string', 'example' => '{"TagKey":"TagValue"}'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfm34x43l*****'], + 'TotalReplica' => ['description' => '总副本数（包括自动扩容副本数）。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'Elastic' => ['description' => '是否开启自动扩容。', 'type' => 'boolean', 'example' => 'true'], + 'ElasticReplica' => ['description' => '自动扩容副本数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ElasticType' => ['description' => '自动扩容类型，目前支持：'."\n" + ."\n" + .'* CronHPA：按时间扩容', 'type' => 'string', 'example' => 'CronHPA'], + 'ElasticPolicy' => [ + 'description' => '自动扩容策略。', + 'type' => 'object', + 'properties' => [ + 'MaxReplica' => ['description' => '自动扩容最大实例数（水平扩容时使用）。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'ElasticType' => ['description' => '自动扩容类型，目前支持：'."\n" + ."\n" + .'- CronHPA：按时间扩容', 'type' => 'string', 'example' => 'CronHPA'], + 'TimePolicyList' => [ + 'description' => '按时间扩容策略。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DesiredReplica' => ['description' => '期望副本数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'StartTime' => ['description' => '自动扩容起始时间。', 'type' => 'string', 'example' => '16:00'], + 'EndTime' => ['description' => '自动扩容结束时间。', 'type' => 'string', 'example' => '18:00'], + ], + 'description' => '', + ], + ], ], ], ], @@ -18018,536 +11720,630 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关信息', + '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 \\"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' => 'Zookeeper导出任务列表', ], - 'CreateZnode' => [ - 'summary' => '创建Zookeeper数据节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetGatewayAuthConsumerDetail' => [ + 'summary' => '获取网关鉴权消费者细节。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], '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' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], - ], - [ - 'name' => 'Path', - 'in' => 'query', - 'schema' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-1a4ab101d5924b6f92c5ec98a84*****'], ], [ - 'name' => 'Data', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '节点数据。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'data', - ], + 'schema' => ['description' => '鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '120'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'description' => '数据概览。', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '节点数据。', - 'type' => 'string', - 'example' => 'cluster', - ], - 'Path' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'example' => '/', - ], - 'Dir' => [ - 'description' => '节点列表信息，取值如下：'."\n" - .'- `true`：信息返回成功。'."\n" - .'- `false`：信息返回失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', + 'Id' => ['description' => '鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'Name' => ['description' => '鉴权消费者名称。', 'type' => 'string', 'example' => 'test'], + 'ConsumerStatus' => ['description' => '鉴权消费者状态：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：停用', 'type' => 'boolean', 'example' => 'true'], + 'PrimaryUser' => ['description' => '创建人。', 'type' => 'string', 'example' => '123'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****'], + 'Type' => ['description' => '鉴权类型：'."\n" + ."\n" + .'- JWT', 'type' => 'string', 'example' => 'JWT'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2023-02-01 14:17:57'], + 'GmtModified' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2023-03-01 14:17:57'], + 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'Description'], + 'EncodeType' => ['description' => '加密类型：'."\n" + ."\n" + .'- RSA'."\n" + ."\n" + .'- OCT', 'type' => 'string', 'example' => 'RSA'], + 'Jwks' => ['description' => 'JWT公钥，支持JSON格式。', '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' => '要校验的Token参数信息的名称，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'example' => 'Authorization'], + 'TokenPass' => ['description' => '是否透传。', 'type' => 'boolean', 'example' => 'true'], + 'TokenPosition' => ['description' => '要校验的Token参数信息的位置，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'example' => 'HEADER'], + 'TokenPrefix' => ['description' => '要校验的Token参数信息的前缀，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'example' => 'Bearer '], + 'KeyName' => ['description' => 'JWT内身份标识KeyName。', 'type' => 'string', 'example' => 'iss'], + 'KeyValue' => ['description' => 'JWT内身份标识KeyValue。', 'type' => 'string', 'example' => 'abcd'], + 'ResourceList' => [ + 'description' => '资源列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '鉴权消费者授权ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'ConsumerId' => ['description' => '网关鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3458'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'test'], + 'ResourceStatus' => ['description' => '资源授权状态：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：停用', 'type' => 'boolean', 'example' => 'true'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-4822033a8513496fa10f05c934f*****'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-12-06 01:38:03'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2022-12-06 01:38:03'], + ], + ], ], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": \\"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' => '获取网关鉴权消费者细节', + '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' => '[{"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' => '创建ZooKeeper数据节点', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteZnode' => [ - 'summary' => '释放Zookeeper数据节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetGatewayAuthDetail' => [ + 'summary' => '获取网关鉴权详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17014', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '37108', + 'abilityTreeNodes' => ['FEATUREmseFZIQVY'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['title' => '鉴权ID', 'description' => '鉴权ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1100'], ], [ - 'name' => 'ClusterId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['title' => '网关ID（和网关唯一ID二选一）', 'description' => '网关ID（和网关唯一ID二选一）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2274'], ], [ - 'name' => 'Path', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['title' => '网关唯一ID（和网关ID二选一，网关唯一ID不为空时优先使用网关唯一ID查询）', 'description' => '网关唯一ID（和网关ID二选一，网关唯一ID不为空时优先使用网关唯一ID查询）', 'type' => 'string', 'required' => false, 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：'."\n" + .'* zh（默认值）：中文'."\n" + .'* en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6'], + 'HttpStatusCode' => ['title' => 'HTTP 状态码。', 'description' => 'HTTP 状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '信息。', 'description' => '信息。', 'type' => 'string', 'example' => 'OK'], + 'Code' => ['title' => '用于和Success同步，当Success为true时，Code为200', 'description' => '用于和Success同步，当Success为true时，Code为200', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', + 'title' => '鉴权详情', + 'description' => '鉴权详情', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '节点数据列表。', - 'type' => 'string', - 'example' => 'cluster', - ], - 'Path' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'example' => '/', - ], - 'Dir' => [ - 'description' => '节点列表信息，取值如下：'."\n" - .'- `true`：信息返回成功。'."\n" - .'- `false`：信息返回失败。', - 'type' => 'boolean', - 'example' => 'true', + 'Id' => ['title' => '鉴权ID', 'description' => '鉴权ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1100'], + 'Name' => ['title' => '鉴权名称', 'description' => '鉴权名称', 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['title' => '鉴权所属网关的唯一ID', 'description' => '鉴权所属网关的唯一ID', 'type' => 'string', 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****'], + 'GatewayId' => ['title' => '鉴权所属网关的ID', 'description' => '鉴权所属网关的ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2274'], + 'Type' => ['title' => '鉴权类型：'."\n" + ."\n" + .'- JWT'."\n" + .'- OIDC'."\n" + .'- IDaaS'."\n" + .'- ExternalAuthZ（自建的鉴权服务）', 'description' => '鉴权类型：'."\n" + ."\n" + .'- JWT'."\n" + .'- OIDC'."\n" + .'- IDaaS'."\n" + .'- ExternalAuthZ（自建的鉴权服务）', 'type' => 'string', 'example' => 'JWT'], + 'Issuer' => ['title' => '鉴权类型为JWT/OIDC时使用：'."\n" + ."\n" + .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" + .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', 'description' => '鉴权类型为JWT/OIDC时使用：'."\n" + ."\n" + .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" + .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', 'type' => 'string', 'example' => 'https://example.com/auth'], + 'Jwks' => ['title' => 'JWT公钥，JSON格式', 'description' => 'JWT公钥，JSON格式', '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' => '授权黑白名单模式：'."\n" + ."\n" + .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" + .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', 'type' => 'boolean', 'example' => 'true'], + 'GmtCreate' => ['title' => '鉴权创建的GMT时间', 'description' => '鉴权创建的GMT时间', 'type' => 'string', 'example' => '2024-02-19T02:41:03.000+0000'], + 'GmtModified' => ['title' => '鉴权修改的GMT时间', 'description' => '鉴权修改的GMT时间', 'type' => 'string', 'example' => '2024-02-19T02:41:03.000+0000'], + 'TokenPosition' => ['title' => 'JWT Token类型：'."\n" + ."\n" + .'- HEADER：通过Header传输', 'description' => 'JWT Token类型：'."\n" + ."\n" + .'- HEADER：通过Header传输', 'type' => 'string', 'example' => 'HEADER'], + 'TokenName' => ['title' => 'JWT Token保存的位置', 'description' => 'JWT Token保存的位置', 'type' => 'string', 'example' => 'Authorization'], + 'TokenNamePrefix' => ['title' => 'JWT Token的前缀', 'description' => 'JWT Token的前缀', 'type' => 'string', 'example' => 'Bearer '], + 'TokenPass' => ['title' => '是否透传Token', 'description' => '是否透传Token', 'type' => 'boolean', 'example' => 'true'], + 'Status' => ['title' => '鉴权是否开启', 'description' => '鉴权是否开启', 'type' => 'boolean', 'example' => 'false'], + 'RedirectUrl' => ['title' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', 'description' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', 'type' => 'string', 'example' => 'https://yourdomain/path'], + 'ClientId' => ['title' => '服务注册的应用ID（OIDC/IDaaS使用）。', 'description' => '服务注册的应用ID（OIDC/IDaaS使用）。', 'type' => 'string', 'example' => 'example-app'], + 'ClientSecret' => ['title' => '服务注册的应用Secret（OIDC/IDaaS使用）。', 'description' => '服务注册的应用Secret（OIDC/IDaaS使用）。', 'type' => 'string', 'example' => 'xxxxx'], + 'CookieDomain' => ['title' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态（OIDC/IDaaS使用）。', 'description' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态（OIDC/IDaaS使用）。', 'type' => 'string', 'example' => 'hello.com'], + 'ScopesList' => ['title' => 'OIDC 作用域（OIDC 使用）。', 'description' => 'OIDC作用域（OIDC使用）。', 'type' => 'string', 'example' => '["openid","email"]'], + 'LoginUrl' => ['title' => 'IDaaS实例用户登录页地址（IDaaS使用）。', 'description' => 'IDaaS实例用户登录页地址（IDaaS使用）。', 'type' => 'string', 'example' => 'https://daxxxxcn.aliyunidaas.com/'], + 'Sub' => ['title' => '鉴权类型为JWT时使用；JWT claims 的sub(subject)，即主体。', 'description' => '鉴权类型为JWT时使用；JWT claims 的sub(subject)，即主体。', 'type' => 'string', 'example' => 'https://example.com/auth'], + 'ExternalAuthZ' => [ + 'title' => '自定义鉴权信息', + 'description' => '自定义鉴权信息', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['title' => '鉴权服务ID', 'description' => '鉴权服务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '15300'], + 'PrefixPath' => ['title' => '鉴权API的Path', 'description' => '鉴权API的Path', 'type' => 'string', 'example' => '/auth'], + 'TokenKey' => ['title' => 'Token位置，表示Token位于请求报文中哪个Header中，常见的有Authorization和Cookie', 'description' => 'Token位置，表示Token位于请求报文中哪个Header中，常见的有Authorization和Cookie', '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' => '自定义鉴权模式：'."\n" + ."\n" + .'- true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关拒绝客户端请求'."\n" + .'- false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关放过客户端请求', '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' => '是否允许携带Body', 'type' => 'boolean', 'example' => 'true'], + 'BodyMaxBytes' => ['title' => 'Body的最大字节数', 'description' => 'Body的最大字节数', 'type' => 'integer', 'format' => 'int32', 'example' => '4000000'], + 'WithRematchRoute' => ['description' => '是否在鉴权完成后重新匹配路由。', 'type' => 'boolean'], + ], ], - 'Name' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', + 'ResourceList' => [ + 'title' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', + 'description' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', + 'type' => 'array', + 'items' => [ + 'description' => '鉴权的授权规则。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '授权规则ID', 'description' => '授权规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1303'], + 'AuthId' => ['title' => '规则所归属鉴权的ID', 'description' => '规则所归属鉴权的ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2274'], + 'DomainId' => ['title' => '规则内域名的ID', 'description' => '规则内域名的ID', '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' => '授权黑白名单模式：'."\n" + ."\n" + .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" + .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', 'type' => 'boolean', 'example' => 'true'], + 'GatewayId' => ['title' => '规则所属网关的ID', 'description' => '规则所属网关的ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2274'], + 'GatewayUniqueId' => ['title' => '规则所属网关的唯一ID', 'description' => '规则所属网关的唯一ID', 'type' => 'string', 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****'], + 'GmtCreate' => ['title' => '授权规则的创建GMT时间', 'description' => '授权规则的创建GMT时间', 'type' => 'string', 'example' => '2024-02-19T03:32:38.000+0000'], + 'GmtModified' => ['title' => '授权规则的修改GMT时间', 'description' => '授权规则的修改GMT时间', 'type' => 'string', 'example' => '2024-02-19T03:32:38.000+0000'], + 'MatchType' => ['title' => '请求Path的匹配类型：'."\n" + ."\n" + .'- EQUAL：精确匹配'."\n" + .'- PRE：前缀匹配'."\n" + .'- ERGULAR：正则匹配', 'description' => '请求Path的匹配类型：'."\n" + ."\n" + .'- EQUAL：精确匹配'."\n" + .'- PRE：前缀匹配'."\n" + .'- ERGULAR：正则匹配', 'type' => 'string', 'example' => 'EQUAL'], + 'IgnoreCase' => ['title' => '路径是否开启大小写敏感'."\n" + ."\n" + .'- true：开启大小写敏感'."\n" + .'- false：关闭大小写敏感', 'description' => '路径是否开启大小写敏感'."\n" + ."\n" + .'- true：开启大小写敏感'."\n" + .'- false：关闭大小写敏感', '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' => '匹配条件：'."\n" + ."\n" + .'- EQUAL：等于'."\n" + .'- NOT_EQUAL：不等于'."\n" + .'- EXIST：存在'."\n" + .'- NOT_EXIST：不存在'."\n" + .'- INCLUDE：包含'."\n" + .'- EXCLUDE：不包含'."\n" + .'- PREFIX：前缀'."\n" + .'- SUFFIX：后缀'."\n" + .'- REGREX：正则', 'type' => 'string', 'example' => 'EQUAL'], + 'HeaderValue' => ['title' => '请求头的值', 'description' => '请求头的值', 'type' => 'string', 'example' => '123'], + ], + 'description' => '', + ], + ], + ], + ], ], + 'AuthResourceMode' => ['title' => '授权资源模式：'."\n" + ."\n" + .'- 0：简单模式'."\n" + .'- 1：复杂模式', 'description' => '授权资源模式：'."\n" + ."\n" + .'- 0：简单模式'."\n" + .'- 1：复杂模式', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'AuthResourceConfig' => ['title' => '复杂模式的YAML配置', 'description' => '复杂模式的YAML配置', 'type' => 'string', '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'], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], ], ], ], ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - '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' => '删除ZooKeeper数据节点', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateZnode' => [ - 'summary' => '更新Zookeeper数据节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'cluster', + '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' => '获取网关鉴权详情', + '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' => '获取网关参数配置。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '17105', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '141101', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], - ], - [ - 'name' => 'Path', - 'in' => 'query', - 'schema' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/zookeeper', - ], - ], - [ - 'name' => 'Data', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '节点数据。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'data', - ], + 'schema' => ['description' => '网关唯一ID', 'type' => 'string', 'required' => true, 'example' => 'gw-61f465fa2dd044069e2208c4912*****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F6092602-C357-4750-89D9-E572FBEA****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', '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' => '网关唯一ID', 'type' => 'string', 'example' => 'gw-61f465fa2dd044069e2208c4912*****'], + 'EnableGenerateRequestId' => ['title' => '是否生成requestId', 'description' => '作用于请求范围，根据配置会在请求头中生成requestId，以便追踪请求。', 'type' => 'boolean', 'example' => 'true'], + 'EnableGzip' => ['title' => '是否启用gzip进行压缩', 'description' => '作用于请求与响应环节，启用gzip会对请求响应进行压缩，会减少网关流量，增加网关cpu消耗。', 'type' => 'boolean', 'example' => 'false'], + 'EnableSlashMerge' => ['title' => '是否合并‘/’, 开启后www.a.com//b多余的\'/\'会被合并，将会同www.a.com/b一致', 'description' => '作用于请求环节，是否合并请求中多余的‘/’, 开启后www.a.com//b多余的\'/\'会被合并，将会同www.a.com/b一致。', 'type' => 'boolean', 'example' => 'true'], + 'DownstreamIdleTime' => ['title' => '客户端到网关处于指定的时间内[0-600]没有请求，则会断开链接', 'description' => '作用于网关连接，客户端到网关处于指定的时间内没有请求，则会断开链接。', 'type' => 'integer', 'format' => 'int32', 'example' => '180'], + 'PreserveHeaderFormat' => ['title' => '是否保持header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写', 'description' => '作用于请求和响应环节，是否保持请求header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写。', 'type' => 'boolean', 'example' => 'true'], + 'DownstreamConnectionBufferLimits' => ['title' => '单条链接的buffer大小', 'description' => '作用于网关连接，单条链接的buffer大小，配置后会影响吞吐和网关的内存使用（单位：Byte）。', 'type' => 'integer', 'format' => 'int32', 'example' => '32768'], + 'EnableHardwareAccelerate' => ['title' => '是否开启硬件加速(若您的地域处于底层不支持地域，或购买时未指定硬件加速会生效失败)', 'description' => '是否开启硬件加速(若您的地域处于底层不支持地域，或购买时未指定硬件加速会生效失败)。', 'type' => 'boolean', 'example' => 'true'], + 'XffTrustedNum' => ['title' => '网关前可信任的设备个数', 'description' => '作用于请求环节，网关前可信任的代理个数，会影响网关是否会使用客户端产生的x-forwarded-for和x-request-id等请求头。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'EnableHttp2' => ['title' => '是否默认开启http2', 'description' => '作用于请求环节，服务端与客户端协商时是否使用http2（修改后1～2分钟后生效）。', 'type' => 'boolean', 'example' => 'false'], + 'DownstreamHttp2MaxConcurrentStream' => ['title' => '下游http最大并发数', 'description' => '作用于请求环节，客户端使用http2时一条链接上最大并发数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'InitialStreamWindowSize' => ['title' => 'http2 stream 初始窗口大小', 'description' => '作用于请求环节，网关同客户端使用http2时协商的stream初始窗口大小（单位：Byte）。', 'type' => 'integer', 'format' => 'int32', 'example' => '65535'], + 'InitialConnectionWindowSize' => ['title' => 'http2 连接 初始窗口大小', 'description' => '作用于请求环节，网关同客户端使用http2时连接级别初始窗口大小（单位：Byte）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1048576'], + 'XtraceDetails' => [ + 'description' => '链路追踪信息。', + 'type' => 'object', + 'properties' => [ + 'TraceOn' => ['description' => '是否开启链路追踪。', 'type' => 'boolean', 'example' => 'true'], + 'Id' => ['description' => '链路追踪信息ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '255'], + 'Sample' => ['description' => '采样率（%）。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '500'], + 'GatewayUniqueId' => ['description' => '网关唯一ID。', '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' => '链路追踪类型：'."\n" + ."\n" + .'- XTRACE：可观测链路OpenTelemetry版，链路追踪协议Zipkin'."\n" + ."\n" + .'- SKYWALKING：自建Skywalking'."\n" + ."\n" + .'- OPENTELEMETRY：可观测链路OpenTelemetry版，链路追踪协议OpenTelemetry'."\n" + ."\n" + .'- OTSKYWALKING：可观测链路OpenTelemetry版，链路追踪协议Skywalking', 'type' => 'string', 'example' => 'OPENTELEMETRY'], + 'ServiceId' => ['description' => '自建Skywalking，Skywalking服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '333'], + 'ServicePort' => ['description' => '自建Skywalking，Skywalking服务端口。', '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' => '日志投递目标Project', 'type' => 'string', 'example' => 'test'], + 'LogStoreName' => ['description' => '日志投递目标Logstore，取值：'."\n" + ."\n" + .'- 未开启兼容Nginx Ingress：mse_gw_access_log'."\n" + ."\n" + .'- 开启兼容Nginx Ingress：nginx-ingress', 'type' => 'string', 'example' => 'mse_gw_access_log'], + 'GatewayUniqueId' => ['description' => '网关唯一ID。', 'type' => 'string', 'example' => 'gw-61f465fa2dd044069e2208c4912*****'."\n"], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '500'], + 'GmtCreate' => ['description' => '未开放使用。', 'type' => 'string', 'example' => '""'], + 'GmtModified' => ['description' => '未开放使用。', 'type' => 'string', 'example' => ' ""'], + 'NginxCompatible' => ['description' => '是否开启兼容 Nginx Ingress', 'type' => 'boolean', 'example' => 'false'], + ], + ], + 'SupportWaf' => ['description' => '网关是否支持WAF。', 'type' => 'boolean', 'example' => 'true'], + 'EnableWaf' => ['description' => '是否开启WAF。', 'type' => 'boolean', 'example' => 'true'], + 'AccessLogHeader' => ['description' => '自定义日志格式。', 'type' => 'string', 'example' => '{"requestMetadata":[],"responseHeaders":[],"requestHeaders":["x-test"],"responseMetadata":[]}'], + 'EnableHttp3' => ['description' => '是否支持http3协议。', 'type' => 'boolean', 'example' => 'false'], + 'UpstreamIdleTimeout' => ['description' => '默认到上游的idle时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'ZipAlgorithm' => ['description' => '开启压缩后使用的算法，可以选择brotli，gzip，如果此时EnableGzip未开启，将自动开启EnableGzip选项。', 'type' => 'string', 'example' => '["gzip"]'], + 'PathWithEscapedSlashes' => ['description' => '确定 URI 路径中包含 %2F、%2f、%5C 或 %5c 这些转义的请求的操作, 默认为KEEP_UNCHANGED(保持不变)'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- KEEP_UNCHANGED'."\n" + ."\n" + .'- REJECT_REQUEST'."\n" + ."\n" + .'- UNESCAPE_AND_REDIRECT'."\n" + ."\n" + .'- UNESCAPE_AND_FORWARD', 'type' => 'string', 'example' => 'KEEP_UNCHANGED'], + 'NoSupportedConfigList' => ['description' => '不支持的配置列表。', 'type' => 'string', 'example' => '"EnableProxyProtocol,EnableCustomAuthConfigPush"'], + 'LogFilterConfig' => ['description' => '未开放使用。', 'type' => 'string', 'example' => ' ""'], + 'EnableProxyProtocol' => ['description' => '是否开启Proxy协议，如果网关入口流量使用NLB接入，如果不开启则无法获取客户端的真实IP，开启后对于非Proxy协议请求没有影响。', 'type' => 'boolean', 'example' => 'true'], + 'EnableCustomAuthConfigPush' => ['description' => '作用于使用自建的鉴权服务的场景，开启后鉴权规则变更不会引起连接中断，适用于WebSocket和在线业务场景。', 'type' => 'string', 'example' => 'false'], + 'KeepaliveHeaderTimeout' => ['description' => '用于生成Keep-Alive响应头返回给客户端，告知连接的保活时间。例如配置为10时，会返回响应头: `keep-alive: timeout=10`。配置为0时，不会返回该响应头。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'WebsocketTermGracePeriod' => ['title' => '', 'description' => '当网关实例升级、重启等需要关闭连接的场景下，为Websocket连接维持的保活时间（单位：s）。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'EnableK8sSourceWorkloadFilter' => [ + 'type' => 'object', + 'properties' => [ + 'Enable' => ['type' => 'boolean', 'description' => ''], + 'LabelKey' => ['type' => 'string', 'description' => ''], + 'LabelValue' => ['type' => 'string', 'description' => ''], + 'FilterOpt' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'EnableXffTrustedCidrs' => [ + 'type' => 'object', + 'properties' => [ + 'Enable' => ['type' => 'boolean', 'description' => ''], + 'IpListContent' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'EnableGzipHardwareAccelerate' => ['type' => 'boolean', 'description' => ''], + ], ], ], ], @@ -18555,76 +12351,41 @@ ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 }\\n}","type":"json"}]', + 'title' => '获取网关参数配置', + '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' => '[{"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' => '更新ZooKeeper数据节点', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListZnodeChildren' => [ - 'summary' => '查询ZooKeeper数据子节点。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetGatewayDomainDetail' => [ + 'summary' => '查询网关域名详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -18633,187 +12394,116 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '17075', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '35699', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], ], 'parameters' => [ [ - 'name' => 'Path', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['description' => '域名ID。', 'type' => 'string', 'required' => false, 'example' => '29'], ], [ - 'name' => 'ClusterId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-6d0b23e1d39e41658a968d79a635****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '88B83302-CD88-54D3-8DF2-208BFDC73F0D'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '403'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '节点数据。', - 'type' => 'string', - 'example' => 'cluster', - ], - 'Path' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'example' => '/zookeeper', - ], - 'Dir' => [ - 'description' => '节点列表信息，取值如下：'."\n" - .'- `true`：信息返回成功。'."\n" - .'- `false`：信息返回失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', - ], - ], + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test.com'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。'."\n", 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Protocol' => ['description' => '网关协议。', 'type' => 'string', 'example' => 'HTTP'], + 'MustHttps' => ['description' => '强制HTTPS', 'type' => 'boolean', 'example' => 'true'], + 'CertIdentifier' => ['description' => '证书标识。', 'type' => 'string', 'example' => '234-cn-hangzhou'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'CertName' => ['description' => '证书名称。', 'type' => 'string', 'example' => 'test'], + 'CommonName' => ['description' => '公网域名。', 'type' => 'string', 'example' => 'name'], + 'Sans' => ['description' => '扩展字段名称。', 'type' => 'string', 'example' => 'test.com'], + 'BeforeDate' => ['description' => '证书签发时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-04-01 02:35:12'], + 'AfterDate' => ['description' => '证书过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-04-01 02:35:12'], + 'Algorithm' => ['description' => '算法。', 'type' => 'string', 'example' => 'RSA'], + 'Issuer' => ['description' => '签发者。', 'type' => 'string', 'example' => 'Istio'], + 'GmtBefore' => ['description' => '证书签发时间（GMT）。', 'type' => 'string', 'example' => '2021-04-01 02:35:12'], + 'GmtAfter' => ['description' => '证书到期时间（GMT）。', 'type' => 'string', 'example' => '2021-04-01 02:35:12'], + 'Http2' => ['description' => '是否开启`Http2`。'."\n" + .'- `open`：开启`Http2`。'."\n" + .'- `close`：关闭`Http2`。'."\n" + .'- `globalConfig`：使用全局配置。', 'type' => 'string', 'example' => 'close'], + 'TlsMax' => ['description' => 'Tls最大版本。', 'type' => 'string', 'example' => 'TLS 1.3'], + 'TlsMin' => ['description' => 'Tls最小版本。', 'type' => 'string', 'example' => 'TLS 1.0'], + 'IsManaged' => ['title' => '是否为托管域名', 'description' => '是否为托管域名', 'type' => 'boolean'], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 }\\n}","type":"json"}]', + 'title' => '查询网关域名详情', + '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' => '[{"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' => '查询ZooKeeper子节点', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryZnodeDetail' => [ - 'summary' => '查询ZooKeeper数据节点信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetGatewayOption' => [ + 'summary' => '获取网关全局参数。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -18823,198 +12513,504 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '17085', - 'abilityTreeNodes' => [ - 'FEATUREmseINOH9I', - ], + 'abilityTreeCode' => '92787', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '429'], ], [ - 'name' => 'ClusterId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mse-09k1q11****', - ], + 'schema' => ['description' => '网关唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491*****'], ], [ - 'name' => 'Path', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/zookeeper', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-cn-5bffa4e8630', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C92F4A4D-A2FD-593E-839E-F3D4DFD2****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因，例如：TaskId not found。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '状态码。说明：200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '网关操作详情。'."\n" + ."\n" + .'- **TraceDetails**：XTrace采样描述。内容：TraceEnabled为是否开通XTrace，Sample为XTrace的采样率。'."\n" + ."\n" + .'- **LogConfigDetails**：日志投递服务描述。内容：LogEnabled为是否开启日志投递SLS服务，ProjectName为日志投递的目的，LogStoreName为日志存储名称。'."\n" + ."\n" + .'- **EnableHardwareAcceleration**：是否开启硬件加速。'."\n" + ."\n" + .'- **DisableHttp2Alpn**：是否关闭HTTP 2.0协议。'."\n" + ."\n" + .'- **EnableWaf**：是否开启waf。', 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': False}, \'TraceDetails\': {\'TraceEnabled\': False}}', '$ref' => '#/components/schemas/GatewayOption'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关选项', + '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}'], + ], + ], + ], + ], + ], + 'GetGatewayRouteDetail' => [ + 'summary' => '查询网关路由详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1050'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-5d3a78a53ec947aa928212d671d400ac'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FDF2D16C-5D28-5FAA-A56B-30BDE3559880'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '节点数据。', - 'type' => 'string', - 'example' => 'cluster', + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1050'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DefaultServiceId' => ['description' => '默认服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'DefaultServiceName' => ['description' => '默认服务名称。', 'type' => 'string', 'example' => 'test'], + 'Status' => ['description' => '路由状态。'."\n" + ."\n" + .'- 未发布：0'."\n" + ."\n" + .'- 发布中：2'."\n" + ."\n" + .'- 已发布：3'."\n" + ."\n" + .'- 编辑中(有更新未发布)：4'."\n" + ."\n" + .'- 下线中：5'."\n" + ."\n" + .'- 不可用：6', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'GmtModified' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'RouteOrder' => ['description' => '路由顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Predicates' => ['description' => '匹配条件。', 'type' => 'string', 'example' => '{}'], + 'RoutePredicates' => [ + 'description' => '路由匹配。', + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => '路由匹配。', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => '路径。', 'type' => 'string', 'example' => '/api'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'example' => 'PRE'], + 'IgnoreCase' => ['description' => '是否忽略大小写。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'MethodPredicates' => [ + 'description' => '方法匹配。', + 'type' => 'array', + 'items' => ['description' => '方法。', 'type' => 'string', 'example' => 'GET'], + ], + 'HeaderPredicates' => [ + 'description' => '头匹配。', + 'type' => 'array', + 'items' => [ + 'description' => '请求头。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '请求头KEY。', 'type' => 'string', 'example' => 'id'], + 'Value' => ['description' => '匹配值。', 'type' => 'string', 'example' => '200'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'PRE'], + ], + ], + ], + 'QueryPredicates' => [ + 'description' => '参数匹配。', + 'type' => 'array', + 'items' => [ + 'description' => '参数。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'userid'], + 'Value' => ['description' => '匹配值。', 'type' => 'string', 'example' => 'test'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'PRE'], + ], + ], + ], + ], ], - 'Path' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'example' => '/zookeeper', + 'DomainId' => ['description' => '域名ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '235'], + 'DomainName' => ['description' => '域名。', 'type' => 'string', 'example' => '123.com'], + 'Services' => ['description' => '服务的配置信息。', 'type' => 'string', 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]'], + 'RouteServices' => [ + 'description' => '服务。', + 'type' => 'array', + 'items' => [ + 'description' => '服务。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '782'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'xkc-crm'], + 'Percent' => ['description' => '权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'Version' => ['description' => '服务版本。', 'type' => 'string', 'example' => 'v1'], + 'Name' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'dubbo4'], + 'SourceType' => ['description' => '服务来源。', 'type' => 'string', 'example' => 'MSE'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'acs_ecs_dashboard'], + 'GroupName' => ['description' => '服务组名称。', 'type' => 'string', 'example' => 'api'], + 'AgreementType' => ['description' => '协议类型。', 'type' => 'string', 'example' => 'DUBBO'], + 'HttpDubboTranscoder' => [ + 'description' => 'Dubbo协议转换体。', + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => ['description' => 'Dubbo服务名称。', 'type' => 'string', 'example' => 'org.apache.dubbo.samples.basic.api.DemoService'."\n"], + 'DubboServiceVersion' => ['description' => 'Dubbo服务版本。', 'type' => 'string', 'example' => '0.0.0'], + 'MothedMapList' => [ + 'description' => 'Dubbo转发规则列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => ['description' => 'Dubbo方法名。', 'type' => 'string', 'example' => 'sayHello'], + 'HttpMothed' => ['description' => 'Http方法。'."\n" + .'> 支持http方法参数值。'."\n" + .'> - ALL_GET'."\n" + .'> - ALL_POST'."\n" + .'> - ALL_PUT'."\n" + .'> - ALL_DELETE'."\n" + .'> - ALL_PATCH'."\n", 'type' => 'string', 'example' => 'ALL_GET'], + 'Mothedpath' => ['description' => '方法匹配路径。', 'type' => 'string', 'example' => '/mytestzbk/sayhello'], + 'PassThroughAllHeaders' => ['description' => 'Header透传类型。'."\n" + .'> 透传类型枚举值。'."\n" + .'> - 透传所有：PASS_ALL'."\n" + .'> - 不透传：PASS_NOT'."\n" + .'> - 指定参数：PASS_ASSIGN', 'type' => 'string', 'example' => 'PASS_NOT'], + 'PassThroughList' => [ + 'description' => '指定Header透传列表。', + 'type' => 'array', + 'items' => ['description' => '指定Header透传值。', 'type' => 'string', 'example' => 'x-forward'], + ], + 'ParamMapsList' => [ + 'description' => '参数映射列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => ['description' => '入参位置。'."\n" + .'> 入参位置枚举值。'."\n" + .'> - 请求参数：`ALL_QUERY_PARAMETER`'."\n" + .'> - 请求头：`ALL_HEADER`'."\n" + .'> - 请求路径：`ALL_PATH`'."\n" + .'> - 请求体：`ALL_BODY`'."\n", 'type' => 'string', 'example' => 'ALL_QUERY_PARAMETER'], + 'ExtractKey' => ['description' => '入参位提取Key。', 'type' => 'string', 'example' => 'name'], + 'MappingType' => ['description' => '后端参数类型。', 'type' => 'string', 'example' => 'java.lang.String'], + ], + ], + ], + ], + ], + ], + 'DubboServiceGroup' => ['description' => 'Dubbo服务组。', 'type' => 'string', 'example' => 'service group'], + ], + ], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '20880'], + 'HealthStatus' => ['title' => '健康状态'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Checking'."\n" + ."\n" + .'- Unknown', 'description' => '健康状态'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Checking'."\n" + ."\n" + .'- Unknown', 'type' => 'string', 'example' => 'Health'], + 'UnhealthyEndpoints' => [ + 'title' => '非健康Endpoint列表', + 'description' => '非健康Endpoint列表', + 'type' => 'array', + 'items' => ['title' => '非健康Endpoint', 'description' => '非健康Endpoint', 'type' => 'string', 'example' => '192.168.1.2'], + ], + ], + ], ], - 'Dir' => [ - 'description' => '节点列表信息，取值如下：'."\n" - .'- `true`：信息返回成功。'."\n" - .'- `false`：信息返回失败。', - 'type' => 'boolean', - 'example' => 'true', + 'HTTPRewrite' => [ + 'description' => '重写策略信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '开启状态。', 'type' => 'string', 'example' => 'off'], + 'Path' => ['description' => '节点路径。', 'type' => 'string', 'example' => '/test/client'], + 'Host' => ['description' => '实例地址。', 'type' => 'string', 'example' => 'aliyuncs.com'], + 'PathType' => ['description' => '重写类型。', 'type' => 'string', 'example' => 'PRE'], + 'Pattern' => ['description' => '匹配Pattern。', 'type' => 'string', 'example' => '/test'], + 'Substitution' => ['description' => '替换。', 'type' => 'string', 'example' => 'test'], + ], ], - 'Name' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => 'zookeeper', + 'HeaderOp' => [ + 'description' => 'Header设置信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'off'], + 'HeaderOpItems' => [ + 'description' => '头字段对象。', + 'type' => 'array', + 'items' => [ + 'description' => '设置策略。', + 'type' => 'object', + 'properties' => [ + 'DirectionType' => ['description' => '请求或响应。', 'type' => 'string', 'example' => 'Response'], + 'OpType' => ['description' => '操作类型。', 'type' => 'string', 'example' => 'Add'], + 'Key' => ['description' => 'Header Key。', 'type' => 'string', 'example' => 'debug'], + 'Value' => ['description' => '设置值。', 'type' => 'string', 'example' => 'test'], + ], + ], + ], + ], + ], + 'DestinationType' => ['description' => '目标服务类型。', 'type' => 'string', 'example' => 'Single'], + 'DirectResponse' => [ + 'description' => 'Mock信息。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Body' => ['description' => 'Mock返回值。', 'type' => 'string', 'example' => '{}'], + ], + ], + 'Cors' => [ + 'description' => '跨域配置。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'off'], + 'AllowOrigins' => ['description' => '跨域。', 'type' => 'string', 'example' => '*'], + 'AllowMethods' => ['description' => '跨域方法。', 'type' => 'string', 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH'], + 'AllowHeaders' => ['description' => '跨域Header。', 'type' => 'string', 'example' => '*'], + 'ExposeHeaders' => ['description' => '响应头。', 'type' => 'string', 'example' => '*'], + 'TimeUnit' => ['description' => '时间单位。', 'type' => 'string', 'example' => 'h'], + 'UnitNum' => ['description' => '时间数。', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + 'AllowCredentials' => ['description' => '允许携带凭证。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'Timeout' => [ + 'description' => '超时配置。', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => ['description' => '时间数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TimeUnit' => ['description' => '时间单位。', 'type' => 'string', 'example' => 's'], + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'off'], + ], + ], + 'Retry' => [ + 'description' => '重试配置。', + 'type' => 'object', + 'properties' => [ + 'Attempts' => ['description' => '重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RetryOn' => [ + 'description' => '重试条件。', + 'type' => 'array', + 'items' => ['description' => '重试条件。', 'type' => 'string', 'example' => '5xx'], + ], + 'HttpCodes' => [ + 'description' => 'HTTP状态码。', + 'type' => 'array', + 'items' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '500'], + ], + 'Status' => ['description' => '重试状态。', 'type' => 'string', 'example' => 'on'], + ], + ], + 'DomainIdList' => [ + 'description' => '域名列表', + 'type' => 'array', + 'items' => ['description' => '域名ID列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'DomainNameList' => [ + 'description' => '域名列表', + 'type' => 'array', + 'items' => ['description' => '域名列表。', 'type' => 'string', 'example' => 'test.com'], + ], + 'Redirect' => [ + 'description' => '重定向配置', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Host' => ['description' => '主机。', 'type' => 'string', 'example' => '16'], + 'Path' => ['description' => '路径。', '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' => '是否开启Waf。', 'type' => 'boolean', 'example' => 'true'], + 'AhasStatus' => ['description' => 'Ahas状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Fallback' => ['description' => '是否开启Fallback服务。', 'type' => 'boolean', 'example' => 'true'], + 'FallbackServices' => [ + 'description' => 'Fallback服务。', + 'type' => 'array', + 'items' => [ + 'description' => '数据对象。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'name'], + 'Percent' => ['description' => '权重百分比。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'Version' => ['description' => '服务版本。', 'type' => 'string', 'example' => 'v1'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'name'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'example' => 'MSE'], + 'Namespace' => ['description' => '服务所在命名空间。', 'type' => 'string', 'example' => 'namespace'], + 'GroupName' => ['description' => '服务分组名称。', 'type' => 'string', 'example' => 'test'], + 'AgreementType' => ['description' => '协议类型。', 'type' => 'string', 'example' => 'DUBBO'], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '8848'], + ], + ], ], + 'Policies' => ['description' => '路由策略Json字符串。', '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' => '路由描述', 'description' => '路由描述', 'type' => 'string', 'example' => 'a route for xxx'], ], ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'string', - 'example' => 'true', - ], ], ], ], ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关路由详情', + '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' => '[{"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' => '查询ZooKeeper数据节点', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListZkTrack' => [ - 'summary' => '获取ZooKeeper的轨迹数据。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'cluster', - ], + 'GetGatewayServiceDetail' => [ + 'summary' => '查询服务详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -19023,368 +13019,202 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '150858', - 'abilityTreeNodes' => [ - 'FEATUREmseN84UZV', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '39518', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => 'RequestPars。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-0ju2yq****', - ], - ], - [ - 'name' => 'Path', - 'in' => 'query', - 'schema' => [ - 'description' => '路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/path', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'SessionId。', - 'type' => 'string', - 'required' => false, - 'example' => '0x301fdfbdbf00***', - ], - ], - [ - 'name' => 'StartTs', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间戳，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1669618483', - ], - ], - [ - 'name' => 'EndTs', - 'in' => 'query', - 'schema' => [ - 'description' => '结束时间戳，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1669619383', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], - ], - [ - 'name' => 'PageNum', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '当前页。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '35'], ], [ - 'name' => 'Reverse', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '是否倒序。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-f4c960ad071a48a790b36324394c****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - ."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Traces' => [ - 'description' => '轨迹数据。', - 'type' => 'array', - 'items' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'LogDate' => [ - 'description' => '记录时间。', - 'type' => 'string', - 'example' => '2022-11-28 15:09:15,606', - ], - 'Timestamp' => [ - 'description' => '时间戳（暂无）。', - 'type' => 'string', - 'example' => '1669619383000', - ], - 'SessionId' => [ - 'description' => 'SessionId。', - 'type' => 'string', - 'example' => '0x301fdfbdbf00***', - ], - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'example' => '/path', - ], - 'TraceType' => [ - 'title' => '轨迹类型：push、pull、notify', - 'description' => '轨迹类型：'."\n" - ."\n" - .'- Push'."\n" - ."\n" - .'- Pull'."\n" - ."\n" - .'- Notify', - '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' => '操作类型。'."\n" - .'对于Push：'."\n" - .' '."\n" - .'- Create'."\n" - ."\n" - .'- Update'."\n" - ."\n" - .'- Delete'."\n" - ."\n" - .'- SetAcl'."\n" - ."\n" - .'- Multi'."\n" - ."\n" - .'对于Pull：'."\n" - ."\n" - .'- GetData'."\n" - ."\n" - .'- GetChild'."\n" - ."\n" - .'- GetStat', - 'type' => 'string', - 'example' => 'Create', - ], - 'EventType' => [ - 'title' => '事件类型'."\n" - .'对于notify：'."\n" - .' ○ NodeCreated'."\n" - .' ○ NodeDeleted'."\n" - .' ○ NodeDataChanged'."\n" - .' ○ NodeChildrenChanged', - 'description' => '事件类型。'."\n" - .'对于notify：'."\n" - ."\n" - .'- NodeCreated'."\n" - ."\n" - .'- NodeDeleted'."\n" - ."\n" - .'- NodeDataChanged'."\n" - ."\n" - .'- NodeChildrenChanged', - 'type' => 'string', - 'example' => 'NodeCreated', - ], - 'DataType' => [ - 'title' => '数据类型：persist、ephemeral', - 'description' => '数据类型：'."\n" - ."\n" - .'- persist'."\n" - ."\n" - .'- ephemeral', - 'type' => 'string', - 'example' => 'persist', - ], - 'Watch' => [ - 'title' => '监听', - 'description' => '是否监听。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Acl' => [ - 'description' => 'ACL。', - 'type' => 'string', - 'example' => 'world:anyone:cdrwa', - ], - 'MultiSize' => [ - 'description' => '事务大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9802C54E-5CC5-5706-927B-993DBB6DCF2F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Succ'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SourceType' => ['description' => '服务来源', 'type' => 'string', 'example' => 'MSE'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'GroupName' => ['description' => '分组名称。', 'type' => 'string', 'example' => 'test'], + 'SourceId' => ['description' => '来源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ServiceNameInRegistry' => ['description' => '服务注册到注册中心的名称。', 'type' => 'string', 'example' => 'test'], + 'MetaInfo' => ['description' => '服务的基本信息。', 'type' => 'string', 'example' => '{}'], + 'Ips' => [ + 'description' => '服务IP地址。', + 'type' => 'array', + 'items' => ['description' => 'IP。', 'type' => 'string', 'example' => '127.0.1.12'], + ], + 'Versions' => [ + 'description' => '服务版本号（已废弃）。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => '标签。', 'type' => 'string', 'example' => 'version'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'v1'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'test'], + ], ], - 'Result' => [ - 'description' => '结果。', - 'type' => 'string', - 'example' => 'success', + ], + 'LabelDetails' => [ + 'description' => '标签详情。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签。', 'type' => 'string', 'example' => 'label'], + 'Values' => [ + 'description' => '标签值。', + 'type' => 'array', + 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'v1'], + ], + ], ], - 'Ttl' => [ - 'description' => 'TTL。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + ], + 'VersionDetails' => [ + 'description' => '版本详细。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'ServiceVersion' => [ + 'description' => '服务版本。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '版本名。', 'type' => 'string', 'example' => 'v2'], + 'Labels' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签。', 'type' => 'string', 'example' => 'version'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'v2'], + ], + ], + ], + ], + ], + 'EndpointNum' => ['description' => '实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'EndpointNumPercent' => ['description' => '实例百分比。', 'type' => 'string', 'example' => '20%'], + ], ], - 'Finished' => [ - 'description' => '业务是否结束。', - 'type' => 'boolean', - 'example' => 'true', + ], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'GmtModified' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GatewayTrafficPolicy' => ['description' => '服务流量策略。', 'example' => '{}', '$ref' => '#/components/schemas/TrafficPolicy'], + 'HealthStatus' => ['description' => '健康检查状态。', 'type' => 'string', 'example' => 'true'], + 'HealthCheck' => ['description' => '是否健康检查。', 'type' => 'string', 'example' => 'true'], + 'ServiceProtocol' => ['description' => '服务协议。', 'type' => 'string', 'example' => 'HTTP'], + 'Ports' => [ + 'description' => '服务端口数组。', + 'type' => 'array', + 'items' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + ], + 'PortTrafficPolicyList' => [ + 'description' => '服务端口流量策略。', + 'type' => 'array', + 'items' => [ + 'description' => '端口流量策略对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '端口配置ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '8080'], + 'GatewayUniqueId' => ['description' => '网关UniqueId。', 'type' => 'string', 'example' => 'gw-2837hfd91h34dbg87364g*****'], + 'TrafficPolicy' => ['description' => '流量策略。', '$ref' => '#/components/schemas/TrafficPolicy'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '1667460287386'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '1667460287386'], + ], ], ], + 'ServiceFQDN' => ['description' => '服务的完全限定域名（FQDN）。', 'type' => 'string'], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32'], + 'DnsServerList' => [ + 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'description' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'type' => 'array', + 'items' => ['title' => 'DNS服务器地址（IP+端口）', 'description' => 'DNS服务器地址（IP+端口）', 'type' => 'string', 'example' => '1.1.1.1:80'], + ], ], ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => '当前页。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'."\n", - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => 'ok', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- true：请求成功。'."\n" - ."\n" - .'- false：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关服务详情', + '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 \\"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' => '查询ZooKeeper轨迹数据', ], - 'ListSentinelBlockFallbackDefinitions' => [ - 'summary' => '获取流量防护自定义行为。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetGovernanceKubernetesCluster' => [ + 'summary' => '获取服务治理的kubernetes集群信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -19393,293 +13223,240 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '163990', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '24691', + 'abilityTreeNodes' => ['FEATUREmse3O985H'], ], 'parameters' => [ [ - 'name' => 'ClassificationSet', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '行为类型列表。', - 'description' => '行为类型列表。', - 'type' => 'array', - 'items' => [ - 'title' => '行为类型。', - 'description' => '行为类型。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => 'WEB行为', - 'RPC行为', - ], - 'example' => '1', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '集群所在地域，MSE支持的地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AppName', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => '状态码。', - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息。', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], 'Data' => [ - 'title' => '行为信息。', - 'description' => '行为信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '行为ID。', - 'description' => '行为ID。', - 'type' => 'string', - 'example' => '12', - ], - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Name' => [ - 'title' => '行为名称。', - 'description' => '行为名称。', - 'type' => 'string', - 'example' => 'defaultFallback', - ], - 'ResourceClassification' => [ - 'title' => '行为类型。', - 'description' => '行为类型。', - 'type' => 'string', - 'example' => '1', - ], - 'FallbackBehavior' => [ - 'title' => '行为详情。', - 'description' => '行为详情。', - 'type' => 'object', - 'example' => '{"webRespStatusCode":429,"webRespMessage":"test","webFallbackMode":0,"webRespContentType":0}', - ], - 'TargetMap' => [ - 'title' => '与该行为绑定的资源信息。', - 'description' => '与该行为绑定的资源信息。', + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc30d5'], + 'ClusterName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'myCluster'], + 'Region' => ['description' => '集群所在地域，MSE支持的地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'K8sVersion' => ['description' => 'k8s版本。', 'type' => 'string', 'example' => '1.20.11-aliyun.1'], + 'NamespaceInfos' => ['description' => '命名空间信息。', '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' => 'Pilot启动时间。', 'type' => 'string', 'example' => '2022-01-11T11:50:38.000+0000'], + 'UpdateTime' => ['description' => '最后更新时间。', 'type' => 'string', 'example' => '2022-01-12T05:24:31.000+0000'], + 'Namespaces' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间结构。', 'type' => 'object', - 'example' => '{"/params/{hot}":[1]}', + 'properties' => [ + 'Name' => ['title' => 'Kubernetes命名空间名字', 'description' => 'Kubernetes命名空间名字。', 'type' => 'string', 'example' => 'default'], + 'MseNamespace' => ['title' => '对应接入的mse命名空间名字', 'description' => '对应接入的mse命名空间名字。', 'type' => 'string', 'example' => 'default'], + ], ], ], + 'PilotVersion' => ['description' => 'ack-onepilot 组件版本', 'type' => 'string', 'example' => '4.1.1'], + 'VersionLifeCycle' => [ + 'description' => '版本生命周期', + 'type' => 'string', + 'enumValueTitles' => ['EXPIRED' => '过期', 'SUNSETTING' => '即将过期', 'STABLE' => '稳定', 'DEPRECATED' => '不推荐版本'], + 'example' => 'STABLE', + ], ], ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询已接入服务治理的集群信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '获取流量防护自定义行为', ], - 'BindSentinelBlockFallbackDefinition' => [ - 'summary' => '绑定流量防护行为。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetImage' => [ + 'summary' => '查询当前版本可升级的最大版本号。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '164017', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '43433', + 'abilityTreeNodes' => ['FEATUREmseLINUSD'], ], 'parameters' => [ [ - 'name' => 'AppName', + 'name' => 'VersionCode', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['title' => '集群版本', 'description' => '当前集群所在的版本号。', 'type' => 'string', 'required' => true, 'example' => 'ZooKeeper_3_5_5'], ], [ - 'name' => 'Namespace', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型。'."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'required' => true, - 'example' => 'prod', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '25EA0A83-9007-4E87-808C-637BE1A****'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'CurrentVersionFullShowName' => ['title' => '当前集群镜像版本的4位全名', 'description' => '当前集群镜像版本的4位全名', 'type' => 'string', 'example' => '3.5.5.0'], + 'MaxVersionCode' => ['title' => '可升级的增量版本Code', 'description' => '可升级的增量版本Code', 'type' => 'string', 'example' => 'ZooKeeper_3_6_3'], + 'MaxVersionFullShowName' => ['title' => '可升级的增量版本全名', 'description' => '可升级的增量版本全名', 'type' => 'string', 'example' => '3.6.3.0'], + 'MaxVersionChangelogUrl' => ['title' => '可升级的最大版本变更日志url', 'description' => '可升级的最大版本变更日志url', 'type' => 'string', 'example' => 'https://xxxxx'], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'FallbackId', - 'in' => 'query', - 'schema' => [ - 'title' => '行为ID。', - 'description' => '行为ID，其中0表示默认行为。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '21', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询本地单个镜像信息', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'TargetType', - 'in' => 'query', - 'schema' => [ - 'title' => '目标规则类型。', - 'description' => '目标规则类型。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 1 => '接口流控', - '熔断规则', - 4 => '热点参数防护（RPC）', - 6 => '并发隔离', - 11 => '热点参数防护（HTTP 请求）', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => '1', ], ], + ], + ], + 'GetImportFileUrl' => [ + 'summary' => '获取Nacos配置导入时获取文件的上传地址。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'Resource', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76156', + 'abilityTreeNodes' => ['FEATUREmseEPOTV0'], + ], + 'parameters' => [ + [ + 'name' => 'ContentType', 'in' => 'query', - 'schema' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'type' => 'string', - 'required' => true, - 'example' => '/a', - ], + 'schema' => ['description' => '文件类型。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'application/zip'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-7pp2b****'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'example' => '12788f73-9848-4388-98f1-507778f2****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -19687,94 +13464,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '响应信息。', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '19488A00-4AF5-55E1-A689-98BA9F5E7441'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'title' => '返回详情。', - 'description' => '返回详情。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => '状态码。', - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => '状态码。', - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => '文件上传地址。', 'type' => 'string', 'example' => 'http://xxxxxxx'], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取文件上传地址', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + '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\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => '绑定流量防护行为', ], - 'ListIsolationRules' => [ - 'summary' => '查询隔离规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetKubernetesSource' => [ + 'summary' => '获取当前所有ACK集群来源信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -19783,408 +13533,146 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '163572', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '24906', + 'abilityTreeNodes' => ['FEATUREmseE7U1OL'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c5d1aadb7df646cfb7065fbf75c1****'], ], [ - 'name' => 'AppName', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => '专有网络vpcid。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1t50e045b5g7i3p****'], ], [ - 'name' => 'ResourceSearchKey', - 'in' => 'query', - 'schema' => [ - 'title' => '查找包含接口关键字的防护规则。', - 'description' => '查找包含接口关键字的防护规则。', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - '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' => '起始页。默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'IsAll', 'in' => 'query', - 'schema' => [ - 'title' => '页大小。默认值为6。', - 'description' => '页大小。默认值为6。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '是否获取所有K8s集群（false时只获取未被关联的集群）。', 'type' => 'boolean', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应码。', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息。', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'title' => '规则信息。', - 'description' => '规则信息。', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'title' => '返回结果。', - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'RuleId' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - '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' => '应用ID。', - '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' => [ - 'description' => '请求来源应用。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - ], - ], - ], - 'PageNumber' => [ - 'title' => '起始页。', - 'description' => '起始页。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页大小。', - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalSize' => [ - 'title' => '规则总数。', - 'description' => '规则总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'description' => '数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'ACK集群名称。', 'type' => 'string', 'example' => 'k8s-demo'], + 'Cluster' => ['description' => 'ACK集群ID。', 'type' => 'string', 'example' => 'cbc1efca895a64af097ff00b26f3f****'], ], ], ], - 'HttpStatusCode' => [ - 'title' => '状态码。', - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询ACK集群来源信息', + '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\\": \\"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' => '获取隔离规则列表', ], - 'CreateIsolationRule' => [ - 'summary' => '创建隔离规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetLocalityRule' => [ + 'summary' => '获取同可用区优先路由规则', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '163570', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '45915', + 'abilityTreeNodes' => ['FEATUREmseZ3XXPX'], 'tenantRelevance' => 'tenant', ], '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', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '隔离规则并发数阈值。', - 'description' => '隔离规则并发数阈值。', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'docRequired' => true, - 'example' => '3', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Enable', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '规则的启用状态。', - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'Resource', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/a', - ], + 'schema' => ['title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 64], ], [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所在地域。', - 'description' => '集群所在地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => false, 'example' => 'hgxznfcvbe@be2c0228f******'], ], [ - 'name' => 'LimitApp', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => '规则来源（非必填）。', 'type' => 'string', 'required' => false, 'example' => 'edasmsc'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -20192,257 +13680,145 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '响应信息。', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Code' => [ - 'title' => '响应码。', - 'description' => '响应码。', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'title' => '规则信息。', - 'description' => '规则信息。', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - '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' => '应用ID。', - 'type' => 'string', - 'example' => 'hpn9ac29kz@e31a4b871******', - ], - 'RegionId' => [ - 'title' => '集群所在地域。', - 'description' => '集群所在地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'LimitApp' => [ - 'type' => 'string', - ], - ], - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'D3971C60-3F07-58B0-8EA0-A194********'], + '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' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'string', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'http状态码。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取同可用区优先路由规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetLocalityRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '创建隔离规则', ], - 'DeleteIsolationRules' => [ - 'summary' => '删除隔离规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetLosslessRuleByApp' => [ + 'summary' => '获取指定应用无损上下线规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '163574', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '173262', + 'abilityTreeNodes' => ['FEATUREmse9OTHB7'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['title' => 'region id, such as cn-hangzhou', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Ids', + 'name' => 'AppName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '待删除的规则ID列表。', - 'description' => '待删除的规则ID列表。', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['title' => 'Key word of search lossless list', 'description' => '应用名。', 'type' => 'string', 'required' => false, 'example' => 'example-app'], ], [ - 'name' => 'AppName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'MSE命名空间名。', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => 'appId', 'description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522baa***'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + .'* zh：中文。'."\n" + .'* en：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult', + 'description' => '返回值。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '返回码。', - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息。', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP状态码。', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'success'], 'Data' => [ - 'title' => '完成删除的规则ID列表。', - 'description' => '完成删除的规则ID列表。', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['title' => 'appName', 'description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'AppId' => ['title' => 'appId', 'description' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@24810bf4364a***'], + 'Count' => ['title' => 'instance\'s count of app', 'description' => '实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Enable' => ['title' => 'rule is open or close', 'description' => '无损上线启用状态。取值：'."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：禁用。', 'type' => 'boolean', 'example' => 'true'], + 'WarmupTime' => ['description' => '预热时长（秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '120'], + 'DelayTime' => ['description' => '延迟注册时间（秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'FuncType' => ['title' => 'warmup function type, 2 means f(x)=x^2', 'description' => '预热曲线斜率。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Aligned' => ['title' => 'microservices lifecycle aligns to k8s\'s or NOT', 'description' => '是否开启“通过就绪检查前完成服务注册”。', 'type' => 'boolean', 'example' => 'true'], + 'Related' => ['title' => 'K8s\'s HPA is related to warmup or NOT', 'description' => '是否开启“通过就绪检查前完成服务预热”。', 'type' => 'boolean', 'example' => 'false'], + 'LossLessDetail' => ['title' => 'show lossLess offline&online detail', 'description' => '是否开启上下线处理明细。', 'type' => 'boolean', 'example' => 'true'], + 'Notice' => ['title' => 'enable lossLess offline active notification', 'description' => '是否开启主动通知。', 'type' => 'boolean', 'example' => 'false'], ], ], ], @@ -20451,153 +13827,163 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取指定应用无损上下线规则', + 'description' => '调用GetLosslessRuleByApp接口来获取指定应用的无损上下线的配置规则。'."\n" + ."\n" + .'优先按AppId查询。'."\n" + ."\n" + .'若AppId为空，使用RegionId+Namespace+AppName查询。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetLosslessRuleByApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '删除隔离规则', ], - 'UpdateIsolationRule' => [ - 'summary' => '更新隔离规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetMseFeatureSwitch' => [ + 'summary' => '获取MSE能力开关。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '163571', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6B4653A3-8D9C-5FDC-BB0C-936D40E9794B'], + 'Result' => ['description' => '返回结果。', 'type' => 'object', 'example' => '{\'nacos_config_encrypt\': False}'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoPermission'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取MSE能力开关', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetMseFeatureSwitch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'GetMseSource' => [ + 'summary' => '查询已有MSE Nacos。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'Threshold', - 'in' => 'query', - 'schema' => [ - 'title' => '隔离规则并发数阈值。', - 'description' => '隔离规则并发数阈值。', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'docRequired' => false, - 'example' => '3', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '24939', + 'abilityTreeNodes' => ['FEATUREmseZM8SC5', 'FEATUREmseRZJSHZ'], + ], + 'parameters' => [ [ - 'name' => 'Enable', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '规则的启用状态。', - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****'], ], [ - 'name' => 'AppId', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522******', - ], + 'schema' => ['description' => 'VPC ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1t50e045b5g7i3p****'], ], [ - 'name' => 'LimitApp', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'MSE引擎类型：'."\n" + ."\n" + .'- NACOS'."\n" + ."\n" + .'- ZOOKEEPER', 'type' => 'string', 'required' => false, 'example' => 'NACOS'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => [ 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['en' => '英文', 'zh' => '中文'], 'example' => 'zh', ], ], @@ -20605,708 +13991,584 @@ 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '响应信息。', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Code' => [ - 'title' => '响应码。', - 'description' => '响应码。', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5EB2D865-B43F-5526-8F92-857718CF73A2'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因，例如：TaskId not found。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'title' => '规则信息。', - 'description' => '规则信息。', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - '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' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - 'LimitApp' => [ - 'type' => 'string', + 'description' => '数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse_prepaid_public_cn-7pp2eec****'], + 'Address' => ['description' => '链接地址。', 'type' => 'string', 'example' => 'mse-af1****-nacos-ans.mse.aliyuncs.com:8848'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'Nacos'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'], + 'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'mse_'], ], ], ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询MSE Nacos来源', + '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\\": \\"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' => '更新隔离规则', ], - 'DeleteCircuitBreakerRules' => [ - 'summary' => '删除熔断规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetNacosConfig' => [ + 'summary' => '获取Nacos配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '167824', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '17035', + 'abilityTreeNodes' => ['FEATUREmseEUE1FY'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-i7m2h0****'], ], [ - 'name' => 'Ids', + 'name' => 'DataId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '待删除的规则ID列表。', - 'description' => '待删除的规则ID列表。', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => '数据ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'halvie-mp-item****'], ], [ - 'name' => 'AppName', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => '配置组信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'common'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b'], + ], + [ + 'name' => 'Beta', + 'in' => 'query', + 'schema' => ['description' => '是否Beta发布，默认为false'."\n" + ."\n" + .'- `true`：是'."\n" + .'- `false`：否', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '完成删除的规则ID列表。', - 'description' => '完成删除的规则ID列表。', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD'], + 'Configuration' => [ + 'description' => '配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '配置内容的格式。', 'type' => 'string', 'example' => 'text'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test'], + 'Tags' => ['description' => '配置的标签。', 'type' => 'string', 'example' => 'context'], + 'Md5' => ['description' => '配置的消息摘要。', 'type' => 'string', 'example' => '123rfsdf3'], + 'DataId' => ['description' => '配置ID。', 'type' => 'string', 'example' => 'log.yaml'], + 'Content' => ['description' => '配置内容。', 'type' => 'string', 'example' => 'log.level=error'], + 'Group' => ['description' => '配置组名称。', 'type' => 'string', 'example' => 'test'], + 'Desc' => ['description' => '配置描述。', 'type' => 'string', 'example' => 'Testdedicateduse'], + 'EncryptedDataKey' => ['description' => '加密密钥。', 'type' => 'string', 'example' => 'key'], + 'BetaIps' => ['description' => 'Beta发布的IP列表。', 'type' => 'string', 'example' => '1.1.XX.XX，2.2.XX.XX'], + 'GrayVersions' => [ + 'title' => '当前配置的灰度版本信息', + 'description' => '当前配置的灰度版本信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '灰度类型', + 'description' => '灰度类型', + 'type' => 'string', + 'enumValueTitles' => ['Tags' => 'Tags', 'Beta' => 'Beta'], + 'example' => 'Beta', + ], + 'Name' => ['title' => '灰度版本名称', 'description' => '灰度版本名称', 'type' => 'string', 'example' => 'test'], + 'Rule' => ['title' => '当前灰度版本的规则', 'description' => '当前灰度版本的规则', 'type' => 'string', 'example' => 'a=b'], + 'Priority' => ['title' => '当前灰度规则的优先级', 'description' => '当前灰度规则的优先级', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], + 'description' => '', + ], + ], ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除流控规则。', - 'methods' => [ - 'get', - 'post', - ], - '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' => '获取Nacos配置', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](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}'], + ], + ], + ], ], + ], + 'GetNacosHistoryConfig' => [ + 'summary' => '查询Nacos配置变更历史列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '159871', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-st220g9ka02'], ], [ - 'name' => 'Ids', + 'name' => 'DataId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '待删除的规则ID列表。', - 'description' => '待删除的规则ID列表。', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => true, - 'docRequired' => true, - 'example' => '[1,2]', - ], + 'schema' => ['description' => '数据ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'msg-center.main.yaml'], ], [ - 'name' => 'AppName', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => '分组。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba'], + ], + [ + 'name' => 'Nid', + 'in' => 'query', + 'schema' => ['description' => '配置单ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '40****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '完成删除的规则ID列表。', - 'description' => '完成删除的规则ID列表。', - 'type' => 'array', - 'items' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Configuration' => [ + 'description' => '配置信息。', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test'], + 'Md5' => ['description' => '配置的消息摘要。', 'type' => 'string', 'example' => '23sdf32f****'], + 'DataId' => ['description' => '配置ID。', 'type' => 'string', 'example' => 'test.yaml'], + 'Content' => ['description' => '配置内容。', 'type' => 'string', 'example' => 'test'], + 'Group' => ['description' => '配置组名称。', 'type' => 'string', 'example' => 'public'], + 'OpType' => ['description' => '配置类型。', 'type' => 'string', 'example' => 'text'], + 'EncryptedDataKey' => ['description' => '加密密钥。', 'type' => 'string', 'example' => '23fds****'], ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoPermission'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询Nacos配置历史', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosHistoryConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除流控规则', ], - 'UpdateFlowRule' => [ - 'summary' => '更新流控规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetOverview' => [ + 'summary' => '查询治理概览信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '159855', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '查询时间。单位：天。比如传入30，说明查询30天内的治理规则情况。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'AppName', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RuleId', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '规则的 ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '13', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Threshold', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '流控规则阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '30', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'Data' => ['description' => '数据概览。', 'type' => 'string', 'example' => 'data'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。'."\n", 'type' => 'string', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', - ], - 'example' => 'true', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询应用概览', + 'description' => '通过GetOverview接口查询服务治理概览信息。', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'ControlBehavior', - 'in' => 'query', - 'schema' => [ - 'description' => '流控效果。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - '快速失败', - 2 => '排队等待', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:GetOverview', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => '0', ], ], + ], + ], + 'GetPluginConfig' => [ + 'summary' => '获取插件配置。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'MaxQueueingTimeMs', - 'in' => 'query', - 'schema' => [ - 'description' => '超时时间，单位毫秒。当controlBehavior类型为（排队等待）时，需要设置该字段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '500', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '128638', + 'abilityTreeNodes' => ['FEATUREmseKZMVG1'], + ], + 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522******', - ], + 'schema' => ['description' => '网关UniqueId。', 'type' => 'string', 'required' => true, 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n"], ], [ - 'name' => 'LimitApp', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => '请求来源应用。', - 'type' => 'string', - 'required' => false, - 'example' => 'Spring-cloud-a', - ], + 'schema' => ['description' => '网关插件ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'zh：中文'."\n" + .'en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'Code。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '500'], + 'HttpStatusCode' => ['description' => 'HTTP STATUS编码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '接口信息。', 'type' => 'string', 'example' => 'success'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误编码。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'message'], 'Data' => [ - 'description' => '节点数据列表。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => '接口资源名。', - 'type' => 'string', - 'example' => '/c', - ], - 'ControlBehavior' => [ - 'description' => '流控效果。', + 'Id' => ['description' => '插件ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PrimaryUser' => ['description' => '创建人ID。', 'type' => 'string', 'example' => '123'], + 'Type' => [ + 'description' => '插件类型：'."\n" + .'- 0：http filter'."\n" + .'- 1：network filte', 'type' => 'integer', 'format' => 'int32', - 'enumValueTitles' => [ - '快速失败', - 2 => '排队等待', - ], + 'enumValueTitles' => [], 'example' => '0', ], - 'MaxQueueingTimeMs' => [ - 'description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Threshold' => [ - 'description' => '流控规则阈值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'Enable' => [ - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '开启', - 'fasle' => '关闭', + 'Category' => ['description' => '插件目录。'."\n" + ."\n" + .'自定义：0'."\n" + ."\n" + .'认证权限：1'."\n" + ."\n" + .'安全防护：2'."\n" + ."\n" + .'传输协议：3'."\n" + ."\n" + .'流量管控：4'."\n" + ."\n" + .'流量观测：5', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Name' => ['description' => '插件名称。', 'type' => 'string', 'example' => 'name'], + 'Version' => ['description' => '插件版本。', 'type' => 'string', 'example' => 'v1'], + 'Summary' => ['description' => '插件概要。', 'type' => 'string', 'example' => 'This is a plugin.'], + 'SummaryEn' => ['description' => '英文插件概要。', 'type' => 'string'], + 'Readme' => ['description' => 'README描述。', 'type' => 'string', 'example' => 'read me'], + 'ReadmeEn' => ['description' => '英文README描述。', 'type' => 'string', 'example' => 'read me'], + 'ConfigExample' => ['title' => '插件配置样例', 'description' => '插件配置样例', 'type' => 'string'], + 'Phase' => ['description' => '插件执行阶段。'."\n" + ."\n" + .'默认阶段：0'."\n" + ."\n" + .'认证阶段：1'."\n" + ."\n" + .'鉴权阶段：2'."\n" + ."\n" + .'统计阶段：3', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Priority' => ['description' => '插件执行优先级。数值越大，优先级越高。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ConfigCheck' => ['description' => '配置校验。', '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'], + 'Mode' => ['description' => '模式。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'WasmLang' => ['description' => 'wasm实现语言。'."\n" + ."\n" + .'C++：0'."\n" + ."\n" + .'TinyGo：1'."\n" + ."\n" + .'Rust：2'."\n" + ."\n" + .'AssemblyScript：3'."\n" + ."\n" + .'Zig：4', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ImageName' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'name'], + 'PublishState' => ['description' => '发布状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Status' => ['description' => '启用状态。'."\n" + ."\n" + .'未启用：0'."\n" + ."\n" + .'启用：1', 'type' => 'string', 'example' => '1'], + 'GatewayConfigList' => [ + 'title' => '网关插件配置规则列表。规则排列顺序为路由级规则、域名级规则、实例级规则', + 'description' => '网关插件配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '插件配置ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GatewayUniqueId' => ['description' => '网关UniqueId。', 'type' => 'string', 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'], + 'PluginId' => ['description' => '网关插件ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Enable' => ['description' => '是否开启。', 'type' => 'boolean', 'example' => 'true'], + 'Config' => ['description' => '插件配置。', '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'], + 'ConfigLevel' => ['description' => '插件应用范围。'."\n" + ."\n" + .'全局：0'."\n" + ."\n" + .'域名：1'."\n" + ."\n" + .'路由：2', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResourceList' => [ + 'title' => '域名/路由资源列表（根据ConfigLevel区分）', + 'description' => '域名/路由资源列表（根据ConfigLevel区分）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '资源ID。', 'type' => 'integer', 'format' => 'int64'], + 'Name' => ['title' => '资源名称（域名/路由名）', 'description' => '资源名称（域名/路由名）', 'type' => 'string', 'example' => 'test-route'], + ], + 'description' => '', + ], + ], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '1667309705000'], + 'GmtModified' => ['description' => '更新时间。', 'type' => 'string', 'example' => '1667309705000'], + ], ], - 'example' => 'true', - ], - 'AppId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hpn9ac29kz@e31a4b871******', ], - 'LimitApp' => [ - 'description' => '请求来源应用。', - 'type' => 'string', - 'example' => 'Spring-cloud-a', - ], - ], - ], - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '请求成功', - 'false' => '请求失败', + 'RouteConfigStartIndex' => ['title' => '路由级规则在GatewayConfigList中的起始下标。若不存在路由级规则，值为-1', 'description' => '路由级规则在GatewayConfigList中的起始下标。若不存在路由级规则，值为-1', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'DomainConfigStartIndex' => ['title' => '域名级规则在GatewayConfigList中的起始下标。若不存在域名级规则，值为-1', 'description' => '域名级规则在GatewayConfigList中的起始下标。若不存在域名级规则，值为-1', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'GatewayConfigStartIndex' => ['title' => '实例规则在GatewayConfigList中的下标。若不存在实例级规则，值为-1', 'description' => '实例规则在GatewayConfigList中的下标。若不存在实例级规则，值为-1', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'VersionJson' => ['description' => '网关插件版本信息列表。', 'type' => 'string', 'example' => '[{"id":1, "version": "1.0.0"}]'], ], - 'example' => 'true', ], ], ], @@ -21314,50 +14576,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取插件配置', + '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\\": \\"请求处理成功\\",\\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' => '更新流控规则', ], - 'ListFlowRules' => [ - 'summary' => '获取流控规则列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetPlugins' => [ + 'summary' => '获取插件市场插件。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21366,474 +14619,385 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '159811', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '128636', + 'abilityTreeNodes' => ['FEATUREmse7RUWJD'], ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'xx-demo', - ], - ], - [ - 'name' => 'ResourceSearchKey', - 'in' => 'query', - 'schema' => [ - 'description' => '搜索关键字。', - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], - ], - [ - 'name' => 'AppId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522******', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****'], ], [ - 'name' => 'Resource', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => '资源名。', - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], + 'schema' => ['description' => '插件类型：'."\n" + ."\n" + .'- 自定义：0'."\n" + ."\n" + .'- 认证权限：1'."\n" + ."\n" + .'- 安全防护：2'."\n" + ."\n" + .'- 传输协议：3'."\n" + ."\n" + .'- 流量管控：4'."\n" + ."\n" + .'- 流量观测：5', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'PageIndex', + 'name' => 'EnableOnly', 'in' => 'query', - 'schema' => [ - 'description' => '目标页号，默认为1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '是否已启用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '分页，每页 N 个。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '插件名称。', 'type' => 'string', 'required' => false, 'example' => 'key-auth'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'zh：中文'."\n" + .'en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '请求成功', - 'false' => '请求失败', - ], - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'."\n"], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'Code。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '500'], + 'HttpStatusCode' => ['description' => 'HTTP STATUS编码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '接口信息。', 'type' => 'string', 'example' => 'success'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'message'], 'Data' => [ - 'description' => '节点数据。', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '返回集合。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'RuleId' => [ - 'description' => '规则ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'AppName' => [ - 'description' => '应用名。', - 'type' => 'string', - 'example' => 'finance', - ], - 'Resource' => [ - 'description' => '接口资源名', - 'type' => 'string', - 'example' => '/a', - ], - 'ResourceType' => [ - 'description' => '接口资源分类', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ControlBehavior' => [ - 'description' => '流控效果。', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '快速失败', - 2 => '排队等待', - ], - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Threshold' => [ - 'description' => '流控规则阈值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'Enable' => [ - 'description' => '规则启用状态。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '启用', - 'false' => '关闭', - ], - 'example' => 'true', - ], - 'AppId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@5f1b08becb*****', - ], - 'RegionId' => [ - 'description' => '地域ID。', - '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}"', - ], - 'MetricType' => [ - 'description' => '统计维度，1表示通过请求数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TrafficTags' => [ - 'description' => '预留字段。', - 'type' => 'object', - 'example' => '{\\"origin\\":\\"default\\"}', - ], - 'LimitApp' => [ - 'description' => '请求来源应用。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalSize' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '插件ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PrimaryUser' => ['description' => '创建人ID。', 'type' => 'string', 'example' => '123'], + 'Category' => ['description' => '插件类型：'."\n" + ."\n" + .'自定义：0'."\n" + ."\n" + .'认证权限：1'."\n" + ."\n" + .'安全防护：2'."\n" + ."\n" + .'传输协议：3'."\n" + ."\n" + .'流量管控：4'."\n" + ."\n" + .'流量观测：5', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Name' => ['description' => '插件名称。', 'type' => 'string', 'example' => 'key-auth'], + 'Version' => ['description' => '插件版本。', 'type' => 'string', 'example' => 'v1'], + 'Summary' => ['description' => '插件概要。', 'type' => 'string', 'example' => 'This is a plugin.'], + 'SummaryEn' => ['description' => '英文插件概要。', 'type' => 'string'], + 'Phase' => ['description' => '插件执行阶段：'."\n" + ."\n" + .'- 默认阶段：0'."\n" + ."\n" + .'- 认证阶段：1'."\n" + ."\n" + .'- 鉴权阶段：2'."\n" + ."\n" + .'- 统计阶段：3', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Priority' => ['description' => '插件执行优先级。数值越大，优先级越高。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ConfigCheck' => ['description' => '配置校验。', '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'], + 'WasmLang' => ['description' => 'Wasm实现语言：'."\n" + ."\n" + .'- C++：0'."\n" + ."\n" + .'- TinyGo：1'."\n" + ."\n" + .'- Rust：2'."\n" + ."\n" + .'- AssemblyScript：3'."\n" + ."\n" + .'- Zig：4', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'PublishState' => ['description' => '发布状态：'."\n" + .'- 0：成功'."\n" + .'- 1：发布中'."\n" + .'- 2：发布失败', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'WasmFile' => ['description' => 'Wasm插件OSS。', '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' => '启用状态。'."\n" + ."\n" + .'- 未启用：0'."\n" + ."\n" + .'- 启用：1', 'type' => 'string', 'example' => '1'], + 'Mode' => ['description' => '插件语言：'."\n" + ."\n" + .'- 0：WASM插件'."\n" + .'- 2：LUA插件', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'MaxVersion' => ['description' => '最新版本。', 'type' => 'string', 'example' => '1.0.0'], + 'NewVersionPublishingFlag' => ['description' => '最新版本是否正在发布中。', 'type' => 'boolean', 'example' => 'false'], ], ], ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取插件列表', + '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\\": \\"请求处理成功\\",\\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' => '获取流控规则列表', ], - 'CreateFlowRule' => [ - 'summary' => '创建流控规则。', - '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' => 'create', - 'abilityTreeCode' => '163217', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '17043', + 'abilityTreeNodes' => ['FEATUREmseW9QIF2'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou'], ], [ - 'name' => 'AppName', + 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'description' => '应用名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => '框架类型。', 'type' => 'string', 'required' => false, 'example' => 'dubbo'], ], [ - 'name' => 'Threshold', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '流控规则阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => 'xxx@xxx'], ], [ - 'name' => 'Enable', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'required' => true, - 'enumValueTitles' => [ - 'true' => '启用', - 'false' => '禁用', - ], - 'example' => 'false', - ], + 'schema' => ['description' => '服务名。', 'type' => 'string', 'required' => false, 'example' => 'com.alibaba.xxx'], ], [ - 'name' => 'Resource', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'description' => '接口资源名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/b', - ], + 'schema' => ['description' => 'IP地址。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], ], [ - 'name' => 'AppId', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '语言类型。', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ib09eblv6p@c3df23522******', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EdasAppName' => ['description' => '应用名。', 'type' => 'string', 'example' => 'test'], + 'DubboApplicationName' => ['description' => 'Dubbo应用名。', 'type' => 'string', 'example' => 'dubbo-application'], + 'Version' => ['description' => '版本信息。', 'type' => 'string', 'example' => '1.0.0'], + 'SpringApplicationName' => ['description' => 'Spring应用名。', 'type' => 'string', 'example' => 'spring-application'], + 'RegistryType' => ['description' => '注册中心类型。', 'type' => 'string', 'example' => 'nacos'], + 'ServiceType' => ['description' => '服务类型。', 'type' => 'string', 'example' => 'dubbo'], + 'ServiceName' => ['description' => '服务名。', 'type' => 'string', 'example' => 'com.alibaba.xxx'], + 'Methods' => [ + 'description' => '方法列表。', + 'type' => 'array', + 'items' => [ + 'description' => '方法列表。', + 'type' => 'object', + 'properties' => [ + 'Paths' => [ + 'description' => '路径。', + 'type' => 'array', + 'items' => ['description' => '服务映射地址。', 'type' => 'string', 'example' => '/path'], + ], + 'ParameterTypes' => [ + 'description' => '参数类型。', + 'type' => 'array', + 'items' => ['description' => '参数类型。', 'type' => 'string', 'example' => 'int'], + ], + 'RequestMethods' => [ + 'description' => '方法。', + 'type' => 'array', + 'items' => ['description' => '方法。', 'type' => 'string', 'example' => 'sayHello'], + ], + 'Name' => ['description' => '方法名。', 'type' => 'string', 'example' => 'sayHello'], + 'MethodController' => ['description' => '方法接口。', 'type' => 'string', 'example' => 'com.alibaba.SayHelloController'], + 'ReturnType' => ['description' => '返回值类型。', 'type' => 'string', 'example' => 'int'], + ], + ], + ], + 'Metadata' => ['description' => '元数据。', 'type' => 'object', 'example' => '{}'], + 'Group' => ['description' => '分组。', 'type' => 'string', 'example' => 'dubbo'], + ], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '调用成功与否。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'ControlBehavior', - 'in' => 'query', - 'schema' => [ - 'description' => '流控效果。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - '快速失败', - 2 => '排队等待', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询应用服务信息', + 'summary' => '通过GetServiceList接口查询应用服务信息。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => '0', - 'default' => '0', ], ], + ], + ], + 'GetServiceListPage' => [ + 'summary' => '获取服务列表', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'MaxQueueingTimeMs', - 'in' => 'query', - 'schema' => [ - 'description' => '超时时间，流控效果为排队等待时需要设置，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17044', + 'abilityTreeNodes' => ['FEATUREmseXPQ6HT'], + ], + 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '地域。', 'description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceType', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '接口资源分类。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '0', - '1', - '2', - '4', - '3', - ], - ], + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'LimitApp', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '请求来源应用。', - 'type' => 'string', - 'required' => false, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['title' => '应用名字。', 'description' => '应用名字。', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 100], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => ['title' => '服务类型。', 'description' => '服务类型。', 'type' => 'string', 'required' => false, 'example' => 'springCloud'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '应用id。', 'description' => '应用id。', 'type' => 'string', 'required' => false, 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx'], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['title' => '服务名字。', 'description' => '服务名字。', 'type' => 'string', 'required' => false, 'example' => 'sc-A'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '页数。', 'description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页大小。', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['title' => '要查询的ip地址。', 'description' => '要查询的ip地址。', 'type' => 'string', 'required' => false, 'example' => '223.5.5.5'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -21841,576 +15005,242 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => '200', - ], + 'Success' => ['title' => '请求是否成功。', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], + 'Message' => ['title' => '请求信息。', 'description' => '请求信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求id。', 'description' => '请求id。', 'type' => 'string', 'example' => 'A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx'], 'Data' => [ - 'description' => '返回数据。', + 'title' => '请求响应数据。', + 'description' => '请求响应数据。', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => '接口资源名。', - 'type' => 'string', - 'example' => 'app', - ], - 'ControlBehavior' => [ - 'description' => '流控效果。', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '快速失败', - 2 => '排队等待', - ], - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Threshold' => [ - 'description' => '流控规则阈值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '200', - ], - 'Enable' => [ - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', + 'Result' => [ + 'title' => '当前页面数据。', + 'description' => '当前页面数据。', + 'type' => 'array', + 'items' => [ + 'title' => '每个服务的信息。', + 'description' => '每个服务的信息。', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['title' => '应用名。', 'description' => '应用名。', 'type' => 'string', 'example' => 'example-app'], + 'Version' => ['title' => '服务版本。', 'description' => '服务版本。', 'type' => 'string', 'example' => '1'], + 'InstanceNum' => ['title' => '服务对应的节点数。', 'description' => '服务对应的节点数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GmtModifyTime' => ['title' => '服务最后的更新时间。', 'description' => '服务最后的更新时间。', 'type' => 'string', 'example' => '123456'], + 'AppId' => ['title' => '应用id。', 'description' => '应用id。', 'type' => 'string', 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx'], + 'ServiceName' => ['title' => '服务名。', 'description' => '服务名。', 'type' => 'string', 'example' => 'sc-A'], + 'Group' => ['title' => '服务分组。', 'description' => '服务分组。', 'type' => 'string', 'example' => 'DEFAULT_GROUP'], + 'ServiceType' => ['description' => '服务类型。', 'type' => 'string'], + ], ], - 'example' => 'true', - ], - 'AppId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@54e1f42f3******', - ], - 'RegionId' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'LimitApp' => [ - 'description' => '请求来源应用。', - 'type' => 'string', - 'example' => 'spring-cloud-a', ], + 'TotalSize' => ['title' => '数据总数。', 'description' => '数据总数。', 'type' => 'string', 'example' => '100'], + 'PageNumber' => ['title' => '当前页码。', 'description' => '当前页码。', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['title' => '页面大小。', 'description' => '页面大小。', 'type' => 'string', 'example' => '10'], ], ], - 'Success' => [ - 'description' => '请求结果。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取服务列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceListPage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '创建流控规则', ], - 'CreateCircuitBreakerRule' => [ - 'summary' => '创建熔断规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetServiceListeners' => [ + 'summary' => '获取目标服务的监听者列表。', + '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', + 'operationType' => 'get', + 'abilityTreeCode' => '137871', + 'abilityTreeNodes' => ['FEATUREmseXDLQRG'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['title' => '查询指定的服务名信息', 'description' => '查询指定的服务名信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zeekr-orderboss'], ], [ - 'name' => 'AppName', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['title' => '服务所在的分组', 'description' => '服务所在的分组。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WEB_GROUP'], ], [ - 'name' => 'Threshold', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'docRequired' => true, - 'example' => '0.8', - ], + 'schema' => ['title' => '服务所在的 namespace', 'description' => '服务所在的 namespace。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b'], ], [ - 'name' => 'Enable', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'title' => '规则的启用状态。', - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'required' => true, - 'enumValueTitles' => [ - 'true' => '启用', - 'false' => '关闭', - ], - 'example' => 'true', - ], + 'schema' => ['title' => '查询服务下某个集群的实例列表是所需要的参数', 'description' => '服务所属集群名字。'."\n" + .'> 此处集群为nacos服务中的概念，非MSE集群。', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], ], [ - 'name' => 'Resource', + 'name' => 'HasIpCount', 'in' => 'query', - 'schema' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/a', - ], + 'schema' => ['description' => '保留字段。', 'type' => 'string', 'required' => false, 'example' => 'none'], ], [ - 'name' => 'AppId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], + 'schema' => ['title' => '当前查询服务的集群标识', 'description' => '待查询服务所属的MSE集群ID。'."\n" + .'> InstanceId与ClusterId其中一个必填。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'RegionId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群所在地域。', - 'description' => '集群所在地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '当前查询服务的集群标识', 'description' => '当前查询服务的集群ID。'."\n" + .'> InstanceId与ClusterId其中一个必填。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-tl32odtt20j'], ], [ - 'name' => 'Strategy', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - '慢调用比例', - '异常比例', - ], - 'example' => '0', - ], + 'schema' => ['title' => '查询第几页', 'description' => '查询第几页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'RetryTimeoutMs', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', - 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['title' => '每页展示条数', 'description' => '每页展示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'StatIntervalMs', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20000', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'MaxAllowedRtMs', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', - 'description' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'MinRequestAmount', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', - 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => 'RegCenterOperatorResult', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Addr' => ['title' => '地址', 'description' => '监听者的地址。', 'type' => 'string', 'example' => '119.23.84.102'], + 'Agent' => ['title' => '客户端版本', 'description' => '监听者客户端版本。', 'type' => 'string', 'example' => 'Nacos-Java-Client:v2.1.1'], + 'App' => ['title' => '应用', 'description' => '监听者的应用名称。', 'type' => 'string', 'example' => 'app'], + 'IP' => ['title' => 'ip地址', 'description' => '被监听服务的IP地址。', 'type' => 'string', 'example' => '172.16.1.5'], + 'Port' => ['title' => '端口号', 'description' => '被监听服务的端口号。', 'type' => 'string', 'example' => '8080'], + 'NamespaceId' => ['title' => '命名空间id', 'description' => '命名空间ID。', 'type' => 'string', 'example' => '0ba53825-b183-414f-a6a0-288e4f1c467e'], + 'ServiceName' => ['title' => '服务名称', 'description' => '被监听服务的名称。', 'type' => 'string', 'example' => 'zeekr-orderboss'], + 'Cluster' => ['title' => '集群名称', 'description' => '被监听服务所属集群名字。', 'type' => 'string', 'example' => 'DEFAULT'], + ], + ], + ], + 'PageNumber' => ['title' => '实例列表的页码', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['title' => '查询到的实例总数', 'description' => '查询到的监听者数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageSize' => ['title' => '输入时设置的每页行数', 'description' => '每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'HalfOpenBaseAmountPerStep', - 'in' => 'query', - 'schema' => [ - 'title' => '熔断恢复每步最小通过数目，默认值为1。', - 'description' => '熔断恢复每步最小通过数目，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取nacos服务监听者', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'HalfOpenRecoveryStepNum', - 'in' => 'query', - 'schema' => [ - 'title' => '熔断恢复阶段数，默认值为1。', - 'description' => '熔断恢复阶段数，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '资源类型。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '自定义接口', - 'WEB', - 'RPC', - 'ROUTE', - 'SQL', - ], - 'example' => '0', - 'enum' => [ - '0', - '1', - '2', - '4', - '3', - ], - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'title' => '响应信息。', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Code' => [ - 'title' => '响应码。', - 'description' => '响应码。', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'title' => '规则信息。', - 'description' => '规则信息。', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'type' => 'string', - 'example' => '/a', - ], - 'StatIntervalMs' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'Threshold' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.8', - ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Strategy' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '慢调用比例', - '异常比例', - ], - 'example' => '0', - ], - 'RetryTimeoutMs' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - 'RegionId' => [ - 'title' => '集群所在地域。', - 'description' => '集群所在地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'MaxAllowedRtMs' => [ - 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', - 'description' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'MinRequestAmount' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'HalfOpenBaseAmountPerStep' => [ - 'title' => '熔断恢复每步最小通过数目。', - 'description' => '熔断恢复每步最小通过数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'HalfOpenRecoveryStepNum' => [ - 'title' => '熔断恢复阶段数。', - 'description' => '熔断恢复阶段数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '请求成功', - 'false' => '请求失败', - ], - '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', + '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 \\"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' => '创建熔断规则', ], - 'ListCircuitBreakerRules' => [ - 'summary' => '获取熔断规则列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetServiceMethodPage' => [ + 'summary' => '获取服务接口列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -22418,103 +15248,82 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '167823', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none'], 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => ['title' => '服务类型。', 'description' => '服务类型。', 'type' => 'string', 'required' => false, 'example' => 'springCloud'], + ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['title' => '应用所属的MSE命名空间。', 'description' => '应用所属的MSE命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 64], ], [ - 'name' => 'ResourceSearchKey', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '查找包含接口关键字的防护规则。', - 'description' => '查找包含接口关键字的防护规则。', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], + 'schema' => ['title' => '应用id。', 'description' => '应用id。', 'type' => 'string', 'required' => false, 'example' => 'hkhonxxxxx@f3f75ed8ffxxxxx'], ], [ - 'name' => 'AppId', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], + 'schema' => ['title' => '服务名。', 'description' => '服务名。', 'type' => 'string', 'required' => false, 'example' => 'sc-A'], ], [ - 'name' => 'Resource', + 'name' => 'ServiceVersion', 'in' => 'query', - 'schema' => [ - 'title' => '查找指定接口的防护规则。', - 'description' => '查找指定接口的防护规则。', - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], + 'schema' => ['title' => '服务版本。', 'description' => '服务版本。', 'type' => 'string', 'required' => false, 'example' => '1.0.0'], ], [ - 'name' => 'PageIndex', + 'name' => 'ServiceGroup', 'in' => 'query', - 'schema' => [ - 'title' => '起始页。', - 'description' => '起始页。默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '服务分组。', 'description' => '服务分组。', 'type' => 'string', 'required' => false, 'example' => 'ALIYUN'], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['title' => '服务提供者ip。', 'description' => '服务提供者ip。', 'type' => 'string', 'required' => false, 'example' => '223.5.5.5'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '获取第几页的数据。', 'description' => '获取第几页的数据。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '65536', 'minimum' => '1', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '页大小。', - 'description' => '页大小。默认值为6。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '每一页多少条。', 'description' => '每一页多少条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '65536', 'minimum' => '1', 'example' => '10'], + ], + [ + 'name' => 'MethodController', + 'in' => 'query', + 'schema' => ['title' => '接口所在的Controller类全称。', 'description' => '接口所在的Controller类全称。', 'type' => 'string', 'required' => false, 'example' => 'com.alibabacloud.mse.demo.a.AController'], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => ['title' => '接口对应的请求路径。', 'description' => '接口对应的请求路径。', 'type' => 'string', 'required' => false, 'example' => '/a'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '方法名。', 'description' => '方法名。', 'type' => 'string', 'required' => false, 'example' => 'aMethod'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -22522,950 +15331,738 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '响应码。', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息。', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', - ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['title' => '请求是否成功。', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], + 'Message' => ['title' => '请求信息。', 'description' => '请求信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求id。', 'description' => '请求id。', 'type' => 'string', 'example' => '2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1'], 'Data' => [ - 'title' => '规则信息。', - 'description' => '规则信息。', + 'title' => '请求响应数据。', + 'description' => '请求响应数据。', 'type' => 'object', 'properties' => [ 'Result' => [ - 'title' => '返回结果。', - 'description' => '返回结果。', + 'title' => '方法描述列表。', + 'description' => '方法描述列表。', 'type' => 'array', 'items' => [ + 'title' => '每个方法描述。', + 'description' => '每个方法描述。', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'example' => 'default', + 'NameDetail' => ['title' => '接口描述信息。', 'description' => '接口描述信息。', 'type' => 'string', 'example' => 'sample description'], + 'ParameterDetails' => [ + 'title' => '接口参数类型。', + 'description' => '接口参数类型。', + 'type' => 'array', + 'items' => ['title' => '每个参数的类型。', 'description' => '每个参数的类型。', 'type' => 'string', 'example' => 'java.lang.String'], ], - 'RuleId' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + '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' => 'sample description'], + 'Name' => ['title' => '参数名字。', 'description' => '参数名字。', 'type' => 'string', 'example' => 'aParam'], + ], + ], ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', + 'Paths' => [ + 'title' => '接口对应的请求路径列表。', + 'description' => '接口对应的请求路径列表。', + 'type' => 'array', + 'items' => ['title' => '接口对应的请求路径。', 'description' => '接口对应的请求路径。', 'type' => 'string', 'example' => '/a'], ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'type' => 'string', - 'example' => '/a', + 'ParameterTypes' => [ + 'title' => '参数类型。', + 'description' => '参数类型。', + 'type' => 'array', + 'items' => ['title' => '参数类型。', 'description' => '参数类型。', 'type' => 'string', 'example' => 'java.lang.String'], ], - 'ResourceType' => [ - 'description' => '接口资源分类。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Strategy' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '慢调用比例', - '异常比例', - ], - 'example' => '0', - ], - 'Threshold' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.8', - ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RetryTimeoutMs' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'StatIntervalMs' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - '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}"', - ], - 'MaxAllowedRtMs' => [ - 'title' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', - 'description' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'MinRequestAmount' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'HalfOpenBaseAmountPerStep' => [ - 'title' => '熔断恢复每步最小通过数目。', - 'description' => '熔断恢复每步最小通过数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'HalfOpenRecoveryStepNum' => [ - 'title' => '熔断恢复阶段数。', - 'description' => '熔断恢复阶段数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'RequestMethods' => [ + 'title' => 'HTTP请求方法。', + 'description' => 'HTTP请求方法。', + 'type' => 'array', + 'items' => ['title' => 'HTTP请求参数。', 'description' => 'HTTP请求参数。', 'type' => 'string', 'example' => 'GET'], ], + 'ReturnDetails' => ['title' => '返回值类型。', 'description' => '返回值类型。', 'type' => 'string', 'example' => 'java.lang.String'], + 'Name' => ['title' => '方法名。', 'description' => '方法名。', 'type' => 'string', 'example' => 'aMethod'], + 'MethodController' => ['title' => '接口所在的Controller类全称。', 'description' => '接口所在的Controller类全称。', 'type' => 'string', 'example' => 'com.alibabacloud.mse.demo.a.AController'], + 'ReturnType' => ['title' => '返回值类型。', 'description' => '返回值类型。', 'type' => 'string', 'example' => 'java.lang.String'], ], ], ], - 'PageNumber' => [ - 'title' => '起始页。', - 'description' => '起始页。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页大小。', - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalSize' => [ - 'title' => '总页数。', - 'description' => '总页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + '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'], ], ], - 'HttpStatusCode' => [ - 'title' => '状态码。', - 'description' => '状态码。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '获取服务方法列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceMethodPage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取熔断规则列表', ], - 'UpdateCircuitBreakerRule' => [ - 'summary' => '更新熔断规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'GetTagsBySwimmingLaneGroupId' => [ + 'summary' => '用于获取当前泳道组内的所有标签。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '167822', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的微服务命空间。', - 'description' => '应用所属的微服务命空间。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '泳道组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '154'], ], [ - 'name' => 'AppName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['title' => '需要查询的MSE命名空间名字', 'description' => '需要查询的MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'Threshold', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => '0.8', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Data' => [ + 'description' => '标签数据。', + 'type' => 'array', + 'items' => ['description' => '标签数据。', 'type' => 'string', 'example' => '[{"desc":"k8s-pod-label","priority":100,"tag":"gray","type":"tag"}]'], + 'example' => '["gray"]', + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => '规则的启用状态。', - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取当前泳道组内的所有标签', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetTagsBySwimmingLaneGroupId', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => 'true', ], ], + ], + ], + 'GetZookeeperDataImportUrl' => [ + 'summary' => '获取上传数据文件的URL，用户能通过此URL上传Zookeeper待导入的数据文件。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https', 'wss'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'AppId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '146920', + 'abilityTreeNodes' => ['FEATUREmseBQYNCQ'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-zvp2xzzkk06'], ], [ - 'name' => 'Strategy', + 'name' => 'ContentType', 'in' => 'query', - 'schema' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '慢调用比例', - '异常比例', - ], - 'example' => '0', - ], + 'schema' => ['description' => '文件类型。', 'type' => 'string', 'required' => false, 'example' => 'zip'], ], [ - 'name' => 'RetryTimeoutMs', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', - 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E4E2058F-C524-5C29-9BC7-5874EA8D7CE2'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'Code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => '文件上传地址。', 'type' => 'string', 'example' => 'http://xxxxxxxxx'], + 'MaxSize' => ['description' => '允许上传文件的最大大小（单位MB）。', 'type' => 'string', 'example' => '250000'], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'StatIntervalMs', - 'in' => 'query', - 'schema' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20000', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取Zookeeper数据导入URL', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetZookeeperDataImportUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ImportNacosConfig' => [ + 'summary' => '使用配置文件导入Nacos配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '76157', + 'abilityTreeNodes' => ['FEATUREmseEPOTV0'], + ], + 'parameters' => [ [ - 'name' => 'MaxAllowedRtMs', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', - 'description' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-****'], ], [ - 'name' => 'MinRequestAmount', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', - 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'example' => 'f5cdc80a-****-8094-282f5650fc00'], ], [ - 'name' => 'HalfOpenBaseAmountPerStep', + 'name' => 'Policy', 'in' => 'query', 'schema' => [ - 'title' => '熔断恢复每步最小通过数目，默认值为1。', - 'description' => '熔断恢复每步最小通过数目，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '策略。', + 'type' => 'string', 'required' => false, - 'example' => '5', + 'docRequired' => true, + 'enumValueTitles' => ['ABORT' => 'ABORT', 'OVERWRITE' => 'OVERWRITE', 'SKIP' => 'SKIP'], + 'example' => 'OVERWRITE', ], ], [ - 'name' => 'HalfOpenRecoveryStepNum', + 'name' => 'FileUrl', 'in' => 'query', - 'schema' => [ - 'title' => '熔断恢复阶段数，默认值为1。', - 'description' => '熔断恢复阶段数，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '导入文件地址必须为MSE生成的地址（否则提示无权限）。'."\n" + .'获取步骤：'."\n" + ."\n" + .'1.GetImportFileUrl API获取到地址。'."\n" + ."\n" + .'2.通过标准的HTTP PUT方法将文件上传到上述API返回的HTTP地址。'."\n" + ."\n" + .'3.调用ImportNacosConfig API导入。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'http://mse-shared.oss-xxx.aliyuncs.com/cfg/import/xxxx/2021/01/11/xxxx.zip'], ], [ - 'name' => 'RuleId', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-100'], + 'Code' => ['description' => '代码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的 **%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'description' => '规则信息。', + 'description' => '数据概览。', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的微服务命名空间。', - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'Id' => [ - 'title' => '规则ID。', - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'title' => '应用名称。', - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'type' => 'string', - 'example' => '/a', - ], - 'Strategy' => [ - 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '慢调用比例', - '异常比例', + 'SuccCount' => ['description' => '导入成功的实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'SkipCount' => ['description' => '跳过消息数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'SkipData' => [ + 'description' => '跳过的配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'DataId' => ['description' => '数据ID。', 'type' => 'string', 'example' => 'test.yaml'], + 'Group' => ['description' => '分组ID。', 'type' => 'string', 'example' => 'public '], + ], ], - 'example' => '0', - ], - 'Threshold' => [ - 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.8', - ], - 'Enable' => [ - 'title' => '规则的启用状态。', - 'description' => '规则的启用状态。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RetryTimeoutMs' => [ - 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'StatIntervalMs' => [ - 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@c3df23522bXXXXX', - ], - 'MaxAllowedRtMs' => [ - 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', - 'description' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'MinRequestAmount' => [ - 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'HalfOpenBaseAmountPerStep' => [ - 'title' => '熔断恢复每步最小通过数目。', - 'description' => '熔断恢复每步最小通过数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', ], - 'HalfOpenRecoveryStepNum' => [ - 'title' => '熔断恢复阶段数。', - 'description' => '熔断恢复阶段数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'FailData' => [ + 'description' => '导入失败列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'DataId' => ['description' => '数据ID。', 'type' => 'string', 'example' => 'test2.yaml'], + 'Group' => ['description' => '分组ID。', 'type' => 'string', 'example' => 'test'], + 'Reason' => ['description' => '失败原因', 'type' => 'string', 'example' => 'The import configuration format is incorrect.'], + ], + ], ], ], ], - 'Success' => [ - 'title' => '请求结果。', - 'description' => '请求结果。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '请求成功', - 'false' => '请求失败', - ], - 'example' => 'true', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '导入Nacos配置', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](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' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '更新熔断规则', ], - 'ListWebFlowRules' => [ - 'summary' => '查询热点参数防护规则（HTTP 请求）。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ImportServices' => [ + 'summary' => '订阅导入网关的服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '164286', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '25182', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'ServiceList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '命名空间。', - 'type' => 'string', + 'description' => '服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '服务名。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'public'], + 'GroupName' => ['description' => '分组。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Ips' => [ + 'description' => 'IP列表。', + 'type' => 'array', + 'items' => ['description' => 'IP。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'], + 'required' => false, + ], + 'ServicePort' => ['title' => '服务的端口', 'description' => '服务的端口。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8080'], + 'ServiceProtocol' => ['title' => '服务的协议版本', 'description' => '服务的协议版本。', 'type' => 'string', 'required' => false, 'example' => 'GRPC, HTTP'], + 'DnsServerList' => [ + 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'description' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'type' => 'array', + 'items' => ['title' => 'DNS服务器地址（IP+端口）', 'description' => 'DNS服务器地址（IP+端口）', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1:80'], + 'required' => false, + ], + 'SaeAppId' => ['description' => 'SAE应用ID。', 'type' => 'string', 'required' => false], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'default', - 'default' => 'default', + 'example' => 'DNS', ], ], [ - 'name' => 'AppName', + 'name' => 'SourceType', 'in' => 'query', 'schema' => [ - 'description' => '应用名称。', + 'title' => '服务来源', + 'description' => '服务来源：'."\n" + ."\n" + .'- MSE（MSE-NACOS）'."\n" + .'- K8s（ACK容器服务）'."\n" + .'- VIP（固定地址）'."\n" + .'- DNS（DNS域名）', 'type' => 'string', 'required' => true, - 'example' => 'spring-cloud-a', + 'docRequired' => true, + 'enumValueTitles' => ['EDAS' => 'EDAS', 'MSE_ZK' => 'MSE_ZK', 'SAE' => 'SAE', 'K8S' => 'K8S', 'DNS' => 'DNS', 'VIP' => 'VIP', 'MSE' => 'MSE'], + 'example' => 'DNS', ], ], [ - 'name' => 'ResourceSearchKey', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '查找包含接口关键字的防护规则（与Resource不可同时存在）。', - 'type' => 'string', - 'required' => false, - 'example' => 'flow', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5'], ], [ - 'name' => 'AppId', + 'name' => 'TlsSetting', 'in' => 'query', - 'schema' => [ - 'description' => '应用Id', - 'type' => 'string', - 'required' => false, - 'example' => 'b22qb1****@2f0586be4b1****', - ], + 'schema' => ['description' => 'TLS设定。'."\n" + ."\n" + .'- TLS模式：mode'."\n" + ."\n" + .'- 证书ID：certId'."\n" + ."\n" + .'- CA证书ID：caCertId'."\n" + ."\n" + .'- CA证书公钥：caCertContent'."\n" + ."\n" + .'- 服务名称标识：sni', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "mode": "MUTUAL",'."\n" + .' "certId": "1*****-cn-hangzhou",'."\n" + .' "caCertContent": "123",'."\n" + .' "sni": "ceshi"'."\n" + .'}'], ], [ - 'name' => 'Resource', + 'name' => 'FcServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '查找指定接口的防护规则（与ResourceSearchKey不可同时存在）。', - 'type' => 'string', - 'required' => false, - 'example' => '/flow', - ], + 'schema' => ['description' => 'FC服务名称，服务来源为“FC 函数计算”时使用。', 'type' => 'string', 'required' => false, 'example' => 'guide'], ], [ - 'name' => 'PageIndex', + 'name' => 'FcVersion', 'in' => 'query', - 'schema' => [ - 'description' => '起始页。默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'FC服务版本号，服务来源为“FC 函数计算”时使用。', 'type' => 'string', 'required' => false, 'example' => 'LATEST'], ], [ - 'name' => 'PageSize', + 'name' => 'FcAlias', 'in' => 'query', - 'schema' => [ - 'description' => '分页，每页 N 个。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'FC服务别名，服务来源为“FC 函数计算”时使用。', 'type' => 'string', 'required' => false, 'example' => 'test-alias'], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['title' => '服务来源ID，指定来源添加服务时使用', 'description' => '服务来源ID，指定来源添加服务时使用', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Succ'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回结果。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建网关服务', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:ImportServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + 'ImportZookeeperData' => [ + 'summary' => '发起Zookeeper数据导入任务，使Zookeeper集群开始导入目标URL内的数据。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '146919', + 'abilityTreeNodes' => ['FEATUREmseBQYNCQ'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-u0t2xzvxa06'], + ], + [ + 'name' => 'FileUrl', + 'in' => 'query', + 'schema' => ['description' => '源数据链接。'."\n" + .'> 需要使用通过GetZookeeperDataImportUrl接口生成的URL', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxxxxxxx'], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => '需导入的文件名称。', 'type' => 'string', 'required' => false, 'example' => 'snapshot.5'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求Id。', - 'type' => 'string', - 'example' => '4AE73569-304C-5AA9-AE11-C1D99C7D1689', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - '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' => '规则Id', - 'type' => 'string', - 'example' => '1', - ], - 'AppName' => [ - 'description' => '应用名。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => '接口资源名', - 'type' => 'string', - 'example' => '/flow', - ], - 'ResourceType' => [ - 'description' => '资源类型'."\n" - ."\n" - .'- 0(自定义接口)'."\n" - .'- 1(WEB)'."\n" - .'- 2(RPC)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ControlBehavior' => [ - 'description' => '流控方式'."\n" - ."\n" - .'- 0(快速失败)'."\n" - .'- 2(排队等待)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Burst' => [ - 'description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ResourceMode' => [ - 'description' => '资源模式'."\n" - ."\n" - .'- 0(资源名模式)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Threshold' => [ - 'description' => '阈值', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'Enable' => [ - 'description' => '开启或关闭。'."\n" - ."\n" - .'- `true`：开启。'."\n" - .'- `false`：关闭。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParamItem' => [ - 'description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" - .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" - .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" - .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" - .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', - 'type' => 'string', - 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', - ], - 'AppId' => [ - 'description' => '应用Id。', - 'type' => 'string', - 'example' => 'hkhon1XXXX@c3df23522bXXXXX', - ], - 'MetricType' => [ - 'description' => '阈值类型'."\n" - ."\n" - .'- 1(请求数)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RegionId' => [ - 'description' => '地域Id。', - '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', - ], - ], - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'Data' => ['description' => '数据概览。', 'type' => 'any', 'example' => 'null'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '发起Zookeeper数据导入', + 'description' => '>此操作会清空原有数据，请谨慎操作>', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ImportZookeeperData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询热点参数防护规则（HTTP）', ], - 'CreateWebFlowRule' => [ - 'summary' => '创建热点参数防护规则（HTTP 请求）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'InitializeServiceLinkRole' => [ + 'summary' => '创建MSE SLR。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['common'], 'security' => [ [ 'AK' => [], @@ -23474,252 +16071,153 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '164156', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17049', + 'abilityTreeNodes' => ['FEATUREmseRIJL6U'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'Token', 'in' => 'query', - 'schema' => [ - 'title' => '命名空间', - 'description' => '命名空间', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'default', - 'default' => 'default', - ], + 'schema' => ['description' => '保留参数，暂未使用', 'type' => 'string', 'required' => false, 'example' => '""'], ], [ - 'name' => 'AppName', + 'name' => 'RoleName', 'in' => 'query', - 'schema' => [ - 'title' => '应用名', - 'description' => '应用名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => '服务角色名称，固定为AliyunServiceRoleForMSE', 'type' => 'string', 'required' => false, 'example' => 'AliyunServiceRoleForMSE'], ], [ - 'name' => 'Threshold', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '阈值', - 'description' => '阈值', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'docRequired' => true, - 'example' => '20', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A5E7D4E3-D30C-56C1-817F-F2B8CE6BXXXX'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'RoleName' => ['description' => '创建的角色名称。', 'type' => 'string', 'example' => 'AliyunServiceRoleForMSE'], + 'RequiredPermission' => ['description' => '调用接口的RAM权限点。', 'type' => 'string', 'example' => 'ram:CreateServiceLinkedRole'], + 'ServiceName' => ['description' => '归属服务。', 'type' => 'string', 'example' => 'mse.aliyuncs.com'], + ], + ], + 'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => '规则状态', - 'description' => '规则状态'."\n" - .'- true(开启)'."\n" - .'- false(关闭)', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '开启', - 'false' => '关闭', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '创建MSE SLR', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:InitializeServiceLinkRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => 'true', ], ], + ], + ], + 'ListAnsInstances' => [ + 'summary' => '查询Nacos服务实例列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'Resource', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '17056', + 'abilityTreeNodes' => ['FEATUREmseAPH368'], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '资源名（接口名）', - 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/flow', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'Burst', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => '针对突发请求额外允许的请求数目', - 'description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'AppId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '应用Id', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1****@c3df23522******', - ], + 'schema' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'ControlBehavior', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '流控方式', - 'description' => '流控方式'."\n" - .'- 0(快速失败)'."\n" - .'- 2(排队等待)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - '快速失败', - 2 => '排队等待', - ], - 'example' => '0', - 'default' => '0', - 'enum' => [ - '0', - '2', - ], - ], + 'schema' => ['description' => '集群ID。>此接口同时有InstanceId与ClusterId，则其中一项必填。>'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'MaxQueueingTimeMs', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '超时时间', - 'description' => '超时时间，流控效果为排队等待时需要设置，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'name'], ], [ - 'name' => 'ResourceMode', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '资源模式', - 'description' => '资源模式'."\n" - .'- 0(资源名模式)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - '资源名模式', - ], - 'example' => '0', - 'enum' => [ - '0', - ], - ], + 'schema' => ['description' => '联系人组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'ParamItem', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '参数描述项', - 'description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" - .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" - .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" - .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" - .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', - 'type' => 'string', - 'required' => false, - 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', - ], + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'example' => '12233****'], ], [ - 'name' => 'MetricType', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'title' => '指标类型', - 'description' => '阈值类型'."\n" - .'- 1(请求数)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => '请求数', - ], - 'example' => '1', - 'enum' => [ - '1', - ], - ], - ], - [ - 'name' => 'StatIntervalMs', - 'in' => 'query', - 'schema' => [ - 'title' => '统计间隔', - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，默认值为1秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群别名。', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], ], [ - 'name' => 'ResourceType', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型'."\n" - .'- 0(自定义接口)'."\n" - .'- 1(WEB)'."\n" - .'- 2(RPC)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '自定义接口', - 'WEB', - 'RPC', - ], - 'example' => '1', - 'enum' => [ - '0', - '1', - '2', - '4', - '3', - ], - ], + 'schema' => ['description' => '实例ID。>此接口同时有InstanceId与ClusterId，则其中一项必填。>'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-tl327w****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -23727,1217 +16225,707 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => '200', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'TotalCount' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'PageSize' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'StatIntervalMs' => [ - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Id' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', - 'type' => 'string', - 'example' => '/flow', - ], - 'ControlBehavior' => [ - 'description' => '流控方式'."\n" - .'- 0(快速失败)'."\n" - .'- 2(排队等待)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ReourceMode' => [ - 'description' => '资源模式'."\n" - ."\n" - .'0(资源名模式)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Threshold' => [ - 'description' => '阈值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'Enable' => [ - 'description' => '规则状态'."\n" - ."\n" - .'- true(开启)'."\n" - .'- false(关闭)', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AppId' => [ - 'description' => '应用Id。', - 'type' => 'string', - 'example' => 'hkhon1****@c3df23522******', - ], - 'MetricType' => [ - 'description' => '阈值类型'."\n" - .'- 1(请求数)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RegionId' => [ - 'description' => '地域Id。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Burst' => [ - 'description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParamItem' => [ - 'description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" - .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" - .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" - .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" - .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', - 'type' => 'string', - 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', - ], - ], - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DefaultKey' => ['description' => '缺省键。', 'type' => 'string', 'example' => '30.5.XX.XX:unknown'], + 'Ephemeral' => ['description' => '临时节点，取值如下：'."\n" + .'- `true`：获取成功。'."\n" + .'- `false`：获取失败。', 'type' => 'boolean', 'example' => 'true'], + 'Marked' => ['description' => '标记，取值如下：'."\n" + .'- `true`：标记成功。'."\n" + .'- `false`：标记失败。', 'type' => 'boolean', 'example' => 'true'], + 'Ip' => ['description' => '公网IP。', 'type' => 'string', 'example' => '30.5.XX.XX'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService'], + 'Port' => ['description' => '端口号', 'type' => 'integer', 'format' => 'int32', 'example' => '8080'], + 'LastBeat' => ['description' => '最近一次的心跳时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '20201010'], + 'OkCount' => ['description' => '成功计数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Weight' => ['description' => '权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'InstanceHeartBeatInterval' => ['description' => '实例心跳间隔，单位：秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'], + 'IpDeleteTimeout' => ['description' => 'IP删除超时。', 'type' => 'integer', 'format' => 'int32', 'example' => '30000'], + 'App' => ['description' => '应用名。', 'type' => 'string', 'example' => 'app'], + 'FailCount' => ['description' => '失败计数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Healthy' => ['description' => '实例健康状态，取值如下：'."\n" + .'- `true`：实例健康。'."\n" + .'- `false`：实例不健康。', 'type' => 'boolean', 'example' => 'true'], + 'Enabled' => ['description' => '生效状态，取值如下：'."\n" + .'- `true`：生效。'."\n" + .'- `false`：不生效。', 'type' => 'boolean', 'example' => 'true'], + 'DatumKey' => ['description' => '基准键。', 'type' => 'string', 'example' => '30.5.XX.XX:unknown:DEFAULT'], + 'ClusterName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'DEFAULT'], + 'InstanceHeartBeatTimeOut' => ['description' => '实例心跳超时。', 'type' => 'integer', 'format' => 'int32', 'example' => '15000'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::'], + 'Metadata' => ['description' => '元数据。', 'type' => 'object', 'example' => '[int]'], + ], + 'description' => '', + ], + ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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":"\\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' => '查询Nacos服务实例列表', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '创建热点参数防护（HTTP）规则', ], - 'DeleteWebFlowRules' => [ - 'summary' => '删除热点参数防护规则（HTTP 请求）。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListAnsServiceClusters' => [ + 'summary' => '查询Nacos服务的集群列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '164288', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17057', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'MSE命名空间名。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Ids', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的规则ID列表。', - 'type' => 'string', - 'required' => true, - 'example' => '[1, 2, 3]', - ], + 'schema' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'AppName', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '应用名。', - 'type' => 'string', - 'required' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => 'MSE集群ID。'."\n" + .'> 此处的集群与nacos服务下的集群概念不同，勿混淆。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'mse-09k1xxxx'], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => false, 'example' => 'nacos.test.3'], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => '分组名称，默认为 DEFAULT_GROUP', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'example' => '12233****'], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => ['description' => 'nacos 服务集群名', 'type' => 'string', 'required' => false, 'example' => 'qewr'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-tl32a6****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '354FF159-E9FB-5FBA-BDD5-E99EE440A88D', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], 'Data' => [ - 'description' => '返回数据。', - 'type' => 'array', - 'items' => [ - 'description' => '完成删除的规则Id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '[1, 2, 3]', + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'ProtectThreshold' => ['description' => '保护阈值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'GroupName' => ['description' => '服务所属服务组。', 'type' => 'string', 'example' => 'DEFAULT_GROUP'], + 'Clusters' => [ + 'description' => '集群信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'DefaultCheckPort' => ['description' => '默认检查端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'HealthCheckerType' => ['description' => '健康检查类型。', 'type' => 'string', 'example' => 'tcp'], + 'UseIPPort4Check' => ['description' => '服务端是否主动发起端到端健康状态检查，当服务为非临时服务时此值有效。', 'type' => 'boolean', 'example' => 'true'], + 'ServiceName' => ['description' => '全量服务名。', 'type' => 'string', 'example' => 'DEFAULT_GROUP@@nacos.test.3'], + 'Name' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'test'], + 'DefaultPort' => ['description' => '默认端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'Metadata' => ['description' => '集群元数据。', 'type' => 'object', 'example' => '111'], + ], + ], + ], + 'Name' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'nacos.test.3'], + 'SelectorType' => ['description' => '选举模式。', 'type' => 'string', 'example' => 'none'], + 'Metadata' => ['description' => '服务元数据。', 'type' => 'object', 'example' => '111'], + 'Ephemeral' => ['description' => '是否临时节点，取值如下：'."\n" + .'- `true`：是。'."\n" + .'- `false`：否。', 'type' => 'boolean', 'example' => 'true'], + 'Source' => ['description' => '服务类型，取值如下：'."\n" + .'* console：控制台注册。'."\n" + .'* sdk：SDK注册。'."\n" + .'* governance：服务治理注册。', 'type' => 'string', 'example' => 'console'], + 'AppDetail' => [ + 'description' => '服务类型为服务治理注册时，服务所关联的服务治理应用信息。', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['description' => '服务治理应用id。', 'type' => 'string', 'example' => 'hkhon1po62@904cba2c0xxxxxx'], + 'AppName' => ['description' => '服务治理应用名。', 'type' => 'string', 'example' => 'spring-cloud-b'], + 'Port' => ['description' => '服务治理应用端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '6001'], + 'CheckType' => ['description' => '健康检查协议，取值如下：'."\n" + .'* connection：链接存活检查。'."\n" + .'* tcp: TCP连接检查。'."\n" + .'* http：HTTP连接检查。', 'type' => 'string', 'example' => 'tcp'], + 'CheckPath' => ['description' => '健康检查路径（健康检查类型为http时携带）。', 'type' => 'string', 'example' => '/health'], + 'CheckTimeout' => ['description' => '健康检查响应超时时间，单位：秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'CheckInternal' => ['description' => '健康检查间隔，单位：秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'HealthyCheckTimes' => ['description' => '健康检查健康阈值，指实例从不健康变为健康过程中健康探测重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'UnhealthyCheckTimes' => ['description' => '健康检查不健康阈值，指实例从健康变为不健康过程中健康探测重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + ], + ], ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","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}","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' => '查询集群服务详情', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](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}'], + ], ], ], ], - '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' => '删除热点参数防护（HTTP）规则', ], - 'UpdateWebFlowRule' => [ - 'summary' => '更新热点参数防护规则（HTTP 请求）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListAnsServices' => [ + 'summary' => '查询Nacos服务详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '164287', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17058', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'default', - 'default' => 'default', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '应用名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['title' => '查询指定的服务名信息', 'description' => '服务名称。', 'type' => 'string', 'required' => false, 'example' => 'name'], ], [ - 'name' => 'Threshold', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '阈值', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['title' => '服务所在的分组', 'description' => '联系人组名称。', 'type' => 'string', 'required' => false, 'example' => 'name'], ], [ - 'name' => 'Enable', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '规则状态'."\n" - .'- true(开启)'."\n" - .'- false(关闭)', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '服务所在的 namespace', 'description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'example' => '12233****'], ], [ - 'name' => 'Burst', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['title' => '查询服务下某个集群的实例列表是所需要的参数', 'description' => '查询服务下某个集群的实例列表时所需要的参数。', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], ], [ - 'name' => 'AppId', + 'name' => 'HasIpCount', 'in' => 'query', 'schema' => [ - 'description' => '应用Id。', + 'description' => '是否查询服务实例数量。', 'type' => 'string', 'required' => false, - 'example' => 'hkhon1****@c3df23522******', - ], - ], - [ - 'name' => 'ControlBehavior', - 'in' => 'query', - 'schema' => [ - 'description' => '流控方式'."\n" - ."\n" - .'- 0(快速失败)'."\n" - .'- 2(排队等待)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '0', - 'default' => '0', - ], - ], - [ - 'name' => 'MaxQueueingTimeMs', - 'in' => 'query', - 'schema' => [ - 'description' => '超时时间，流控效果为排队等待时需要设置，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', + 'enumValueTitles' => ['false' => '不需要', 'true' => '需要'], + 'example' => 'true', ], ], [ - 'name' => 'ResourceMode', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '资源模式'."\n" - ."\n" - .'- 0(资源名模式)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '不推荐使用，请使用 InstanceId', 'description' => '集群ID。'."\n" + ."\n" + .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'ParamItem', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" - .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" - .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" - .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" - .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', - 'type' => 'string', - 'required' => false, - 'example' => '{"fieldName":"key","matchStrategy":2,"parseStrategy":2,"pattern":"value"}', - ], + 'schema' => ['title' => '集群实例Id', 'description' => '实例ID。'."\n" + ."\n" + .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21v5****'], ], [ - 'name' => 'MetricType', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '阈值类型'."\n" - ."\n" - .'- 1(请求数)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '查询第几页', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'StatIntervalMs', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['title' => '每页展示条数', 'description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RuleId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '规则Id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求Id。', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => '200', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'TotalCount' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'PageSize' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Data' => [ - 'description' => '返回集合。', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'StatIntervalMs' => [ - 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Id' => [ - 'description' => '规则Id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AppName' => [ - 'description' => '应用名', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Resource' => [ - 'description' => '接口资源名。', - 'type' => 'string', - 'example' => '/flow', - ], - 'ControlBehavior' => [ - 'description' => '流控方式'."\n" - .'- 0(快速失败)'."\n" - .'- 2(排队等待)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ReourceMode' => [ - 'description' => '资源模式'."\n" - .'- 0(资源名模式)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxQueueingTimeMs' => [ - 'description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Threshold' => [ - 'description' => '阈值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'Enable' => [ - 'description' => '规则状态'."\n" - .'- true(开启)'."\n" - .'- false(关闭)', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AppId' => [ - 'description' => '应用Id。', - 'type' => 'string', - 'example' => 'hkhon1XXXX@54e1f42f37cXXXX', - ], - 'MetricType' => [ - 'description' => '阈值类型'."\n" - ."\n" - .'- 1(请求数)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RegionId' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Burst' => [ - 'description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParamItem' => [ - 'description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" - .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" - .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" - .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" - .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', - 'type' => 'string', - 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'HealthyInstanceCount' => ['description' => '健康心跳的服务实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GroupName' => ['description' => '联系人组名称。', 'type' => 'string', 'example' => 'name'], + 'IpCount' => ['description' => '当前服务的实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Name' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'name'], + 'ClusterCount' => ['description' => '集群总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Source' => ['description' => '服务类型，取值如下：'."\n" + .'* console：控制台注册。'."\n" + .'* sdk：SDK注册。'."\n" + .'* governance：服务治理注册。', 'type' => 'string', 'example' => 'console'], ], ], ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], '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' => '当前集群不支持此操作, %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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 \\"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' => '查询Nacos服务详情', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](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' => '全部资源', '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' => '更新热点参数防护规则（HTTP 请求）', ], - 'ListAuthPolicy' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAppBySwimmingLaneGroupTag' => [ + 'summary' => '用于获取当前泳道组内的指定标签的应用列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17061', - 'abilityTreeNodes' => [ - 'FEATUREmseDB5C9P', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'Tag', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], + 'schema' => ['title' => '标签名字。', 'description' => '标签。', 'type' => 'string', 'required' => true, 'example' => 'gray'], ], [ - 'name' => 'PageNumber', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '当前页码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['title' => '泳道组id。', 'description' => '泳道组ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '119'], ], [ - 'name' => 'PageSize', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '每页显示条数。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['title' => '需要查询的MSE命名空间名字', 'description' => '需要查询的MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'Source', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '来源。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'edasmsc', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Protocol', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '协议类型。取值：'."\n" - ."\n" - .'- **SPRING_CLOUD**。'."\n" - .'- **DUBBO**。'."\n" - .'- **istio**。', - 'type' => 'string', - 'required' => false, - 'example' => 'SPRING_CLOUD', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Data' => ['description' => '数据概览。', 'type' => 'any', 'example' => '[{appName:"test",appId:"hkhon1po62@958bba95910341f'."\n" + .'"}]'], + ], ], ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'auto-rule-**', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['mse::2019-05-31::ListAppBySwimmingLaneGroupTags'], + 'returnType' => 'synchronous', + ], + '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' => '获取当前泳道组内的指定标签的应用列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListAppBySwimmingLaneGroupTag', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ListAppBySwimmingLaneGroupTags' => [ + 'summary' => '获取指定泳道组内的指定标签的应用列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'AppId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', + 'title' => '要查询的标签。', + 'description' => '要查询的标签。', + 'type' => 'array', + 'items' => ['title' => '要查询的标签。', 'description' => '要查询的标签。', 'type' => 'string', 'required' => false, 'example' => 'gray'], 'required' => false, - 'example' => 'jgy4cadmqo@***', ], ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['title' => '泳道组id。', 'description' => '泳道组id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'MSE命名空间名。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['title' => '需要查询的MSE命名空间名字。', 'description' => '需要查询的MSE命名空间名字。', 'type' => 'string', 'required' => true, 'example' => 'default', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '05A5A150-4A5F-5A8C-97D6-710776CC8408', - ], + 'RequestId' => ['title' => '请求id。', 'description' => '请求id。', 'type' => 'string', 'example' => '6832e76b-bb5f-4dea-****-************'], + 'Success' => ['title' => '请求是否成功。', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'], + 'ErrorCode' => ['title' => '请求错误码。', 'description' => '请求错误码。', 'type' => 'string', 'example' => 'Success'], + 'Message' => ['title' => '请求附加信息。', 'description' => '请求附加信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '数据概览。', + 'title' => '请求返回数据。', + 'description' => '请求返回数据。', 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '返回数据。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AuthRule' => [ - 'description' => '服务鉴权规则内容列表。', - 'type' => 'array', - 'items' => [ - 'description' => '服务鉴权规则内容。', - 'type' => 'object', - 'properties' => [ - 'Black' => [ - 'description' => '是否黑名单。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'example' => '/a', - ], - 'Method' => [ - 'description' => '请求方法。', - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'description' => '方法版本号。', - 'type' => 'string', - 'example' => '0.0.1', - ], - 'ParameterTypes' => [ - 'description' => '请求参数类型列表。', - 'type' => 'array', - 'items' => [ - 'description' => '请求参数类型。', - 'type' => 'string', - 'example' => '[\\"java.lang.String\\",\\"java.lang.Object\\",\\"java.lang.String\\"]', - ], - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Name' => [ - 'description' => '方法名。', - 'type' => 'string', - 'example' => 'hello', - ], - 'Group' => [ - 'description' => '分组。', - 'type' => 'string', - 'example' => 'default', - ], - 'ReturnType' => [ - 'description' => '返回值类型。', - 'type' => 'string', - 'example' => 'Boolean', - ], - ], - ], - 'AppIds' => [ - 'description' => '应用集合。', - 'type' => 'array', - 'items' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => '["dez4qt7weh@***"]', - ], - ], - 'AuthType' => [ - 'description' => '规则类型。'."\n" - ."\n" - .'- 0， 按照应用维度。'."\n" - .'- 1，按照命名空间维度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'K8sNamespaces' => [ - 'description' => '命名空间列表。', - 'type' => 'array', - 'items' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'acced****', - ], - ], - ], - ], - ], - 'NamespaceId' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'example' => 'ced54a95-4e33-4bda-be7e-37e95868***', - ], - 'Protocol' => [ - 'description' => '协议类型。取值：'."\n" - ."\n" - .'- **SPRING_CLOUD**。'."\n" - .'- **DUBBO**。'."\n" - .'- **istio**。', - 'type' => 'string', - 'example' => 'SPRING_CLOUD', - ], - 'AccountId' => [ - 'description' => '资源拥有者的阿里云账号ID。', - 'type' => 'string', - 'example' => '19039813784***', - ], - 'Source' => [ - 'description' => '应用来源。', - 'type' => 'string', - 'example' => 'edasmsc', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'AppId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@5f1b08becb*****', - ], - 'Name' => [ - 'description' => '鉴权规则名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '204', - ], - 'Enable' => [ - 'description' => '开启或关闭。'."\n" - ."\n" - .'- `true`：开启。'."\n" - .'- `false`：关闭。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AuthType' => [ - 'description' => '规则类型。'."\n" - ."\n" - .'- 0， 按照应用维度。'."\n" - .'- 1，按照命名空间维度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'K8sNamespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***', - ], - ], + 'additionalProperties' => [ + 'title' => '每个tag对应的应用信息列表。', + 'description' => '返回信息', + 'type' => 'array', + 'items' => [ + 'title' => '应用列表。', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '应用所属的用户id。', 'type' => 'string', 'example' => '12345', 'description' => '应用所属的用户id。'], + 'RegionId' => ['title' => '应用所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou', 'description' => '应用所在地域。'], + 'Namespace' => ['title' => '应用所在的微服务命名空间。', 'type' => 'string', 'example' => 'default', 'description' => '应用所在的微服务命名空间。'], + 'AppName' => ['title' => '应用名字。', 'type' => 'string', 'example' => 'example-app-name', 'description' => '应用名字。'], + 'AppId' => ['title' => '应用id。', 'type' => 'string', 'example' => '123456abcde@12345abcde', 'description' => '应用id。'], ], ], - 'TotalSize' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], ], ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取泳道组内的指定标签的应用列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAppBySwimmingLaneGroupTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取服务鉴权规则列表', - 'summary' => '通过ListAuthPolicy接口查询服务鉴权规则列表。', ], - 'UpdateAuthPolicy' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListApplicationsWithTagRules' => [ + 'summary' => '通过ListApplicationsWithTagRules接口获取应用的路由规则。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17097', - 'abilityTreeNodes' => [ - 'FEATUREmseDB5C9P', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'demo-test', - ], - ], - [ - 'name' => 'Source', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '应用接入来源。', - 'type' => 'string', - 'required' => false, - 'example' => 'edasmsc', - ], + 'schema' => ['description' => '分页，第 N 页。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Id', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '规则ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '432', - ], + 'schema' => ['description' => '分页，每页 N 个。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '50', 'example' => '10'], ], [ 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Enable', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '数据来源，默认edasmsc。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'edasmsc'], ], [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'abcde@12345', - ], - ], - [ - 'name' => 'Protocol', - 'in' => 'query', - 'schema' => [ - 'description' => '协议类型。取值：'."\n" - ."\n" - .'- **SPRING_CLOUD**。'."\n" - .'- **DUBBO**。'."\n" - .'- **istio**。', - 'type' => 'string', - 'required' => false, - 'example' => 'SPRING_CLOUD', - ], + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'xjpc0h9h4d@xxx'], ], [ - 'name' => 'AuthRule', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '服务鉴权规则内容。', - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"all\\":true,\\"appIds\\":[\\"f6xqzbao96@4adfaf3c92c947a\\"],\\"black\\":false}]', - ], + 'schema' => ['title' => '应用所属的MSE命名空间', 'description' => '应用所属的MSE命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64, 'default' => 'default'], ], [ - 'name' => 'K8sNamespace', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'k8s集群的命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***', - ], + 'schema' => ['title' => '应用名字', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -24945,37 +16933,175 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '83E3909D-D26F-5D97-B73B-407A26***', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据概览。', - 'type' => 'string', - 'example' => '{}', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：- true：请求成功。- false：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['title' => '应用所属的MSE命名空间', 'description' => '应用所属的MSE命名空间。', 'type' => 'string', 'example' => 'default'], + 'AppName' => ['title' => '应用名', 'description' => '应用名。', 'type' => 'string', 'example' => 'service-lottery-core'], + 'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'daqijp6c31@xxx'], + 'RouteRules' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Rate' => ['title' => '比例规则，20% 的流量路由到该标签对应的节点。', 'description' => '比例。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Enable' => ['description' => '报警规则的启用状态。取值：'."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：禁用。', 'type' => 'boolean', 'example' => 'true'], + 'Tag' => ['title' => '标签名。', 'description' => '标签。', 'type' => 'string', 'example' => 'gray'], + 'Name' => ['title' => '路由规则名称。', 'description' => '规则名称。', 'type' => 'string', 'example' => 'dubbo'], + 'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '653'], + 'InstanceNum' => ['description' => '实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Rules' => [ + 'description' => '规则的适用路由。', + 'type' => 'object', + 'properties' => [ + 'springcloud' => [ + 'title' => 'springcloud规则。', + 'description' => 'springcloud规则。', + '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' => 'dubbo 规则。', + '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' => 'dubbo服务分组。', 'type' => 'string'], + 'version' => ['title' => 'dubbo服务版本。', 'description' => 'dubbo服务版本。', 'type' => 'string'], + 'methodName' => ['title' => 'dubbo服务方法名。', 'description' => 'dubbo服务方法名。', 'type' => 'string'], + 'paramTypes' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'condition' => ['title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', 'description' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', 'type' => 'string'], + 'argumentItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'operator' => ['title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', 'description' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', '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' => '参数位置，从0开始。', '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' => '路由状态，取值如下：'."\n" + ."\n" + .'- 0：关闭'."\n" + ."\n" + .'- 1：开启', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], + 'TotalSize' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页面大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], ], ], ], @@ -24983,195 +17109,101 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": 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' => '获取应用的路由规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListApplicationsWithTagRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '更新服务鉴权规则', - 'summary' => '通过UpdateAuthPolicy接口更新服务鉴权规则。', ], - 'AddAuthPolicy' => [ - 'summary' => '通过 AddAuthPolicy 接口创建服务鉴权规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListAuthPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '16988', - 'abilityTreeNodes' => [ - 'FEATUREmseDB5C9P', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '17061', + 'abilityTreeNodes' => ['FEATUREmseDB5C9P'], ], 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '来源。可选值为：edasmsc。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'edasmsc', - ], - ], [ 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ - 'name' => 'Enable', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '鉴权规则的启用状态。取值：'."\n" - ."\n" - .'- `true`：启用。'."\n" - .'- `false`：禁用。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '当前页码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'AppId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'e9clba2xlc@***', - ], + 'schema' => ['description' => '每页显示条数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'Protocol', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '协议类型。取值：'."\n" - ."\n" - .'- **SPRING_CLOUD**。'."\n" - .'- **DUBBO**。'."\n" - .'- **istio**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SPRING_CLOUD', - ], + 'schema' => ['description' => '来源。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'edasmsc'], ], [ - 'name' => 'AuthRule', + 'name' => 'Protocol', 'in' => 'query', - 'schema' => [ - 'description' => '服务鉴权规则内容。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"all":true,"black":false,"appIds":["dez4qt7weh@***"]}]', - ], + 'schema' => ['description' => '协议类型。取值：'."\n" + ."\n" + .'- **SPRING_CLOUD**。'."\n" + .'- **DUBBO**。'."\n" + .'- **istio**。', 'type' => 'string', 'required' => false, 'example' => 'SPRING_CLOUD'], ], [ - 'name' => 'Namespace', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '应用所属的MSE命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '鉴权规则名称。', 'type' => 'string', 'required' => false, 'example' => 'auto-rule-**'], ], [ - 'name' => 'AuthType', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '规则类型。'."\n" - ."\n" - .'- 0， 按照应用维度。'."\n" - .'- 1，按照命名空间维度。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'jgy4cadmqo@***'], ], [ - 'name' => 'K8sNamespace', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'k8s集群的命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c19c6c500e1ff4d7abc7***', - ], + 'schema' => ['description' => 'MSE命名空间名。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -25179,122 +17211,189 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'dc63-465d-8ef5-20dc18af****', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05A5A150-4A5F-5A8C-97D6-710776CC8408'], 'Data' => [ 'description' => '数据概览。', - 'type' => 'string', - 'example' => '请求处理成功。', - ], - 'Code' => [ - 'description' => 'Code仅仅用来和Success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AuthRule' => [ + 'description' => '服务鉴权规则内容列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务鉴权规则内容。', + 'type' => 'object', + 'properties' => [ + 'Black' => ['description' => '是否黑名单。', 'type' => 'boolean', 'example' => 'false'], + 'Path' => ['description' => '路径。', 'type' => 'string', 'example' => '/a'], + 'Method' => [ + 'description' => '请求方法。', + 'type' => 'object', + 'properties' => [ + 'Version' => ['description' => '方法版本号。', 'type' => 'string', 'example' => '0.0.1'], + 'ParameterTypes' => [ + 'description' => '请求参数类型列表。', + 'type' => 'array', + 'items' => ['description' => '请求参数类型。', 'type' => 'string', 'example' => '[\\"java.lang.String\\",\\"java.lang.Object\\",\\"java.lang.String\\"]'], + ], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Name' => ['description' => '方法名。', 'type' => 'string', 'example' => 'hello'], + 'Group' => ['description' => '分组。', 'type' => 'string', 'example' => 'default'], + 'ReturnType' => ['description' => '返回值类型。', 'type' => 'string', 'example' => 'Boolean'], + ], + ], + 'AppIds' => [ + 'description' => '应用集合。', + 'type' => 'array', + 'items' => ['description' => '应用ID。', 'type' => 'string', 'example' => '["dez4qt7weh@***"]'], + ], + 'AuthType' => ['description' => '规则类型。'."\n" + ."\n" + .'- 0， 按照应用维度。'."\n" + .'- 1，按照命名空间维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'K8sNamespaces' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'acced****'], + ], + ], + ], + ], + 'NamespaceId' => ['description' => '命名空间ID。', 'type' => 'string', 'example' => 'ced54a95-4e33-4bda-be7e-37e95868***'], + 'Protocol' => ['description' => '协议类型。取值：'."\n" + ."\n" + .'- **SPRING_CLOUD**。'."\n" + .'- **DUBBO**。'."\n" + .'- **istio**。', 'type' => 'string', 'example' => 'SPRING_CLOUD'], + 'AccountId' => ['description' => '资源拥有者的阿里云账号ID。', 'type' => 'string', 'example' => '19039813784***'], + 'Source' => ['description' => '应用来源。', 'type' => 'string', 'example' => 'edasmsc'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@5f1b08becb*****'], + 'Name' => ['description' => '鉴权规则名称。', 'type' => 'string', 'example' => 'test'], + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '204'], + 'Enable' => ['description' => '开启或关闭。'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', 'type' => 'boolean', 'example' => 'false'], + 'AuthType' => ['description' => '规则类型。'."\n" + ."\n" + .'- 0， 按照应用维度。'."\n" + .'- 1，按照命名空间维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'K8sNamespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***'], + ], + ], + ], + 'TotalSize' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '获取服务鉴权规则列表', + 'summary' => '通过ListAuthPolicy接口查询服务鉴权规则列表。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '创建服务鉴权规则', ], - 'RemoveAuthPolicy' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListCircuitBreakerRules' => [ + 'summary' => '获取熔断规则列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17087', - 'abilityTreeNodes' => [ - 'FEATUREmseDB5C9P', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'PolicyId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '策略ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '259', - ], + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'required' => true, 'example' => 'default'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], + ], + [ + 'name' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => ['title' => '查找包含接口关键字的防护规则。', 'description' => '查找包含接口关键字的防护规则。', 'type' => 'string', 'required' => false, 'example' => 'a'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '应用ID。', 'description' => '应用ID。', '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' => '起始页。', 'description' => '起始页。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '页大小。', 'description' => '页大小。默认值为6。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -25302,91 +17401,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9515ACA4-E94D-440D-989E-C379FCED****', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], + 'Code' => ['title' => '响应码。', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '响应信息。', 'description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Success' => ['title' => '请求结果。', 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', + 'title' => '规则信息。', + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '返回结果。', + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['title' => '应用所属的微服务命空间。', 'description' => '应用所属的微服务命空间。', 'type' => 'string', 'example' => 'default'], + 'RuleId' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AppName' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'type' => 'string', 'example' => '/a'], + 'ResourceType' => ['description' => '接口资源分类。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Strategy' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['慢调用比例', '异常比例'], + 'example' => '0', + ], + 'Threshold' => ['title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', 'type' => 'number', 'format' => 'float', 'example' => '0.8'], + 'Enable' => ['title' => '规则的启用状态。', 'description' => '规则的启用状态。', 'type' => 'boolean', 'example' => 'true'], + 'RetryTimeoutMs' => ['title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'StatIntervalMs' => ['title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '20000'], + 'AppId' => ['title' => '应用ID。', 'description' => '应用ID。', '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}"'], + 'MaxAllowedRtMs' => ['title' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', 'description' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'MinRequestAmount' => ['title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'HalfOpenBaseAmountPerStep' => ['title' => '熔断恢复每步最小通过数目。', 'description' => '熔断恢复每步最小通过数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'HalfOpenRecoveryStepNum' => ['title' => '熔断恢复阶段数。', 'description' => '熔断恢复阶段数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + ], + ], + 'PageNumber' => ['title' => '起始页。', 'description' => '起始页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '页大小。', 'description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalSize' => ['title' => '总页数。', 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], ], + 'HttpStatusCode' => ['title' => '状态码。', 'description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取熔断规则列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListCircuitBreakerRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除服务鉴权规则', - 'summary' => '通过RemoveAuthPolicy接口删除服务鉴权规则。', ], - 'GetServiceMethodPage' => [ - 'summary' => '获取服务接口列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListClusterConnectionTypes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -25396,347 +17500,226 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', + 'abilityTreeCode' => '76158', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8625467C-27DD-5711-878E-6857E3074937'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%**s**。'."\n" + ."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则表示所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'ShowName' => ['description' => '连接类型。', 'type' => 'string', 'example' => 'slb'], + ], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ], [ - 'name' => 'ServiceType', - 'in' => 'query', - 'schema' => [ - 'title' => '服务类型。', - 'description' => '服务类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'springCloud', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 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' => '查询集群连接信息', + 'summary' => '查询支持的集群连接类型。', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间。', - 'description' => '应用所属的MSE命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusterConnectionTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ListClusterHealthCheckTask' => [ + 'summary' => '获取历史风险评估任务列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '应用名称', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '150980', + 'abilityTreeNodes' => ['FEATUREmseZDUZ1K'], + ], + 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '应用id。', - 'description' => '应用id。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhonxxxxx@f3f75ed8ffxxxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-7pp2o4wfx01'], ], [ - 'name' => 'ServiceName', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => '服务名。', - 'description' => '服务名。', - 'type' => 'string', - 'required' => false, - 'example' => 'sc-A', - ], + 'schema' => ['title' => '查询第几页', 'description' => '查询第几页', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ServiceVersion', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '服务版本。', - 'description' => '服务版本。', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], + 'schema' => ['title' => '每页展示条数', 'description' => '每页展示条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'ServiceGroup', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '服务分组。', - 'description' => '服务分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'ALIYUN', - ], - ], - [ - 'name' => 'Ip', - 'in' => 'query', - 'schema' => [ - 'title' => '服务提供者ip。', - 'description' => '服务提供者ip。', - 'type' => 'string', - 'required' => false, - 'example' => '223.5.5.5', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '获取第几页的数据。', - 'description' => '获取第几页的数据。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '65536', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每一页多少条。', - 'description' => '每一页多少条。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '65536', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'MethodController', - 'in' => 'query', - 'schema' => [ - 'title' => '接口所在的Controller类全称。', - 'description' => '接口所在的Controller类全称。', - 'type' => 'string', - 'required' => false, - 'example' => 'com.alibabacloud.mse.demo.a.AController', - ], - ], - [ - 'name' => 'Path', - 'in' => 'query', - 'schema' => [ - 'title' => '接口对应的请求路径。', - 'description' => '接口对应的请求路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/a', - ], + 'schema' => ['description' => '集群所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Name', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '方法名。', - 'description' => '方法名。', - 'type' => 'string', - 'required' => false, - 'example' => 'aMethod', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '请求是否成功。', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'title' => '请求信息。', - 'description' => '请求信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求id。', - 'description' => '请求id。', - 'type' => 'string', - 'example' => '2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'Code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。取值说明如下：'."\n" + ."\n" + .'- 请求成功：不返回**ErrorCode**字段。'."\n" + .'- 请求失败：返回**ErrorCode**字段。具体信息，请参见本文的**错误码**目录。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'title' => '请求响应数据。', - 'description' => '请求响应数据。', + 'description' => '数据概览。', 'type' => 'object', 'properties' => [ + 'PageNumber' => ['title' => '实例列表的页码', 'description' => '列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalSize' => ['title' => '查询到的实例总数', 'description' => '查询到的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '9'], + 'PageSize' => ['title' => '输入时设置的每页行数', 'description' => '输入时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Result' => [ - 'title' => '方法描述列表。', - 'description' => '方法描述列表。', + 'description' => '风险评估任务列表。', 'type' => 'array', 'items' => [ - 'title' => '每个方法描述。', - 'description' => '每个方法描述。', + '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' => '参数的详细定义。', + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Score' => ['description' => '总得分。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'TotalItem' => ['description' => '总检查项数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalRisk' => ['description' => '总风险项数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse_ingresspost-cn-0jbvrcex****'], + 'ClusterType' => ['description' => '集群类型。', 'type' => 'string', 'example' => 'Nacos-Ans'], + 'Type' => ['description' => '冗余字段。', 'type' => 'string', 'example' => 'null'."\n"], + 'Status' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'FINISH'], + 'PrimaryUser' => ['description' => '集群归属用户ID。', 'type' => 'string', 'example' => '123456'], + 'Spec' => ['description' => '规格。', 'type' => 'string', 'example' => 'MSE_SC_2_4_200_c'], + 'Replica' => ['description' => '集群节点数量。', 'type' => 'string', 'example' => '3'], + 'VersionCode' => ['description' => '版本号。', 'type' => 'string', 'example' => 'NACOS_ANS_1_2_1_3'], + 'AppVersion' => ['description' => '完整版本号。', 'type' => 'string', 'example' => '1.2.1'], + 'ImageVersion' => ['description' => '冗余字段。', 'type' => 'string', 'example' => 'null'], + 'CreateTime' => ['description' => '任务创建时间。', 'type' => 'string', 'example' => '2022-06-20T06:51:46Z'], + 'UpdateTime' => ['description' => '最后更新时间。', 'type' => 'string', 'example' => '2022-11-12 15:07:55'], + 'RiskList' => [ + 'description' => '风险项列表。', 'type' => 'array', 'items' => [ - 'title' => '参数的详细定义。', - 'description' => '参数的详细定义。', + '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', - ], + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '3426'], + 'TaskId' => ['description' => '关联的父任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RiskName' => ['description' => '风险名称。', 'type' => 'string', 'example' => 'Engine version too low'], + 'RiskCode' => ['description' => '风险编码。', 'type' => 'string', 'example' => '22020010001'], + 'PrimaryUser' => ['description' => '集群归属用户ID。', 'type' => 'string', 'example' => '123456'], + 'Type' => ['description' => '冗余字段。', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'], + 'Values' => ['description' => '冗余字段。', 'type' => 'string', 'example' => 'null'], + 'Module' => ['description' => '冗余字段。', 'type' => 'string', 'example' => 'null'], + 'RiskType' => ['description' => '风险类型。', 'type' => 'string', 'example' => 'Version risk'], + 'RiskLevel' => ['title' => 'HIGH, MID, LOW, NONE', 'description' => '风险等级，取值：'."\n" + .'- HIGH 高风险'."\n" + .'- MID 中风险'."\n" + .'- LOW 低风险', 'type' => 'string', 'example' => 'MID'], + 'Suggestion' => ['description' => '建议。', 'type' => 'string', 'example' => '{"desc": "Upgrade to the latest version at the earliest opportunity.", "links":[{"type":"upgrade","desc":"Click to upgrade"}]}'], + 'Situation' => ['description' => '现状。', 'type' => 'string', 'example' => '{"desc":"The current engine version is too low with many missing features","links":[{"type":"url","value":"https://xxxx"","desc":"Version notes"}]}'], + 'Description' => ['description' => '描述说明。', 'type' => 'string', 'example' => '{"desc":"The engine version is outdated and many features are missing. Upgrade to the latest version at the earliest opportunity."}'], + 'Mute' => ['description' => '是否禁用此风险项通知功能。'."\n" + ."\n" + .'- true 禁用风险项通知'."\n" + .'- false 开启风险项通知', 'type' => 'boolean', 'example' => 'false'], + 'NoticeFeature' => ['description' => '冗余字段。', 'type' => 'boolean', 'example' => 'null'], + 'RiskNameEn' => ['description' => '风险英文名', 'type' => 'string', 'example' => 'Low engine version'], + 'SuggestionEn' => ['description' => '建议的英文描述', 'type' => 'string', 'example' => 'Upgrade to the latest version'], + 'SituationEn' => ['description' => '现状的英文描述', 'type' => 'string', 'example' => 'The current engine version is low, and there are many missing features'], + 'DescriptionEn' => ['description' => '风险描述的英文描述', 'type' => 'string', 'example' => 'Upgrade to the latest version to ensure that all features are available!'], ], ], ], - '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' => 'HTTP请求方法。', - 'type' => 'array', - 'items' => [ - 'title' => 'HTTP请求参数。', - 'description' => 'HTTP请求参数。', - 'type' => 'string', - 'example' => 'GET', - ], - ], - 'ReturnDetails' => [ - 'title' => '返回值类型。', - 'description' => '返回值类型。', - 'type' => 'string', - 'example' => 'java.lang.String', - ], - 'Name' => [ - 'title' => '方法名。', - 'description' => '方法名。', - 'type' => 'string', - 'example' => 'aMethod', - ], - 'MethodController' => [ - 'title' => '接口所在的Controller类全称。', - 'description' => '接口所在的Controller类全称。', - 'type' => 'string', - 'example' => 'com.alibabacloud.mse.demo.a.AController', - ], - 'ReturnType' => [ - 'title' => '返回值类型。', - 'description' => '返回值类型。', - 'type' => 'string', - 'example' => 'java.lang.String', - ], + 'ChargeType' => ['description' => '付费类型。', 'type' => 'string', 'example' => 'PREPAY'], ], ], ], - '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', - ], ], ], ], @@ -25745,53 +17728,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取风险评估任务列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusterHealthCheckTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取服务方法列表', ], - 'GetServiceListPage' => [ - 'summary' => '获取服务列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListClusterTypes' => [ + 'summary' => '查询支持开通的引擎类型。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -25799,232 +17770,171 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17044', - 'abilityTreeNodes' => [ - 'FEATUREmseXPQ6HT', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域。', - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群所在地域，MSE支持的地域。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Namespace', + 'name' => 'ConnectType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', + 'title' => '网络连接类型', + 'description' => '网络类型，取值如下：'."\n" + ."\n" + .'- slb'."\n" + .'- eni', 'type' => 'string', 'required' => false, - 'example' => 'default', - 'maxLength' => 64, + 'example' => 'slb', + 'enum' => ['eni', 'slb'], ], ], [ - 'name' => 'AppName', + 'name' => 'MseVersion', 'in' => 'query', - 'schema' => [ - 'title' => '应用名字。', - 'description' => '应用名字。', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 100, - ], + 'schema' => ['description' => '待开通的MSE集群版本。'."\n" + ."\n" + .'- mse_pro：表示专业版。'."\n" + .'- mse_dev：表示开发版。', 'type' => 'string', 'required' => false, 'example' => 'mse_pro'], ], [ - 'name' => 'ServiceType', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '服务类型。', - 'description' => '服务类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'springCloud', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '821B5B05-8919-5FBB-BA75-417BFC093EB8'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '引擎类型Code', 'type' => 'string', 'example' => 'ZooKeeper'], + 'ShowName' => ['description' => '可开通的MSE引擎类型。', 'type' => 'string', 'example' => 'Zookeeper'], + ], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '应用id。', - 'description' => '应用id。', - 'type' => 'string', - 'required' => false, - 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '查询引擎类型', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListClusterTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ListClusterVersions' => [ + 'summary' => '查询支持的集群版本信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'ServiceName', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'title' => '服务名字。', - 'description' => '服务名字。', - 'type' => 'string', - 'required' => false, - 'example' => 'sc-A', - ], + 'schema' => ['description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Nacos-Ans'], ], [ - 'name' => 'PageNumber', + 'name' => 'MseVersion', 'in' => 'query', - 'schema' => [ - 'title' => '页数。', - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '取值如下：'."\n" + ."\n" + .'- `mse_dev`：表示开发版。'."\n" + .'- `mse_pro`：表示专业版（默认取值）。', 'type' => 'string', 'required' => false, 'example' => 'mse_pro'], ], [ - 'name' => 'PageSize', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '每页大小。', - 'description' => '每页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Ip', - 'in' => 'query', - 'schema' => [ - 'title' => '要查询的ip地址。', - 'description' => '要查询的ip地址。', - 'type' => 'string', - 'required' => false, - 'example' => '223.5.5.5', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '请求是否成功。', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'title' => '请求信息。', - 'description' => '请求信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'title' => '请求id。', - 'description' => '请求id。', - 'type' => 'string', - 'example' => 'A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7717BE5B-C958-5F87-BF49-464AA276EDD1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['description' => '与本次请求相关的动态错误信息。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'title' => '请求响应数据。', - 'description' => '请求响应数据。', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'title' => '当前页面数据。', - 'description' => '当前页面数据。', - 'type' => 'array', - 'items' => [ - 'title' => '每个服务的信息。', - 'description' => '每个服务的信息。', - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'title' => '应用名。', - 'description' => '应用名。', - 'type' => 'string', - 'example' => 'example-app', - ], - 'Version' => [ - 'title' => '服务版本。', - 'description' => '服务版本。', - 'type' => 'string', - 'example' => '1', - ], - 'InstanceNum' => [ - 'title' => '服务对应的节点数。', - 'description' => '服务对应的节点数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtModifyTime' => [ - 'title' => '服务最后的更新时间。', - 'description' => '服务最后的更新时间。', - 'type' => 'string', - 'example' => '123456', - ], - 'AppId' => [ - 'title' => '应用id。', - 'description' => '应用id。', - 'type' => 'string', - 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx', - ], - 'ServiceName' => [ - 'title' => '服务名。', - 'description' => '服务名。', - 'type' => 'string', - 'example' => 'sc-A', - ], - 'Group' => [ - 'title' => '服务分组。', - 'description' => '服务分组。', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'ServiceType' => [ - 'type' => 'string', - ], - ], - ], - ], - 'TotalSize' => [ - 'title' => '数据总数。', - 'description' => '数据总数。', - 'type' => 'string', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '当前页码。', - 'description' => '当前页码。', - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页面大小。', - 'description' => '页面大小。', - 'type' => 'string', - 'example' => '10', + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '集群类型编码。', 'type' => 'string', 'example' => 'NACOS_2_0_0'], + 'ShowName' => ['description' => '集群版本。', 'type' => 'string', 'example' => '2.1.0'], + 'ClusterType' => ['description' => '集群类型。', 'type' => 'string', 'example' => 'Nacos-Ans'], ], ], ], @@ -26034,52 +17944,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询集群版本', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListClusterVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '获取服务列表', ], - 'GetServiceList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListClusters' => [ + 'summary' => '查询注册配置中心集群列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -26089,1916 +17988,1271 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '17043', - 'abilityTreeNodes' => [ - 'FEATUREmseW9QIF2', - ], + 'abilityTreeCode' => '17063', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjiakou', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'ServiceType', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '框架类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'dubbo', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'AppId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'xxx@xxx', - ], + 'schema' => ['description' => '每页展示集群数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'ServiceName', + 'name' => 'ClusterAliasName', 'in' => 'query', - 'schema' => [ - 'description' => '服务名。', - 'type' => 'string', - 'required' => false, - 'example' => 'com.alibaba.xxx', - ], + 'schema' => ['description' => '集群名字，支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'cluster'], ], [ - 'name' => 'Ip', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '集群所在地域，MSE支持的地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。资源组详情请参见查看资源组基本信息。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxbzafebvvfa'], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'IP地址。', - 'type' => 'string', + 'description' => '标签列表，最多包含20个子项', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'prd'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '127.0.0.1', + 'maxItems' => 21, ], ], + [ + 'name' => 'KeyId', + 'in' => 'query', + 'schema' => ['description' => '如果是nacos集群，查询绑定了指定keyId的实例', 'type' => 'string', 'required' => false, 'example' => 'key-hzz67774641bsp21vhj4h'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '语言类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'description' => '字符串对象。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'Http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'TotalCount' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'OK'], + 'PageSize' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Data' => [ - 'description' => '返回数据。', + 'description' => '数据概览。', 'type' => 'array', 'items' => [ - 'description' => '返回结果。', + 'description' => '字符串对象。', 'type' => 'object', 'properties' => [ - 'EdasAppName' => [ - 'description' => '应用名。', - 'type' => 'string', - 'example' => 'test', - ], - 'DubboApplicationName' => [ - 'description' => 'Dubbo应用名。', - 'type' => 'string', - 'example' => 'dubbo-application', - ], - 'Version' => [ - 'description' => '版本信息。', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'SpringApplicationName' => [ - 'description' => 'Spring应用名。', - 'type' => 'string', - 'example' => 'spring-application', - ], - 'RegistryType' => [ - 'description' => '注册中心类型。', - 'type' => 'string', - 'example' => 'nacos', - ], - 'ServiceType' => [ - 'description' => '服务类型。', - 'type' => 'string', - 'example' => 'dubbo', - ], - 'ServiceName' => [ - 'description' => '服务名。', - 'type' => 'string', - 'example' => 'com.alibaba.xxx', - ], - 'Methods' => [ - 'description' => '方法列表。', - 'type' => 'array', - 'items' => [ - 'description' => '方法列表。', - 'type' => 'object', - 'properties' => [ - 'Paths' => [ - 'description' => '路径。', - 'type' => 'array', - 'items' => [ - 'description' => '服务映射地址。', - 'type' => 'string', - 'example' => '/path', - ], - ], - 'ParameterTypes' => [ - 'description' => '参数类型。', - 'type' => 'array', - 'items' => [ - 'description' => '参数类型。', - 'type' => 'string', - 'example' => 'int', - ], - ], - 'RequestMethods' => [ - 'description' => '方法。', - 'type' => 'array', - 'items' => [ - 'description' => '方法。', - 'type' => 'string', - 'example' => 'sayHello', - ], - ], - 'Name' => [ - 'description' => '方法名。', - 'type' => 'string', - 'example' => 'sayHello', - ], - 'MethodController' => [ - 'description' => '方法接口。', - 'type' => 'string', - 'example' => 'com.alibaba.SayHelloController', - ], - 'ReturnType' => [ - 'description' => '返回值类型。', - 'type' => 'string', - 'example' => 'int', - ], - ], - ], - ], - 'Metadata' => [ - 'description' => '元数据。', + 'EndDate' => ['description' => '集群截止时间。', 'type' => 'string', 'example' => '2021-08-01 00:00:00'], + 'IntranetDomain' => ['description' => '私网域名。', 'type' => 'string', 'example' => 'mse-7413****-eureka.mse.aliyuncs.com'], + 'InternetDomain' => ['description' => '公网域名。', 'type' => 'string', 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com'], + 'CreateTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2020-07-31 11:36:08'], + 'ChargeType' => ['description' => '付费模式，包括包年包月和按量付费。', 'type' => 'string', 'example' => 'subscription'], + 'IntranetAddress' => ['description' => '私网地址。', 'type' => 'string', 'example' => '192.168.XX.XX'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + 'InternetAddress' => ['description' => '公网地址。', 'type' => 'string', 'example' => '47.98.XX.XX'], + 'ClusterAliasName' => ['description' => '集群别名。', 'type' => 'string', 'example' => 'mse-7413****'], + 'ClusterType' => ['description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', 'type' => 'string', 'example' => 'Eureka'], + 'InitStatus' => ['description' => '初始化状态。', 'type' => 'string', 'example' => 'RESTART_SUCCESS'], + 'AppVersion' => ['description' => 'APP版本。', 'type' => 'string', 'example' => '1.9.3'], + 'CanUpdate' => ['description' => '是否能够升级。', 'type' => 'boolean', 'example' => 'true'], + 'VersionCode' => ['description' => '版本信息。', 'type' => 'string', 'example' => 'EUREKA_1_9_3'], + 'InstanceCount' => ['description' => '集群数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'ClusterName' => ['description' => '集群名字。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + 'MseVersion' => ['description' => '集群所使用的版本类别。', 'type' => 'string', 'example' => 'mse_pro'], + 'Tags' => ['description' => '实例所绑定的标签。', 'type' => 'object'], + 'ResourceGroupId' => ['description' => '实例所属的资源组 ID。', 'type' => 'string', 'example' => 'rg-acfmv7jiavm4uxa'], + 'VpcId' => ['description' => '集群所处的VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1hcg467ekqsv0zr****'], + 'MaintenancePeriod' => [ + 'description' => '运维时间窗口', 'type' => 'object', - 'example' => '{}', - ], - 'Group' => [ - 'description' => '分组。', - 'type' => 'string', - 'example' => 'dubbo', + 'properties' => [ + 'StartTime' => ['description' => '运维时间窗口开始时间', 'type' => 'string', 'example' => '02:00'], + 'EndTime' => ['description' => '运维时间窗口结束时间', 'type' => 'string', 'example' => '06:00'], + ], ], + 'VersionLifecycle' => ['description' => '版本生命周期', 'type' => 'string'], ], ], ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '调用成功与否。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'responseDemo' => '[{"type":"json","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}","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' => '查询集群列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询应用服务信息', - 'summary' => '通过GetServiceList接口查询应用服务信息。', ], - 'CreateOrUpdateSwimmingLaneGroup' => [ - 'summary' => '用于创建或者更新全链路灰度泳道组。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListConfigTrack' => [ + 'summary' => '获取Nacos配置中心的轨迹数据。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'abilityTreeCode' => '116107', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], - ], + 'operationType' => 'list', + 'abilityTreeCode' => '139046', + 'abilityTreeNodes' => ['FEATUREmseU19WQV'], + ], 'parameters' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'title' => 'region', - 'description' => 'Region。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'default', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '泳道组ID。-1时为创建泳道组，大于0时为修改指定泳道组。', - 'description' => '泳道组ID。-1时为创建泳道组，大于0时为修改指定泳道组。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '120', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '名称', - 'description' => '泳道组名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'group1', - ], - ], - [ - 'name' => 'Status', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '0 未生效', - 'description' => '取值为0表示未生效，取值为1表示生效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'EntryApp', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '入口应用。格式 "来源系统:id"。比如：'."\n" - .'- mse:${mse应用id}'."\n" - .'- mse-gw:${mse云原生网关id}', - 'description' => '入口应用。格式 "来源系统:id"。比如：'."\n" - .'- mse:${mse应用id}'."\n" - .'- mse-gw:${mse云原生网关id}'."\n" - .'- apig:${云原生API网关id}', - 'type' => 'string', - 'required' => false, - 'example' => 'mse-gw:gw-2b1407e050f1446xxxcd2a65fd9xxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'mse_prepaid_public_cn-i7m2ne****'], ], [ - 'name' => 'AppIds', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'title' => '应用集合。以 "," 分割应用 id', - 'description' => '应用集合。以 "," 分割应用 id', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxn1po62@492b8f98d4bxxxx,xxxxn1po62@2d8f5d1b7f2xxxx', - ], + 'schema' => ['description' => '查询的配置的dataId，默认为不按照dataId进行筛选查询', 'type' => 'string', 'required' => false, 'example' => 'ballot'], ], [ - 'name' => 'MessageQueueGrayEnable', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'title' => '是否开启消息灰度', - 'description' => '是否开启消息灰度。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '配置分组，默认为不按照配置分组进行筛选查询', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'MessageQueueFilterSide', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'title' => '消息灰度过滤侧', - 'description' => '消息灰度过滤侧。', - 'type' => 'string', - 'required' => false, - 'example' => 'Server', - 'default' => 'Server', - 'enum' => [ - 'Server', - 'Client', - ], - ], + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'example' => 'f3a510e2-df52-4fad-9815-42d8bc40****'], ], [ - 'name' => 'DbGrayEnable', + 'name' => 'StartTs', 'in' => 'query', - 'schema' => [ - 'title' => '是否开启数据库灰度', - 'description' => '已废弃，是否开启数据库灰度。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], + 'schema' => ['description' => '开始时间戳，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1671010148'], ], [ - 'name' => 'RecordCanaryDetail', + 'name' => 'EndTs', 'in' => 'query', - 'schema' => [ - 'title' => '是否开启记录请求详情', - 'description' => '是否开启记录请求详情。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '结束时间戳，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657178373'], ], [ - 'name' => 'Paths', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '已废弃，java网关为入口时填写该参数', - 'type' => 'array', - 'items' => [ - 'description' => '已废弃，path', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'required' => false, - ], + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], ], [ - 'name' => 'RouteIds', + 'name' => 'PageNum', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '路由ID列表（以云原生网关为入口时，在创建泳道组的泳道前，需调用本接口传入选择的云原生网关路由ID列表）', - 'description' => '路由ID列表（以云原生网关为入口时，在创建泳道组的泳道前，需调用本接口传入选择的云原生网关路由ID列表）', - 'type' => 'array', - 'items' => [ - 'description' => '路由Id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '111', - ], - 'required' => false, - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'CanaryModel', + 'name' => 'Reverse', 'in' => 'query', - 'schema' => [ - 'description' => '全链路灰度模式：'."\n" - ."\n" - .'- 0: 按请求内容路由'."\n" - ."\n" - .'- 1: 按比例路由', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '是否倒序，默认为false'."\n" + ."\n" + .'- true'."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'SwimVersion', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'description' => '全链路灰度版本，取值范围：0（不推荐使用，需要指定路由）,2(推荐使用，无需指定路由)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '监听IP地址，默认为不按照ip进行筛选查询', 'type' => 'string', 'required' => false, 'example' => '192.168.22.2'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult。', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'true：请求成功。'."\n" - .'false：请求失败。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '错误码。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n", - 'type' => 'string', - 'example' => '请求处理成功'."\n", - ], - 'Data' => [ - 'description' => '数据概览。'."\n" - ."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '应用名', - 'description' => '应用名', - 'type' => 'string', - 'example' => 'example-app', - ], - 'DbGrayEnable' => [ - 'title' => '是否开启数据库灰度', - 'description' => '是否开启数据库灰度', - 'type' => 'string', - 'example' => 'true', - ], - 'UserId' => [ - 'title' => '应用所属的用户id。', - 'description' => '应用所属的用户id。', - 'type' => 'string', - 'example' => '12345', - ], - 'MessageQueueFilterSide' => [ - 'title' => '消息灰度过滤侧', - 'description' => '消息灰度过滤侧。', - 'type' => 'string', - 'example' => 'Client', - ], - 'AppIds' => [ - 'title' => '应用id列表，逗号分隔。', - 'description' => '应用id列表，逗号分隔。', - 'type' => 'string', - 'example' => 'abcd1@abcde123,abcd1@abcde124', - ], - 'Namespace' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字。', - 'type' => 'string', - 'example' => 'prod', - ], - 'RecordCanaryDetail' => [ - 'title' => '是否开启记录请求详情。', - 'description' => '是否开启记录请求详情。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'title' => '泳道组id。', - 'description' => '泳道组id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2047', - 'default' => '123', - ], - 'EntryApp' => [ - 'title' => '入口应用。格式 "来源系统:id"。比如：'."\n" - .'mse:${mse应用id}'."\n" - .'mse-gw:${mse云原生网关id}', - 'description' => '入口应用。', - 'type' => 'string', - 'example' => 'mse:abcd1@a2345', - ], - 'Region' => [ - 'title' => '应用所属地域。', - 'description' => '应用所属地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'MessageQueueGrayEnable' => [ - 'title' => '是否开启消息灰度。', - 'description' => '是否开启消息灰度。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'paths' => [ - 'description' => '已废弃，java网关为入口时该参数为Path列表', - 'type' => 'string', - 'example' => '["/a"]', - ], - 'Paths' => [ - 'description' => '已废弃，java网关为入口时该参数为Path列表', - 'type' => 'string', - 'example' => '["/a"]', - ], - 'canaryModel' => [ - 'description' => '全链路灰度模式：'."\n" + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Traces' => [ + 'description' => '信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'LogDate' => ['description' => '记录时间。', 'type' => 'string', 'example' => '2022-11-28 15:09:15'], + 'Ts' => ['description' => '监控指标值对应的时间戳。'."\n" ."\n" - .'- 0: 按请求内容路由'."\n" + .'单位：秒。', 'type' => 'string', 'example' => '1659666529'], + 'RequestIp' => ['description' => '请求来源IP。', 'type' => 'string', 'example' => '192.168.1.2'], + 'ResponseIp' => ['description' => '响应节点。', 'type' => 'string', 'example' => 'mse-1973b9a0-1670834*****-reg-center-0-2'], + 'DataId' => ['description' => '配置ID。', 'type' => 'string', 'example' => 'eir-server.properties'], + 'Group' => ['description' => '配置组。', 'type' => 'string', 'example' => 'DEFAULT_GROUP'], + 'Event' => ['description' => '事件。'."\n" ."\n" - .'- 1: 按比例路由', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CanaryModel' => [ - 'description' => '全链路灰度模式：'."\n" + .'- 配置获取事件：pull'."\n" + .'- 持久化事件：persist', 'type' => 'string', 'example' => 'pull'], + 'Result' => ['description' => '结果。', 'type' => 'string', 'example' => 'ok'], + 'Delay' => ['description' => '延迟，单位为ms。', 'type' => 'string', 'example' => '0'], + 'Md5' => ['description' => '配置MD5值。', 'type' => 'string', 'example' => 'd21c9091c60daa0ff7ee2f420141e5a0'], + 'Type' => ['description' => '发布类型。'."\n" ."\n" - .'- 0: 按请求内容路由'."\n" + .'- beta发布：beta'."\n" + .'- 灰度发布：tag'."\n" + .'- 分批发布：batch', 'type' => 'string', 'example' => 'beta'], + 'Push' => ['description' => '是否是服务端推送。'."\n" ."\n" - .'- 1: 按比例路由', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + .'- true'."\n" + .'- false', 'type' => 'boolean', 'example' => 'false'], + 'Client' => ['description' => '是否是客户端的请求。'."\n" + ."\n" + .'- true'."\n" + .'- false', 'type' => 'boolean', 'example' => 'false'], ], ], - 'example' => '{}', ], + 'PageSize' => ['description' => '当前页的大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0CE3ABD2-1E04-561F-A9B4-0423D50****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取Nacos配置中心推送轨迹', + '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\\": \\"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' => '创建或者更新全链路灰度泳道组', ], - 'DeleteSwimmingLaneGroup' => [ - 'summary' => '用于删除全链路泳道组。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListEngineNamespaces' => [ + 'summary' => '查询Nacos命名空间列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'abilityTreeCode' => '17066', + 'abilityTreeNodes' => ['FEATUREmseL2AGED'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '全链路泳道组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '145', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'Namespace', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'TotalCount' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '062D13C5-DEA3-4921-8918-C49A0F1B****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'PageSize' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '命名空间类型，取值如下：'."\n" + .'- `0`：全局配置'."\n" + .'- `1`：默认命名空间'."\n" + .'- `2`：自定义命名空间', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'NamespaceShowName' => ['description' => '命名空间名称。', 'type' => 'string', 'example' => 'public'], + 'Quota' => ['description' => '配额。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'DEFAULT'], + 'NamespaceDesc' => ['description' => '命名空间描述。', 'type' => 'string', 'example' => 'mytest'], + 'ConfigCount' => ['description' => '配额数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ServiceCount' => ['description' => '活跃服务数。', 'type' => 'string', 'example' => '3'], + 'SourceType' => ['description' => '创建此空间的来源。', 'type' => 'string', 'example' => 'mse'], + ], + ], + ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'OperationNotSupport', 'errorMessage' => 'The current cluster does not support this operation, %s.', 'description' => '当前集群不支持此操作, %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '名称', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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":"\\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' => '查询引擎命名空间列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListEngineNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ListEurekaInstances' => [ + 'summary' => '查询Eureka实例列表。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17067', + 'abilityTreeNodes' => ['FEATUREmseKQ13CA'], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****'], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'name'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'TotalCount' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'PageSize' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Data' => [ 'description' => '数据概览。', - 'type' => 'any', - 'example' => '{}', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '服务提供者数量，健康实例数/总实例数。', 'type' => 'string', 'example' => '1/1'], + 'LastDirtyTimestamp' => ['description' => '实例属性最后更新的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '20201009115543'], + 'IpAddr' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '30.5.XX.XX'], + 'HomePageUrl' => ['description' => '主页地址。', 'type' => 'string', 'example' => 'http://30.5.XX.XX:8091/'], + 'HostName' => ['description' => '主机名。', 'type' => 'string', 'example' => '30.5.XX.XX'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'L-PC1A6A28-****.hz.ali.com:contactinfo:8091'], + 'Port' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '8091'], + 'SecurePort' => ['description' => '安全端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '443'], + 'App' => ['description' => '应用名。', 'type' => 'string', 'example' => 'CONTACTINFO'], + 'DurationInSecs' => ['description' => '实例超时时间。 '."\n" + .'超过这个时间后，服务默认不可用，将会被删除。', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'LastUpdatedTimestamp' => ['description' => '最近一次心跳时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '20201010071203'], + 'RenewalIntervalInSecs' => ['description' => '心跳执行器在续约过程中超时后再次执行续约的最大延迟倍数。 '."\n" + .'默认最大延迟倍数为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'VipAddress' => ['description' => 'VIP地址。', 'type' => 'string', 'example' => 'contactinfo'], + 'Metadata' => ['description' => '元数据。', 'type' => 'object', 'example' => '[string]'], + ], + ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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":"\\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' => '查询Eureka实例列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListEurekaInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除全链路泳道组', ], - 'CreateOrUpdateSwimmingLane' => [ - 'summary' => '用于创建或者更新全链路灰度泳道。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListEurekaServices' => [ + 'summary' => '查询Eureka服务列表。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '116127', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17068', + 'abilityTreeNodes' => ['FEATUREmseKQ13CA'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => 'region', - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'Namespace', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Id', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '泳道ID。-1时为创建泳道，大于0时为修改指定泳道。', - 'description' => '主键ID。-1时为创建泳道，大于0时为修改指定泳道。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'schema' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'Name', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '名称', - 'description' => '泳道名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'gray', - 'maxLength' => 64, - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'Tag', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '匹配到后的目标机器标签', - 'description' => '标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - 'maxLength' => 64, - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Enable', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '是否开启。', - 'description' => '是否开启。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'TotalCount' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'PageSize' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'InstancesId' => [ + 'description' => '实例信息。', + 'type' => 'array', + 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + ], + 'Name' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'CONTACTINFO'], + 'UpStatus' => ['description' => '服务提供者数量，健康实例数/总实例数。', 'type' => 'string', 'example' => '1/1'], + ], + ], + ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '所属泳道组', - 'description' => '所属泳道组。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '115', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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":"\\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' => '查询Eureka服务列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListEurekaServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ListExportZookeeperData' => [ + 'summary' => '列出Zookeeper的历史数据导出任务列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'EnableRules', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '是否开启规则', - 'description' => '是否配置泳道的路由规则，Ingress为网关暂时不需要配置。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'true', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-7pp2d1****'], ], [ - 'name' => 'PathIndependentPercentageEnable', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '已废弃。Java网关相关配置，Path按比例路由', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], ], [ - 'name' => 'EntryRules', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'title' => 'SwimmingLane', - 'description' => '泳道规则集合', - 'type' => 'array', - 'items' => [ - 'description' => '泳道规则', - 'type' => 'object', - 'properties' => [ - 'Paths' => [ - 'title' => '路径列表', - 'description' => '路径列表', - 'type' => 'array', - 'items' => [ - 'description' => '路径', - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], - 'required' => false, - 'maxItems' => 50, - ], - 'Condition' => [ - 'title' => '指示RestItems如何组合成最终的条件', - 'description' => '指示RestItems如何组合成最终的条件', - 'type' => 'string', - 'required' => false, - 'example' => 'AND', - 'default' => 'AND', - 'enum' => [ - 'AND', - 'OR', - ], - ], - 'RestItems' => [ - 'title' => '匹配列表', - 'description' => '匹配列表', - 'type' => 'array', - 'items' => [ - 'description' => 'Rest匹配信息', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '匹配类型', - 'description' => '匹配类型', - 'type' => 'string', - 'required' => false, - 'example' => 'header', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'required' => false, - 'example' => 'x-mse-tag', - ], - 'Operator' => [ - 'title' => '操作符', - 'description' => '操作符', - 'type' => 'string', - 'required' => false, - 'example' => 'rawvalue', - ], - 'NameList' => [ - 'title' => '匹配列表', - 'description' => '匹配列表', - 'type' => 'array', - 'items' => [ - 'description' => '名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'required' => false, - 'maxItems' => 10, - ], - 'Datum' => [ - 'title' => '数值', - 'description' => '数值', - 'type' => 'string', - 'required' => false, - 'example' => 'x', - ], - 'Cond' => [ - 'title' => '匹配符', - 'description' => '匹配符', - 'type' => 'string', - 'required' => false, - 'example' => '=='."\n", - ], - 'Divisor' => [ - 'title' => '除数', - 'description' => '除数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Remainder' => [ - 'title' => '余数', - 'description' => '余数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Rate' => [ - 'title' => '百分比', - 'description' => '百分比', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'Value' => [ - 'title' => '值', - 'description' => '值', - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], - 'Priority' => [ - 'title' => '优先级', - 'description' => '优先级', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'EntryRule', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'json string', - 'description' => 'json string。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '[{"Priority":1,"Paths":[],"Condition":"AND","RestItems":[{"Type":"param","Name":"name","Value":"xiaoming","Cond":"==","Operator":"rawvalue"}]}]', - ], + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '5'], ], [ - 'name' => 'GatewaySwimmingLaneRouteJson', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '网关路由信息（使用云原生网关为入口时使用）', - 'description' => '网关路由信息（使用云原生网关为入口时使用）', + 'title' => 'BaseResult>', + 'description' => 'BaseResult>', 'type' => 'object', 'properties' => [ - 'GatewayId' => [ - 'title' => '网关ID', - 'description' => '网关ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'GatewayUniqueId' => [ - 'title' => '网关唯一ID', - 'description' => '网关唯一ID', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-84efde2ee1464260bdb17a5b****', - ], - 'RouteIdList' => [ - 'title' => '路由ID列表', - 'description' => '路由ID列表', - 'type' => 'array', - 'items' => [ - 'description' => '路由ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'CanaryModel' => [ - 'title' => '全链路灰度模式：'."\n" - ."\n" - .'- 0: 按请求内容路由'."\n" - ."\n" - .'- 1: 按比例路由', - 'description' => '全链路灰度模式：'."\n" - ."\n" - .'- 0: 按请求内容路由'."\n" - ."\n" - .'- 1: 按比例路由', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Conditions' => [ - 'title' => '匹配条件列表（按内容路由使用）', - 'description' => '匹配条件列表', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '条件项', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '参数名称', - 'description' => '参数名称', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Value' => [ - 'title' => '参数值', - 'description' => '参数值', - 'type' => 'string', - 'required' => false, - 'example' => 'xiaoming', - ], - 'Type' => [ - 'title' => '参数类型：'."\n" - .'- header：Header'."\n" - .'- param：Parameter', - 'description' => '参数类型：'."\n" - .'- header：Header'."\n" - .'- param：Parameter', - 'type' => 'string', - 'required' => false, - 'example' => 'header', - ], - 'Cond' => [ - 'title' => '条件：'."\n" - .'- PRE：前缀匹配'."\n" - .'- EQUAL：精确匹配'."\n" - .'- ERGULAR：正则匹配', - 'description' => '如果您使用老版本的全链路灰度（swimversion为0，使用标签路由和灰度路由），支持：'."\n" - .'- PRE：前缀匹配'."\n" - .'- ERGULAR：正则匹配'."\n" - .'- EQUAL：精准匹配'."\n" - ."\n" - .'如果您使用新版本的全链路灰度（swiminversion为1或2，使用单服务路由），支持：'."\n" - .'- PRE：前缀匹配'."\n" - .'- regexp：正则匹配'."\n" - .'- =='."\n" - .'- !='."\n" - .'- list ：in'."\n" - .'- % ：百分比'."\n" - ."\n" - .'新版全链路灰度和旧版全链路灰度功能一样，性能更强、配置更简单，请您迁移至新版全链路灰度', - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Percentage' => [ - 'title' => '流量比例（按比例路由使用，取值0-100）', - 'description' => '流量比例（按比例路由使用，取值0-100）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'RouteIndependentPercentageEnable' => [ - 'description' => '已废弃。MSE云原生网关为入口时使用该参数指定按照路由进行百分比设置', - 'type' => 'boolean', - 'required' => false, - ], - 'RouteIndependentPercentageList' => [ - 'description' => '已废弃。按照路由独立进行百分比灰度的路由列表', + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'description' => '数据概览。', 'type' => 'array', 'items' => [ - 'description' => '路由与百分比列表', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '111', - ], - 'Percentage' => [ - 'description' => '流量比例（按比例路由使用，取值0-100）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + 'ExportType' => ['description' => '导出类型，取值：'."\n" + ."\n" + .'- transactionLog 事务日志'."\n" + .'- snapshot 快照文件', 'type' => 'string', 'example' => 'snapshot'], + 'ContentMap' => ['description' => '任务详情。', 'type' => 'string', 'example' => '{}'], + 'Extend' => ['description' => '其他扩展信息，JSON结构，方便后续扩展参数。', 'type' => 'string', 'example' => '{}'], + 'Status' => ['description' => '任务状态，取值：'."\n" + .'- CREATE 创建中'."\n" + .' - RUNNING 执行中'."\n" + .' - FINISH 已完成'."\n" + .' - FAILED 失败'."\n" + .' - EXPIRE 已过期', 'type' => 'string', 'example' => 'FINISH'], + 'KubeoneTaskIds' => ['description' => '关联的底层taskId，仅作为失败时的排查使用。', 'type' => 'string', 'example' => '10'], + 'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CreateTime' => ['description' => '任务创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631001140913'], + 'UpdateTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1632979237663'], ], - 'required' => false, ], - 'required' => false, - ], - 'Condition' => [ - 'description' => '灰度条件同时满足:AND;'."\n" - .'灰度条件任意满足:OR', - 'type' => 'string', - 'required' => false, - 'example' => 'AND', ], ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => 'Zookeeper导出任务列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListExportZookeeperData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListFlowRules' => [ + 'summary' => '获取流控规则列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '159811', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'example' => 'default'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'xx-demo'], + ], + [ + 'name' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => ['description' => '搜索关键字。', 'type' => 'string', 'required' => false, 'example' => '/a'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522******'], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => ['description' => '资源名。', 'type' => 'string', 'required' => false, 'example' => '/a'], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => '目标页号，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页，每页 N 个。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', + 'description' => '请求结果。', 'type' => 'boolean', + 'enumValueTitles' => ['true' => '请求成功', 'false' => '请求失败'], 'example' => 'true', ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'Code仅仅用来和Success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], 'Data' => [ - 'description' => '数据概览。', + 'description' => '节点数据。', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '泳道名称', - 'type' => 'string', - 'example' => 'test', - ], - 'id' => [ - 'description' => '泳道ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94765', - ], - 'tag' => [ - 'description' => '泳道对应的标签。', - 'type' => 'string', - 'example' => 'release', - ], - 'status' => [ - 'description' => '泳道状态', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'enable' => [ - 'description' => '泳道开关', - 'type' => 'boolean', - 'example' => 'true', - ], - 'regionId' => [ - 'description' => '应用所在的区域。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'groupId' => [ - 'description' => '泳道组Id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72586', - ], - 'entryRule' => [ - 'description' => '入口应用规则', - 'type' => 'string', - 'example' => '{}', - ], - 'entryRules' => [ - 'description' => '名称', + 'Result' => [ + 'description' => '返回集合。', 'type' => 'array', 'items' => [ - 'description' => '入口应用规则详情', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'paths' => [ - 'description' => '路径列表', - 'type' => 'array', - 'items' => [ - 'description' => '路径列表', - 'type' => 'string', - 'example' => '/', - ], - ], - 'path' => [ - 'title' => '', - 'description' => '代码组路径', - 'type' => 'string', - 'example' => '/adump/wxb/prod', - ], - 'condition' => [ - 'description' => '条件', - 'type' => 'string', - 'example' => 'AND', + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AppName' => ['description' => '应用名。', 'type' => 'string', 'example' => 'finance'], + 'Resource' => ['description' => '接口资源名', 'type' => 'string', 'example' => '/a'], + 'ResourceType' => ['description' => '接口资源分类', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ControlBehavior' => [ + 'description' => '流控效果。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['快速失败', 2 => '排队等待'], + 'example' => '0', ], - 'restItems' => [ - 'description' => 'Rest匹配规则列表', - 'type' => 'array', - 'items' => [ - 'description' => 'Rest匹配规则', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'title' => '匹配类型', - 'description' => '匹配类型', - 'type' => 'string', - 'example' => 'cookie', - ], - 'name' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'example' => 'test', - ], - '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' => '9', - ], - ], - ], + 'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'Threshold' => ['description' => '流控规则阈值。', 'type' => 'number', 'format' => 'float', 'example' => '10'], + 'Enable' => [ + 'description' => '规则启用状态。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '启用', 'false' => '关闭'], + 'example' => 'true', ], + 'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@5f1b08becb*****'], + 'RegionId' => ['description' => '地域ID。', '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}"'], + 'MetricType' => ['description' => '统计维度，1表示通过请求数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TrafficTags' => ['description' => '预留字段。', 'type' => 'object', 'example' => '{\\"origin\\":\\"default\\"}'], + 'LimitApp' => ['description' => '请求来源应用。', 'type' => 'string', 'example' => 'spring-cloud-a'], ], ], ], - 'enableRules' => [ - 'description' => '是否开启规则。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'gmtCreate' => [ - 'description' => '泳道创建时间。', - 'type' => 'string', - 'example' => '1545726028000', - ], - 'gmtModified' => [ - 'description' => '泳道更新时间。', - 'type' => 'string', - 'example' => '1565701886000', - ], - 'gatewaySwimmingLaneRouteJson' => [ - 'description' => 'MSE网关路由规则', - 'type' => 'string', - 'example' => '{}', - ], - 'pathIndependentPercentageEnable' => [ - 'description' => '已废弃。Java网关为入口时使用，该参数标识是否开启按照path百分比灰度。', - 'type' => 'boolean', - 'example' => 'false', - ], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalSize' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], ], - 'example' => '{}', ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '获取流控规则列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '创建或者更新全链路灰度泳道', ], - 'DeleteSwimmingLane' => [ - 'summary' => '用于删除全链路泳道。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGateway' => [ + 'summary' => '查询该网关列表信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'get', + 'abilityTreeCode' => '24675', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], ], 'parameters' => [ [ - 'name' => 'LaneId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '泳道ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '229', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Namespace', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'OrderItem', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - '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', - ], + 'schema' => ['description' => '订单信息。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"请求处理成功\\"\\n}","type":"json"}]', - 'title' => '删除全链路泳道', - ], - 'QueryAllSwimmingLaneGroup' => [ - 'summary' => '用于查询所有泳道组。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '116120', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', + 'name' => 'DescSort', + 'in' => 'query', + 'schema' => ['description' => '排序（暂时未使用）。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'FilterParams', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '需要查询的MSE命名空间名字', - 'description' => '需要查询的MSE命名空间名字。', - 'type' => 'string', + 'description' => '参数信息。', + 'type' => 'object', + 'properties' => [ + 'GatewayType' => ['description' => '网关类型。', 'type' => 'string', 'required' => false, 'example' => 'Ingress'], + 'Name' => ['description' => '网关名称。', 'type' => 'string', 'required' => false, 'example' => 'rutain-test'], + 'Vpc' => ['description' => '专有网络。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp13hhyjntbab7w****'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'example' => 'gw-5017305290e14centbrveca****'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_ingresspre-cn-****'], + 'MseTag' => ['description' => '资源标签。', 'type' => 'string', 'required' => false, 'example' => '[{"key":"tagkey","value":"tagvalue"}]'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-7y2uye*****'], + ], 'required' => false, - 'example' => 'default', - 'maxLength' => 64, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicMessage' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '34300B3-52EC-5049-8C96-914098CF****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '泳道组名称', - 'description' => '泳道组名称。', - 'type' => 'string', - 'example' => 'swimmingGroup', - ], - 'UserId' => [ - 'title' => '泳道所属的用户id', - 'description' => '泳道所属的用户ID。', - 'type' => 'string', - 'example' => '12345', - ], - 'MessageQueueFilterSide' => [ - 'title' => '在哪一侧实现消息灰度', - 'description' => '在哪一侧开启消息灰度。', - 'type' => 'string', - 'example' => 'Client', - ], - 'AppIds' => [ - 'title' => '应用Id列表', - 'description' => '应用Id列表。', - 'type' => 'string', - 'example' => 'abcde@abcde,abcde@abcde', - ], - 'Namespace' => [ - 'title' => '泳道所属的MSE命名空间', - 'description' => '泳道所属的MSE命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'RecordCanaryDetail' => [ - 'title' => '是否记录请求详情（全链路灰度可观测）', - 'description' => '是否记录请求详情（全链路灰度可观测）。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Id' => [ - 'title' => '泳道组Id', - 'description' => '泳道组ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'EntryApp' => [ - 'title' => '入口应用类型+入口应用Id', - 'description' => '入口应用类型和入口应用ID。', - 'type' => 'string', - 'example' => 'mse:abcde@abcde', - ], - 'Region' => [ - 'title' => '所属地域', - 'description' => '所属地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'MessageQueueGrayEnable' => [ - 'title' => '是否开启消息灰度', - 'description' => '是否开启消息灰度。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Paths' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '["/a"]', - ], - 'paths' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '["/a"]', - ], - 'CanaryModel' => [ - 'description' => '全链路灰度模式：'."\n" - ."\n" - .'- 0: 按请求内容路由'."\n" - ."\n" - .'- 1: 按比例路由', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'canaryModel' => [ - 'description' => '全链路灰度模式：'."\n" - ."\n" - .'- 0: 按请求内容路由'."\n" - ."\n" - .'- 1: 按比例路由', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SwimVersion' => [ - 'description' => '全链路灰度版本，取值范围：0,2(推荐使用)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'swimVersion' => [ - 'description' => '全链路灰度版本，取值范围：0,2(推荐使用)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', + 'description' => 'Meta返回信息。', + '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' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '153'], + 'Name' => ['description' => '网关名称。', 'type' => 'string', 'example' => 'tesa-test'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-5017305290e14cebb8ce5cb6a4****'], + 'GatewayType' => ['description' => '网关类型。', 'type' => 'string', 'example' => 'Ingress'], + 'Region' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'PrimaryUser' => ['description' => '用户信息。', 'type' => 'string', 'example' => '18278117654342'], + 'Status' => ['description' => '网关状态'."\n" + ."\n" + .'- 0 创建中'."\n" + .'- 1 创建失败'."\n" + .'- 2 运行中'."\n" + .'- 3 变更中'."\n" + .'- 4 缩容中'."\n" + .'- 6 扩容中'."\n" + .'- 8 删除中'."\n" + .'- 9 停服待释放'."\n" + .'- 10 重启中'."\n" + .'- 11 重建中'."\n" + .'- 12 升级中'."\n" + .'- 13 升级失败', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'AhasOn' => ['description' => '是否开启AHAS。', 'type' => 'boolean', 'example' => 'false'], + 'ArmsOn' => ['description' => '是否开启ARMS。', 'type' => 'boolean', 'example' => 'false'], + 'Spec' => ['description' => '规格。', 'type' => 'string', 'example' => 'MSE_GTW_1_2_200_c'], + 'Replica' => ['description' => '备份。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-09-13 19:24:23'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2021-09-13 19:24:23'], + 'StatusDesc' => ['description' => '状态描述。', 'type' => 'string', 'example' => 'Restart'], + 'Slb' => [ + 'description' => 'SLB集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'SLB集合信息。', + 'type' => 'object', + 'properties' => [ + 'SlbIp' => ['description' => 'SLB IP。', 'type' => 'string', 'example' => '153.12.XX.XX'], + 'SlbPort' => ['description' => 'SLB端口。', 'type' => 'string', 'example' => '80'], + 'SlbSpec' => ['description' => 'SLB规格。', 'type' => 'string', 'example' => 'slb.s2.small'], + 'Type' => ['description' => '网络类型'."\n" + ."\n" + .'- PUB_NET：公网'."\n" + .'- PRIVATE_NET：私网', 'type' => 'string', 'example' => 'PUB_NET'], + 'GatewaySlbStatus' => ['description' => '网关SLB状态。', 'type' => 'string', 'example' => 'Ready'], + 'StatusDesc' => ['description' => '状态描述。', 'type' => 'string', 'example' => 'Creating'], + 'GatewaySlbMode' => ['description' => '网关SLB模式。', 'type' => 'string', 'example' => 'UserHost'], + 'SlbId' => ['description' => 'SLB ID。', 'type' => 'string', 'example' => 'lb-bp1ut8asdfgucjk****'], + ], + ], + ], + 'InternetSlb' => [ + 'description' => '互联网SLB。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'SlbIp' => ['description' => 'SLB IP。', 'type' => 'string', 'example' => '153.12.XX.XX'], + 'SlbPort' => ['description' => 'SLB端口。', 'type' => 'string', 'example' => 'slb.s2.small'], + 'SlbSpec' => ['description' => 'SLB规格。', 'type' => 'string', 'example' => 'slb.s2.small'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'PUB_NET'], + 'InternetNetworkFlow' => ['description' => '网关流量。', 'type' => 'string', 'example' => '20'], + 'GatewaySlbStatus' => ['description' => '网关SLB状态。', 'type' => 'string', 'example' => 'Ready'], + 'StatusDesc' => ['description' => '状态描述。', 'type' => 'string', 'example' => '创建中'], + 'GatewaySlbMode' => ['description' => '网关SLB模式。'."\n" + ."\n", 'type' => 'string', 'example' => 'UserHost'], + 'SlbId' => ['description' => 'SLB ID。', 'type' => 'string', 'example' => 'lb-bp1ut8asdfgucjk****'], + ], + ], + ], + 'Upgrade' => ['description' => '升级。', 'type' => 'boolean', 'example' => 'false'], + 'MustUpgrade' => ['description' => '强制升级。', 'type' => 'boolean', 'example' => 'false'], + 'SupportWasm' => ['description' => '是否支持WASM。', 'type' => 'boolean', 'example' => 'true'], + 'CurrentVersion' => ['description' => '当前版本。', 'type' => 'string', 'example' => '0.1.0-mse-gw'], + 'AppVersion' => ['description' => '应用版本。', 'type' => 'string', 'example' => '1.0.1.0'], + 'LatestVersion' => ['description' => '最新版本。', 'type' => 'string', 'example' => '0.1.0-mse-gw'], + 'Vswitch2' => ['description' => '交换机2。', 'type' => 'string', 'example' => 'vsw-bpbrveck45nf****'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse_ingresspost-cn-0jbvrcex****'], + 'ChargeType' => ['description' => '付费类型。', 'type' => 'string', 'example' => 'POSTPAY'], + 'EndDate' => ['description' => '到期日期。', 'type' => 'string', 'example' => '4792060800000'], + 'Tag' => ['description' => '标签。', 'type' => 'string', 'example' => 'test'], + 'InitConfig' => [ + 'description' => '配置信息。', + 'type' => 'object', + 'properties' => [ + 'EnableWaf' => ['description' => '是否开启WAF。', 'type' => 'boolean', 'example' => 'true'], + 'SupportWaf' => ['description' => '是否支持WAF。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'GatewayVersion' => ['description' => '网关版本。', 'type' => 'string', 'example' => '1.2.9'], + 'RollBack' => ['description' => '是否支持回滚。', 'type' => 'boolean', 'example' => 'false'], + 'MseTag' => ['description' => '资源标签。', 'type' => 'string', 'example' => '{"tagKey":"tagValue"}'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-97hg87vi****'], + 'TotalReplica' => ['description' => '总副本数（包括自动扩容副本数）。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'Elastic' => ['description' => '是否开启自动扩容。', 'type' => 'boolean', 'example' => 'true'], + 'ElasticReplica' => ['description' => '自动扩容副本数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'ElasticType' => ['description' => '自动扩容类型，目前支持：'."\n" + ."\n" + .'- CronHPA：按时间扩容', 'type' => 'string', 'example' => 'CronHPA'], + 'ElasticPolicy' => [ + 'description' => '自动扩容策略。', + 'type' => 'object', + 'properties' => [ + 'Elastic' => ['description' => '是否开启自动扩容。', 'type' => 'boolean', 'example' => 'true'], + 'MaxReplica' => ['description' => '自动扩容最大实例数（水平扩容时使用）。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ElasticType' => ['description' => '自动扩容类型，目前支持：'."\n" + ."\n" + .'* CronHPA：按时间扩容', 'type' => 'string', 'example' => 'CronHPA'], + 'TimePolicyList' => [ + 'description' => '自动扩容时间策略列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DesiredReplica' => ['description' => '自动扩容期望副本数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'StartTime' => ['description' => '自动扩容起始时间。', 'type' => 'string', 'example' => '07:00'], + 'EndTime' => ['description' => '自动扩容结束时间。', 'type' => 'string', 'example' => '09:00'], + ], + 'description' => '', + ], + ], + 'LoadWarningThreshold' => ['title' => '网关按负载弹性的水位设置，true表示开启警戒水位，false表示开启安全水位', 'description' => '网关按负载弹性的水位设置，true表示开启警戒水位，false表示开启安全水位', 'type' => 'boolean'], + 'EnableScaleTimePolicyList' => [ + 'title' => '允许缩容时间段', + 'description' => '允许缩容时间段', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '开始时间。', 'type' => 'string'], + 'EndTime' => ['description' => '结束时间。', 'type' => 'string'], + ], + 'description' => '', + ], + ], + ], + ], + 'ElasticInstanceId' => ['description' => '网关弹性实例ID，使用自动扩容时返回。', 'type' => 'string', 'example' => 'mse_ingresselastic_public_cn-uqm3d0*****'], + 'VpcId' => ['description' => '网关VPC ID。', 'type' => 'string', 'example' => 'vpc-uf6heojei217tv14*****'], + 'MseVersion' => ['description' => '集群版本。', 'type' => 'string'], + 'MaintenancePeriod' => [ + 'description' => '运维时间窗口。', + 'type' => 'object', + 'properties' => [ + 'TimeZone' => ['description' => '时区。', 'type' => 'string'], + 'StartTime' => ['description' => '开始时间。', 'type' => 'string'], + 'EndTime' => ['description' => '结束时间。', 'type' => 'string'], + ], + ], + 'GatewayEntry' => [ + 'title' => '网关入口地址（适用普通实例专业版）', + 'description' => '网关入口地址（适用普通实例专业版）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NetType' => ['title' => '入口网络类型'."\n" + ."\n" + .'- PRIVATE_NET：私网'."\n" + ."\n" + .'- PUB_NET：公网', 'description' => '入口网络类型'."\n" + ."\n" + .'- PRIVATE_NET：私网'."\n" + ."\n" + .'- PUB_NET：公网', 'type' => 'string', 'example' => 'PUB_NET'], + 'EntryDomain' => ['title' => '入口域名', 'description' => '入口域名', 'type' => 'string', 'example' => 'gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com'], + 'IpList' => [ + 'title' => '入口IP列表', + 'description' => '入口IP列表', + 'type' => 'array', + 'items' => ['title' => '入口IP', 'description' => '入口IP', 'type' => 'string', 'example' => '1.2.3.4'], + ], + 'HttpPorts' => [ + 'title' => 'HTTP监听端口列表', + 'description' => 'HTTP监听端口列表', + 'type' => 'array', + 'items' => ['title' => 'HTTP监听端口', 'description' => 'HTTP监听端口', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + ], + 'HttpsPorts' => [ + 'title' => 'HTTPS监听端口列表', + 'description' => 'HTTPS监听端口列表', + 'type' => 'array', + 'items' => ['title' => 'HTTPS监听端口', 'description' => 'HTTPS监听端口', 'type' => 'integer', 'format' => 'int32', 'example' => '443'], + ], + ], + 'description' => '', + ], + ], + 'VersionLifecycle' => ['description' => '版本生命周期', 'type' => 'string'], + ], ], ], ], - 'example' => '[{id:100,name:"test"}]'."\n", ], ], ], @@ -28006,53 +19260,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": 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 }\\n ],\\n \\"VersionLifecycle\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询网关信息列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询所有泳道组', ], - 'QueryAllSwimmingLane' => [ - 'summary' => '获取所有泳道信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayAuthConsumer' => [ + 'summary' => '获取网关鉴权消费者列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -28060,445 +19302,105 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '116125', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-0fe488252dc44d55a9dd57875193****'], ], [ - 'name' => 'GroupId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '泳道组id。', - 'description' => '泳道组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '186', - ], + 'schema' => ['description' => '鉴权消费者名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '鉴权类型：'."\n" + ."\n" + .'- JWT', 'type' => 'string', 'required' => false, 'example' => 'JWT'], + ], + [ + 'name' => 'ConsumerStatus', + 'in' => 'query', + 'schema' => ['description' => '鉴权消费者状态：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：停用', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => '当前页数值。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '当前页的大小。', 'type' => 'string', 'required' => true, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'title' => '请求信息。', - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'OK', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'dc63-465d-8ef5-20dc18af****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%**s**。'."\n" + ."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则表示所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '泳道组名称。', - 'description' => '泳道组名称。', - 'type' => 'string', - 'example' => 'swimmingGroup', - ], - 'UserId' => [ - 'title' => '泳道所属的用户id。', - 'description' => '泳道所属的用户id。', - 'type' => 'string', - 'example' => '12345', - ], - 'MessageQueueFilterSide' => [ - 'title' => '在哪一侧实现消息灰度。', - 'description' => '在哪一侧实现消息灰度。', - 'type' => 'string', - 'example' => 'Client', - ], - 'Enable' => [ - 'title' => '是否开启。', - 'description' => '是否开启。', - 'type' => 'string', - 'example' => 'true', - ], - 'Namespace' => [ - 'title' => '泳道所属的MSE命名空间。', - 'description' => '泳道所属的MSE命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'RecordCanaryDetail' => [ - 'title' => '是否记录请求详情（全链路灰度可观测）。', - 'description' => '是否记录请求详情（全链路灰度可观测）。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Id' => [ - 'title' => '泳道组Id。', - 'description' => '泳道Id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RegionId' => [ - 'title' => '所属地域。', - 'description' => '所属地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'MessageQueueGrayEnable' => [ - 'title' => '是否开启消息灰度。', - 'description' => '是否开启消息灰度。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'enableRules' => [ - 'title' => '是否开启规则。', - 'description' => '是否开启规则。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EntryRules' => [ - 'description' => '入口应用规则列表', - 'type' => 'array', - 'items' => [ - 'description' => '入口应用规则', - 'type' => 'object', - 'properties' => [ - 'paths' => [ - 'description' => '路径列表', - 'type' => 'array', - 'items' => [ - 'description' => '路径', - 'type' => 'string', - 'example' => '/', - ], - ], - 'path' => [ - 'title' => '', - 'description' => '路径', - 'type' => 'string', - 'example' => '/adump/wxb/prod', - ], - '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' => 'test', - ], - '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' => 'test', - ], - ], - ], - ], - ], - ], - ], - 'gmtCreate' => [ - 'title' => '泳道创建时间。', - 'description' => '泳道创建时间。', - 'type' => 'string', - 'example' => '1683598484000', - ], - 'gmtModified' => [ - 'title' => '泳道更新时间。', - 'description' => '泳道更新时间。', - 'type' => 'string', - 'example' => '1683598484000', - ], - 'groupId' => [ - 'title' => '泳道组Id。', - 'description' => '泳道组Id。', - 'type' => 'string', - 'example' => '72709', - ], - 'GroupId' => [ - 'title' => '泳道组Id。', - 'description' => '泳道组Id。', - 'type' => 'string', - 'example' => '6859', - ], - 'tag' => [ - 'title' => '泳道对应的标签。', - 'description' => '泳道对应的标签。', - 'type' => 'string', - 'example' => 'gray', - ], - 'Tag' => [ - 'title' => '泳道对应的标签。', - 'description' => '泳道对应的标签。', - 'type' => 'string', - 'example' => 'gray', - ], - 'GatewaySwimmingLaneRoute' => [ - 'title' => '网关路由信息（使用云原生网关为入口时使用）', - 'description' => '网关路由信息（使用云原生网关/APIG网关为入口时使用）', - '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' => '路由ID', - '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' => '路由 id', - 'type' => 'string', - 'example' => '12345', - ], - 'Percentage' => [ - 'description' => '百分比', - 'type' => 'string', - 'example' => '60', - ], - ], - ], - ], - 'Condition' => [ - 'description' => '灰度条件', - 'type' => 'string', - 'example' => 'AND、OR', - ], - ], - ], - 'PathIndependentPercentageEnable' => [ - 'description' => '是否设置每条路径的百分比', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GatewaySwimmingLaneRouteJson' => [ - 'description' => '网关相关信息（MSE云原生网关/云原生API网关作为入口时使用）', - 'type' => 'string', - 'example' => '{\\"GatewayUniqueId\\":\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\",\\"Percentage\\":0,\\"RouteIdList\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\"CanaryModel\\":1,\\"Conditions\\":[]}', + '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' => '鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['description' => '鉴权消费者名称。', 'type' => 'string', 'example' => 'test'], + 'ConsumerStatus' => ['description' => '鉴权消费者状态：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：停用', 'type' => 'boolean', 'example' => 'true'], + 'PrimaryUser' => ['description' => '创建人。', 'type' => 'string', 'example' => '123'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****'], + 'Type' => ['description' => '鉴权类型：'."\n" + ."\n" + .'- JWT', 'type' => 'string', 'example' => 'JWT'], + 'Description' => ['description' => '鉴权消费者描述。', 'type' => 'string', 'example' => 'Description'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-09-13 19:24:23'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + ], ], ], ], - 'example' => '[{id:100,name:"test"}]', ], ], ], @@ -28506,53 +19408,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取网关鉴权消费者列表', + '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 \\"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' => '查询当前泳道组内所有泳道', ], - 'GetTagsBySwimmingLaneGroupId' => [ - 'summary' => '用于获取当前泳道组内的所有标签。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayAuthConsumerResource' => [ + 'summary' => '获取网关鉴权消费者的授权列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -28560,86 +19451,99 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '泳道组ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '154', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****'], ], [ - 'name' => 'Namespace', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'title' => '需要查询的MSE命名空间名字', - 'description' => '需要查询的MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => '网关鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => ['description' => '路由名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'ResourceStatus', + 'in' => 'query', + 'schema' => ['description' => '资源状态：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：停用', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '当前页的大小。', 'type' => 'string', 'required' => true, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'description' => '标签数据。', - 'type' => 'array', - 'items' => [ - 'description' => '标签数据。', - 'type' => 'string', - 'example' => '[{"desc":"k8s-pod-label","priority":100,"tag":"gray","type":"tag"}]', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + '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' => '鉴权消费者授权ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ConsumerId' => ['description' => '网关鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3091'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'test'], + 'ResourceStatus' => ['description' => '资源授权状态：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：停用', 'type' => 'boolean', 'example' => 'true'], + 'GatewayUniqueId' => ['description' => '网关唯一标识。', 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + ], + ], + ], ], - 'example' => '["gray"]', ], ], ], @@ -28647,53 +19551,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取网关鉴权消费者的授权列表', + '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 \\"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' => '获取当前泳道组内的所有标签', ], - 'QuerySwimmingLaneById' => [ - 'summary' => '用于通过泳道ID查询泳道信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayCircuitBreakerRule' => [ + 'summary' => '查询该网关熔断规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -28701,265 +19594,150 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '116123', - 'abilityTreeNodes' => [ - 'FEATUREmseCR8P7I', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'LaneId', - 'in' => 'query', - 'schema' => [ - 'description' => '泳道ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '250', - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'FilterParams', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['title' => 'just for POP', 'description' => 'just for POP', 'type' => 'string', 'required' => true, 'example' => 'param'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'title' => '请求信息。', - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], 'Data' => [ - 'description' => '数据概览。', + 'description' => '返回数据。', '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' => '入口应用规则详情', + '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' => '入口应用规则', + 'description' => '返回集合。', 'type' => 'object', 'properties' => [ - 'paths' => [ - 'description' => '路径列表', + 'Id' => ['description' => '熔断规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '467'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '11919'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3091'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeName'], + 'Strategy' => ['description' => '阈值模式。'."\n" + ."\n" + .'0：慢调用模式。'."\n" + ."\n" + .'1：异常模式。', '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' => '阈值转化模式。'."\n" + ."\n" + .'0：单机。'."\n" + ."\n" + .'1：集群。'."\n" + ."\n" + .'2：集群转单机。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BehaviorType' => ['description' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '204'], + 'ResponseContentBody' => ['description' => 'HTTP返回文本。', 'type' => 'string', 'example' => 'text'], + 'ResponseRedirectUrl' => ['description' => '跳转地址。', 'type' => 'string', 'example' => 'www.******.com'], + 'ResponseAdditionalHeaders' => ['description' => '自定义header，输入为key-value键值对。', 'type' => 'string', 'example' => 'key=value'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '筛选规则id', 'type' => 'array', - 'items' => [ - 'description' => '路径', - 'type' => 'string', - 'example' => '/', - ], - ], - 'path' => [ - 'title' => '', - 'description' => '路径', - 'type' => 'string', - 'example' => '/', - ], - 'condition' => [ - 'description' => '条件', - 'type' => 'string', - 'example' => 'AND', + 'items' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '467'], ], - 'restItems' => [ - 'description' => 'Rest匹配规则列表', + ], + ], + ], + 'Results' => [ + 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', + 'description' => '返回结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '返回集合。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '熔断规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '467'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '11919'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-1ee34548c68f4778a25c05abd657****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3450'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeName'], + 'Strategy' => ['description' => '阈值模式。'."\n" + ."\n" + .'0：慢调用模式。'."\n" + ."\n" + .'1：异常模式。', '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' => '阈值转化模式。'."\n" + ."\n" + .'0：单机。'."\n" + ."\n" + .'1：集群。'."\n" + ."\n" + .'2：集群转单机。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BehaviorType' => ['description' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容'."\n" + ."\n" + .'1：跳转到指定页面', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '204'], + 'ResponseContentBody' => ['description' => 'HTTP返回文本。', 'type' => 'string', 'example' => 'text'], + 'ResponseRedirectUrl' => ['description' => '跳转地址。', 'type' => 'string', 'example' => 'www.******.com'], + 'ResponseAdditionalHeaders' => ['description' => '自定义header，输入为key-value键值对。', 'type' => 'string', 'example' => 'key=value'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '筛选规则id', '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', - ], - ], - ], + 'items' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '467'], ], ], ], ], - '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' => '已废弃。Java网关为泳道组入口时使用该参数指定是否开启按照Path进行比例灰度。', - 'type' => 'boolean', - 'example' => 'false', - ], ], - 'example' => '{id:102,name:"test"}', ], ], ], @@ -28967,53 +19745,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关熔断规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '通过泳道ID查询泳道信息', ], - 'ListAppBySwimmingLaneGroupTags' => [ - 'summary' => '获取指定泳道组内的指定标签的应用列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayDomain' => [ + 'summary' => '查询网关已关联域名列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -29023,136 +19789,90 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', + 'abilityTreeCode' => '35641', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], ], 'parameters' => [ [ - 'name' => 'Tags', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '要查询的标签。', - 'description' => '要查询的标签。', - 'type' => 'array', - 'items' => [ - 'title' => '要查询的标签。', - 'description' => '要查询的标签。', - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], - 'required' => false, - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****'], ], [ - 'name' => 'GroupId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '泳道组id。', - 'description' => '泳道组id。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '域名类型。', 'type' => 'string', 'required' => false, 'example' => 'All'], ], [ - 'name' => 'Namespace', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'title' => '需要查询的MSE命名空间名字。', - 'description' => '需要查询的MSE命名空间名字。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['title' => '按域名模糊搜索', 'description' => '按域名模糊搜索', 'type' => 'string', 'required' => false, 'example' => 'example.com'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id。', - 'description' => '请求id。', - 'type' => 'string', - 'example' => '6832e76b-bb5f-4dea-****-************', - ], - 'Success' => [ - 'title' => '请求是否成功。', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'ErrorCode' => [ - 'title' => '请求错误码。', - 'description' => '请求错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'title' => '请求附加信息。', - 'description' => '请求附加信息。', - 'type' => 'string', - 'example' => 'OK', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3F5D8E93-CA66-57F1-8BCF-A223E11B6B91'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'title' => '请求返回数据。', - 'description' => '请求返回数据。', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '每个tag对应的应用信息列表。', - 'description' => '返回信息', - 'type' => 'array', - 'items' => [ - 'title' => '应用列表。', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '应用所属的用户id。', - 'type' => 'string', - 'example' => '12345', - 'description' => '应用所属的用户id。', - ], - 'RegionId' => [ - 'title' => '应用所在地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'description' => '应用所在地域。', - ], - 'Namespace' => [ - 'title' => '应用所在的微服务命名空间。', - 'type' => 'string', - 'example' => 'default', - 'description' => '应用所在的微服务命名空间。', - ], - 'AppName' => [ - 'title' => '应用名字。', - 'type' => 'string', - 'example' => 'example-app-name', - 'description' => '应用名字。', - ], - 'AppId' => [ - 'title' => '应用id。', - 'type' => 'string', - 'example' => '123456abcde@12345abcde', - 'description' => '应用id。', + 'description' => '节点数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '域名ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '243'], + 'Name' => ['description' => '域名。', 'type' => 'string', 'example' => 'test.com'], + 'Protocol' => ['description' => '协议。', 'type' => 'string', 'example' => 'HTTP'], + 'MustHttps' => ['description' => '是否强制HTTPS。', 'type' => 'boolean', 'example' => 'true'], + 'CertIdentifier' => ['description' => '证书ID。', 'type' => 'string', 'example' => '3452-cn-hangzhou'], + 'CertBeforeDate' => ['description' => '证书到期时间（已废弃，请进入域名详情页查看）。', 'type' => 'string', 'example' => ' 2031-03-30 02:35:12'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'GmtCreate' => ['description' => '域名记录创建时间。', 'type' => 'string', 'example' => ' 2031-03-30 02:35:12'], + 'GmtModified' => ['description' => '域名记录更新时间。', 'type' => 'string', 'example' => ' 2031-03-30 02:35:12'], + 'Status' => ['description' => '域名状态。'."\n" + .'枚举值'."\n" + ."\n" + .'- 0未发布'."\n" + .'- 2发布中'."\n" + .'- 3已发布'."\n" + .'- 4编辑中'."\n" + .'- 5下线中'."\n" + .'- 6不可用', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'Type' => ['description' => '域名来源类型：'."\n" + .'- Op：控制台创建'."\n" + .'- Ingress：MSE Ingress创建', 'type' => 'string', 'example' => 'Op'], + 'Comment' => [ + 'description' => '路由备注（ingress）', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'Error'], ], ], + 'Http2' => ['description' => '是否开启`Http2`。'."\n" + .'- `open`：开启`Http2`。'."\n" + .'- `close`：关闭`Http2`。'."\n" + .'- `globalConfig`：使用全局配置。', 'type' => 'string', 'example' => 'close'], + 'TlsMax' => ['description' => 'Tls最大版本。', 'type' => 'string', 'example' => 'TLS 1.3'], + 'TlsMin' => ['description' => 'Tls最小版本.', 'type' => 'string', 'example' => 'TLS 1.0'], + 'IsManaged' => ['title' => '是否为托管域名', 'description' => '是否为托管域名', 'type' => 'boolean'], ], ], ], @@ -29162,149 +19882,336 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 }\\n ]\\n}","type":"json"}]', + 'title' => '查询网关已关联域名列表', + '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}'], + ], + ], + ], ], - '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' => '获取泳道组内的指定标签的应用列表', ], - 'ListAppBySwimmingLaneGroupTag' => [ - 'summary' => '用于获取当前泳道组内的指定标签的应用列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayFlowRule' => [ + 'summary' => '查询该网关流控规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'schema' => [ - 'title' => '标签名字。', - 'description' => '标签。', - 'type' => 'string', - 'required' => true, - 'example' => 'gray', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '泳道组id。', - 'description' => '泳道组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '119', - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'FilterParams', 'in' => 'query', - 'schema' => [ - 'title' => '需要查询的MSE命名空间名字', - 'description' => '需要查询的MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['title' => 'just for POP', 'description' => 'just for POP', 'type' => 'string', 'required' => true, 'example' => 'param'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'title' => 'RestResult>', + 'description' => 'RestResult>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0951EBF0-798E-5E0B-8D38-460A14AD****'], + 'Data' => [ + 'description' => 'Meta返回信息。', + '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' => '路由流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '549'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14407'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '48811'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeA'], + 'Threshold' => ['description' => '总体QPS阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'BehaviorType' => ['description' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容'."\n" + ."\n" + .'1：跳转到指定页面', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '429'], + 'ResponseContentBody' => ['description' => 'Http返回文本。', 'type' => 'string', 'example' => 'text'], + 'ResponseRedirectUrl' => ['description' => '跳转地址。', 'type' => 'string', 'example' => 'www.******.com'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', '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' => '路由流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '549'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14407'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '48811'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeA'], + 'Threshold' => ['description' => '总体QPS阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'StatDurationMs' => ['description' => '统计持续时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'LimitMode' => ['description' => '阈值转化模式。'."\n" + ."\n" + .'0：单机。'."\n" + ."\n" + .'1：集群。'."\n" + ."\n" + .'2：集群转单机。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BehaviorType' => ['description' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容'."\n" + ."\n" + .'1：跳转到指定页面', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '429'], + 'ResponseContentBody' => ['description' => 'Http返回文本。', 'type' => 'string', 'example' => 'text'], + 'ResponseRedirectUrl' => ['description' => '跳转地址。', 'type' => 'string', 'example' => 'www.******.com'], + 'ResponseAdditionalHeaders' => ['description' => '自定义header，输入为key-value键值对。', 'type' => 'string', 'example' => 'key=value'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '筛选规则id。', + 'type' => 'array', + 'items' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '549'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关流控规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + 'ListGatewayIsolationRule' => [ + 'summary' => '查询该网关并发规则。', + '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' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6F025D43-8632-5716-AE9B-7EDDF16C****'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'any', - 'example' => '[{appName:"test",appId:"hkhon1po62@958bba95910341f'."\n" - .'"}]', + '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' => '并发规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '358'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14407'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '52853'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeName'], + 'MaxConcurrency' => ['description' => '总体并发数阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'LimitMode' => ['description' => '阈值转化模式。'."\n" + ."\n" + .'0：单机'."\n" + ."\n" + .'1：集群'."\n" + ."\n" + .'2：集群转单机', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BehaviorType' => ['description' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本。'."\n" + ."\n" + .'1：JSON。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '429'], + 'ResponseContentBody' => ['description' => 'HTTP返回文本。', 'type' => 'string', 'example' => 'text'], + 'ResponseRedirectUrl' => ['description' => '跳转地址。', 'type' => 'string', 'example' => 'www.******.com'], + 'ResponseAdditionalHeaders' => ['description' => '自定义header，输入为key-value键值对', 'type' => 'string', 'example' => 'key:value'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '筛选规则id', + 'type' => 'array', + 'items' => ['description' => '规则ID。', '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' => '并发规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '358'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14407'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '52853'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeName'], + 'MaxConcurrency' => ['description' => '总体并发数阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'LimitMode' => ['description' => '阈值转化类型。'."\n" + ."\n" + .'0：单机。'."\n" + ."\n" + .'1：集群。'."\n" + ."\n" + .'2：单机转集群。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'BehaviorType' => ['description' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本。'."\n" + ."\n" + .'1：JSON。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '429'], + 'ResponseContentBody' => ['description' => 'HTTP返回文本。', 'type' => 'string', 'example' => 'text'], + 'ResponseRedirectUrl' => ['description' => '跳转地址。', 'type' => 'string', 'example' => 'www.******.com'], + 'ResponseAdditionalHeaders' => ['description' => '自定义header，输入为key-value键值对', 'type' => 'string', 'example' => 'key=value'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '筛选规则id', + 'type' => 'array', + 'items' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '358'], + ], + ], + ], + ], + ], ], ], ], @@ -29312,56 +20219,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'mse::2019-05-31::ListAppBySwimmingLaneGroupTags', + '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' => '查询网关并发规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取当前泳道组内的指定标签的应用列表', ], - 'GetLosslessRuleByApp' => [ - 'summary' => '获取指定应用无损上下线规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayRoute' => [ + 'summary' => '查询网关路由列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -29371,186 +20263,314 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '173262', - 'abilityTreeNodes' => [ - 'FEATUREmse9OTHB7', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '25969', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => 'region id, such as cn-hangzhou', - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'AppName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'Key word of search lossless list', - 'description' => '应用名。', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - ], + 'schema' => ['description' => '每页展示实例数（暂未生效，默认查询全量）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Namespace', + 'name' => 'OrderItem', 'in' => 'query', - 'schema' => [ - 'description' => 'MSE命名空间名。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '排序属性。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreate'], ], [ - 'name' => 'AppId', + 'name' => 'DescSort', 'in' => 'query', + 'schema' => ['description' => '排序。该字段目前不可用，下线中。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'FilterParams', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'appId', - 'description' => '应用ID。', - 'type' => 'string', + 'description' => '过滤条件，格式为{"key1":"value1"}。', + 'type' => 'object', + 'properties' => [ + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '81'], + 'Name' => ['description' => '路由名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Status' => ['description' => '路由状态：'."\n" + ."\n" + .'- 未发布：0'."\n" + .'- 发布中：2'."\n" + .'- 已发布：3'."\n" + .'- 编辑中(有更新未发布)：4'."\n" + .'- 下线中：5'."\n" + .'- 不可用：6', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'DefaultServiceId' => ['title' => '默认服务ID（已废弃）', 'description' => '缺省服务ID。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '1'], + 'RouteOrder' => ['description' => '顺序（未使用）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'DomainId' => ['description' => '域名id。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '284'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-30a0106924c94bca8712ec4e79fc5acc'], + 'DomainName' => ['description' => '关联域名', 'type' => 'string', 'required' => false, 'example' => '*.alites.com'], + 'Path' => ['title' => '按路由路径模糊搜索', 'description' => '路由路径。', 'type' => 'string', 'required' => false, 'example' => '/test'], + ], 'required' => false, - 'example' => 'hkhon1po62@c3df23522baa***', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - .'* zh：中文。'."\n" - .'* en：英文。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => '返回值。', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- true：请求成功。'."\n" - .'- false：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '83F02EAB-ECDF-55C6-B332-8649E5E7AF2C'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '代码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'title' => 'appName', - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'AppId' => [ - 'title' => 'appId', - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@24810bf4364a***', - ], - 'Count' => [ - 'title' => 'instance\'s count of app', - 'description' => '实例数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Enable' => [ - 'title' => 'rule is open or close', - 'description' => '无损上线启用状态。取值：'."\n" - ."\n" - .'- `true`：启用。'."\n" - .'- `false`：禁用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'WarmupTime' => [ - 'description' => '预热时长（秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'DelayTime' => [ - 'description' => '延迟注册时间（秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'FuncType' => [ - 'title' => 'warmup function type, 2 means f(x)=x^2', - 'description' => '预热曲线斜率。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Aligned' => [ - 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', - 'description' => '是否开启“通过就绪检查前完成服务注册”。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Related' => [ - 'title' => 'K8s\'s HPA is related to warmup or NOT', - 'description' => '是否开启“通过就绪检查前完成服务预热”。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'LossLessDetail' => [ - 'title' => 'show lossLess offline&online detail', - 'description' => '是否开启上下线处理明细。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Notice' => [ - 'title' => 'enable lossLess offline active notification', - 'description' => '是否开启主动通知。', - 'type' => 'boolean', - 'example' => 'false', + 'TotalSize' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '36'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Result' => [ + 'description' => '数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '返回集合。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '47'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => '网关唯一标识。', 'type' => 'string', 'example' => 'gw-cf0e7f52ecc7429dbc7ba4d5e3656100'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '496'], + 'Status' => ['description' => '状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'RouteOrder' => ['description' => '顺序', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DefaultServiceName' => ['description' => '默认服务名称。', 'type' => 'string', 'example' => 'test'], + 'DefaultServiceId' => ['description' => '默认服务id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Predicates' => ['description' => '匹配规则', 'type' => 'string', 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/rpc/compute \\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":true}}'], + 'RoutePredicates' => [ + 'description' => '匹配规则', + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => '路由Path匹配。', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => '节点路径。', 'type' => 'string', 'example' => '/getIp'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'example' => 'PRE'], + 'IgnoreCase' => ['description' => '忽略大小写', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'MethodPredicates' => [ + 'description' => 'HTTP方法匹配', + 'type' => 'array', + 'items' => ['description' => '方法', 'type' => 'string', 'example' => 'GET'], + ], + 'HeaderPredicates' => [ + 'description' => 'Header匹配', + 'type' => 'array', + 'items' => [ + 'description' => 'Header列表', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Header KEY ', 'type' => 'string', 'example' => 'userid'], + 'Value' => ['description' => '匹配值', 'type' => 'string', 'example' => 'test'], + 'Type' => ['description' => '匹配类型', 'type' => 'string', 'example' => 'PRE'], + ], + ], + ], + 'QueryPredicates' => [ + 'description' => '参数匹配', + 'type' => 'array', + 'items' => [ + 'description' => '参数列表', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '参数名称', 'type' => 'string', 'example' => 'userid'], + 'Value' => ['description' => '匹配值', 'type' => 'string', 'example' => 'test'], + 'Type' => ['description' => '匹配类型', 'type' => 'string', 'example' => 'PRE'], + ], + ], + ], + ], + ], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-25T07:14:01.817+0000'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'Services' => ['description' => '服务。', 'type' => 'string', 'example' => '[]'], + 'RouteServices' => [ + 'description' => '服务。', + 'type' => 'array', + 'items' => [ + 'description' => '服务列表', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1563'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'hu'], + 'Percent' => ['description' => '权重百分比', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'Version' => ['description' => '服务版本。', 'type' => 'string', 'example' => 'v1'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'], + 'SourceType' => ['description' => '来源类型', 'type' => 'string', 'example' => 'MSE'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'GroupName' => ['description' => '服务组名称。', 'type' => 'string', 'example' => 'api'], + 'AgreementType' => ['description' => '协议类型。', 'type' => 'string', 'example' => 'DUBBO'], + 'HttpDubboTranscoder' => [ + 'description' => 'Dubbo协议转换体。', + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => ['description' => 'Dubbo服务名称。', 'type' => 'string', 'example' => 'org.apache.dubbo.samples.basic.api.DemoService'], + 'DubboServiceVersion' => ['description' => 'Dubbo服务版本。', 'type' => 'string', 'example' => '0.0.0'], + 'MothedMapList' => [ + 'description' => 'Dubbo转发规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '方法映射体。', + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => ['description' => 'Dubbo方法名。', 'type' => 'string', 'example' => 'sayHello'], + 'HttpMothed' => ['description' => 'Http方法。'."\n" + .'> 支持http方法参数值。'."\n" + .'> - ALL_GET'."\n" + .'> - ALL_POST'."\n" + .'> - ALL_PUT'."\n" + .'> - ALL_DELETE'."\n" + .'> - ALL_PATCH'."\n", 'type' => 'string', 'example' => 'ALL_GET'], + 'Mothedpath' => ['description' => '方法匹配路径。', 'type' => 'string', 'example' => '/mytestzbk/sayhello'], + 'PassThroughAllHeaders' => ['description' => 'Header透传类型。'."\n" + .'> 透传类型枚举值。'."\n" + .'> - 透传所有：PASS_ALL'."\n" + .'> - 不透传：PASS_NOT'."\n" + .'> - 指定参数：PASS_ASSIGN', 'type' => 'string', 'example' => 'PASS_NOT'], + 'PassThroughList' => [ + 'description' => '指定透传Header列表。', + 'type' => 'array', + 'items' => ['description' => '指定Header透传值。', 'type' => 'string', 'example' => 'x-forward'], + ], + 'ParamMapsList' => [ + 'description' => '参数映射列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数映射体。', + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => ['description' => '入参位置。'."\n" + .'> 入参位置枚举值。'."\n" + .'> - 请求参数：`ALL_QUERY_PARAMETER`'."\n" + .'> - 请求头：`ALL_HEADER`'."\n" + .'> - 请求路径：`ALL_PATH`'."\n" + .'> - 请求体：`ALL_BODY`'."\n", 'type' => 'string', 'example' => 'ALL_QUERY_PARAMETER'], + 'ExtractKey' => ['description' => '入参位提取Key。', 'type' => 'string', 'example' => 'name'], + 'MappingType' => ['description' => '后端参数类型。', 'type' => 'string', 'example' => 'java.lang.String'], + ], + ], + ], + ], + ], + ], + 'DubboServiceGroup' => ['description' => 'Dubbo服务组。', 'type' => 'string', 'example' => 'service group'], + ], + ], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '20880'], + 'HealthStatus' => ['title' => '健康状态'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Checking'."\n" + ."\n" + .'- Unknown', 'description' => '健康状态'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Checking'."\n" + ."\n" + .'- Unknown', 'type' => 'string', 'example' => 'Health'], + 'UnhealthyEndpoints' => [ + 'title' => '非健康Endpoint列表', + 'description' => '非健康Endpoint列表', + 'type' => 'array', + 'items' => ['title' => '非健康Endpoint', 'description' => '非健康Endpoint', 'type' => 'string', 'example' => '192.168.1.2'], + ], + ], + ], + ], + 'DomainId' => ['description' => '域名ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '265'], + 'DomainName' => ['description' => '域名。', 'type' => 'string', 'example' => 'y.com'], + 'DestinationType' => ['description' => '目标类型。', 'type' => 'string', 'example' => 'Single'], + 'DirectResponse' => [ + 'description' => 'Mock配置', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Body' => ['description' => 'Mock返回值', 'type' => 'string', 'example' => 'hello'], + ], + ], + 'DomainIdList' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => ['description' => '域名ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + ], + 'DomainNameList' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => ['description' => '域名', 'type' => 'string', 'example' => 'test.com'], + ], + 'Redirect' => [ + 'description' => '重定向', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Host' => ['description' => '重定向主机名', 'type' => 'string', 'example' => 'test.com'], + 'Path' => ['description' => '路径。', 'type' => 'string', 'example' => '/test'], + ], + ], + 'Type' => ['description' => '路由类型', 'type' => 'string', 'example' => 'Op'], + 'Comment' => [ + 'description' => '路由备注（ingress）', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'error'], + ], + ], + 'EnableWaf' => ['description' => '是否开启waf', 'type' => 'string', 'example' => 'false'], + 'Fallback' => ['description' => '是否开启Fallback服务。', 'type' => 'boolean', 'example' => 'true'], + 'FallbackServices' => [ + 'description' => 'Fallback服务。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '353'."\n"], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'service name'], + 'Percent' => ['description' => '权重百分比。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Version' => ['description' => '服务版本。', 'type' => 'string', 'example' => 'v1'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'name'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'example' => 'MSE'."\n"], + 'Namespace' => ['description' => '服务所在命名空间。', 'type' => 'string', 'example' => 'Namespace'], + 'GroupName' => ['description' => '服务分组名称。', 'type' => 'string', 'example' => 'test'], + 'AgreementType' => ['description' => '协议类型。', 'type' => 'string', 'example' => 'DUBBO'], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '8848'], + ], + ], + ], + 'DynamicRoute' => ['title' => '是否开启动态路由', 'description' => '是否开启动态路由', 'type' => 'boolean'], + ], + ], ], ], ], @@ -29560,275 +20580,429 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '网关路由列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewayRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取指定应用无损上下线规则', - 'description' => '调用GetLosslessRuleByApp接口来获取指定应用的无损上下线的配置规则。'."\n" - ."\n" - .'优先按AppId查询。'."\n" - ."\n" - .'若AppId为空，使用RegionId+Namespace+AppName查询。', ], - 'ModifyLosslessRule' => [ - 'summary' => '修改用户无损上下线配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewayRouteOnAuth' => [ + 'summary' => '获取开启鉴权的路由列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '115999', - 'abilityTreeNodes' => [ - 'FEATUREmse9OTHB7', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => 'regionId', - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****'], ], [ - 'name' => 'AppName', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => 'appName', - 'description' => '应用名。', - 'type' => 'string', - 'required' => false, - 'example' => 'wx-work-api', - ], + 'schema' => ['description' => '鉴权类型：'."\n" + ."\n" + .'- JWT', 'type' => 'string', 'required' => true, 'example' => 'JWT'], ], [ - 'name' => 'Namespace', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => 'namespace', - 'description' => '规则所属的微服务命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'default' => 'default', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'AppId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'appName', - 'description' => '应用ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'c644n5frmc@3e75f25fd4*****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'description' => '节点数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'Name' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'ceshi'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597c****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'string', 'example' => '399'], + 'RoutePredicates' => [ + 'description' => '路由匹配。', + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => '路由匹配。', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => '路径。', 'type' => 'string', 'example' => '/api'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'example' => 'PRE'], + ], + ], + ], + ], + 'DomainId' => ['description' => '域名ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '235'], + 'DomainName' => ['description' => '域名。', 'type' => 'string', 'example' => '123.com'], + 'DomainIdList' => [ + 'description' => '域名ID列表。', + 'type' => 'array', + 'items' => ['description' => '域名ID列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'DomainNameList' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => ['description' => '域名列表。', 'type' => 'string', 'example' => 'test.com'], + ], + ], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => 'the switch of rule, TRUE means open, FALSE means close', - 'description' => '无损上线启用状态。取值：'."\n" - ."\n" - .'- true：启用。'."\n" - .'- false：禁用。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], + ], + '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' => '获取开启鉴权的路由列表', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'WarmupTime', - 'in' => 'query', - 'schema' => [ - 'title' => 'warmup time of App', - 'description' => '预热时长。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '60', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayRouteOnAuth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'ListGatewayService' => [ + 'summary' => '查询网关已订阅的服务列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'DelayTime', - 'in' => 'query', - 'schema' => [ - 'title' => 'delay time of register to registry', - 'description' => '延迟注册时间。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '25193', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], + ], + 'parameters' => [ [ - 'name' => 'FuncType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => 'warmup function type, 2 means f(x)=x^2', - 'description' => '预热曲线斜率。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Aligned', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', - 'description' => '是否开启“通过就绪检查前完成服务注册”。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Related', + 'name' => 'OrderItem', 'in' => 'query', - 'schema' => [ - 'title' => 'K8s\'s HPA is related to warmup or NOT', - 'description' => '是否开启“通过就绪检查前完成服务预热”。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '排序属性。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreate'], ], [ - 'name' => 'LossLessDetail', + 'name' => 'DescSort', 'in' => 'query', - 'schema' => [ - 'title' => 'show lossLess offline&online detail', - 'description' => '是否开启上下线处理明细。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '排序。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Notice', + 'name' => 'FilterParams', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'enable lossLess offline active notification', - 'description' => '是否开启主动通知。', - 'type' => 'boolean', + 'description' => '过滤条件，格式为{"key1":"value1"}。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '服务名。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'required' => false, 'example' => 'MSE'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'public'], + 'GroupName' => ['description' => '分组。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-5017305290e14centbrveca****'], + 'ServiceProtocol' => [ + 'description' => '服务协议。'."\n" + ."\n" + .'- HTTP'."\n" + ."\n" + .'- HTTPS'."\n" + ."\n" + .'- HTTP2'."\n" + ."\n" + .'- GRPC'."\n" + ."\n" + .'- DUBBO', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['HTTP2' => 'HTTP2', 'HTTPS' => 'HTTPS', 'HTTP' => 'HTTP', 'DUBBO' => 'DUBBO', 'GRPC' => 'GRPC'], + 'example' => 'HTTP', + ], + ], 'required' => false, - 'example' => 'false', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'modifyLosslessRule success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F46CDBA4-B1EE-5C94-8A48-51C10177****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回数据。', - 'type' => 'any', - 'example' => 'null', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页最大记录数，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Result' => [ + 'description' => '返回集合。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['description' => '服务名。', 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => '网关唯一ID。', 'type' => 'string', 'example' => 'gw-5017305290e14centbrveca****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'example' => 'MSE'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'public'], + 'GroupName' => ['description' => '分组。', 'type' => 'string', 'example' => 'test'], + 'SourceId' => ['description' => '来源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'ServiceNameInRegistry' => ['description' => '注册中心中原服务名。', 'type' => 'string', 'example' => 'test'], + 'MetaInfo' => ['description' => '元信息或IP列表。', 'type' => 'string', 'example' => '{}'], + 'Ips' => [ + 'description' => 'IP列表。', + 'type' => 'array', + 'items' => ['description' => 'IP。', 'type' => 'string', 'example' => '127.0.2.1'], + ], + 'GmtCreate' => ['description' => '记录创建时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'GmtModified' => ['description' => '记录修改时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'Versions' => [ + 'description' => '服务版本。', + 'type' => 'array', + 'items' => [ + 'description' => '版本。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '版本名。', 'type' => 'string', 'example' => 'v1'], + ], + ], + ], + 'ServiceProtocol' => ['description' => '服务协议。', 'type' => 'string', 'example' => 'HTTP'], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int64', 'example' => '80'], + 'HealehStatus' => ['description' => '健康状态。'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Unknown', 'type' => 'string', 'example' => 'Unhealthy'], + 'HealthStatus' => ['description' => '健康状态。'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Unknown', 'type' => 'string', 'example' => 'Unhealthy'], + 'HealthCheck' => ['description' => '是否进行健康检查。', 'type' => 'boolean', 'example' => 'true'], + 'HealthCheckInfo' => [ + 'description' => '健康检查信息。', + 'type' => 'object', + 'properties' => [ + 'Check' => ['description' => '是否检查。', 'type' => 'boolean', 'example' => 'true'], + 'Protocol' => ['description' => '网络协议。', 'type' => 'string', 'example' => 'TCP'], + 'Timeout' => ['description' => '超时时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Interval' => ['description' => '健康检查间隔。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'HealthyThreshold' => ['description' => '健康阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'UnhealthyThreshold' => ['description' => '非健康阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'HttpPath' => ['description' => '健康检查HTTP请求路径。', 'type' => 'string', 'example' => '/health'], + 'HttpHost' => ['description' => '健康检查HTTP请求地址。', 'type' => 'string', 'example' => 'http://172.168.0.1'], + 'ExpectedStatuses' => [ + 'description' => '健康检查期望状态值。', + 'type' => 'array', + 'items' => ['description' => '期望的HttpStatus。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + ], + ], + ], + 'UnhealthyEndpoints' => [ + 'description' => '非健康endpoint数组', + 'type' => 'array', + 'items' => ['description' => '非健康endpoint', 'type' => 'string', 'example' => '172.168.0.1'], + ], + 'GatewayTrafficPolicy' => [ + 'description' => '流量管理策略。', + 'type' => 'object', + 'properties' => [ + 'Tls' => [ + 'description' => 'TLS。', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['title' => 'DISABLE, SIMPLE, MUTUAL, ISTIO_MUTUAL', 'description' => 'TLS模式。'."\n" + ."\n" + .'- DISABLE'."\n" + ."\n" + .' - SIMPLE'."\n" + ."\n" + .'- MUTUAL'."\n" + ."\n" + .'- ISTIO_MUTUAL', 'type' => 'string', 'example' => 'SIMPLE'], + 'CertId' => ['description' => '证书ID。', 'type' => 'string', 'example' => '5******-cn-hangzhou'], + 'CaCertId' => ['description' => 'CA证书ID。', 'type' => 'string', 'example' => '5******-cn-hangzhou'], + 'CaCertContent' => ['description' => 'CA证书公钥。', 'type' => 'string', 'example' => 'content'], + 'SubjectAltNames' => [ + 'description' => '主体别名数组。', + 'type' => 'array', + 'items' => ['description' => '主体别名。', 'type' => 'string', 'example' => 'name'], + ], + 'Sni' => ['description' => '服务名称标识。', 'type' => 'string', 'example' => 'name-sni'], + ], + ], + 'LoadBalancerSettings' => [ + 'description' => '负载均衡设置。', + 'type' => 'object', + 'properties' => [ + 'LoadbalancerType' => ['title' => 'ROUND_ROBIN, LEAST_CONN, RANDOM, CONSISTENT_HASH', 'description' => '负载均衡策略'."\n" + ."\n" + .'- ROUND_ROBIN'."\n" + ."\n" + .' - LEAST_CONN'."\n" + ."\n" + .' - RANDOM'."\n" + ."\n" + .' - CONSISTENT_HASH', 'type' => 'string', 'example' => 'RANDOM'], + 'ConsistentHashLBConfig' => [ + 'description' => '一致性哈希配置。', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'param'], + 'HttpCookie' => [ + 'description' => '基于Cookie的参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'cookie名称。', 'type' => 'string', 'example' => 'name'], + 'Path' => ['description' => 'cookie路径。', 'type' => 'string', 'example' => '/path'], + 'Ttl' => ['description' => 'cookie生命周期。', 'type' => 'string', 'example' => '360'], + ], + ], + 'MinimumRingSize' => ['description' => '哈希环最小值。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'ConsistentHashLBType' => ['title' => 'HEADER, COOKIE, SOURCE_IP, QUERY_PARAMETER', 'description' => '一致性哈希的方式。'."\n" + ."\n" + .'- HEADER'."\n" + ."\n" + .' - COOKIE'."\n" + ."\n" + .' - SOURCE_IP'."\n" + ."\n" + .' - QUERY_PARAMETER', 'type' => 'string', 'example' => 'HEADER'], + ], + ], + 'WarmupDuration' => ['description' => '最小请求数的预热时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + ], + 'Ports' => [ + 'description' => '端口数组。', + 'type' => 'array', + 'items' => ['description' => '端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '8080'], + ], + 'ServiceFQDN' => ['description' => '服务的完全限定域名（FQDN）。', 'type' => 'string'], + 'DnsServerList' => [ + 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'description' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'type' => 'array', + 'items' => ['title' => 'DNS服务器地址（IP+端口）', 'description' => 'DNS服务器地址（IP+端口）', 'type' => 'string', 'example' => '1.1.1.1:80'], + ], + ], + ], + ], + ], ], ], ], @@ -29836,53 +21010,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关已订阅的服务列表', + '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 \\"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' => '修改无损规则', ], - 'FetchLosslessRuleList' => [ - 'summary' => '获取无损上下线规则列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListGatewaySlb' => [ + 'summary' => '查询网关入口SLB。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -29890,235 +21052,174 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => 'region id, such as cn-hangzhou', - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-1cef5440bf2d484db419fb264d4f****'], ], [ - 'name' => 'AppName', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => 'Key word of search lossless list', - 'description' => '应用名。', - 'type' => 'string', - 'required' => false, - 'example' => 'spring-boot-sample', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Namespace', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EAB345F4-3AC3-560C-B653-65717703****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Succ'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => 'ID'], + 'SlbId' => ['description' => 'SLB ID', 'type' => 'string', 'example' => 'lb-bp1kmnli3hdpreptw2ah3'], + 'SlbIp' => ['description' => 'SLB IP', 'type' => 'string', 'example' => '121.199.XX.XX'], + 'SlbPort' => ['description' => 'SLB端口。', 'type' => 'string', 'example' => '80,443'], + 'Type' => ['description' => '网络类型'."\n" + ."\n" + .'- PUB_NET：公网'."\n" + .'- PRIVATE_NET：私网', 'type' => 'string', 'example' => 'PUB_NET'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'string', 'example' => '1'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-14 14:39:16'], + 'GatewaySlbMode' => ['description' => '来源。', 'type' => 'string', 'example' => 'UserSelect'], + 'GatewaySlbStatus' => ['description' => '关联状态。', 'type' => 'string', 'example' => 'Ready'], + 'StatusDesc' => ['description' => '状态备注。', 'type' => 'string', 'example' => 'Associating'], + 'VServerGroupId' => ['description' => 'http虚拟服务组ID。', 'type' => 'string', 'example' => '353'], + 'HttpPort' => ['description' => 'HTTP端口（虚拟服务组）。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'HttpsPort' => ['description' => 'HTTPS端口（虚拟服务组）。', 'type' => 'integer', 'format' => 'int32', 'example' => '443'], + 'ServiceWeight' => ['description' => '服务权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'EditEnable' => ['description' => '是否可编辑。', 'type' => 'boolean', 'example' => 'false'], + 'HttpsVServerGroupId' => ['description' => 'https虚拟服务组ID。', 'type' => 'string', 'example' => '353'], + 'VsMetaInfo' => ['description' => '虚拟服务器组元信息。', 'type' => 'string', 'example' => '[{"protocol":"HTTP","vServerGroupName":"k8s/80/****","port":80,"vServerGroupId":"rsp-bp***"},{"protocol":"HTTPS","vServerGroupName":"k8s/443/***","port":443,"vServerGroupId":"rsp-bp*****"}]'], + 'VServiceList' => [ + 'description' => 'SLB监听信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Port' => ['description' => '端口。', 'type' => 'string', 'example' => '443'], + 'Protocol' => ['description' => '协议类型。'."\n" + ."\n" + .'- HTTPS'."\n" + .'- HTTP', 'type' => 'string', 'example' => 'HTTPS'], + 'VServerGroupId' => ['description' => '虚拟服务器组ID。', 'type' => 'string', 'example' => 'rsp-bp183l2x70***'], + 'VServerGroupName' => ['description' => ' 虚拟服务器组名称。', 'type' => 'string', 'example' => 'k8s/31**0/***/istio-system/clusterid'], + ], + 'description' => '', + ], + ], + 'SlbType' => ['description' => 'SLB类型。', 'type' => 'string'], + ], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => 'appId', - 'description' => '应用ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'hyaziyb6sc@86827c61f5ed***', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '查询网关入口SLB', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => 'current', - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'ListGatewayZone' => [ + 'summary' => '获取网关可用区列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => 'limit', - 'description' => '每页显示条数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174557', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], + ], + 'parameters' => [ [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - .'* zh：中文。'."\n" - .'* en：英文。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => '返回值。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '56D9E600-6348-4260-B35F-583413F****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => 'success', - ], + 'Code' => ['description' => '用于和Success同步，当Success为true时，Code为200', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NO_PERMISSION'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'DynamicCode' => ['description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%s。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], 'Data' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页面大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalSize' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '36', - ], - 'Results' => [ - 'description' => '返回数据。', - 'type' => 'array', - 'items' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'title' => 'appName', - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'echo-demo', - ], - 'AppId' => [ - 'title' => 'appId', - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@24810bf4364a***', - ], - 'Count' => [ - 'title' => 'instance\'s count of app', - 'description' => '实例数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Enable' => [ - 'title' => 'rule is open or close', - 'description' => '无损上线启用状态。取值：'."\n" - ."\n" - .'- `true`：启用。'."\n" - .'- `false`：禁用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'WarmupTime' => [ - 'description' => '预热时长（秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'DelayTime' => [ - 'description' => '延迟注册时间（秒）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'FuncType' => [ - 'title' => 'warmup function type, 2 means f(x)=x^2', - 'description' => '预热曲线斜率。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Aligned' => [ - 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', - 'description' => '是否开启“通过就绪检查前完成服务注册”。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Related' => [ - 'title' => 'K8s\'s HPA is related to warmup or NOT', - 'description' => '是否开启“通过就绪检查前完成服务预热”。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'LossLessDetail' => [ - 'title' => 'show lossLess offline&online detail', - 'description' => '是否开启上下线处理明细。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Notice' => [ - 'title' => 'enable lossLess offline active notification', - 'description' => '是否开启主动通知。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区数据结构', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'LocalName' => ['description' => '可用区本地名称。', 'type' => 'string', 'example' => 'I'], + 'SupportQat' => ['description' => '是否支持QAT。', 'type' => 'boolean'], ], ], ], @@ -30128,54 +21229,40 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取网关可用区列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayZone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取无损上下线规则列表', - 'description' => '调用FetchLosslessRuleList接口来获取无损上下线的配置规则列表。', ], - 'GetLocalityRule' => [ - 'summary' => '获取同可用区优先路由规则', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListInstanceCount' => [ + 'summary' => '列举集群可开通的节点数。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30183,132 +21270,69 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '45915', - 'abilityTreeNodes' => [ - 'FEATUREmseZ3XXPX', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => '集群类型，包括ZooKeeper、Nacos-Ans。', 'type' => 'string', 'required' => false, 'example' => 'Nacos-Ans'], ], [ - 'name' => 'AppName', + 'name' => 'MseVersion', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '应用名称', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => '集群版本类型，取值如下：'."\n" + ."\n" + .'- `mse_dev`：表示开发版。'."\n" + .'- `mse_pro`：表示专业版。', 'type' => 'string', 'required' => false, 'example' => 'mse_pro'], ], [ - 'name' => 'AppId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '应用id。', - 'type' => 'string', - 'required' => false, - 'example' => 'hgxznfcvbe@be2c0228f******', - ], + 'schema' => ['description' => '集群所在地域，包括但不限于如下地域：'."\n" + ."\n" + .'- cn-hangzhou：杭州 '."\n" + .'- cn-beijing：北京 '."\n" + .'- cn-shanghai：上海 '."\n" + .'- cn-zhangjiakou：张家口 '."\n" + .'- cn-shenzhen：深圳', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Source', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '规则来源（非必填）。', - 'type' => 'string', - 'required' => false, - 'example' => 'edasmsc', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型。'."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => 'D3971C60-3F07-58B0-8EA0-A194********', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。当请求失败，返回ErrorCode字段。具体信息，请参见[本文的错误码列表](~~456441~~)。', 'type' => 'string', 'example' => 'mse-100-100'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => '%s'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数 `ErrMessage` 错误信息中的 `%s`。'."\n" + ."\n" + .'> 如果`ErrMessage`返回`The Value of Input Parameter %s is not valid`，且`DynamicMessage`返回`DtsJobId`，则代表所传入的请求参数`DtsJobId`不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], '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' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'type' => 'array', + 'items' => ['description' => '当前版本下可开通的节点数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], ], ], @@ -30316,159 +21340,96 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '集群可开通的节点数', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListInstanceCount', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => '获取同可用区优先路由规则', ], - 'UpdateLocalityRule' => [ - 'summary' => '更新同可用区优先路由规则', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListIsolationRules' => [ + 'summary' => '查询隔离规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163572', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '地域', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'myNamespace', - 'maxLength' => 64, - ], + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命空间。', 'type' => 'string', 'required' => true, 'example' => 'default'], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '应用名称', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'AppId', + 'name' => 'ResourceSearchKey', 'in' => 'query', - 'schema' => [ - 'description' => '应用id。', - 'type' => 'string', - 'required' => false, - 'example' => 'hkhon1po62@c3df23522******', - ], + 'schema' => ['title' => '查找包含接口关键字的防护规则。', 'description' => '查找包含接口关键字的防护规则。', 'type' => 'string', 'required' => false, 'example' => 'a'], ], [ - 'name' => 'Enable', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启同可用区优先。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], ], [ - 'name' => 'Rules', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => '保留参数，暂未使用。', - 'type' => 'string', - 'required' => false, - 'example' => '无需填写', - ], + 'schema' => ['title' => '查找指定接口的防护规则。', 'description' => '查找指定接口的防护规则。', 'type' => 'string', 'required' => false, 'example' => '/a'], ], [ - 'name' => 'Source', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '规则来源', - 'type' => 'string', - 'required' => false, - 'example' => 'edasmsc', - ], + 'schema' => ['title' => '起始页。默认值为1。', 'description' => '起始页。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Threshold', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '同可用区优先生效阈值。当前应用在某个可用区部署的实例占比超过此阈值时，才会开启该可用区的同可用区优先路由功能。即Consumer向该应用发起请求时，会优先将请求路由到与Consumer同一个可用区的实例上。', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.2', - ], + 'schema' => ['title' => '页大小。默认值为6。', 'description' => '页大小。默认值为6。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -30476,99 +21437,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => '78F05E89-D387-50CE-8186-2E27A8AB****', - ], + 'Code' => ['title' => '响应码。', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '响应信息。', 'description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Success' => ['title' => '请求结果。', 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], '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' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '规则信息。', + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '返回结果。', + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命空间。', 'type' => 'string', 'example' => 'default'], + 'RuleId' => ['title' => '规则ID。', 'description' => '规则ID。', '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' => '应用ID。', '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' => ['description' => '请求来源应用。', 'type' => 'string', 'example' => 'spring-cloud-a'], + ], + ], + ], + 'PageNumber' => ['title' => '起始页。', 'description' => '起始页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '页大小。', 'description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalSize' => ['title' => '规则总数。', 'description' => '规则总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], ], + 'HttpStatusCode' => ['title' => '状态码。', 'description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取隔离规则列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListIsolationRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '更新同可用区优先路由规则', ], - 'GetApplicationList' => [ - 'summary' => '通过GetApplicationList接口获取应用列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListListenersByConfig' => [ + 'summary' => '根据配置信息查询监听者。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -30578,169 +21522,69 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '17022', - 'abilityTreeNodes' => [ - 'FEATUREmseHJJ9Z1', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '17070', + 'abilityTreeNodes' => ['FEATUREmseHU6B10'], ], 'parameters' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'rest-container', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => '应用id。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'hkhon1po62@c3df23522b*****', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '固定值，默认使用这个值。', - 'type' => 'string', - 'required' => false, - 'example' => 'edasmsc', - ], - ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => '语言，如 Java、Go。', - 'type' => 'string', - 'required' => false, - 'example' => 'Java', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '第几页。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '参数弃用，无需填写', 'type' => 'string', 'required' => false, 'example' => '...'], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '每一页显示多少条数据。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '实例的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-m7r1yurp00e'], ], [ - 'name' => 'SwitchEnable', + 'name' => 'DataId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '是否开始Switch。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '数据ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zeekr-clueboss.yml'], ], [ - 'name' => 'SentinelEnable', + 'name' => 'Group', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '是否开启Sentinel。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '分组。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod'], ], [ - 'name' => 'Namespace', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - 'default' => 'default', - ], + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1'], ], [ - 'name' => 'Tags', + 'name' => 'ExtGrayRules', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '阿里云标签，支持按照阿里云标签进行筛选。', + 'description' => '额外的灰度规则列表，在进行listener匹配时会将额外的灰度规则和现有的规则合并进行匹配', 'type' => 'array', 'items' => [ - 'description' => '标签。', + 'description' => '灰度规则项', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '用户输入的自定义标签键。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey', - ], - 'Value' => [ - 'description' => '标签值。', + 'GrayRuleType' => [ + 'description' => '灰度规则类型', 'type' => 'string', 'required' => false, - 'example' => 'tagValue', + 'example' => 'Tags', + 'enum' => ['Tags', 'Beta'], ], + 'GrayRuleName' => ['description' => '灰度版本名称', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'GrayRule' => ['description' => '灰度规则，如果是Beta灰度，此处是灰度的客户端的ip，使用逗号分隔；如果是标签灰度，此处是 标签名=标签值，多个标签值使用逗号分隔', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], + 'GrayRulePriority' => ['description' => '灰度版本优先级', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], 'required' => false, ], 'required' => false, - 'maxItems' => 20, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -30749,290 +21593,124 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => 'F55E608F-7C15-****-9CFD-DF832EBC4A0F', - ], - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '返回集合。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExtraInfo' => [ - 'description' => '其他信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'finance', - ], - 'AppId' => [ - 'description' => '应用id。', - 'type' => 'string', - 'example' => 'hkhon1po62@5f1b08becb*****', - ], - 'UserId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1234567890', - ], - 'InstancesNumber' => [ - 'description' => '实例数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Source' => [ - 'description' => '应用来源。', - 'type' => 'string', - 'example' => 'edasmsc', - ], - 'Language' => [ - 'description' => '应用的编程语言。', - 'type' => 'string', - 'example' => 'JAVA', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'title' => '应用所属的MSE命名空间。', - 'description' => '应用所属的微服务命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'Tags' => [ - 'description' => '阿里云标签。', - 'type' => 'object', - 'example' => '{"tagKey1":"tagValue1","tagKey2":"tagValue2"}', - ], - ], - ], - ], - 'TotalSize' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'PageNumber' => [ - 'description' => '当前页。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页面大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'TotalCount' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'Listeners' => [ + 'description' => '监听者信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Ip' => ['description' => 'IP。', 'type' => 'string', 'example' => '1.1.1.1'], + 'Md5' => ['description' => '校验串。', 'type' => 'string', 'example' => '23sdfdf'], + 'Status' => ['description' => '是否推送成功', 'type' => 'string', 'example' => 'true'], + 'Labels' => [ + 'description' => '监听者所带的标签', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '标签的键值对', 'example' => 'a=b'], + ], + 'Version' => ['description' => '监听者当前的版本，gray（灰度版本）或者nromal（正式版本）', 'type' => 'string', 'example' => 'gray'], + 'MatchRuleName' => ['title' => '当前Listener匹配的灰度规则名称', 'description' => '当前Listener匹配的灰度规则名称', 'type' => 'string', 'example' => 'Matched canary rule name'], + 'MatchRuleType' => ['description' => '匹配到的灰度规则的类型', 'type' => 'string', 'example' => 'Beta'], + ], + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '75E1442F-11EC-567A-9CF0-5A36F7904F39'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'success'], + 'PageSize' => ['description' => '当前页的大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => '获取应用列表', - ], - 'CreateMseServiceApplication' => [ - 'summary' => '创建应用。', - 'methods' => [ - 'post', - 'get', - ], - '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' => '查询配置监听者', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](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}'], + ], + ], + ], ], + ], + 'ListListenersByIp' => [ + 'summary' => '根据IP查询监听者列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '17071', + 'abilityTreeNodes' => ['FEATUREmseHU6B10'], ], 'parameters' => [ [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '应用名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'bsd-xxyp-open-goods-server', - ], - ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，包括但不限于如下地域：'."\n" - ."\n" - .'- cn-hangzhou：杭州'."\n" - .'- cn-beijing：北京'."\n" - .'- cn-shanghai：上海'."\n" - .'- cn-zhangjiakou：张家口'."\n" - .'- cn-shenzhen：深圳', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '来源。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'edasmsc', - 'default' => 'edasmsc', - ], - ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => '应用的编程语言。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'JAVA', - ], - ], - [ - 'name' => 'ExtraInfo', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '其他信息。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{}', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'SentinelEnable', + 'name' => 'InstanceId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '是否开启Sentinel。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-i7m2cecji09'], ], [ - 'name' => 'SwitchEnable', + 'name' => 'Ip', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '是否开始Switch', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '监听IP地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '172.22.0.240'], ], [ - 'name' => 'MseVersion', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '待开通的MSE集群版本。'."\n" - ."\n" - .'- mse_pro：表示专业版。'."\n" - .'- mse_dev：表示开发版。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - ], + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ea02a522-9482-4255-bb65-dc0636d783f2'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型。'."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -31041,292 +21719,113 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '904F6C04-1284-****-8ED2-FFC57E507A72', - ], - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。1表示可用状态，2表示删除状态。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExtraInfo' => [ - 'description' => '额外信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'UpdateTime' => [ - 'description' => '最后更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632979237663', - ], - 'LicenseKey' => [ - 'description' => '用户的对应的LicenseKey。', - 'type' => 'string', - 'example' => 'xxxxxxxx@xxxxxxxxxx', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631001140913', - ], - 'AppId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'xxxxxxxx@xxxxxxxxxx', - ], - 'UserId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1234567890', - ], - 'Source' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'example' => 'edasmsc', - ], - 'Language' => [ - 'description' => '应用的编程语言。', - 'type' => 'string', - 'example' => 'JAVA', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Version' => [ - 'description' => '版本信息。', - 'type' => 'string', - 'example' => '1.0.0', + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], + 'TotalCount' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'Listeners' => [ + 'description' => '监听信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Md5' => ['description' => '校验串。', 'type' => 'string', 'example' => '23sdfdf'], + 'DataId' => ['description' => '数据ID。', 'type' => 'string', 'example' => 'test.yaml'], + 'Group' => ['description' => '分组。', 'type' => 'string', 'example' => 'default'], + 'NamespaceId' => ['description' => '命名空间ID', 'type' => 'string', 'example' => 'test'], ], ], ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'PageSize' => ['description' => '当前页的大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'MSE-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'mse::2019-05-31::CreateApplication', + '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' => '根据IP查询监听者列表', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](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}'], + ], + ], ], - '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' => '创建应用', ], - 'CreateApplication' => [ - 'summary' => '创建应用。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListMigrationTask' => [ + 'summary' => '调用接口查询迁移上云任务。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '17001', - 'abilityTreeNodes' => [ - 'FEATUREmse3O985H', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'list', + 'abilityTreeCode' => '155119', + 'abilityTreeNodes' => ['FEATUREmseKDDXNL'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '地域。', - 'description' => '应用所属的区域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'Namespace', + 'name' => 'OriginInstanceName', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间。', - 'description' => 'MSE命名空间名字。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - 'maxLength' => 64, - ], + 'schema' => ['description' => '源实例名称。', 'type' => 'string', 'required' => false, 'example' => 'whdc'], ], [ - 'name' => 'AppName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '应用名。', - 'description' => '应用名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'spring-cloud-a', - ], + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Source', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '应用的部署方式，ACK表示阿里云容器服务K8s。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ACK', - 'default' => 'edasmsc', - ], - ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => '应用的编程语言。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'JAVA', - 'default' => 'JAVA', - ], - ], - [ - 'name' => 'SentinelEnable', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '是否开启Sentinel。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'SwitchEnable', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '是否开始Switch。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '阿里云标签。', - 'type' => 'array', - 'items' => [ - 'description' => '阿里云标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '用户输入的自定义标签键。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey', - ], - 'Value' => [ - 'description' => '标签值。最多支持128个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey', - ], - ], - 'required' => false, - ], - 'required' => false, - 'minItems' => 0, - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -31335,167 +21834,84 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '68D91223-CCE9-5F9C-B538-20F617DA48B1', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], 'Data' => [ - 'description' => '节点数据。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '应用状态，1表示正常。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExtraInfo' => [ - 'description' => '额外信息。', - 'type' => 'string', - 'example' => '{\\"rpcTypes\\":[\\"dubbo\\",\\"springCloud\\"]}', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'UpdateTime' => [ - 'description' => '更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632979237663', - ], - 'LicenseKey' => [ - 'description' => '用户的对应的LicenseKey。', - 'type' => 'string', - 'example' => 'xxxxxxxx@xxxxxxxxxx', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631001140913', - ], - 'AppId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'xxxxxxxx@xxxxxxxxxx', - ], - 'UserId' => [ - 'description' => '阿里云用户ID。', - 'type' => 'string', - 'example' => '1888888888', - ], - 'Source' => [ - 'description' => '应用的部署方式。'."\n" + 'description' => '数组结构。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '2'], + 'ClusterType' => ['description' => '集群类型。'."\n" ."\n" - .'- ACK：表示阿里云容器服务K8s。'."\n" - .'- Normal：表示其他接入方式。', - 'type' => 'string', - 'example' => 'ACK', - ], - 'Language' => [ - 'description' => '应用的编程语言。', - 'type' => 'string', - 'example' => 'JAVA', - ], - 'RegionId' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => 'MSE命名空间名字。', - 'type' => 'string', - 'example' => 'prod', - ], - 'Version' => [ - 'description' => '版本号。', - 'type' => 'string', - 'example' => '1.0.0', + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', 'type' => 'string', 'example' => 'Nacos-Ans'], + 'OriginInstanceAddress' => ['description' => '源实例节点地址。', 'type' => 'string', 'example' => '192.168.1.1:8848'], + 'OriginInstanceName' => ['description' => '源实例名称。', 'type' => 'string', 'example' => 'test'], + 'OriginInstanceNamespace' => ['description' => '命名空间列表，当来源集群是Nacos时选填。', 'type' => 'string', 'example' => 'fsdfsdfdsf'], + 'TargetInstanceId' => ['description' => '目标实例ID。', 'type' => 'string', 'example' => 'mse-cn-zv*****'], + 'TargetClusterName' => ['description' => '目标实例名称。', 'type' => 'string', 'example' => 'multiple-nacos'], + 'TargetClusterUrl' => ['description' => '目标实例Url。', 'type' => 'string', 'example' => 'mse-f1******-nacos-ans.mse.aliyuncs.com:8848'], + 'ProjectDesc' => ['description' => '描述。', 'type' => 'string', 'example' => 'test'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-30T06:41:52.000+0000'], + 'SyncType' => ['description' => '同步类型', 'type' => 'string', 'example' => 'Service'], ], ], - 'example' => 'data', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', ], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '451EBE59-5F33-5B15-83C1-78593B9*****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询迁移上云任务', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '创建应用', ], - 'GetOverview' => [ - 'summary' => '查询治理概览信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListNacosConfigs' => [ + 'summary' => '查询Nacos配置列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -31503,43 +21919,71 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17072', + 'abilityTreeNodes' => ['FEATUREmse8153EN'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], 'parameters' => [ [ - 'name' => 'Period', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '查询时间。单位：天。比如传入30，说明查询30天内的治理规则情况。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['title' => '参数弃用，无需填写', 'description' => '扩展请求参数，支持JSON格式。', '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\\"}'], ], [ - 'name' => 'Region', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '分页页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '5'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '200'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-7mz2fj****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '集群所在地域，MSE支持的地域。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => ['description' => '数据ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'zeekr-*'], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => '分组类型，默认为`default`。', 'type' => 'string', 'required' => false, 'example' => 'crm'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'fpx-pds-pns'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => '标签。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'billing'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'fad732a7-ff1a-4f21-8126-4edd4****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -31548,204 +21992,169 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'string', - 'example' => 'data', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'TotalCount' => ['description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4081087F-3429-5873-A1E7-D4B5479D0B84'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'PageSize' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Configurations' => [ + 'description' => '配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test'], + 'DataId' => ['description' => '配置ID。', 'type' => 'string', 'example' => 'log.yaml'], + 'Id' => ['description' => '应用ID', 'type' => 'string', 'example' => '132****'], + 'Group' => ['description' => '分组ID。', 'type' => 'string', 'example' => 'public'], + ], + ], ], + 'Code' => ['description' => '返回代码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], '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' => '当前集群不支持此操作, %s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询Nacos配置列表', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNacosConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '查询应用概览', - 'description' => '通过GetOverview接口查询服务治理概览信息。', ], - 'RemoveApplication' => [ - 'summary' => '删除单个应用。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListNacosHistoryConfigs' => [ + 'summary' => '查询Nacos配置历史列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '17086', - 'abilityTreeNodes' => [ - 'FEATUREmseHJJ9Z1', - ], - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17073', + 'abilityTreeNodes' => ['FEATUREmseEUE1FY'], + ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '地域。', - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', '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\\"}'], ], [ - 'name' => 'Namespace', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => '微服务命名空间。', - 'description' => '微服务命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'prod', - 'maxLength' => 64, - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'AppName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '要删除的应用名字。', - 'description' => '要删除的应用名字。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'example-app', - ], + 'schema' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'AppId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '要删除的应用id。', - 'description' => '要删除的应用id。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'abcde@12345', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-2r42e3bk20n'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '集群所在地域，MSE支持的地域。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => ['description' => '数据ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user-prod.yaml'], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => '配置组。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'fc-dev-cluster-1'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'fc0f6e40-****-946b-45e3af313707'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id。', - 'description' => '请求id。', - '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', + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'TotalCount' => ['description' => '实例配置信息总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '53338ECA-F880-54D8-A9B3-5606355A1B89'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'PageSize' => ['description' => '每页展示实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'HistoryItems' => [ + 'description' => '配置项列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => '应用标签。', 'type' => 'string', 'example' => 'gateway'], + 'DataId' => ['description' => '数据ID。', 'type' => 'string', 'example' => 'test.yaml'], + 'Group' => ['description' => '分组名称。', 'type' => 'string', 'example' => 'default'], + 'LastModifiedTime' => ['description' => '最后更新时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1643440066000'], + 'Id' => ['description' => '配置ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '23fdsf'], + 'OpType' => ['description' => '配置文本类型。', 'type' => 'string', 'example' => 'yaml'], + 'SrcUser' => ['description' => '此版本对应的修改用户', 'type' => 'string', 'example' => 'test'], + ], + 'description' => '', + ], ], ], ], @@ -31753,240 +22162,156 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询Nacos配置历史列表', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](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' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abcde-12345\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => '删除应用', ], - 'GetApplicationInstanceList' => [ - 'summary' => '查询微服务应用实例列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListNamespaces' => [ + 'summary' => '展示命名空间列表，同时可以展示出每个命名空间下的在线节点数和总应用数。此外，该接口也可以按照命名空间名称进行模糊查询。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17021', - 'abilityTreeNodes' => [ - 'FEATUREmseZB84VG', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '192223', + 'abilityTreeNodes' => ['FEATUREmseSXV85E'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间。', - 'description' => '应用所属的MSE命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名字。', - 'description' => '应用名字。', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 100, - ], - ], - [ - 'name' => 'AppId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '应用Id。', - 'description' => '应用Id。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'docRequired' => true, - 'example' => 'abcde@12345', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Tag', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '节点标签。', - 'description' => '节点标签。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gray', - ], + 'schema' => ['description' => '分页查询页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'PageNumber', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '第几页。从1开始。', - 'description' => '第几页。从1开始。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '分页查询时每页展示条数。默认为5，如需返回更多数据，请将该值向上调整。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '5'], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '每页大小。', - 'description' => '每页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => '需要模糊查询的命名空间名，不填则默认查询所有。', 'type' => 'string', 'required' => false, 'example' => 'myNamespace'], ], [ - 'name' => 'Region', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '所在地域。', - 'description' => '所在地域。', - 'type' => 'string', + 'description' => '阿里云标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表，最多包含20个子项。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'key'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'cn-hangzhou', + 'minItems' => 0, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC'], 'Data' => [ - 'title' => '返回数据', - 'description' => '返回数据', + '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' => [ - 'title' => '节点列表。', - 'description' => '节点列表。', + 'description' => '返回结果。', 'type' => 'array', 'items' => [ - 'title' => '微服务治理节点列表。', - 'description' => '微服务治理节点列表。', + 'description' => '返回集合。', 'type' => 'object', 'properties' => [ - 'Ip' => [ - 'title' => '节点ip。', - 'description' => '节点ip。', - 'type' => 'string', - 'example' => '10.1.2.3', - ], - 'Tags' => [ - 'title' => '节点标签。', - 'description' => '节点标签。', - 'type' => 'array', - 'items' => [ - 'title' => '节点标签结构。', - 'description' => '节点标签结构。', - 'type' => 'object', - 'properties' => [ - 'Tag' => [ - 'title' => '标签值。', - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'gray', - ], - ], - ], - ], - 'Port' => [ - 'title' => '应用端口。', - 'description' => '应用端口。', - 'type' => 'string', - 'example' => '8080', - ], + 'UserId' => ['description' => '用户id。', 'type' => 'string', 'example' => '178*******'], + 'Region' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'myNamespace'], + 'Version' => ['title' => '--- 基础版', 'description' => '版本。基础版 0，专业版 1，企业版 2。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Describe' => ['description' => '命名空间描述。', 'type' => 'string', 'example' => 'namespace 1 for testing'], + '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' => ['description' => '阿里云标签。', 'type' => 'object', 'example' => '{"1":"1","2":"2"}'], ], ], ], - 'TotalSize' => [ - 'title' => '总共有多少个节点。', - 'description' => '总共有多少个节点。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '第几页，从1开始。', - 'description' => '第几页，从1开始。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少个。', - 'description' => '每页多少个。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'Results' => [ + 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', + 'description' => '返回结果集。', + 'type' => 'array', + 'items' => [ + 'description' => '返回集合。', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => '用户id。', 'type' => 'string', 'example' => '178*******'], + 'Region' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'myNamespace'], + 'Version' => ['title' => '--- 基础版', 'description' => '版本。基础版 0，专业版 1，企业版 2。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Describe' => ['description' => '命名空间描述。', 'type' => 'string', 'example' => 'namespace 1 for testing'], + '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'], + ], + ], ], ], ], @@ -31996,53 +22321,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询命名空间列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListNamespaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取应用实例信息', ], - 'QueryGovernanceKubernetesCluster' => [ - 'summary' => '获取微服务治理K8s集群信息列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListNamingTrack' => [ + 'summary' => '获取Nacos注册中心的轨迹数据。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -32052,79 +22366,76 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '116299', - 'abilityTreeNodes' => [ - 'FEATUREmse3O985H', - ], + 'abilityTreeCode' => '137915', + 'abilityTreeNodes' => ['FEATUREmseN8I3PF'], ], 'parameters' => [ [ - 'name' => 'ClusterName', + 'name' => 'RequestPars', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => 'Kubernetes集群名', - 'description' => 'Kubernetes集群名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'example-cluster', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'ClusterId', + 'name' => 'InstanceId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => 'Kubernetes集群Id', - 'description' => 'Kubernetes集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'c24c9354acxxxxxxx', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'mse_prepaid_public_cn-tl32d*****'], ], [ - 'name' => 'PageNumber', + 'name' => 'ServiceName', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '当前页码', - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => false, 'example' => 'fpx-xms-baseinfo'], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => '分组。', 'type' => 'string', 'required' => false, 'example' => 'group'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cd4d3703-e2a6-46b5-85c6-4447e4f****'], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['description' => '客户端IP。', 'type' => 'string', 'required' => false, 'example' => '172.16.183.232'], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => ['description' => '开始时间戳，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1660238450'], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => ['description' => '结束时间戳，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1665299698'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页元素数量', - 'description' => '每页元素数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '10', - ], + 'schema' => ['description' => '当前页的大小。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => '按照时间正序或者倒序排列。默认值为`false`。'."\n" + ."\n" + .'- `true`：表示倒序'."\n" + .'- `false`：表示正序'."\n" + ."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -32133,278 +22444,140 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DE34D413-2B79-5E77-9696-36D875E822AD', - ], - 'Data' => [ - 'description' => '响应数据。', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '数据结构。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'ClusterName' => [ - 'title' => 'Kubernetes集群名', - 'description' => '集群名字。', - 'type' => 'string', - 'example' => 'example-cluster', - ], - 'ClusterId' => [ - 'title' => 'Kubernetes集群Id', - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'abcdef123456789', - ], - 'Region' => [ - 'title' => 'Kubernetes集群所在的地域', - 'description' => '集群所在地域。', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'K8sVersion' => [ - 'title' => 'Kubernetes集群版本', - 'description' => '集群版本。', - 'type' => 'string', - 'example' => '1.22', - ], - 'NamespaceInfos' => [ - 'title' => 'Kubernetes集群命名空间信息（json格式）', - 'description' => '命名空间信息。', - 'type' => 'string', - 'example' => '[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]', - ], - 'PilotStartTime' => [ - 'title' => 'pilot启动时间', - 'description' => 'Pilot启动时间。', - 'type' => 'string', - 'example' => '2022-05-17T05:39:43.000+0000', - ], - 'VersionLifeCycle' => [ - 'type' => 'string', - ], - 'PilotVersion' => [ - 'type' => 'string', - ], - ], - ], - ], - 'TotalSize' => [ - 'title' => '页码总数', - 'description' => '集群总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'PageNumber' => [ - 'title' => '当前页码', - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页大小', - 'description' => '当前页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Traces' => [ + 'description' => '信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'PushTime' => ['description' => '推送时间。', 'type' => 'string', 'example' => '2022-12-16 11:48:07'], + 'NodeName' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'mse-197*****-167083******-reg-center-0-0'], + 'ClientIp' => ['description' => '客户端IP。', 'type' => 'string', 'example' => '120.40.32.235'], + 'ServerName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'fpx-xms-baseinfo'], + 'Group' => ['description' => '分组。', 'type' => 'string', 'example' => 'prod'], + 'InstanceSize' => ['description' => '实例个数。', 'type' => 'string', 'example' => '1'], + 'PushTimeAll' => ['description' => '总推送耗时。', 'type' => 'string', 'example' => '628ms'], + 'PushTimeNetwork' => ['description' => '推送网络耗时。', 'type' => 'string', 'example' => '37ms'], + 'SlaTime' => ['description' => 'SLA时间。', 'type' => 'string', 'example' => '628ms'], ], ], ], - 'Success' => [ - 'title' => '是否成功', - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'PageSize' => ['description' => '当前页的大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['description' => '总记录条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9916CBED-B2D5-5685-9129-4592FE1*****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '获取Nacos注册中心推送轨迹', + '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 \\"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' => '获取微服务治理K8s集群信息列表', ], - 'ModifyGovernanceKubernetesCluster' => [ - 'summary' => '修改已接入服务治理的集群信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListSSLCert' => [ + 'summary' => '获取网关证书列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '25610', - 'abilityTreeNodes' => [ - 'FEATUREmseSXV85E', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****'], ], [ - 'name' => 'ClusterId', + 'name' => 'CertName', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cd23228b3c80c4d4f9ad87cc3****', - ], - ], - [ - 'name' => 'NamespaceInfos', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '命名空间接入MSE服务治理的对应信息。', - 'description' => '命名空间接入MSE服务治理的对应信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => 'kubernetes命名空间名字。', - 'description' => 'kubernetes命名空间名字。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'MseNamespace' => [ - 'title' => '对应的微服务命名空间，为空代表没有接入。', - 'description' => '对应的微服务命名空间，为空代表没有接入。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['title' => '按证书名称模糊搜索', 'description' => '按证书名称模糊搜索', 'type' => 'string', 'required' => false, 'example' => 'certabc'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F9849E97-2455-54B0-A3B4-3F6E4E9FFEB1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'CAA9A229-141D-5FBA-AC5C-516C02026A11'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '状态码，200表示返回成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'CertIdentifier' => ['description' => '证书ID。', 'type' => 'string', 'example' => '1234'], + 'CertName' => ['description' => '证书名称。', 'type' => 'string', 'example' => 'test.com'], + 'CommonName' => ['description' => '绑定域名。', 'type' => 'string', 'example' => '*.test.com'], + 'Sans' => ['description' => 'SSL证书。', 'type' => 'string', 'example' => 'SSL'], + 'BeforeDate' => ['description' => '证书生效时间（Unix毫秒时间戳）。', 'type' => 'string', 'example' => '1694503184803'], + 'AfterDate' => ['description' => '证书到期时间（Unix毫秒时间戳）。', 'type' => 'string', 'example' => '1726039184803'], + 'Algorithm' => ['description' => '算法。', 'type' => 'string', 'example' => 'test'], + 'Issuer' => ['description' => '颁发者。', 'type' => 'string', 'example' => 'test'], + 'GmtBefore' => ['description' => '证书生效时间（GMT时间戳）。', 'type' => 'string', 'example' => '2023-09-12T07:19:44.803+0000'], + 'GmtAfter' => ['description' => '证书到期时间（GMT时间戳）。', 'type' => 'string', 'example' => '2024-09-11T07:19:44.803+0000'], + ], + ], ], ], ], @@ -32412,53 +22585,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '查询网关证书列表', + '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}'], + ], + ], + ], ], - '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' => '更新已接入服务治理的集群信息', ], - 'GetGovernanceKubernetesCluster' => [ - 'summary' => '获取服务治理的kubernetes集群信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListSecurityGroup' => [ + 'summary' => '获取安全组列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -32466,527 +22627,316 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24691', - 'abilityTreeNodes' => [ - 'FEATUREmse3O985H', - ], - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，MSE支持的地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClusterId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc****', - ], + 'schema' => ['title' => '网关ID', 'description' => '网关ID', 'type' => 'string', 'required' => true, 'example' => 'gw-e98e40675aaf49bda082137d158e1585'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '数据结构。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'ClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc30d5', - ], - 'ClusterName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'myCluster', - ], - 'Region' => [ - 'description' => '集群所在地域，MSE支持的地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'K8sVersion' => [ - 'description' => 'k8s版本。', - 'type' => 'string', - 'example' => '1.20.11-aliyun.1', - ], - 'NamespaceInfos' => [ - 'description' => '命名空间信息。', - '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' => 'Pilot启动时间。', - 'type' => 'string', - 'example' => '2022-01-11T11:50:38.000+0000', - ], - 'UpdateTime' => [ - 'description' => '最后更新时间。', - 'type' => 'string', - 'example' => '2022-01-12T05:24:31.000+0000', - ], - 'Namespaces' => [ - 'description' => '命名空间列表。', - 'type' => 'array', - 'items' => [ - 'description' => '命名空间结构。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => 'Kubernetes命名空间名字', - 'description' => 'Kubernetes命名空间名字。', - 'type' => 'string', - 'example' => 'default', - ], - 'MseNamespace' => [ - 'title' => '对应接入的mse命名空间名字', - 'description' => '对应接入的mse命名空间名字。', - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - ], - 'PilotVersion' => [ - 'description' => 'ack-onepilot 组件版本', - 'type' => 'string', - 'example' => '4.1.1', - ], - 'VersionLifeCycle' => [ - 'description' => '版本生命周期', - 'type' => 'string', - 'enumValueTitles' => [ - 'EXPIRED' => '过期', - 'SUNSETTING' => '即将过期', - 'STABLE' => '稳定', - 'DEPRECATED' => '不推荐版本', - ], - 'example' => 'STABLE', + 'description' => '数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '节点数据。', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-8vb8gsmrqyc35k645rk6'], + 'SecurityGroupName' => ['description' => '安全组名称。', 'type' => 'string', 'example' => 'sg2'], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1b'], + 'SecurityGroupType' => ['description' => '安全组类型，分为普通安全组与企业安全组。取值范围：'."\n" + ."\n" + .'- normal：普通安全组。'."\n" + .'- enterprise：企业安全组。更多详情，请参见[企业安全组概述](~~120621~~)。', 'type' => 'string', 'example' => 'enterprise'], ], ], ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询已接入服务治理的集群信息', - ], - 'ListNamespaces' => [ - 'summary' => '展示命名空间列表，同时可以展示出每个命名空间下的在线节点数和总应用数。此外，该接口也可以按照命名空间名称进行模糊查询。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '获取安全组列表', + 'changeSet' => [ + ['createdAt' => '2023-12-11T12:46:51.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-24T09:02:55.000Z', 'description' => 'OpenAPI 下线'], ], - 'tags' => [ - 'msc', + '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' => '查询网关安全组列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '192223', - 'abilityTreeNodes' => [ - 'FEATUREmseSXV85E', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '网关ID', 'description' => '网关唯一ID', 'type' => 'string', 'required' => true, 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c'], ], [ - 'name' => 'PageNumber', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页查询页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => '返回代码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '安全组授权记录ID。', 'type' => 'string', 'example' => '21'], + 'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-bp1cg6qlyjepj0y6cf2c'], + 'PortRange' => ['description' => '端口范围。', 'type' => 'string', 'example' => '8000/8000'], + 'IpProtocol' => ['description' => '协议类型', 'type' => 'string', 'example' => 'tcp'], + 'AuthCidrs' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => ''], + 'description' => '', + ], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '81'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-12a432a1f5da423997d8880bd32c304d'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'Description' => ['description' => '规则描述。', 'type' => 'string', 'example' => 'Test'], + ], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页展示条数。默认为5，如需返回更多数据，请将该值向上调整。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '5', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关安全组列表', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '需要模糊查询的命名空间名，不填则默认查询所有。', - 'type' => 'string', - 'required' => false, - 'example' => 'myNamespace', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListSecurityGroupRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ListSentinelBlockFallbackDefinitions' => [ + 'summary' => '获取流量防护自定义行为。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '163990', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'ClassificationSet', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '阿里云标签。', + 'title' => '行为类型列表。', + 'description' => '行为类型列表。', 'type' => 'array', 'items' => [ - 'description' => '标签列表，最多包含20个子项。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], + 'title' => '行为类型。', + 'description' => '行为类型。', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, + 'enumValueTitles' => [1 => 'WEB行为', 'RPC行为'], + 'example' => '1', ], 'required' => false, - 'minItems' => 0, ], ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命空间。', 'type' => 'string', 'required' => true, 'example' => 'default'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC', - ], + 'HttpStatusCode' => ['title' => '状态码。', 'description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '响应信息。', 'description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], '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' => '用户id。', - 'type' => 'string', - 'example' => '178*******', - ], - 'Region' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'myNamespace', - ], - 'Version' => [ - 'title' => '--- 基础版', - 'description' => '版本。基础版 0，专业版 1，企业版 2。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Describe' => [ - 'description' => '命名空间描述。', - 'type' => 'string', - 'example' => '测试命名空间1。', - ], - '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' => [ - 'description' => '阿里云标签。', - 'type' => 'object', - 'example' => '{"1":"1","2":"2"}', - ], - ], - ], - ], - 'Results' => [ - 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', - 'description' => '返回结果集。', - 'type' => 'array', - 'items' => [ - 'description' => '返回集合。', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'description' => '用户id。', - 'type' => 'string', - 'example' => '178*******', - ], - 'Region' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'myNamespace', - ], - 'Version' => [ - 'title' => '--- 基础版', - 'description' => '版本。基础版 0，专业版 1，企业版 2。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Describe' => [ - 'description' => '命名空间描述。', - 'type' => 'string', - 'example' => '测试命名空间1。', - ], - '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', - ], - ], - ], + 'title' => '行为信息。', + 'description' => '行为信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '行为ID。', 'description' => '行为ID。', 'type' => 'string', 'example' => '12'], + 'Namespace' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命空间。', 'type' => 'string', 'example' => 'default'], + 'AppName' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Name' => ['title' => '行为名称。', 'description' => '行为名称。', 'type' => 'string', 'example' => 'defaultFallback'], + 'ResourceClassification' => ['title' => '行为类型。', 'description' => '行为类型。', 'type' => 'string', 'example' => '1'], + 'FallbackBehavior' => ['title' => '行为详情。', 'description' => '行为详情。', 'type' => 'object', 'example' => '{"webRespStatusCode":429,"webRespMessage":"test","webFallbackMode":0,"webRespContentType":0}'], + 'TargetMap' => ['title' => '与该行为绑定的资源信息。', 'description' => '与该行为绑定的资源信息。', 'type' => 'object', 'example' => '{"/params/{hot}":[1]}'], ], ], ], + 'Success' => ['title' => '请求结果。', 'description' => '请求结果。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取流量防护自定义行为', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListSentinelBlockFallbackDefinitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询命名空间列表', ], - 'CreateNamespace' => [ - 'summary' => '创建微服务治理命名空间。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListServiceSource' => [ + 'summary' => '查询已关联来源列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -32996,122 +22946,88 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '187065', - 'abilityTreeNodes' => [ - 'FEATUREmseSXV85E', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '24908', + 'abilityTreeNodes' => ['FEATUREmse5GGXKF'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '要搜索的命名空间名字', - 'description' => '微服务治理命名空间名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'myNamespace', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'Describe', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '微服务治理命名空间描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => '测试命名空间1。', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c51a15c7ee934a4fb945ccf35fe1****'], ], [ - 'name' => 'Tag', + 'name' => 'Source', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'json', - 'schema' => [ - 'description' => '阿里云标签。', - 'type' => 'array', - 'items' => [ - 'description' => '待添加的标签列表。最多包含20个子项。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '资源的标签键。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'namespaceTagKey', - ], - 'Value' => [ - 'description' => '标签值。最多支持128个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'namespaceTagValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'minItems' => 0, - ], + 'schema' => ['description' => '获取指定服务来源类型（为空返回所有类型）：'."\n" + .'- 容器服务：K8s'."\n" + .'- MSE Nacos：MSE'."\n" + .'- MSE ZooKeeper：MSE_ZK'."\n" + .'- SAE 注册中心：SAE'."\n" + .'- EDAS 注册中心：EDAS', 'type' => 'string', 'required' => false, 'example' => 'MSE'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '错误时的提示信息', - 'description' => '错误时的提示信息', - 'type' => 'string', - 'example' => '请求处理成功。', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求id', - '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' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B8C4B0D8-EBB9-5F20-8295-04224FBE5529'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'title' => '命名空间所属的地域', - 'description' => '命名空间所属的地域', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'title' => '命名空间名字', - 'description' => '命名空间名字', - 'type' => 'string', - 'example' => 'myNamespace', + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'], + 'Address' => ['description' => 'ACK ID或MSE注册中心地址。', 'type' => 'string', 'example' => '***'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'NACOS'], + 'Source' => ['description' => '来源类型。', 'type' => 'string', 'example' => 'MSE'], + 'BindingWithGateway' => ['description' => '是否完成绑定。'."\n" + .'（数值1表示完成绑定）', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'GmtModified' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2022-01-07 18:07:57'], + 'SourceUniqueId' => ['description' => '来源唯一标识。', 'type' => 'string', 'example' => 'mse-cn-***'], + 'IngressOptions' => [ + 'description' => '应用路由Ingress支持。', + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => ['description' => '开启或关闭Ingress。', 'type' => 'boolean', 'example' => 'true'], + 'IngressClass' => ['description' => 'Ingress Class。', 'type' => 'string', 'example' => 'com.test.xxx'], + 'WatchNamespace' => ['description' => '监听命名空间。', 'type' => 'string', 'example' => 'default'], + 'EnableStatus' => ['description' => '是否更新IngressStatus。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'GatewayUniqueId' => ['description' => '网关UniqueId。', 'type' => 'string', 'example' => 'gw-2u9uhd9283hd92hgd39g239dg2*****'], + 'GroupList' => [ + 'description' => '服务分组数组。', + 'type' => 'array', + 'items' => ['description' => '服务分组。', 'type' => 'string', 'example' => 'DEFAULT_GROUP'], + ], + 'PathList' => [ + 'description' => '服务列表根路径数组。', + 'type' => 'array', + 'items' => ['description' => '服务列表根路径。', 'type' => 'string', 'example' => '/path'], + ], + 'Invalid' => ['title' => '来源是否有效', 'description' => '来源是否有效', 'type' => 'boolean'], ], ], ], @@ -33121,135 +23037,148 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => '创建微服务治理命名空间', - ], - 'DeleteNamespace' => [ - 'summary' => '删除MSE命名空间。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'msc', + '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' => '查询网关已关联的服务来源列表', + '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' => '查标签接口。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域', 'description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['title' => '下一个查询开始Token', 'description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kywps2Ezza3n8HAAzCCqsi'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['title' => '资源类型', 'description' => '资源类型：'."\n" + ."\n" + .'- CLUSTER注册配置中心。'."\n" + ."\n" + .'- GATEWAY云原生网关。', 'type' => 'string', 'required' => true, 'example' => 'CLUSTER'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '操作的地域', - 'description' => '操作的地域。', - 'type' => 'string', + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID，最多 50个子项。', + 'type' => 'array', + 'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-7pp2st29t16'], 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'maxItems' => 51, ], ], [ - 'name' => 'Name', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '要删除的MSE命名空间名称', - 'description' => '要删除的MSE命名空间名称。', - 'type' => 'string', + 'title' => '标签列表，最多包含20个子项', + 'description' => '标签列表，最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签组合。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'prd'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'prod', - 'maxLength' => 64, + 'maxItems' => 21, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'title' => 'HTTP状态码', - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '请求信息，错误排查用', - 'description' => '请求信息，错误排查用。', - 'type' => 'string', - 'example' => '请求处理成功', - 'default' => '请求处理成功', - ], - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'abcde-efg', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'NO_PERMISSION', + 'NextToken' => ['title' => '下一个查询开始Token，NextToken为空说明没有下一个', 'description' => '下一个查询开始Token，NextToken为空说明没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '92ED7C9C-84A2-595F-87FE-354F84C0F739'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '资源列表', + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '由资源及其标签组成的集合，包含了资源ID、资源类型和标签键值等信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['title' => '资源ID', 'description' => '资源ID。', 'type' => 'string', 'example' => 'mse-cn-7pp2st29t16'], + 'ResourceType' => ['title' => '资源类型', 'description' => '资源类型。', 'type' => 'string', 'example' => 'cluster'], + 'TagValue' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'example' => 'prd'], + 'TagKey' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string', 'example' => 'env'], + ], + ], + ], + ], + 'description' => '', ], ], ], @@ -33257,53 +23186,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '获取标签列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListTagResources', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"abcde-efg\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NO_PERMISSION\\"\\n}","type":"json"}]', - 'title' => '删除MSE命名空间', ], - 'QueryNamespace' => [ - 'summary' => '查询MSE命名空间。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListWebFlowRules' => [ + 'summary' => '查询热点参数防护规则（HTTP 请求）。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -33312,45 +23230,51 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'list', + 'abilityTreeCode' => '164286', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '操作的地域', - 'description' => '操作的地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default'], ], [ - 'name' => 'Name', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '要搜索的命名空间名字', - 'description' => '要搜索的命名空间名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'spring-cloud-a'], + ], + [ + 'name' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => ['description' => '查找包含接口关键字的防护规则（与Resource不可同时存在）。', 'type' => 'string', 'required' => false, 'example' => 'flow'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => '应用Id', 'type' => 'string', 'required' => false, 'example' => 'b22qb1****@2f0586be4b1****'], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => ['description' => '查找指定接口的防护规则（与ResourceSearchKey不可同时存在）。', 'type' => 'string', 'required' => false, 'example' => '/flow'], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => '起始页。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页，每页 N 个。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -33358,739 +23282,426 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '错误时的提示信息', - 'description' => '错误时的提示信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'abcde-fg', - ], - 'ErrorCode' => [ - 'title' => '错误码。', - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求Id。', 'type' => 'string', 'example' => '4AE73569-304C-5AA9-AE11-C1D99C7D1689'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'title' => '返回的数据', - 'description' => '返回的数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'title' => '命名空间所属的地域', - 'description' => '命名空间所属的地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'title' => '命名空间名字', - 'description' => '命名空间名字。', - 'type' => 'string', - 'example' => 'default', + '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' => '规则Id', 'type' => 'string', 'example' => '1'], + 'AppName' => ['description' => '应用名。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => '接口资源名', 'type' => 'string', 'example' => '/flow'], + 'ResourceType' => ['description' => '资源类型'."\n" + ."\n" + .'- 0(自定义接口)'."\n" + .'- 1(WEB)'."\n" + .'- 2(RPC)', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ControlBehavior' => ['description' => '流控方式'."\n" + ."\n" + .'- 0(快速失败)'."\n" + .'- 2(排队等待)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Burst' => ['description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ResourceMode' => ['description' => '资源模式'."\n" + ."\n" + .'- 0(资源名模式)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Threshold' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'example' => '20'], + 'Enable' => ['description' => '开启或关闭。'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', 'type' => 'boolean', 'example' => 'true'], + 'ParamItem' => ['description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" + .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" + .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" + .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" + .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', 'type' => 'string', 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}'], + 'AppId' => ['description' => '应用Id。', 'type' => 'string', 'example' => 'hkhon1XXXX@c3df23522bXXXXX'], + 'MetricType' => ['description' => '阈值类型'."\n" + ."\n" + .'- 1(请求数)', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RegionId' => ['description' => '地域Id。', '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'], ], ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '查询热点参数防护规则（HTTP）', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListWebFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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' => '查询MSE命名空间', ], - 'ApplyTagPolicies' => [ - 'summary' => '修改标签路由规则。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListZkTrack' => [ + 'summary' => '获取ZooKeeper的轨迹数据。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '16993', - 'abilityTreeNodes' => [ - 'FEATUREmseW9QIF2', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150858', + 'abilityTreeNodes' => ['FEATUREmseN84UZV'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'RequestPars。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'Namespace', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间', - 'description' => '应用所属的MSE命名空间', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'mse-cn-0ju2yq****'], ], [ - 'name' => 'AppName', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'title' => '应用名字', - 'description' => '应用名字', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => '路径。', 'type' => 'string', 'required' => false, 'example' => '/path'], ], [ - 'name' => 'AppId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'deprecated' => true, - 'required' => true, - 'docRequired' => true, - 'example' => 'h5pohqu3gd@xxx', - ], + 'schema' => ['description' => 'SessionId。', 'type' => 'string', 'required' => false, 'example' => '0x301fdfbdbf00***'], ], [ - 'name' => 'Rules', + 'name' => 'StartTs', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '开始时间戳，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1669618483'], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => ['description' => '结束时间戳，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1669619383'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => '是否倒序。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + ."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'key为标签名。', - 'description' => '路由规则。', + 'description' => '数据结构。', 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => '状态。', - 'enumValueTitles' => [ - '未生效', - '生效', - '失效', - ], - 'example' => '0', - ], - 'Rate' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'description' => '百分比。', - ], - 'Enable' => [ - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'description' => '是否开启。', - ], - 'Tag' => [ - 'type' => 'string', - 'required' => false, - 'description' => '这个路由规则的环境。', - 'example' => 'gray', - ], - 'Name' => [ - 'title' => '路由规则名称。', - 'description' => '路由规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'description' => '规则ID。', - ], - 'InstanceNum' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => '实例数量。', - 'example' => '10', - ], - 'Rules' => [ - 'title' => '规则信息。', - 'description' => '规则信息。', + 'properties' => [ + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Traces' => [ + 'description' => '轨迹数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据概览。', 'type' => 'object', 'properties' => [ - 'springcloud' => [ - 'title' => 'springcloud规则。', - 'description' => 'springcloud规则。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'condition' => [ - 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'description' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'type' => 'string', - 'required' => false, - 'example' => 'AND', - ], - 'restItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'datum' => [ - 'type' => 'string', - 'required' => false, - 'example' => '10', - 'description' => 'rawvalue 等操作符需要比较的值。', - ], - 'operator' => [ - 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - 'description' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - 'type' => 'string', - 'required' => false, - 'example' => 'rawvalue', - ], - 'nameList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => '名称。', - 'example' => 'test1', - ], - 'required' => false, - 'description' => 'list 操作符需要的字段。', - ], - 'cond' => [ - 'title' => '比较符号，可取 >=, <=, >, <, == 。', - 'description' => '比较符号，可取 >=, <=, >, <, == 。', - 'type' => 'string', - 'required' => false, - 'example' => '==', - ], - 'divisor' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'description' => 'mod 操作符需要的字段，除数。', - ], - 'remainder' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => '百分比操作需要的字段，百分比值。', - 'example' => '30', - ], - 'rate' => [ - 'title' => '比例规则，20% 的流量路由到该标签对应的节点。', - 'description' => '比例规则，20% 的流量路由到该标签对应的节点。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'type' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'description' => '类型。', - ], - 'name' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'key', - 'description' => '名称。', - ], - 'value' => [ - 'type' => 'any', - 'required' => false, - 'example' => 'test', - 'description' => '值。', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'triggerPolicy' => [ - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PERCENT' => '比例规则', - 'CONTENT' => '内容匹配规则', - ], - 'example' => 'CONTENT', - 'description' => '策略类型。', - ], - 'enable' => [ - 'type' => 'boolean', - 'required' => false, - 'description' => '是否开启。', - 'example' => 'true', - ], - 'appId' => [ - 'type' => 'string', - 'required' => false, - 'example' => '***@***', - 'description' => '应用ID。', - ], - 'priority' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => '优先级。', - 'example' => '1', - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - 'description' => '标签。', - ], - 'required' => false, - 'description' => '标签列表。', - ], - 'paths' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => '/hello', - 'description' => '路径。', - ], - 'required' => false, - 'description' => '路径列表。', - ], - 'path' => [ - 'type' => 'string', - 'required' => false, - 'description' => '路径。', - 'example' => '/hello', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'dubbo' => [ - 'title' => 'dubbo 规则。', - 'description' => 'dubbo 规则。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'appId' => [ - 'type' => 'string', - 'required' => false, - 'description' => '应用ID。', - 'example' => '***@***'."\n", - ], - 'tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - 'description' => '标签。', - ], - 'required' => false, - 'description' => '标签列表。', - ], - 'triggerPolicy' => [ - 'type' => 'string', - 'required' => false, - 'description' => '策略类型。', - 'example' => 'CONTENT', - ], - 'serviceName' => [ - 'title' => '服务名（接口）。', - 'description' => '服务名（接口）。', - 'type' => 'string', - 'required' => false, - 'example' => 'HelloService', - ], - 'group' => [ - 'title' => 'dubbo服务分组。', - 'description' => 'dubbo服务分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'version' => [ - 'title' => 'dubbo服务版本。', - 'description' => 'dubbo服务版本。', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], - 'methodName' => [ - 'title' => 'dubbo服务的方法名。', - 'description' => 'dubbo服务的方法名。', - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - ], - 'paramTypes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'int', - 'description' => '参数类型。', - ], - 'required' => false, - 'description' => '参数类型列表。', - ], - 'condition' => [ - 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'description' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'type' => 'string', - 'required' => false, - 'example' => 'AND', - ], - 'argumentItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'operator' => [ - 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - 'description' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - 'type' => 'string', - 'required' => false, - 'example' => 'rawvalue', - ], - 'nameList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => '名称。', - 'example' => 'demo', - ], - 'required' => false, - 'description' => '名称列表。', - ], - 'datum' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'rawvalue 等操作符需要比较的值。', - 'example' => '30'."\n", - ], - 'cond' => [ - 'title' => '比较符号，可取 >=, <=, >, <, == 。', - 'description' => '比较符号，可取 >=, <=, >, <, == 。', - 'type' => 'string', - 'required' => false, - 'example' => '==', - ], - 'divisor' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'mod 操作符需要的字段，除数。', - 'example' => '30'."\n", - ], - 'remainder' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30'."\n", - 'description' => '百分比操作需要的字段，百分比值。', - ], - 'rate' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => '比例规则，20% 的流量路由到该标签对应的节点。', - 'example' => '10', - ], - 'index' => [ - 'title' => '参数位置，从0开始。', - 'description' => '参数位置，从0开始。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'expr' => [ - 'title' => '表达式，见其他字段解释。', - 'description' => '表达式，见其他字段解释。', - 'type' => 'string', - 'required' => false, - ], - 'value' => [ - 'title' => '比较的值。表达式得到的值会跟这个值比较。如果 operator 是 list 白名单，value 的值用 \\",\\" 分隔，比如 1,2,3。', - 'description' => '比较的值。表达式得到的值会跟这个值比较。如果 operator 是 list 白名单，value 的值用 \\",\\" 分隔，比如 1,2,3。', - 'type' => 'any', - 'required' => false, - 'example' => '1,2,3', - ], - ], - 'required' => false, - 'description' => '参数内容。', - ], - 'required' => false, - 'description' => '参数内容列表。', - ], - ], - 'required' => false, - 'description' => '规则内容。', - ], - 'required' => false, - ], + 'LogDate' => ['description' => '记录时间。', 'type' => 'string', 'example' => '2022-11-28 15:09:15,606'], + 'Timestamp' => ['description' => '时间戳（暂无）。', 'type' => 'string', 'example' => '1669619383000'], + 'SessionId' => ['description' => 'SessionId。', 'type' => 'string', 'example' => '0x301fdfbdbf00***'], + 'Path' => ['description' => '路径。', 'type' => 'string', 'example' => '/path'], + 'TraceType' => ['title' => '轨迹类型：push、pull、notify', 'description' => '轨迹类型：'."\n" + ."\n" + .'- Push'."\n" + ."\n" + .'- Pull'."\n" + ."\n" + .'- Notify', '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' => '操作类型。'."\n" + .'对于Push：'."\n" + .' '."\n" + .'- Create'."\n" + ."\n" + .'- Update'."\n" + ."\n" + .'- Delete'."\n" + ."\n" + .'- SetAcl'."\n" + ."\n" + .'- Multi'."\n" + ."\n" + .'对于Pull：'."\n" + ."\n" + .'- GetData'."\n" + ."\n" + .'- GetChild'."\n" + ."\n" + .'- GetStat', 'type' => 'string', 'example' => 'Create'], + 'EventType' => ['title' => '事件类型'."\n" + .'对于notify：'."\n" + .' ○ NodeCreated'."\n" + .' ○ NodeDeleted'."\n" + .' ○ NodeDataChanged'."\n" + .' ○ NodeChildrenChanged', 'description' => '事件类型。'."\n" + .'对于notify：'."\n" + ."\n" + .'- NodeCreated'."\n" + ."\n" + .'- NodeDeleted'."\n" + ."\n" + .'- NodeDataChanged'."\n" + ."\n" + .'- NodeChildrenChanged', 'type' => 'string', 'example' => 'NodeCreated'], + 'DataType' => ['title' => '数据类型：persist、ephemeral', 'description' => '数据类型：'."\n" + ."\n" + .'- persist'."\n" + ."\n" + .'- ephemeral', 'type' => 'string', 'example' => 'persist'], + 'Watch' => ['title' => '监听', 'description' => '是否监听。', 'type' => 'boolean', 'example' => 'true'], + 'Acl' => ['description' => 'ACL。', 'type' => 'string', 'example' => 'world:anyone:cdrwa'], + 'MultiSize' => ['description' => '事务大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'Result' => ['description' => '结果。', 'type' => 'string', 'example' => 'success'], + 'Ttl' => ['description' => 'TTL。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Finished' => ['description' => '业务是否结束。', 'type' => 'boolean', 'example' => 'true'], ], - 'required' => false, ], ], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'PageNumber' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'."\n"], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'ok'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- true：请求成功。'."\n" + ."\n" + .'- false：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID，可以不填。', - 'type' => 'string', - 'required' => false, - 'example' => '12233****', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '查询ZooKeeper轨迹数据', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZkTrack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ListZnodeChildren' => [ + 'summary' => '查询ZooKeeper数据子节点。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'Enable', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '17075', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '节点路径。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/zookeeper'], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-09k1q11****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****'], 'Data' => [ - 'description' => '数据概览', + 'description' => '数据概览。', 'type' => 'array', 'items' => [ - 'description' => '数据概览', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '生效状态', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'InstanceNum' => [ - 'description' => '实例数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Remove' => [ - 'description' => '是否删除成功。', - 'type' => 'boolean', - ], - 'CarryData' => [ - 'description' => '是否为主键。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tag' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => 'gray', - ], - 'Name' => [ - 'description' => '策略名称', - 'type' => 'string', - 'example' => 'test', - ], - 'Rules' => [ - 'description' => '标签规则', - 'type' => 'string', - 'example' => '{\\"_base\\": {\\"rate\\": 100, \\"remove\\": true}, \\"blue\\": {\\"rate\\": 0}}', - ], - 'Id' => [ - 'description' => '主键ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Rate' => [ - 'description' => '比例', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Enable' => [ - 'description' => '开启或关闭。'."\n" - ."\n" - .'- `true`：开启。'."\n" - .'- `false`：关闭。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Data' => ['description' => '节点数据。', 'type' => 'string', 'example' => 'cluster'], + 'Path' => ['description' => '节点路径。', 'type' => 'string', 'example' => '/zookeeper'], + 'Dir' => ['description' => '节点列表信息，取值如下：'."\n" + .'- `true`：信息返回成功。'."\n" + .'- `false`：信息返回失败。', 'type' => 'boolean', 'example' => 'true'], + 'Name' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1'], ], + 'description' => '', ], ], - 'Success' => [ - 'description' => '请求结果', - 'type' => 'boolean', - 'example' => 'true', - ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'ZooKeeper.IllegalRequest', 'errorMessage' => 'ZooKeeper operation is illegal.', 'description' => '当前ZooKeeper操作非法，请重新检查后进行操作'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', 'errorMessage' => 'No permission to operate current Znode.', 'description' => '无权限操作当前节点。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', 'errorMessage' => 'The current instance already has this Znode.', 'description' => '当前节点已经存在，请检查后重新操作。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => '当前操作的节点不存在，可能已经被删除。'], + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper 操作超时，可能由于当前操作的Znode数据过大，子节点过多，Server处理请求时间消耗过长，或者集群当前正在选主，无法处理请求。'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"\\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' => '查询ZooKeeper子节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZnodeChildren', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '修改标签路由规则', ], - 'ListApplicationsWithTagRules' => [ - 'summary' => '通过ListApplicationsWithTagRules接口获取应用的路由规则。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'ListZooKeeperSaslUser' => [ + 'summary' => '列出所有ZooKeeper sasl用户', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -34099,910 +23710,726 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217284', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['title' => '实例Id', 'description' => '实例Id', 'type' => 'string', 'required' => true, 'example' => 'mse-cn-5bffa4e8630'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页，第 N 页。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + 'title' => 'RestResult>', + 'description' => 'RestResult>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6C075654-E42F-5F58-914F-E11DA70881B7'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'UserName' => ['title' => 'Sasl 用户名', 'description' => 'Sasl 用户名', 'type' => 'string', 'example' => 'test'], + 'Description' => ['title' => 'Sasl 用户描述', 'description' => 'Sasl 用户描述', 'type' => 'string', 'example' => '测试'], + 'Status' => [ + 'title' => 'Sasl 当前用户状态', + 'description' => 'Sasl 当前用户状态', + 'type' => 'string', + 'example' => 'UserAddNeedReload', + 'maxLength' => 64, + 'enum' => ['UserAddNeedReload', 'UserRemoveNeedReload', 'PasswordResetNeedReload', 'Loaded'], + ], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '1631001140913'], + ], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询zookeeper Sasl 用户列表', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页，每页 N 个。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '50', - 'example' => '10', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + '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"}]', + ], + 'ModifyGovernanceKubernetesCluster' => [ + 'summary' => '修改已接入服务治理的集群信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '25610', + 'abilityTreeNodes' => ['FEATUREmseSXV85E'], + ], + 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群所在地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Source', + 'name' => 'ClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd23228b3c80c4d4f9ad87cc3****'], + ], + [ + 'name' => 'NamespaceInfos', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '数据来源，默认edasmsc。', - 'type' => 'string', + 'title' => '命名空间接入MSE服务治理的对应信息。', + 'description' => '命名空间接入MSE服务治理的对应信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'kubernetes命名空间名字。', 'description' => 'kubernetes命名空间名字。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'MseNamespace' => ['title' => '对应的微服务命名空间，为空代表没有接入。', 'description' => '对应的微服务命名空间，为空代表没有接入。', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'docRequired' => true, - 'example' => 'edasmsc', ], ], [ - 'name' => 'AppId', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'xjpc0h9h4d@xxx', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F9849E97-2455-54B0-A3B4-3F6E4E9FFEB1'], + 'Data' => ['description' => '数据概览。', 'type' => 'boolean', 'example' => 'True'], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。'."\n", 'type' => 'boolean', 'example' => 'True'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '应用所属的MSE命名空间', - 'description' => '应用所属的MSE命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - 'default' => 'default', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新已接入服务治理的集群信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ModifyGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ModifyLosslessRule' => [ + 'summary' => '修改用户无损上下线配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '115999', + 'abilityTreeNodes' => ['FEATUREmse9OTHB7'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => 'regionId', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '应用名字', - 'description' => '应用名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - 'maxLength' => 64, - ], + 'schema' => ['title' => 'appName', 'description' => '应用名。', 'type' => 'string', 'required' => false, 'example' => 'wx-work-api'], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['title' => 'namespace', 'description' => '规则所属的微服务命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => 'appName', 'description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => 'c644n5frmc@3e75f25fd4*****'], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['title' => 'the switch of rule, TRUE means open, FALSE means close', 'description' => '无损上线启用状态。取值：'."\n" + ."\n" + .'- true：启用。'."\n" + .'- false：禁用。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + ], + [ + 'name' => 'WarmupTime', + 'in' => 'query', + 'schema' => ['title' => 'warmup time of App', 'description' => '预热时长。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '60'], + ], + [ + 'name' => 'DelayTime', + 'in' => 'query', + 'schema' => ['title' => 'delay time of register to registry', 'description' => '延迟注册时间。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'FuncType', + 'in' => 'query', + 'schema' => ['title' => 'warmup function type, 2 means f(x)=x^2', 'description' => '预热曲线斜率。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Aligned', + 'in' => 'query', + 'schema' => ['title' => 'microservices lifecycle aligns to k8s\'s or NOT', 'description' => '是否开启“通过就绪检查前完成服务注册”。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], + [ + 'name' => 'Related', + 'in' => 'query', + 'schema' => ['title' => 'K8s\'s HPA is related to warmup or NOT', 'description' => '是否开启“通过就绪检查前完成服务预热”。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], + [ + 'name' => 'LossLessDetail', + 'in' => 'query', + 'schema' => ['title' => 'show lossLess offline&online detail', 'description' => '是否开启上下线处理明细。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Notice', + 'in' => 'query', + 'schema' => ['title' => 'enable lossLess offline active notification', 'description' => '是否开启主动通知。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'title' => 'RestResult', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'modifyLosslessRule success'], + 'Data' => ['description' => '返回数据。', 'type' => 'any', 'example' => 'null'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '修改无损规则', + 'changeSet' => [ + ['createdAt' => '2023-04-11T11:45:42.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-01-09T15:23:46.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-16T02:53:49.000Z', 'description' => '请求参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ModifyLosslessRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + 'OfflineGatewayRoute' => [ + 'summary' => '下线网关路由。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => ['description' => '路由条目ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '645'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '数据结构。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'title' => '应用所属的MSE命名空间', - 'description' => '应用所属的MSE命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'AppName' => [ - 'title' => '应用名', - 'description' => '应用名。', - 'type' => 'string', - 'example' => 'service-lottery-core', - ], - 'AppId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'daqijp6c31@xxx', - ], - 'RouteRules' => [ - 'description' => '规则列表。', - 'type' => 'array', - 'items' => [ - 'description' => '规则列表。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Rate' => [ - 'title' => '比例规则，20% 的流量路由到该标签对应的节点。', - 'description' => '比例。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Enable' => [ - 'description' => '报警规则的启用状态。取值：'."\n" - ."\n" - .'- `true`：启用。'."\n" - .'- `false`：禁用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tag' => [ - 'title' => '标签名。', - 'description' => '标签。', - 'type' => 'string', - 'example' => 'gray', - ], - 'Name' => [ - 'title' => '路由规则名称。', - 'description' => '规则名称。', - 'type' => 'string', - 'example' => 'dubbo', - ], - 'Id' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '653', - ], - 'InstanceNum' => [ - 'description' => '实例数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Rules' => [ - 'description' => '规则的适用路由。', - 'type' => 'object', - 'properties' => [ - 'springcloud' => [ - 'title' => 'springcloud规则。', - 'description' => 'springcloud规则。', - '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' => 'dubbo 规则。', - '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' => 'dubbo服务分组。', - 'type' => 'string', - ], - 'version' => [ - 'title' => 'dubbo服务版本。', - 'description' => 'dubbo服务版本。', - 'type' => 'string', - ], - 'methodName' => [ - 'title' => 'dubbo服务方法名。', - 'description' => 'dubbo服务方法名。', - 'type' => 'string', - ], - 'paramTypes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'condition' => [ - 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'description' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', - 'type' => 'string', - ], - 'argumentItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'operator' => [ - 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - 'description' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', - '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' => '参数位置，从0开始。', - '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' => '路由状态，取值如下：'."\n" - ."\n" - .'- 0：关闭'."\n" - ."\n" - .'- 1：开启', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'TotalSize' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页面大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8EB24742-AB15-5953-BEFB-1FA18E770EEE'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '报错信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '下线是否成功。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '下线网关路由', + '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 \\"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' => '获取应用的路由规则', ], - 'GetAppMessageQueueRoute' => [ - 'summary' => '获取应用消息灰度相关的信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'OrderClusterHealthCheckRiskNotice' => [ + 'summary' => '是否订阅风险项通知功能。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '116141', - 'abilityTreeNodes' => [ - 'FEATUREmse4ZR99T', - ], + 'abilityTreeCode' => '150983', + 'abilityTreeNodes' => ['FEATUREmseZDUZ1K'], ], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域，包括但不限于如下地域：'."\n" - .'- `cn-hangzhou`：杭州'."\n" - .'- `cn-beijing`：北京'."\n" - .'- `cn-shanghai`：上海'."\n" - .'- `cn-zhangjiakou`：张家口'."\n" - .'- `cn-shenzhen`：深圳', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'AppId', + 'name' => 'RiskCode', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'hkhon1po62@c3df23522baa898', - ], + 'schema' => ['description' => '风险编码。', 'type' => 'string', 'required' => false, 'example' => '30010010001'], ], [ - 'name' => 'Namespace', + 'name' => 'Mute', 'in' => 'query', - 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - 'maxLength' => 64, - ], + 'schema' => ['description' => '是否禁用此风险项通知功能。'."\n" + ."\n" + .'- true 禁用风险项通知'."\n" + .'- false 开启风险项通知', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'AppName', + 'name' => 'NoticeType', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '应用名称', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => '预留参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '集群所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型。'."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4B00BCB0-105F-5A2A-B75B-641C8E9B18FC', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@54e1f42f37cd65a', - ], - 'Region' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Enable' => [ - 'description' => '开启或关闭。'."\n" - ."\n" - .'- `true`：开启。'."\n" - .'- `false`：关闭。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tags' => [ - 'description' => '此应用的未打标环境，不会消费的标签。', - 'type' => 'array', - 'items' => [ - 'description' => '此应用的未打标环境，不会消费的标签', - 'type' => 'string', - 'example' => 'gray', - ], - ], - 'FilterSide' => [ - 'description' => '消息灰度过滤侧。', - 'type' => 'string', - 'example' => 'Server', - 'default' => 'Server', - 'enum' => [ - 'Server', - 'Client', - ], - ], - 'GrayBaseTags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：true：请求成功。 false：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。'."\n" + ."\n", 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因，例如：TaskId not found。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '是否订阅成功', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '订阅风险项通知', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:OrderClusterHealthCheckRiskNotice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取应用消息灰度信息', ], - 'UpdateMessageQueueRoute' => [ - 'summary' => '更新应用消息灰度的配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'msc', - ], + 'PreserveHeaderFormat' => [ + 'summary' => '作用于请求和响应环节，是否保持请求header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '116139', - 'abilityTreeNodes' => [ - 'FEATUREmse4ZR99T', - ], + 'abilityTreeCode' => '142071', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'Tags', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '此应用的未打标环境，忽略的标签。', - 'type' => 'array', - 'items' => [ - 'description' => '此应用的未打标环境，忽略的标签。', - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****'], ], [ - 'name' => 'Region', + 'name' => 'PreserveHeaderFormat', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '是否保持请求header头大小写。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ - 'name' => 'Enable', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '消息灰度的启用状态。取值：'."\n" - ."\n" - .'- `true`：启用。'."\n" - .'- `false`：禁用。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '是否开启成功。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'hkhon1po62@c3df23522baa898', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '开启保持请求header头大小写', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'FilterSide', - 'in' => 'query', - 'schema' => [ - 'description' => '消息灰度过滤侧。', - 'type' => 'string', - 'required' => false, - 'example' => 'Server', - 'default' => 'Server', - 'enum' => [ - 'Server', - 'Client', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:PreserveHeaderFormat', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], + ], + ], + 'PullServices' => [ + 'summary' => '查询指定来源可导入服务信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'Namespace', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '25181', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], + ], + 'parameters' => [ + [ + 'name' => 'SourceType', 'in' => 'query', 'schema' => [ - 'title' => 'MSE命名空间名字', - 'description' => 'MSE命名空间名字', + 'description' => '服务来源类型。', 'type' => 'string', 'required' => false, - 'example' => 'default', - 'maxLength' => 64, + 'enumValueTitles' => ['K8S' => 'K8S', 'MSE' => 'MSE'], + 'example' => 'K8S', ], ], [ - 'name' => 'AppName', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '应用名称', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - 'maxLength' => 64, - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-eccf313e2224438ba53d95d039e5****'], ], [ - 'name' => 'GrayBaseTags', + 'name' => 'Namespace', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'public'], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['title' => '服务来源ID', 'description' => '服务来源ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '本次请求的ID。', - 'type' => 'string', - 'example' => 'E3919C62-876A-5926-A0BC-18351A24FA35', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '节点数据。', - 'type' => 'string', - 'example' => 'True', - ], - 'Code' => [ - 'description' => '状态码。状态码为200表示成功，其余取值表示失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'GroupName' => ['description' => '分组。', 'type' => 'string', 'example' => 'test'], + 'Services' => [ + 'description' => '服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '服务名。', 'type' => 'string', 'example' => 'test'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'public'], + 'GroupName' => ['description' => '分组。', 'type' => 'string', 'example' => 'test'], + 'SourceId' => ['description' => '来源ID。', 'type' => 'string', 'example' => '1'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'example' => 'MSE'], + 'SourceIdList' => [ + 'title' => '归属的服务来源ID列表', + 'description' => '归属的服务来源ID列表', + 'type' => 'array', + 'items' => ['title' => '归属的服务来源ID', 'description' => '归属的服务来源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + 'SaeAppId' => ['description' => 'SAE应用ID。', 'type' => 'string'], + ], + ], + ], + 'NamespaceShowName' => ['description' => '命名空间别名。', 'type' => 'string', 'example' => 'public'], + ], + ], ], ], ], @@ -35010,319 +24437,311 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '查询指定来源可导入服务信息', + '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 \\"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' => '更新应用消息灰度的配置', ], - 'AddMockRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutClusterHealthCheckTask' => [ + 'summary' => '对当前集群发起一次风险评估的检查任务。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent-auto-test-sc', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-2r42o83h506'], ], [ - 'name' => 'Region', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Source', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '规则来源。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'edasmsc', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因，例如：TaskId not found。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '执行结果信息。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], - [ - 'name' => 'ProviderAppId', - 'in' => 'query', - 'schema' => [ - 'description' => '服务提供者应用ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'dcqtkuhnc4@66e5235415****', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], ], - [ - 'name' => 'ProviderAppName', - 'in' => 'query', - 'schema' => [ - 'description' => '服务提供者应用名称。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'demo-cartservice', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], ], [ - 'name' => 'ExtraJson', - 'in' => 'query', - 'schema' => [ - 'description' => '描述。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{}', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], - [ - 'name' => 'ScMockItems', - 'in' => 'query', - 'schema' => [ - 'description' => '入参数，支持JSON格式。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[]', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '发起风险评估检查任务', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'DubboMockItems', - 'in' => 'query', - 'schema' => [ - 'description' => '回收站中的项目。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[]', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:PutClusterHealthCheckTask', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], + ], + ], + 'QueryAllSwimmingLane' => [ + 'summary' => '获取所有泳道信息', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'ConsumerAppIds', - 'in' => 'query', - 'schema' => [ - 'description' => '用户自定义应用ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{\\"appName\\":\\"provide\\",\\"appId\\":\\"bst8l6o735@f6d8aaf6e56e67d\\"}]', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '116125', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], + ], + 'parameters' => [ [ - 'name' => 'Enable', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '报警规则的启用状态。取值：'."\n" - ."\n" - .'- `true`：启用。'."\n" - .'- `false`：禁用。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'MockType', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '慢调用RT。取值如下：'."\n" - ."\n" - .'- 15：15ms'."\n" - .'- 30：30ms'."\n" - .'- 60：60ms'."\n" - .'- 120：120ms', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '泳道组id。', 'description' => '泳道组ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '186'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'Message' => ['title' => '请求信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'NamespaceId' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'ScMockItemJson' => [ - 'description' => 'HTTP协议Mock规则。', - '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' => '需查询的应用名称。', - 'type' => 'string', - 'example' => 'demo-xxxx', - ], - 'ConsumerAppId' => [ - 'description' => '服务消费者应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@a000601b265xxxx', - ], - 'AccountId' => [ - 'description' => '账户ID。', - 'type' => 'string', - 'example' => '178432728867xxxx', - ], - 'ExtraJson' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => 'desc', - ], - 'Source' => [ - 'description' => '来源', - 'type' => 'string', - 'example' => 'edasmsc', - ], - 'Region' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'ProviderAppId' => [ - 'description' => '服务提供者应用ID。', - 'type' => 'string', - 'example' => 'hkhon1po62@a000601b265xxxx', - ], - 'ProviderAppName' => [ - 'description' => '服务提供者应用名称。', - 'type' => 'string', - 'example' => 'demo-xxxx', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', - ], - 'Id' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '275', - ], - 'Enable' => [ - 'description' => '开启或关闭。'."\n" - ."\n" - .'- `true`：开启。'."\n" - .'- `false`：关闭。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MockType' => [ - 'description' => '模型类型，取值如下：'."\n" - ."\n" - .'- `[unk]0[unk]`：桌面模型'."\n" - .'- `[unk]1[unk]`：移动端模型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '泳道组名称。', 'description' => '泳道组名称。', 'type' => 'string', 'example' => 'swimmingGroup'], + 'UserId' => ['title' => '泳道所属的用户id。', 'description' => '泳道所属的用户id。', 'type' => 'string', 'example' => '12345'], + 'MessageQueueFilterSide' => ['title' => '在哪一侧实现消息灰度。', 'description' => '在哪一侧实现消息灰度。', 'type' => 'string', 'example' => 'Client'], + 'Enable' => ['title' => '是否开启。', 'description' => '是否开启。', 'type' => 'string', 'example' => 'true'], + 'Namespace' => ['title' => '泳道所属的MSE命名空间。', 'description' => '泳道所属的MSE命名空间。', 'type' => 'string', 'example' => 'default'], + 'RecordCanaryDetail' => ['title' => '是否记录请求详情（全链路灰度可观测）。', 'description' => '是否记录请求详情（全链路灰度可观测）。', 'type' => 'boolean', 'example' => 'false'], + 'Id' => ['title' => '泳道组Id。', 'description' => '泳道Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'RegionId' => ['title' => '所属地域。', 'description' => '所属地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'MessageQueueGrayEnable' => ['title' => '是否开启消息灰度。', 'description' => '是否开启消息灰度。', 'type' => 'boolean', 'example' => 'false'], + 'enableRules' => ['title' => '是否开启规则。', 'description' => '是否开启规则。', 'type' => 'boolean', 'example' => 'true'], + 'EntryRules' => [ + 'description' => '入口应用规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '入口应用规则', + 'type' => 'object', + 'properties' => [ + 'paths' => [ + 'description' => '路径列表', + 'type' => 'array', + 'items' => ['description' => '路径', 'type' => 'string', 'example' => '/'], + ], + 'path' => ['title' => '', 'description' => '路径', 'type' => 'string', 'example' => '/adump/wxb/prod'], + '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' => 'test'], + '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' => 'test'], + ], + ], + ], + ], + ], + ], + 'gmtCreate' => ['title' => '泳道创建时间。', 'description' => '泳道创建时间。', 'type' => 'string', 'example' => '1683598484000'], + 'gmtModified' => ['title' => '泳道更新时间。', 'description' => '泳道更新时间。', 'type' => 'string', 'example' => '1683598484000'], + 'groupId' => ['title' => '泳道组Id。', 'description' => '泳道组Id。', 'type' => 'string', 'example' => '72709'], + 'GroupId' => ['title' => '泳道组Id。', 'description' => '泳道组Id。', 'type' => 'string', 'example' => '6859'], + 'tag' => ['title' => '泳道对应的标签。', 'description' => '泳道对应的标签。', 'type' => 'string', 'example' => 'gray'], + 'Tag' => ['title' => '泳道对应的标签。', 'description' => '泳道对应的标签。', 'type' => 'string', 'example' => 'gray'], + 'GatewaySwimmingLaneRoute' => [ + 'title' => '网关路由信息（使用云原生网关为入口时使用）', + 'description' => '网关路由信息（使用云原生网关/APIG网关为入口时使用）', + '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' => '路由ID', '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' => '路由 id', 'type' => 'string', 'example' => '12345'], + 'Percentage' => ['description' => '百分比', 'type' => 'string', 'example' => '60'], + ], + ], + ], + 'Condition' => ['description' => '灰度条件', 'type' => 'string', 'example' => 'AND、OR'], + ], + ], + 'PathIndependentPercentageEnable' => ['description' => '是否设置每条路径的百分比', 'type' => 'boolean', 'example' => 'true'], + 'GatewaySwimmingLaneRouteJson' => ['description' => '网关相关信息（MSE云原生网关/云原生API网关作为入口时使用）', 'type' => 'string', 'example' => '{\\"GatewayUniqueId\\":\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\",\\"Percentage\\":0,\\"RouteIdList\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\"CanaryModel\\":1,\\"Conditions\\":[]}'], ], ], - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'example' => '[{id:100,name:"test"}]', ], ], ], @@ -35330,48 +24749,53 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - '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' => '创建Mock规则', - 'summary' => '创建Mock规则。', - ], - 'GetPlugins' => [ - 'summary' => '获取插件市场插件。', - 'methods' => [ - 'get', - 'post', + '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' => '查询当前泳道组内所有泳道', + 'changeSet' => [ + ['createdAt' => '2025-01-15T12:13:11.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-12-26T11:34:08.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-09-10T02:16:39.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-05-29T13:45:43.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-03-14T12:14:29.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-06-26T12:41:54.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-06-08T06:44:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-05-05T08:27:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-04-28T06:37:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-03-30T09:31:56.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryAllSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ], + ], + ], ], + ], + 'QueryAllSwimmingLaneGroup' => [ + 'summary' => '用于查询所有泳道组。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -35381,326 +24805,206 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '128636', - 'abilityTreeNodes' => [ - 'FEATUREmse7RUWJD', - ], + 'abilityTreeCode' => '116120', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', - ], + 'schema' => ['title' => '需要查询的MSE命名空间名字', 'description' => '需要查询的MSE命名空间名字。', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ - 'name' => 'Category', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '插件类型：'."\n" - ."\n" - .'- 自定义：0'."\n" - ."\n" - .'- 认证权限：1'."\n" - ."\n" - .'- 安全防护：2'."\n" - ."\n" - .'- 传输协议：3'."\n" - ."\n" - .'- 流量管控：4'."\n" - ."\n" - .'- 流量观测：5', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '泳道组名称', 'description' => '泳道组名称。', 'type' => 'string', 'example' => 'swimmingGroup'], + 'UserId' => ['title' => '泳道所属的用户id', 'description' => '泳道所属的用户ID。', 'type' => 'string', 'example' => '12345'], + 'MessageQueueFilterSide' => ['title' => '在哪一侧实现消息灰度', 'description' => '在哪一侧开启消息灰度。', 'type' => 'string', 'example' => 'Client'], + 'AppIds' => ['title' => '应用Id列表', 'description' => '应用Id列表。', 'type' => 'string', 'example' => 'abcde@abcde,abcde@abcde'], + 'Namespace' => ['title' => '泳道所属的MSE命名空间', 'description' => '泳道所属的MSE命名空间。', 'type' => 'string', 'example' => 'default'], + 'RecordCanaryDetail' => ['title' => '是否记录请求详情（全链路灰度可观测）', 'description' => '是否记录请求详情（全链路灰度可观测）。', 'type' => 'boolean', 'example' => 'false'], + 'Id' => ['title' => '泳道组Id', 'description' => '泳道组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'EntryApp' => ['title' => '入口应用类型+入口应用Id', 'description' => '入口应用类型和入口应用ID。', 'type' => 'string', 'example' => 'mse:abcde@abcde'], + 'Region' => ['title' => '所属地域', 'description' => '所属地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'MessageQueueGrayEnable' => ['title' => '是否开启消息灰度', 'description' => '是否开启消息灰度。', 'type' => 'boolean', 'example' => 'true'], + 'Paths' => ['description' => '已废弃', 'type' => 'string', 'example' => '["/a"]'], + 'paths' => ['description' => '已废弃', 'type' => 'string', 'example' => '["/a"]'], + 'CanaryModel' => ['description' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'canaryModel' => ['description' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'SwimVersion' => ['description' => '全链路灰度版本，取值范围：0,2(推荐使用)', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'swimVersion' => ['description' => '全链路灰度版本，取值范围：0,2(推荐使用)', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + ], + 'description' => '', + ], + 'example' => '[{id:100,name:"test"}]'."\n", + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'EnableOnly', - 'in' => 'query', - 'schema' => [ - 'description' => '是否已启用。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询所有泳道组', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '插件名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'key-auth', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryAllSwimmingLaneGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryBusinessLocations' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['common'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'zh：中文'."\n" - .'en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => '返回数据。', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'."\n", - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'Code。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => '500', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP STATUS编码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '接口信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'message', - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The parameter is invalid.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****'], 'Data' => [ - 'description' => '返回数据。', + 'description' => '数据概览。', 'type' => 'array', 'items' => [ - 'description' => '对象。', + 'description' => '返回集合。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '插件ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PrimaryUser' => [ - 'description' => '创建人ID。', - 'type' => 'string', - 'example' => '123', - ], - 'Category' => [ - 'description' => '插件类型：'."\n" - ."\n" - .'自定义：0'."\n" - ."\n" - .'认证权限：1'."\n" - ."\n" - .'安全防护：2'."\n" - ."\n" - .'传输协议：3'."\n" - ."\n" - .'流量管控：4'."\n" - ."\n" - .'流量观测：5', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Name' => [ - 'description' => '插件名称。', - 'type' => 'string', - 'example' => 'key-auth', - ], - 'Version' => [ - 'description' => '插件版本。', - 'type' => 'string', - 'example' => 'v1', - ], - 'Summary' => [ - 'description' => '插件概要。', - 'type' => 'string', - 'example' => '这是一个插件', - ], - 'SummaryEn' => [ - 'type' => 'string', - ], - 'Phase' => [ - 'description' => '插件执行阶段：'."\n" - ."\n" - .'- 默认阶段：0'."\n" - ."\n" - .'- 认证阶段：1'."\n" - ."\n" - .'- 鉴权阶段：2'."\n" - ."\n" - .'- 统计阶段：3', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Priority' => [ - 'description' => '插件执行优先级。数值越大，优先级越高。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConfigCheck' => [ - 'description' => '配置校验。', - 'type' => 'string', - 'example' => '# 配置必须字段的校验，如下例所示，要求插件配置必须存在 "name"、"age"、“friends” 字段'."\n" - .'name: John'."\n" - .'age: 18'."\n" - .'friends:'."\n" - .'- David'."\n" - .'- Anne'."\n", - ], - 'WasmLang' => [ - 'description' => 'Wasm实现语言：'."\n" - ."\n" - .'- C++：0'."\n" - ."\n" - .'- TinyGo：1'."\n" - ."\n" - .'- Rust：2'."\n" - ."\n" - .'- AssemblyScript：3'."\n" - ."\n" - .'- Zig：4', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PublishState' => [ - 'description' => '发布状态：'."\n" - .'- 0：成功'."\n" - .'- 1：发布中'."\n" - .'- 2：发布失败', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WasmFile' => [ - 'description' => 'Wasm插件OSS。', - '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' => '启用状态。'."\n" - ."\n" - .'- 未启用：0'."\n" - ."\n" - .'- 启用：1', - 'type' => 'string', - 'example' => '1', - ], - 'Mode' => [ - 'description' => '插件语言：'."\n" - ."\n" - .'- 0：WASM插件'."\n" - .'- 2：LUA插件', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxVersion' => [ - 'description' => '最新版本。', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'NewVersionPublishingFlag' => [ - 'description' => '最新版本是否正在发布中。', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Ordering' => ['description' => '订购。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'region'], + 'DistrictEnName' => ['description' => '地域英语名称。', 'type' => 'string', 'example' => 'Asia Pacific'], + 'ShowName' => ['description' => '显示名称。', 'type' => 'string', 'example' => 'China (Shanghai)'], + 'DistrictCnName' => ['description' => '地域中文名称。', 'type' => 'string', 'example' => '亚太'], + 'EnName' => ['description' => '英语名称。', 'type' => 'string', 'example' => 'China (Shanghai)'], + 'DistrictId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'asia-pacific'], + 'DistrictShowName' => ['description' => '地域展示名称。', 'type' => 'string', 'example' => 'Asia Pacific'], + 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'China (Shanghai)'], + 'EnDescription' => ['description' => '英语描述。', 'type' => 'string', 'example' => 'China East 2 (Shanghai)'], + 'CnName' => ['description' => '中文名称。', 'type' => 'string', 'example' => '华东2（上海）'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'cn-shanghai'], + 'DistrictOrdering' => ['description' => '地区订购。', 'type' => 'integer', 'format' => 'int32', 'example' => '101'], ], ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果。', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": \\"这是一个插件\\",\\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' => '获取插件列表', - ], - 'GetPluginConfig' => [ - 'summary' => '获取插件配置。', - 'methods' => [ - 'get', - 'post', - ], - '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":"\\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' => '查询地域信息', + 'summary' => '查询地域信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2026-02-27T05:55:07.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2026-02-27T05:54:51.000Z', 'description' => 'OpenAPI 下线'], ], + 'ramActions' => [], + ], + 'QueryClusterDetail' => [ + 'summary' => '接口查询集群详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -35710,547 +25014,209 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '128638', - 'abilityTreeNodes' => [ - 'FEATUREmseKZMVG1', - ], + 'abilityTreeCode' => '17078', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '网关UniqueId。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n", - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'PluginId', + 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '网关插件ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '订单ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '20576750143****'], + ], + [ + 'name' => 'AclSwitch', + 'in' => 'query', + 'schema' => ['description' => '是否查询ACL。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'zh：中文'."\n" - .'en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '字符串对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'Code。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => '500', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP STATUS编码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '接口信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误编码。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息。', - 'type' => 'string', - 'example' => 'message', - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9515ACA4-E94D-440D-989E-C379FCED****'], 'Data' => [ - 'description' => '返回数据。', + 'description' => '数据概览。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '插件ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PrimaryUser' => [ - 'description' => '创建人ID。', - 'type' => 'string', - 'example' => '123', - ], - 'Type' => [ - 'description' => '插件类型：'."\n" - .'- 0：http filter'."\n" - .'- 1：network filte', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [], - 'example' => '0', - ], - 'Category' => [ - 'description' => '插件目录。'."\n" - ."\n" - .'自定义：0'."\n" - ."\n" - .'认证权限：1'."\n" - ."\n" - .'安全防护：2'."\n" - ."\n" - .'传输协议：3'."\n" - ."\n" - .'流量管控：4'."\n" - ."\n" - .'流量观测：5', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Name' => [ - 'description' => '插件名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'Version' => [ - 'description' => '插件版本。', - 'type' => 'string', - 'example' => 'v1', - ], - 'Summary' => [ - 'description' => '插件概要。', - 'type' => 'string', - 'example' => '这是一个插件。', - ], - 'SummaryEn' => [ - 'type' => 'string', - ], - 'Readme' => [ - 'description' => 'README描述。', - 'type' => 'string', - 'example' => 'read me', - ], - 'ReadmeEn' => [ - 'description' => '英文README描述。', - 'type' => 'string', - 'example' => 'read me', - ], - 'ConfigExample' => [ - 'title' => '插件配置样例', - 'description' => '插件配置样例', - 'type' => 'string', - ], - 'Phase' => [ - 'description' => '插件执行阶段。'."\n" - ."\n" - .'默认阶段：0'."\n" - ."\n" - .'认证阶段：1'."\n" - ."\n" - .'鉴权阶段：2'."\n" - ."\n" - .'统计阶段：3', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Priority' => [ - 'description' => '插件执行优先级。数值越大，优先级越高。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConfigCheck' => [ - 'description' => '配置校验。', - 'type' => 'string', - 'example' => '# 配置必须字段的校验，如下例所示，要求插件配置必须存在 "name"、"age"、“friends” 字段'."\n" - .'name: John'."\n" - .'age: 18'."\n" - .'friends:'."\n" - .'- David'."\n" - .'- Anne', - ], - 'Mode' => [ - 'description' => '模式。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WasmLang' => [ - 'description' => 'wasm实现语言。'."\n" - ."\n" - .'C++：0'."\n" - ."\n" - .'TinyGo：1'."\n" - ."\n" - .'Rust：2'."\n" - ."\n" - .'AssemblyScript：3'."\n" - ."\n" - .'Zig：4', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ImageName' => [ - 'description' => '镜像名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'PublishState' => [ - 'description' => '发布状态。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => '启用状态。'."\n" - ."\n" - .'未启用：0'."\n" - ."\n" - .'启用：1', - 'type' => 'string', - 'example' => '1', - ], - 'GatewayConfigList' => [ - 'title' => '网关插件配置规则列表。规则排列顺序为路由级规则、域名级规则、实例级规则', - 'description' => '网关插件配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据对象。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '插件配置ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayUniqueId' => [ - 'description' => '网关UniqueId。', - 'type' => 'string', - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', - ], - 'PluginId' => [ - 'description' => '网关插件ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Enable' => [ - 'description' => '是否开启。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Config' => [ - 'description' => '插件配置。', - 'type' => 'string', - 'example' => '# 配置必须字段的校验，如下例所示，要求插件配置必须存在 "name"、"age"、“friends” 字段'."\n" - .'name: John'."\n" - .'age: 18'."\n" - .'friends:'."\n" - .'- David'."\n" - .'- Anne', - ], - 'ConfigLevel' => [ - 'description' => '插件应用范围。'."\n" - ."\n" - .'全局：0'."\n" - ."\n" - .'域名：1'."\n" - ."\n" - .'路由：2', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResourceList' => [ - 'title' => '域名/路由资源列表（根据ConfigLevel区分）', - 'description' => '域名/路由资源列表（根据ConfigLevel区分）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Name' => [ - 'title' => '资源名称（域名/路由名）', - 'description' => '资源名称（域名/路由名）', - 'type' => 'string', - 'example' => 'test-route', - ], - ], - ], - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '1667309705000', - ], - 'GmtModified' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '1667309705000', - ], - ], - ], - ], - 'RouteConfigStartIndex' => [ - 'title' => '路由级规则在GatewayConfigList中的起始下标。若不存在路由级规则，值为-1', - 'description' => '路由级规则在GatewayConfigList中的起始下标。若不存在路由级规则，值为-1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DomainConfigStartIndex' => [ - 'title' => '域名级规则在GatewayConfigList中的起始下标。若不存在域名级规则，值为-1', - 'description' => '域名级规则在GatewayConfigList中的起始下标。若不存在域名级规则，值为-1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'GatewayConfigStartIndex' => [ - 'title' => '实例规则在GatewayConfigList中的下标。若不存在实例级规则，值为-1', - 'description' => '实例规则在GatewayConfigList中的下标。若不存在实例级规则，值为-1', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'VersionJson' => [ - 'description' => '网关插件版本信息列表。', - 'type' => 'string', - 'example' => '[{"id":1, "version": "1.0.0"}]', + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1hcg467ekqsv0zr****'], + 'CreateTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2020-07-31 11:36:08'], + 'IntranetAddress' => ['description' => '私网地址。', 'type' => 'string', 'example' => '192.168.XX.XX'], + 'DiskType' => ['description' => '磁盘类型。', 'type' => 'string', 'example' => 'alicloud-disk-ssd-multi-zone'], + 'PubNetworkFlow' => ['description' => '公网带宽，单位：Mbps。 '."\n" + .'取值范围：0~5000，其中0表示不接入公网。', 'type' => 'string', 'example' => '3'], + 'DiskCapacity' => ['description' => '磁盘容量，单位：G。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'MemoryCapacity' => ['description' => '内存大小，单位：G。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'ClusterAliasName' => ['description' => '集群别名。', 'type' => 'string', 'example' => 'mse-7413****'], + 'InstanceCount' => ['description' => '集群实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'IntranetPort' => ['description' => '私网端口。', 'type' => 'string', 'example' => '8761'], + 'InstanceModels' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字符串对象。', + 'type' => 'object', + 'properties' => [ + 'PodName' => ['description' => 'Pod名称。', 'type' => 'string', 'example' => 'mse-7413****-159616656****-reg-center-0-0'], + 'SingleTunnelVip' => ['description' => '单线程IP。', 'type' => 'string', 'example' => '192.168.XX.XX'], + 'InternetIp' => ['description' => '公网IP。', 'type' => 'string', 'example' => '47.98.XX.XX'], + 'Ip' => ['description' => '实例IP。', 'type' => 'string', 'example' => '10.12.XX.XX'], + 'Role' => ['description' => '角色。', 'type' => 'string', 'example' => 'Peer'], + 'HealthStatus' => ['description' => '实例健康状态。', 'type' => 'string', 'example' => 'Running'], + 'CreationTimestamp' => ['description' => '创建时间戳。', 'type' => 'string', 'example' => '1578575377732'], + 'Zone' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-shanghai-f'], + ], + ], ], + 'IntranetDomain' => ['description' => '私网域名。', 'type' => 'string', 'example' => 'mse-7413****-eureka.mse.aliyuncs.com'], + 'InternetDomain' => ['description' => '公网域名。', 'type' => 'string', 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com'], + 'PayInfo' => ['description' => '付费类型，包括包年包月和按量付费类型。', 'type' => 'string', 'example' => 'Pay-as-you-go'], + 'InternetAddress' => ['description' => '公网地址。', 'type' => 'string', 'example' => '47.98.XX.XX'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + 'AclEntryList' => ['description' => '白名单列表。', 'type' => 'string', 'example' => '[]'], + 'HealthStatus' => ['description' => '集群健康状态。', 'type' => 'string', 'example' => 'RESTART_SUCCESS'], + 'InitCostTime' => ['description' => '集群创建耗时，单位：ms。', 'type' => 'integer', 'format' => 'int64', 'example' => '98408'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'AclId' => ['description' => '白名单ID。', 'type' => 'string', 'example' => 'acl-bp17020kiqvzutwwj****'], + 'Cpu' => ['description' => 'CPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ClusterType' => ['description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', 'type' => 'string', 'example' => 'Nacos-Ans'], + 'ClusterName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'mse-bc1a29b0-160230875****'], + 'InitStatus' => ['description' => '集群创建状态。', 'type' => 'string', 'example' => 'RESTART_SUCCESS'], + 'InternetPort' => ['description' => '私网端口。', 'type' => 'string', 'example' => '8761'], + 'AppVersion' => ['description' => 'APP版本。', 'type' => 'string', 'example' => '1.2.1'], + 'NetType' => ['description' => '网络类型，取值如下：'."\n" + ."\n" + .'- `privatenet`：表示专有网络。'."\n" + .'- `pubnet`：表示公网。', 'type' => 'string', 'example' => 'privatenet'], + 'ClusterVersion' => ['description' => '集群版本。', 'type' => 'string', 'example' => '1.2.1'], + 'ClusterSpecification' => ['description' => '引擎规格。', 'type' => 'string', 'example' => 'MSE_SC_1_2_200_c'], + 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-xxx-xxxx'], + 'ConnectionType' => ['description' => '网络连接类型，取值如下：'."\n" + ."\n" + .'- slb'."\n" + .'- eni', 'type' => 'string', 'example' => 'slb'], + 'MseVersion' => ['description' => 'MSE版本号', 'type' => 'string', 'example' => 'mse_basic'], + 'ChargeType' => ['description' => '付费模式，包括包年包月和按量付费。', 'type' => 'string', 'example' => 'Pay-as-you-go'], + 'OrderClusterVersion' => ['description' => '原始订单版本号。', 'type' => 'string', 'example' => '1.2.0'], + 'Tags' => ['description' => '实例所绑定的标签。', 'type' => 'object'], + 'ResourceGroupId' => ['description' => '资源组 ID。', 'type' => 'string', 'example' => 'rg-aek2dhgysj*****'], + 'VersionLifecycle' => ['description' => '版本生命周期。', 'type' => 'string'], ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","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}","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' => '查询集群详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取插件配置', ], - 'CreatePluginConfig' => [ - 'summary' => '创建插件配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryClusterDiskSpecification' => [ + 'summary' => '查询支持的集群磁盘规格信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '219339', - 'abilityTreeNodes' => [ - 'FEATUREmseKZMVG1', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '76161', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID', - 'description' => '网关唯一ID', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', - ], - ], - [ - 'name' => 'PluginId', - 'in' => 'query', - 'schema' => [ - 'title' => '网关插件ID', - 'description' => '网关插件ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], - ], - [ - 'name' => 'ConfigLevel', - 'in' => 'query', - 'schema' => [ - 'title' => '插件应用范围。'."\n" - ."\n" - .'- 全局：0'."\n" - .'- 路由：1'."\n" - .'- 域名：2', - 'description' => '插件应用范围。'."\n" - ."\n" - .'- 全局：0'."\n" - .'- 路由：1'."\n" - .'- 域名：2', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'title' => '插件配置。Wasm 插件配置内容是 YAML 格式，Lua 插件配置内容是 Lua 代码。', - 'description' => '插件配置。Wasm 插件配置内容是 YAML 格式，Lua 插件配置内容是 Lua 代码。', - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'title' => '是否开启。', - 'description' => '是否开启。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'ResourceIdList', + 'name' => 'ClusterType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '域名ID/路由ID列表（根据ConfigLevel区分）', - 'description' => '域名ID/路由ID列表（根据ConfigLevel区分）', - 'type' => 'array', - 'items' => [ - 'title' => 'ID值', - 'description' => 'ID值', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - 'required' => false, - ], + 'schema' => ['description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ZooKeeper'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', - ], - 'PluginConfigID' => [ - 'title' => '插件配置ID', - 'description' => '插件配置ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'HttpStatusCode' => ['description' => '请求返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E13A3A34-7201-50C4-B2D0-0D7DB891811E'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => '磁盘大小步长。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Max' => ['description' => '磁盘允许最大值，单位：GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'Min' => ['description' => '磁盘允许最小值，单位：GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], ], ], @@ -36258,373 +25224,310 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '查询集群磁盘规格', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterDiskSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"PluginConfigID\\": 10\\n}","type":"json"}]', - 'title' => '创建插件配置', ], - 'UpdatePluginConfig' => [ - 'summary' => '更新插件配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryClusterInfo' => [ + 'summary' => '查询集群的静态信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '128635', - 'abilityTreeNodes' => [ - 'FEATUREmseKZMVG1', - ], + 'abilityTreeCode' => '129315', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '插件配置ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'GatewayId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-7mz2t63ci03'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '网关UniqueId。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', - ], + 'schema' => ['description' => '订单ID。', 'type' => 'string', 'required' => false, 'example' => '20574710974****'], ], [ - 'name' => 'PluginId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关插件ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'ConfigLevel', - 'in' => 'query', - 'schema' => [ - 'description' => '插件应用范围。'."\n" - ."\n" - .'- 全局：0'."\n" - ."\n" - .'- 路由：1'."\n" - ."\n" - .'- 域名：2', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'ResourceIdList', + 'name' => 'AclSwitch', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '域名ID/路由ID列表（根据ConfigLevel区分）', - 'description' => '域名ID/路由ID列表（根据ConfigLevel区分）', - 'type' => 'array', - 'items' => [ - 'title' => 'ID值', - 'description' => 'ID值', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - 'required' => false, - ], + 'schema' => ['description' => '是否查询公网白名单配置。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true'], ], [ - 'name' => 'GmtCreate', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '1667309705000', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'GmtModified', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '1667309705000', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'zh：中文'."\n" - .'en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'Code。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => '500', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP STATUS编码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '接口信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '415088B3-A7BE-56F6-9CD9-C42DE895CD41'], 'Data' => [ - 'description' => 'id值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => '集群所处的VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1v5nbauzh8xxxxxxx'], + 'CreateTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2022-12-15 10:02:07'], + 'IntranetAddress' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'DiskType' => ['description' => '废弃字段。', 'type' => 'string', 'example' => 'null'], + 'PubNetworkFlow' => ['description' => '公网带宽，单位：Mbps。 '."\n" + .'取值范围：0~5000，其中0表示不接入公网。', 'type' => 'string', 'example' => '1'], + 'DiskCapacity' => ['description' => '废弃字段。', 'type' => 'integer', 'format' => 'int64', 'example' => 'null'], + 'MemoryCapacity' => ['description' => '废弃字段。', 'type' => 'integer', 'format' => 'int64', 'example' => 'null'], + 'ClusterAliasName' => ['description' => '集群别名。', 'type' => 'string', 'example' => 'Development environment'], + 'InstanceCount' => ['description' => '集群实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'IntranetPort' => ['description' => '集群内网开放的端口。', 'type' => 'string', 'example' => '8848,6443,9848,8761'], + 'InstanceModels' => [ + 'description' => '预留结构。', + 'type' => 'array', + 'items' => [ + 'description' => '预留结构。', + 'type' => 'object', + 'properties' => [ + 'PodName' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'SingleTunnelVip' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'InternetIp' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'Ip' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'Role' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'HealthStatus' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'CreationTimestamp' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'Zone' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + ], + ], + ], + 'IntranetDomain' => ['description' => '内网域名。', 'type' => 'string', 'example' => 'mse-xxxxx-nacos-ans.mse.aliyuncs.com'], + 'InternetDomain' => ['description' => '公网域名。', 'type' => 'string', 'example' => 'mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com'], + 'PayInfo' => ['description' => '付费方式。', 'type' => 'string', 'example' => 'Pay-as-you-go'], + 'InternetAddress' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'mse-cn-st21ri2****'], + 'AclEntryList' => ['description' => '公网白名单。', 'type' => 'string', 'example' => '["127.0.0.0/32"]'], + 'HealthStatus' => ['description' => '集群状态。', 'type' => 'string', 'example' => 'INIT_SUCCESS'], + 'InitCostTime' => ['description' => '集群初始化所用的时间（毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '53353'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'AclId' => ['description' => '公网白名单实例ID', 'type' => 'string', 'example' => 'acl-bp144q24cgqvzckmxxxx'], + 'Cpu' => ['description' => '废弃字段。', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'], + 'ClusterType' => ['description' => '集群类型，包括ZooKeeper、Nacos-Ans和Eureka。', 'type' => 'string', 'example' => 'Nacos-Ans'], + 'ClusterName' => ['description' => '集群完整名称。', 'type' => 'string', 'example' => 'mse-74355150-xxxxxxx'], + 'InitStatus' => ['description' => '初始化状态。', 'type' => 'string', 'example' => 'INIT_SUCCESS'], + 'InternetPort' => ['description' => '公网集群开放端口。', 'type' => 'string', 'example' => '8848,6443,9848,8761'], + 'AppVersion' => ['description' => '集群版本号。', 'type' => 'string', 'example' => '2.1.0'], + 'NetType' => ['description' => '集群网络连接类型。', 'type' => 'string', 'example' => 'privatenet'], + 'ClusterVersion' => ['description' => '订单版本。', 'type' => 'string', 'example' => 'NACOS_2_0_0'], + 'ClusterSpecification' => ['description' => '引擎规格。', 'type' => 'string', 'example' => 'MSE_SC_2_4_60_c'], + 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bp1egfakxxxxx'], + 'ConnectionType' => ['description' => '废弃字段。', 'type' => 'string', 'example' => 'null'], + 'MseVersion' => ['description' => '集群版本。', 'type' => 'string', 'example' => 'mse_pro'], + 'ChargeType' => ['title' => '', 'description' => '付费模式，包括包年包月和按量付费。', 'type' => 'string', 'example' => 'POSTPAY'], + 'Tags' => ['description' => '标签。', 'type' => 'object'], + 'ExpectZones' => [ + 'description' => '当前集群可打散到的可用区列表。', + 'type' => 'array', + 'items' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-k'], + ], + 'MaintenancePeriod' => [ + 'description' => '运维时间窗口', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => '运维时间窗口开始时间', 'type' => 'string', 'example' => '02:00'], + 'StartTime' => ['description' => '运维时间窗口结束时间', 'type' => 'string', 'example' => '06:00'], + ], + ], + 'EndDate' => ['title' => '到期时间（包年包月）', 'description' => '到期时间（包年包月）', 'type' => 'string', 'example' => '2021-08-01 00:00:00'], + 'SecurityGroupId' => ['title' => 'ENI网络接入的安全组ID', 'description' => 'ENI网络接入的安全组ID', 'type' => 'string', 'example' => 'sg-uf6hgwe067prhg68agfa'], + 'SecurityGroupType' => [ + 'title' => 'ENI网络接入的安全组类型', + 'description' => 'ENI网络接入的安全组类型', + 'type' => 'string', + 'example' => 'enterprise', + 'enum' => ['enterprise', 'normal'], + ], + 'EipInstanceId' => ['title' => '弹性公网IP（EIP）的实例ID', 'description' => '弹性公网IP（EIP）的实例ID', 'type' => 'string', 'example' => 'eip-bp1uujshd5funmyy8rcl9'], + 'CanUpdate' => ['description' => '集群是否有小版本可以升级', 'type' => 'boolean', 'example' => 'true'], + 'VersionCode' => ['description' => '集群当前版本Code', 'type' => 'string', 'example' => 'NACOS_2_1_0_1'], + 'VersionLifecycle' => ['description' => '版本生命周期。', 'type' => 'string'], + ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '查询集群静态信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '更新插件配置', ], - 'DeletePluginConfig' => [ - 'summary' => '删除插件配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryClusterSpecification' => [ + 'summary' => '查询支持的集群规格列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '217729', - 'abilityTreeNodes' => [ - 'FEATUREmseKZMVG1', - ], - ], + 'operationType' => 'read', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'ConnectType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'title' => '网关唯一ID', - 'description' => '网关唯一ID', + 'title' => '网络连接类型', + 'description' => '网络类型，取值如下：'."\n" + ."\n" + .'- slb'."\n" + .'- eni', 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + 'required' => false, + 'example' => 'slb', + 'pattern' => '', + 'enum' => ['eni', 'slb'], ], ], [ - 'name' => 'PluginConfigId', + 'name' => 'MseVersion', 'in' => 'query', 'schema' => [ - 'title' => '插件配置ID', - 'description' => '插件配置ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '200', + 'description' => '待开通的MSE集群版本。'."\n" + ."\n" + .'- mse_pro：表示专业版。'."\n" + .'- mse_dev：表示开发版。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'mse_pro', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ClusterSpecificationName' => ['description' => '可使用的引擎规格。', 'type' => 'string', 'example' => 'MSE_SC_1_2_200_c'], + 'MemoryCapacity' => ['description' => '此规格下的内存大小，单位：G。', 'type' => 'string', 'example' => '2'], + 'CpuCapacity' => ['description' => '此规格下的CPU核数。', 'type' => 'string', 'example' => '1'], + ], + ], ], ], ], @@ -36632,408 +25535,334 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"\\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' => '查询集群规格', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:QueryClusterSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\"\\n}","type":"json"}]', - 'title' => '删除插件配置', ], - 'AddSSLCert' => [ - 'summary' => '网关域名关联证书，证书可托管在云盾服务。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryConfig' => [ + 'summary' => '查询集群配置信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '35701', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17081', + 'abilityTreeNodes' => ['FEATUREmseY3D6DK'], ], 'parameters' => [ [ - 'name' => 'DomainId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'CertIdentifier', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '证书ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '5213641-cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ConfigType', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], + 'schema' => ['description' => '预留字段。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'null'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse_prepaid_public_cn-st2212****'], + ], + [ + 'name' => 'NeedRunningConf', + 'in' => 'query', + 'schema' => ['description' => '是否需要运行时配置。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E1CC74F0-5BDE-5220-A031-5CA622D80723', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => ' '."\n" - .'返回结果码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112EC53'], 'Data' => [ - 'description' => '返回数据结构，关联是否成功。', - 'type' => 'boolean', - 'example' => 'true', + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'MaxClientCnxns' => ['description' => 'zookeeper配置，单个客户端与单台服务器之间的连接数。 '."\n" + .'如果设置为0，表示不作任何限制。', 'type' => 'string', 'example' => '0'], + 'ConfigAuthSupported' => ['description' => 'nacos配置，当前集群的配置中心是否支持RAM鉴权，取值如下：'."\n" + .'- `true`：支持'."\n" + .'- `false`：不支持', 'type' => 'boolean', 'example' => 'true'], + 'InitLimit' => ['description' => 'zookeeper配置，实例最长连接时间，单位：秒。', 'type' => 'string', 'example' => '100'], + 'MCPEnabled' => ['description' => 'nacos配置，MCP是否生效，取值如下：'."\n" + .'- `true`：生效'."\n" + .'- `false`：不生效', 'type' => 'boolean', 'example' => 'true'], + 'OpenSuperAcl' => ['description' => 'zookeeper配置，超级权限开关，取值如下：'."\n" + .'- `true`：打开'."\n" + .'- `false`：关闭', 'type' => 'boolean', 'example' => 'true'], + 'RestartFlag' => ['description' => '当前集群是否已重启并应用新配置，取值如下：'."\n" + .'- `true`：重启成功。'."\n" + .'- `false`：重启失败。', 'type' => 'boolean', 'example' => 'true'], + 'JvmFlagsCustom' => ['description' => '保留字段', 'type' => 'string', 'example' => 'none'], + 'AutopurgePurgeInterval' => ['description' => '保留字段。', 'type' => 'string', 'example' => 'none'], + 'AutopurgeSnapRetainCount' => ['description' => '保留字段。', 'type' => 'string', 'example' => 'none'], + 'SyncLimit' => ['description' => 'zookeeper配置，实例连接超时时间，单位：秒。', 'type' => 'string', 'example' => '10'], + 'ConfigAuthEnabled' => ['description' => 'nacos配置，是否开启配置中心ram鉴权，取值如下：'."\n" + .'- `true`：生效'."\n" + .'- `false`：未生效', 'type' => 'boolean', 'example' => 'true'], + 'ClusterName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'name'], + 'MCPSupported' => ['description' => 'nacos配置，MCP是否支持，取值如下：'."\n" + .'- `true`：支持'."\n" + .'- `false`：不支持', 'type' => 'boolean', 'example' => 'true'], + 'JuteMaxbuffer' => ['description' => 'zookeeper配置，每个节点最大数据量，单位：字节。', 'type' => 'string', 'example' => '1'], + 'TickTime' => ['description' => 'zookeeper配置，引擎中的一个时间单元，默认为2000毫秒。', 'type' => 'string', 'example' => '2000'], + 'PassWord' => ['description' => '用户密码。当OpenSuperAcl为true时，展示此值。', 'type' => 'string', 'example' => 'password'], + 'UserName' => ['description' => '用户名称。当OpenSuperAcl为true时，展示此值。', 'type' => 'string', 'example' => 'name'], + 'ConfigSecretSupported' => ['description' => 'nacos配置，当前集群是否支持配置中心配置加密，取值如下：'."\n" + .'- `true`：支持'."\n" + .'- `false`：不支持', 'type' => 'boolean', 'example' => 'true'], + 'ConfigSecretEnabled' => ['description' => 'nacos配置，当前集群是否开启配置中心配置加密，取值如下：'."\n" + .'- `true`：开启'."\n" + .'- `false`：未开启', 'type' => 'boolean', 'example' => 'true'], + 'NamingAuthEnabled' => ['description' => 'nacos配置，是否开启注册中心ram鉴权：'."\n" + .'- `true`：开启'."\n" + .'- `false`：关闭', 'type' => 'boolean', 'example' => 'false'], + 'NamingAuthSupported' => ['description' => 'nacos配置，当前集群是否支持服务RAM鉴权，取值如下：'."\n" + .'- `true`：支持'."\n" + .'- `false`：不支持', 'type' => 'boolean', 'example' => 'true'], + 'NamingCreateServiceSupported' => ['description' => 'nacos配置，当前集群是否支持创建服务，取值如下：'."\n" + .'- `true`：支持'."\n" + .'- `false`：不支持', 'type' => 'boolean', 'example' => 'true'], + 'MinSessionTimeout' => ['title' => '最小超时时间', 'description' => 'zookeeper配置，最小超时时间。', 'type' => 'string', 'example' => '-1'], + 'MaxSessionTimeout' => ['title' => '最大超时时间', 'description' => 'zookeeper配置，最大超时时间。', 'type' => 'string', 'example' => '-1'], + 'SnapshotCount' => ['description' => 'zookeeper配置，生成快照的频率', 'type' => 'string', 'example' => '100000'], + 'ConfigContentLimit' => ['description' => '单个配置的配置内容大小上限（单位：KB）。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'NacosRunningEnv' => [ + 'description' => 'nacos运行时配置。', + 'type' => 'object', + 'properties' => [ + 'emptyProtect' => ['description' => '推空保护开关。', 'type' => 'boolean', 'example' => 'true'], + 'grayAuth' => ['type' => 'string', 'description' => ''], + ], + ], + 'ExtendedTypesEnable' => ['description' => 'zookeeper参数，是否开启TTL配置。', 'type' => 'boolean', 'example' => 'true'], + 'EurekaSupported' => ['description' => '是否打开Eureka协议的访问端口8761。关闭此端口，应用将无法使用Eureka协议进行服务注册发现。', 'type' => 'boolean', 'example' => 'true'], + 'TLSEnabled' => ['description' => 'MSE Nacos从2.1.2.1版本开始支持TLS传输链路加密，nacos-client需升级至2.2.1及以上版本，开启TLS后，会有10%左右性能下降，请合理评估系统容量水位，操作指引详见Nacos TLS传输加密.', 'type' => 'boolean', 'example' => 'true'], + 'ConsoleUIEnabled' => ['description' => '是否开始Nacos开源控制台', 'type' => 'boolean', 'example' => 'true'], + 'Enable4lw' => ['description' => '是否开启四字命令', 'type' => 'boolean', 'example' => 'true'], + 'AuthEnabled' => ['title' => 'ZooKeeper sasl 强制身份认证开关', 'description' => 'ZooKeeper sasl 强制身份认证开关', 'type' => 'boolean', 'example' => 'true'], + ], ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => ' '."\n" + .'返回结果码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'responseDemo' => '[{"type":"json","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}","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' => '查询集群配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '添加网关域名关联证书', ], - 'AddGatewayDomain' => [ - 'summary' => '添加网关关联域名。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryGatewayRegion' => [ + 'summary' => '查询网关支持的地域。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '35639', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'MustHttps', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启HTTPS。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'CertIdentifier', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '证书ID。', - 'type' => 'string', - 'required' => false, - 'example' => '6828169-cn-hangzhou', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Name', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '域名名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test.com', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '返回数据信息。', + 'type' => 'array', + 'items' => ['description' => '返回地域信息集合。', 'type' => 'string', 'example' => '{"cn-hanghzou"}'], + ], + ], ], ], - [ - 'name' => 'Protocol', - 'in' => 'query', - 'schema' => [ - 'description' => '协议类型：'."\n" - .'- `HTTP`'."\n" - .'- `HTTPS`', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HTTP', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], ], [ - 'name' => 'Http2', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启`Http2`：'."\n" - .'- `open`：开启`Http2`。'."\n" - .'- `close`：关闭`Http2`。'."\n" - .'- `globalConfig`：使用全局配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'close', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], - [ - 'name' => 'TlsMax', - 'in' => 'query', - 'schema' => [ - 'description' => 'Tls最大版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'TLS 1.3', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关支持地域', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'TlsMin', - 'in' => 'query', - 'schema' => [ - 'description' => 'Tls最小版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'TLS 1.0', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGatewayRegion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryGatewayType' => [ + 'summary' => '查询网关可用类型。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'TlsCipherSuitesConfigJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'TLS加密套件配置', - 'description' => 'TLS加密套件配置', - 'type' => 'object', - 'properties' => [ - 'ConfigType' => [ - 'title' => '加密套件配置类型', - 'description' => '加密套件配置类型', - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'DEFAULT', - 'CUSTOM', - ], - ], - 'TlsCipherSuites' => [ - 'title' => '加密套件名称列表', - 'description' => '加密套件名称列表', - 'type' => 'array', - 'items' => [ - 'title' => '加密套件名称', - 'description' => '加密套件名称', - 'type' => 'string', - 'required' => false, - 'example' => 'AES256-SHA', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '16BA802F-B848-55DF-9F57-CD71B7272D1F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '状态码。状态码为200表示成功，其余取值表示失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '返回数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'description' => '网关类型，参数数据类型为list。', + 'type' => 'array', + 'items' => ['description' => '网关类型。', 'type' => 'string', 'example' => 'Ingress'], ], ], ], @@ -37041,350 +25870,249 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '查询网关可用类型', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGatewayType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '添加网关关联域名', ], - 'DeleteGatewayDomain' => [ - 'summary' => '删除网关关联域名。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryGovernanceKubernetesCluster' => [ + 'summary' => '获取微服务治理K8s集群信息列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '35642', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '116299', + 'abilityTreeNodes' => ['FEATUREmse3O985H'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'description' => '域名ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '109', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => 'Kubernetes集群名', 'description' => 'Kubernetes集群名。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example-cluster'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-90392d768a3847a7b804c505254d****', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => 'Kubernetes集群Id', 'description' => 'Kubernetes集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'c24c9354acxxxxxxx'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '当前页码', 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页元素数量', 'description' => '每页元素数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '5', 'example' => '10'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '39016EAC-6EDB-52FE-AE20-4B013DF236FF', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => '返回信息。'."\n" + ."\n", 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE34D413-2B79-5E77-9696-36D875E822AD'], 'Data' => [ - 'description' => '返回数据。', + 'description' => '响应数据。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'CONTACTINFO', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '253', - ], - 'Protocol' => [ - 'description' => '协议。', - 'type' => 'string', - 'example' => 'HTTP', - ], - 'MustHttps' => [ - 'description' => '是否允许HTTP探测。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CertIdentifier' => [ - 'description' => '证书ID。', - 'type' => 'string', - 'example' => '243', - ], - 'GmtCreate' => [ - 'description' => '域名创建时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', + 'Result' => [ + 'description' => '数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => ['title' => 'Kubernetes集群名', 'description' => '集群名字。', 'type' => 'string', 'example' => 'example-cluster'], + 'ClusterId' => ['title' => 'Kubernetes集群Id', 'description' => '集群ID。', 'type' => 'string', 'example' => 'abcdef123456789'], + 'Region' => ['title' => 'Kubernetes集群所在的地域', 'description' => '集群所在地域。', 'type' => 'string', 'example' => 'cn-shanghai'], + 'K8sVersion' => ['title' => 'Kubernetes集群版本', 'description' => '集群版本。', 'type' => 'string', 'example' => '1.22'], + 'NamespaceInfos' => ['title' => 'Kubernetes集群命名空间信息（json格式）', 'description' => '命名空间信息。', 'type' => 'string', 'example' => '[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]'], + 'PilotStartTime' => ['title' => 'pilot启动时间', 'description' => 'Pilot启动时间。', 'type' => 'string', 'example' => '2022-05-17T05:39:43.000+0000'], + 'VersionLifeCycle' => ['description' => '版本生命周期。', 'type' => 'string'], + 'PilotVersion' => ['description' => 'Pilot版本。', 'type' => 'string'], + ], + ], ], + 'TotalSize' => ['title' => '页码总数', 'description' => '集群总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '页大小', 'description' => '当前页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], + 'Success' => ['title' => '是否成功', 'description' => '是否成功。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '获取微服务治理K8s集群信息列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除网关关联域名', ], - 'UpdateSSLCert' => [ - 'summary' => '更换证书。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryInstancesInfo' => [ + 'summary' => '查询指定集群的运行时数据。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '35702', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '129092', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'DomainId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '域名ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '210', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'CertIdentifier', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '证书ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5951436-cn-hangzhou', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-tl32g1u9k01'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-2a99625886d54722be94d92e9a69****', - ], + 'schema' => ['description' => '订单ID。', 'type' => 'string', 'required' => false, 'example' => '20574710974****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '实例所属地域的ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体结构。', + 'title' => 'BaseResult', + 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CA689BED-08F3-54C2-A206-A0924E2ACA0A', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '202'], 'Data' => [ - 'description' => '是否更新成功。', - 'type' => 'boolean', - 'example' => 'true', + 'description' => '数据概览。', + 'type' => 'array', + 'items' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'HealthStatus' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'Role' => ['description' => '预留字段。', 'type' => 'string', 'example' => 'null'], + 'PodName' => ['description' => 'POD名称。', 'type' => 'string', 'example' => 'mse-xxxxx-xxxxx-reg-center-0-1'], + 'Ip' => ['description' => 'POD的IP。', 'type' => 'string', 'example' => '25.24.91.x'], + 'InternetIp' => ['description' => '公网IP。', 'type' => 'string', 'example' => '120.55.71.x'], + 'SingleTunnelVip' => ['description' => '内网IP。', 'type' => 'string', 'example' => '172.16.66.x'], + 'CreationTimestamp' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-12-15T02:02:15Z'], + 'ClientPort' => ['description' => '启用的端口。', 'type' => 'string', 'example' => '8848'], + 'Zone' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-k'], + 'ZoneDistributed' => ['description' => '所有Pod是否已满足多可用区分布。', 'type' => 'boolean', 'example' => 'true'], + ], + ], ], ], ], @@ -37392,295 +26120,190 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '查询集群静态信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryInstancesInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '更换证书', ], - 'UpdateGatewayDomain' => [ - 'summary' => '修改关联域名信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryMonitor' => [ + 'summary' => '查询监控信息。此接口只支持查询基础版实例的监控信息，专业版，开发版，serverless 版本监控数据已经投递到用户自己的云产品多租prometheus实例中，可以直接通过prometheus接口进行访问。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '35640', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17082', + 'abilityTreeNodes' => ['FEATUREmseZAXYAZ'], ], 'parameters' => [ [ - 'name' => 'Protocol', - 'in' => 'query', - 'schema' => [ - 'description' => '协议类型。'."\n" - ."\n" - .'- HTTPS'."\n" - .'- HTTP', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTPS', - ], - ], - [ - 'name' => 'MustHttps', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '强制HTTPS', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'CertIdentifier', + 'name' => 'MonitorType', 'in' => 'query', - 'schema' => [ - 'description' => '证书ID。', - 'type' => 'string', - 'required' => false, - 'example' => '6209108-cn-hangzhou', - ], + 'schema' => ['description' => '监控类型如下：'."\n" + ."\n" + .'[基础系统指标]'."\n" + .'- cpu使用量 cpuUsage'."\n" + .'- 内存使用量 memoryUsage'."\n" + .'- 磁盘使用量 diskUsage'."\n" + .'- gc次数（每分钟） gcCount'."\n" + .'- gc时间（每分钟） gcTime'."\n" + ."\n" + .'[nacos 注册中心]'."\n" + .'- 服务数 serviceCount'."\n" + .'- 写接口的平均请求耗时 writeCostTime'."\n" + .'- 读接口的平均请求耗时 readCostTime'."\n" + .'- TPS regCenterTps'."\n" + .'- QPS regCenterQps'."\n" + ."\n" + .'[nacos 配置中心]'."\n" + .'- 配置数 publish'."\n" + .'- 配置监听者数 getConfig'."\n" + ."\n" + .'[zookeeper]'."\n" + .'- TPS zk_TpsCount'."\n" + .'- QPS zk_QpsCount'."\n" + .'- 平均RT zookeeper_AvgRequestLatency', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'regCenterQps'], ], [ - 'name' => 'Id', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '需要更新的域名id。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '94', - ], + 'schema' => ['description' => '监控开始时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1666678376'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', - ], + 'schema' => ['description' => '监控结束时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1666678376'], ], [ - 'name' => 'Http2', + 'name' => 'Step', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启`Http2`。'."\n" - .'- `open`：开启`Http2`。'."\n" - .'- `close`：关闭`Http2`。'."\n" - .'- `globalConfig`：使用全局配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'close', - ], + 'schema' => ['description' => '数据点间隔，单位：s。 ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '7'], ], [ - 'name' => 'TlsMax', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Tls最大版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'TLS 1.3', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-****'], ], [ - 'name' => 'TlsMin', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'Tls最小版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'TLS 1.0', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'TlsCipherSuitesConfigJSON', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'TLS加密套件配置。', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'ConfigType' => [ - 'description' => '加密套件配置类型选择。'."\n" - ."\n" - .'- DEFAULT'."\n" - ."\n" - .'- CUSTOM', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], - 'TlsCipherSuites' => [ - 'description' => '加密套件名称列表。', + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****'], + 'Data' => [ + 'description' => '数据概览。', 'type' => 'array', 'items' => [ - 'description' => '加密套件名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ECDHE-RSA-AES128-GCM-SHA256', + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'podName' => ['description' => 'pod名称。', 'type' => 'string', 'example' => 'mse-xxxxxx-xxxxxx-reg-center-0-0'], + 'clusterNamePrefix' => ['description' => '名称前缀。', 'type' => 'string', 'example' => 'mse-xxxx-xxxxxx'], + 'values' => [ + 'description' => '数据概览。', + 'type' => 'array', + 'items' => ['description' => '数据内容。', 'type' => 'object'], + ], + ], ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', + 'example' => '6', ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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":"\\nADDD8AB7-8D1C-4697-A83E-410D2607****\\n请求处理成功\\n6\\nmse-100-000\\ntrue\\n","errorExample":""}]', + 'title' => '查询监控信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryMonitor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '更新关联域名信息', ], - 'ListSSLCert' => [ - 'summary' => '获取网关证书列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryNamespace' => [ + 'summary' => '查询MSE命名空间。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -37688,416 +26311,135 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], + 'schema' => ['title' => '操作的地域', 'description' => '操作的地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'CertName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '按证书名称模糊搜索', - 'description' => '按证书名称模糊搜索', - 'type' => 'string', - 'required' => false, - 'example' => 'certabc', - ], + 'schema' => ['title' => '要搜索的命名空间名字', 'description' => '要搜索的命名空间名称。', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CAA9A229-141D-5FBA-AC5C-516C02026A11', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '状态码，200表示返回成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['title' => '错误时的提示信息', 'description' => '错误时的提示信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'abcde-fg'], + 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => 'Success'], + 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '返回数据。', + 'title' => '返回的数据', + 'description' => '返回的数据。', 'type' => 'array', 'items' => [ - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'CertIdentifier' => [ - 'description' => '证书ID。', - 'type' => 'string', - 'example' => '1234', - ], - 'CertName' => [ - 'description' => '证书名称。', - 'type' => 'string', - 'example' => 'test.com', - ], - 'CommonName' => [ - 'description' => '绑定域名。', - 'type' => 'string', - 'example' => '*.test.com', - ], - 'Sans' => [ - 'description' => 'SSL证书。', - 'type' => 'string', - 'example' => 'SSL', - ], - 'BeforeDate' => [ - 'description' => '证书生效时间（Unix毫秒时间戳）。', - 'type' => 'string', - 'example' => '1694503184803', - ], - 'AfterDate' => [ - 'description' => '证书到期时间（Unix毫秒时间戳）。', - 'type' => 'string', - 'example' => '1726039184803', - ], - 'Algorithm' => [ - 'description' => '算法。', - 'type' => 'string', - 'example' => 'test', - ], - 'Issuer' => [ - 'description' => '颁发者。', - 'type' => 'string', - 'example' => 'test', - ], - 'GmtBefore' => [ - 'description' => '证书生效时间（GMT时间戳）。', - 'type' => 'string', - 'example' => '2023-09-12T07:19:44.803+0000', - ], - 'GmtAfter' => [ - 'description' => '证书到期时间（GMT时间戳）。', - 'type' => 'string', - 'example' => '2024-09-11T07:19:44.803+0000', - ], + 'Region' => ['title' => '命名空间所属的地域', 'description' => '命名空间所属的地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Namespace' => ['title' => '命名空间名字', 'description' => '命名空间名字。', 'type' => 'string', 'example' => 'default'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '查询MSE命名空间', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询网关证书列表', ], - 'ListGatewayDomain' => [ - 'summary' => '查询网关已关联域名列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QuerySlbSpec' => [ + 'summary' => '查询SLB类型。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '35641', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '域名类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'All', - ], - ], - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'title' => '按域名模糊搜索', - 'description' => '按域名模糊搜索', - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - ], - ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3F5D8E93-CA66-57F1-8BCF-A223E11B6B91', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '节点数据。', + 'description' => '返回数据。', 'type' => 'array', 'items' => [ - 'description' => '数据结构。', + 'description' => '返回集合信息。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '243', - ], - 'Name' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => 'test.com', - ], - 'Protocol' => [ - 'description' => '协议。', - 'type' => 'string', - 'example' => 'HTTP', - ], - 'MustHttps' => [ - 'description' => '是否强制HTTPS。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CertIdentifier' => [ - 'description' => '证书ID。', - 'type' => 'string', - 'example' => '3452-cn-hangzhou', - ], - 'CertBeforeDate' => [ - 'description' => '证书到期时间（已废弃，请进入域名详情页查看）。', - 'type' => 'string', - 'example' => ' 2031-03-30 02:35:12', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'GmtCreate' => [ - 'description' => '域名记录创建时间。', - 'type' => 'string', - 'example' => ' 2031-03-30 02:35:12', - ], - 'GmtModified' => [ - 'description' => '域名记录更新时间。', - 'type' => 'string', - 'example' => ' 2031-03-30 02:35:12', - ], - 'Status' => [ - 'description' => '域名状态。'."\n" - .'枚举值'."\n" - ."\n" - .'- 0未发布'."\n" - .'- 2发布中'."\n" - .'- 3已发布'."\n" - .'- 4编辑中'."\n" - .'- 5下线中'."\n" - .'- 6不可用', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Type' => [ - 'description' => '域名来源类型：'."\n" - .'- Op：控制台创建'."\n" - .'- Ingress：MSE Ingress创建', - 'type' => 'string', - 'example' => 'Op', - ], - 'Comment' => [ - 'description' => '路由备注（ingress）', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态', - 'type' => 'string', - 'example' => 'Error', - ], - ], - ], - 'Http2' => [ - 'description' => '是否开启`Http2`。'."\n" - .'- `open`：开启`Http2`。'."\n" - .'- `close`：关闭`Http2`。'."\n" - .'- `globalConfig`：使用全局配置。', - 'type' => 'string', - 'example' => 'close', - ], - 'TlsMax' => [ - 'description' => 'Tls最大版本。', - 'type' => 'string', - 'example' => 'TLS 1.3', - ], - 'TlsMin' => [ - 'description' => 'Tls最小版本.', - 'type' => 'string', - 'example' => 'TLS 1.0', - ], - 'IsManaged' => [ - 'title' => '是否为托管域名', - 'description' => '是否为托管域名', - 'type' => 'boolean', - ], - 'TlsCipherSuitesConfig' => [ - 'type' => 'object', - 'properties' => [ - 'ConfigType' => [ - 'type' => 'string', - ], - 'TlsCipherSuites' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], + 'Id' => ['description' => '返回数据ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'Spec' => ['description' => '规格。', 'type' => 'string', 'example' => 'slb.s2.small'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'Standard I'], + 'MaxConnection' => ['description' => '最大连接数。', 'type' => 'string', 'example' => '50,000'], + 'NewConnectionPerSecond' => ['description' => '每秒连接数。', 'type' => 'string', 'example' => '50,000'], + 'Qps' => ['description' => '每秒查询率。', 'type' => 'string', 'example' => '50,000'], ], ], ], @@ -38107,50 +26449,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '查询SLB类型', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:QuerySlbSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询网关已关联域名列表', ], - 'GetGatewayDomainDetail' => [ - 'summary' => '查询网关域名详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QuerySwimmingLaneById' => [ + 'summary' => '用于通过泳道ID查询泳道信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], @@ -38160,221 +26494,104 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '35699', - 'abilityTreeNodes' => [ - 'FEATUREmseM77BTJ', - ], + 'abilityTreeCode' => '116123', + 'abilityTreeNodes' => ['FEATUREmseCR8P7I'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'LaneId', 'in' => 'query', - 'schema' => [ - 'description' => '域名ID。', - 'type' => 'string', - 'required' => false, - 'example' => '29', - ], + 'schema' => ['description' => '泳道ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '250'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-6d0b23e1d39e41658a968d79a635****', - ], + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '88B83302-CD88-54D3-8DF2-208BFDC73F0D', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Message' => ['title' => '请求信息。', 'description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], 'Data' => [ - 'description' => '数据。', + 'description' => '数据概览。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'test.com', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Protocol' => [ - 'description' => '网关协议。', - 'type' => 'string', - 'example' => 'HTTP', - ], - 'MustHttps' => [ - 'description' => '强制HTTPS', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CertIdentifier' => [ - 'description' => '证书标识。', - 'type' => 'string', - 'example' => '234-cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'CertName' => [ - 'description' => '证书名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'CommonName' => [ - 'description' => '公网域名。', - 'type' => 'string', - 'example' => 'name', - ], - 'Sans' => [ - 'description' => '扩展字段名称。', - 'type' => 'string', - 'example' => 'test.com', - ], - 'BeforeDate' => [ - 'description' => '证书签发时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-04-01 02:35:12', - ], - 'AfterDate' => [ - 'description' => '证书过期时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-04-01 02:35:12', - ], - 'Algorithm' => [ - 'description' => '算法。', - 'type' => 'string', - 'example' => 'RSA', - ], - 'Issuer' => [ - 'description' => '签发者。', - 'type' => 'string', - 'example' => 'Istio', - ], - 'GmtBefore' => [ - 'description' => '证书签发时间（GMT）。', - 'type' => 'string', - 'example' => '2021-04-01 02:35:12', - ], - 'GmtAfter' => [ - 'description' => '证书到期时间（GMT）。', - 'type' => 'string', - 'example' => '2021-04-01 02:35:12', - ], - 'Http2' => [ - 'description' => '是否开启`Http2`。'."\n" - .'- `open`：开启`Http2`。'."\n" - .'- `close`：关闭`Http2`。'."\n" - .'- `globalConfig`：使用全局配置。', - 'type' => 'string', - 'example' => 'close', - ], - 'TlsMax' => [ - 'description' => 'Tls最大版本。', - 'type' => 'string', - 'example' => 'TLS 1.3', - ], - 'TlsMin' => [ - 'description' => 'Tls最小版本。', - 'type' => 'string', - 'example' => 'TLS 1.0', - ], - 'IsManaged' => [ - 'title' => '是否为托管域名', - 'description' => '是否为托管域名', - 'type' => 'boolean', - ], - 'TlsCipherSuitesConfig' => [ - 'type' => 'object', - 'properties' => [ - 'ConfigType' => [ - 'type' => 'string', - ], - 'TlsCipherSuites' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', + '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' => '已废弃。Java网关为泳道组入口时使用该参数指定是否开启按照Path进行比例灰度。', 'type' => 'boolean', 'example' => 'false'], ], + 'example' => '{id:102,name:"test"}', ], ], ], @@ -38382,981 +26599,587 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '通过泳道ID查询泳道信息', + '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\\": \\"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' => '查询网关域名详情', ], - 'AddGateway' => [ - 'summary' => '添加网关。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'QueryZnodeDetail' => [ + 'summary' => '查询ZooKeeper数据节点信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '24670', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '17085', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '网关名称', - 'description' => '网关名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-ceshi', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'Region', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'Vpc', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'title' => '专有网络ID', - 'description' => '专有网络ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp15mncnrtm83uauxd1xb', - ], + 'schema' => ['description' => '节点路径。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/zookeeper'], ], [ - 'name' => 'ZoneInfo', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-5bffa4e8630'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '可用区信息。', - 'type' => 'array', - 'items' => [ - 'description' => '可用区信息。', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen-e', - ], - 'VSwitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp*****', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '节点数据。', 'type' => 'string', 'example' => 'cluster'], + 'Path' => ['description' => '节点路径。', 'type' => 'string', 'example' => '/zookeeper'], + 'Dir' => ['description' => '节点列表信息，取值如下：'."\n" + .'- `true`：信息返回成功。'."\n" + .'- `false`：信息返回失败。', 'type' => 'boolean', 'example' => 'true'], + 'Name' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'zookeeper'], ], ], - 'required' => false, + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'string', 'example' => 'true'], ], - 'required' => true, - 'docRequired' => true, ], ], - [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'title' => '主交换机ID', - 'description' => '主交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1q8th57frl5khj2li43', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper 操作超时，可能由于当前操作的Znode数据过大，子节点过多，Server处理请求时间消耗过长，或者集群当前正在选主，无法处理请求。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => '当前操作的节点不存在，可能已经被删除。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', 'errorMessage' => 'No permission to operate current Znode.', 'description' => '无权限操作当前节点。'], + ['errorCode' => 'ZooKeeper.IllegalRequest', 'errorMessage' => 'ZooKeeper operation is illegal.', 'description' => '当前ZooKeeper操作非法，请重新检查后进行操作'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', 'errorMessage' => 'The current instance already has this Znode.', 'description' => '当前节点已经存在，请检查后重新操作。'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], ], - [ - 'name' => 'VSwitchId2', - 'in' => 'query', - 'schema' => [ - 'title' => '备交换机ID', - 'description' => '备交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-wz9bu6o5vsvitt5mrxo6s', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], ], [ - 'name' => 'ChargeType', - 'in' => 'query', - 'schema' => [ - 'description' => '付费类型（购买传统实例时指定）。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PREPAY' => '包年包月', - 'POSTPAY' => '按量付费', - ], - 'example' => 'POSTPAY', - 'enum' => [ - 'PREPAY', - 'POSTPAY', - ], - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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":"\\n请求处理成功\\n58E06A0A-BD2C-47A0-99C2-B100F353****\\n\\n /zookeeper\\n cluster\\n true\\n zookeeper\\n\\nmse-100-000\\ntrue\\n","errorExample":""}]', + 'title' => '查询ZooKeeper数据节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'MserVersion', - 'in' => 'query', - 'schema' => [ - 'title' => '网关产品类型：'."\n" - .'- mse_pro：传统实例'."\n" - .'- mse_serverless：Serverless', - 'description' => '网关产品类型：'."\n" - .'- mse_pro：传统实例'."\n" - .'- mse_serverless：Serverless', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_pro', - 'default' => 'mse_pro', - 'enum' => [ - 'mse_premium', - 'mse_pro', - 'mse_serverless', - ], - ], - ], - [ - 'name' => 'Spec', - 'in' => 'query', - 'schema' => [ - 'title' => '节点规格', - 'description' => '节点规格（购买传统实例时指定）。'."\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)', - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryZnodeDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], + ], + ], + 'RemoveApplication' => [ + 'summary' => '删除单个应用。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ [ - 'name' => 'Replica', - 'in' => 'query', - 'schema' => [ - 'title' => '节点数量', - 'description' => '节点数量（购买传统实例时指定）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17086', + 'abilityTreeNodes' => ['FEATUREmseHJJ9Z1'], + ], + 'parameters' => [ [ - 'name' => 'ManagedEntryNetworkType', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '网关入口类型（普通实例专业版适用）', - 'description' => '网关入口类型（普通实例专业版适用）'."\n" - ."\n" - .'- pubnet：公网'."\n" - .'- privatenet：私网'."\n" - .'- privatepubnet：公网+私网', - 'type' => 'string', - 'required' => false, - 'example' => 'pubnet', - 'enum' => [ - 'pubnet', - 'privatenet', - 'privatepubnet', - ], - ], + 'schema' => ['title' => '地域。', 'description' => '地域。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'NlbNetworkType', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '代购NLB的网络类型：'."\n" - .'- pubnet：公网'."\n" - .'- privatenet：私网'."\n" - .'- privatepubnet：公网+私网', - 'description' => '代购的NLB网络类型：'."\n" - .'- pubnet：公网'."\n" - .'- privatenet：私网'."\n" - .'- privatepubnet：公网+私网'."\n" - ."\n" - .'> 传统实例：创建时只能在NLB、按LCU计费的CLB、按规格的CLB中选择一种代购'."\n" - ."\n" - .'> Serverless实例：创建时只能在NLB、按LCU计费的CLB中选择一种代购', - 'type' => 'string', - 'required' => false, - 'example' => 'pubnet', - 'enum' => [ - 'pubnet', - 'privatenet', - 'privatepubnet', - ], - ], + 'schema' => ['title' => '微服务命名空间。', 'description' => '微服务命名空间。', 'type' => 'string', 'required' => false, 'example' => 'prod', 'maxLength' => 64], ], [ - 'name' => 'ClbNetworkType', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '代购按LCU计费的CLB的网络类型：'."\n" - .'- pubnet：公网'."\n" - .'- privatenet：私网'."\n" - .'- privatepubnet：公网+私网', - 'description' => '代购按LCU计费的CLB的网络类型：'."\n" - .'- pubnet：公网'."\n" - .'- privatenet：私网'."\n" - .'- privatepubnet：公网+私网'."\n" - ."\n" - .'> 传统实例：创建时只能在NLB、按LCU计费的CLB、按规格的CLB中选择一种代购'."\n" - ."\n" - .'> Serverless实例：创建时只能在NLB、按LCU计费的CLB中选择一种代购', - 'type' => 'string', - 'required' => false, - 'example' => 'pubnet', - 'enum' => [ - 'pubnet', - 'privatenet', - 'privatepubnet', - ], - ], + 'schema' => ['title' => '要删除的应用名字。', 'description' => '要删除的应用名字。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example-app'], ], [ - 'name' => 'SlbSpec', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '内网SLB规格', - 'description' => '私网SLB规格（适用于传统实例）。'."\n" - ."\n" - .'- 简约型 (slb.s1.small)'."\n" - .'- 标准型1 (slb.s2.small)'."\n" - .'- 标准型I(slb.s2.medium)'."\n" - .'- 高阶型1 (slb.s3.small)'."\n" - .'- 高阶型I(slb.s3.medium)'."\n" - .'- 超强型I (slb.s3.large)'."\n" - ."\n" - .'> 传统实例：创建时只能在NLB、按LCU计费的CLB、按规格的CLB中选择一种代购'."\n" - ."\n" - .'> Serverless实例：创建时只能在NLB、按LCU计费的CLB中选择一种代购', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'slb.s2.small', - ], + 'schema' => ['title' => '要删除的应用id。', 'description' => '要删除的应用id。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'abcde@12345'], ], [ - 'name' => 'InternetSlbSpec', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '外网SLB规格', - 'description' => '公网SLB规格（适用于传统实例）。'."\n" - ."\n" - .'- 简约型 (slb.s1.small)'."\n" - .'- 标准型1 (slb.s2.smal)'."\n" - .'- 标准型I(slb.s2.medium)'."\n" - .'- 高阶型1 (slb.s3.small)'."\n" - .'- 高阶型I(slb.s3.medium)'."\n" - .'- 超强型I (slb.s3.large)'."\n" - ."\n" - .'> 传统实例：创建时只能在NLB、按LCU计费的CLB、按规格的CLB中选择一种代购'."\n" - ."\n" - .'> Serverless实例：创建时只能在NLB、按LCU计费的CLB中选择一种代购', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'slb.s2.small', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'EnterpriseSecurityGroup', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '是否企业安全组类型', - 'description' => '是否企业安全组类型。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求id。', 'description' => '请求id。', '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'], + ], ], ], - [ - 'name' => 'EnableHardwareAcceleration', - 'in' => 'query', - 'schema' => [ - 'title' => '是否开启硬件加速', - 'description' => '是否开启硬件加速。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], ], - [ - 'name' => 'EnableXtrace', - 'in' => 'query', - 'schema' => [ - 'title' => '是否开启xtrace', - 'description' => '是否启用链路追踪。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], ], [ - 'name' => 'XtraceRatio', - 'in' => 'query', - 'schema' => [ - 'title' => 'xtrace采样率，取值[0,100]', - 'description' => '链路追踪采样率，取值[1,100]。', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], - [ - 'name' => 'EnableSls', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否开启SLS日志投递', - 'description' => '是否启用SLS日志投递。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除应用', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => '网关标签。', - 'type' => 'array', - 'items' => [ - 'description' => '标签对象。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签Key。', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签Value。', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:RemoveApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 21, ], ], + ], + ], + 'RemoveAuthPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm34x43l*****', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17087', + 'abilityTreeNodes' => ['FEATUREmseDB5C9P'], + ], + 'parameters' => [ [ - 'name' => 'RequestPars', + 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => '扩展字段。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '259'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。'."\n", - 'type' => 'string', - 'example' => 'gw-5017305290e14cebbrvec4a5****', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9515ACA4-E94D-440D-989E-C379FCED****'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Data' => ['description' => '数据概览。', 'type' => 'string', 'example' => 'true'], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除服务鉴权规则', + 'summary' => '通过RemoveAuthPolicy接口删除服务鉴权规则。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:RemoveAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '添加网关', ], - 'ListGatewayZone' => [ - 'summary' => '获取网关可用区列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'RemoveZooKeeperSaslUser' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '174557', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], + 'abilityTreeCode' => '217283', + 'abilityTreeNodes' => ['FEATUREmse2TF2YB'], ], 'parameters' => [ [ - 'name' => 'AcceptLanguage', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例id', 'description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'mse_prepaid_public_cn-****'], + ], + [ + 'name' => 'UserNames', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'title' => '需要移除的用户名列表', + 'description' => '需要移除的用户名列表', + 'type' => 'array', + 'items' => ['description' => '用户名', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'required' => true, ], ], + [ + 'name' => 'Reload', + 'in' => 'query', + 'schema' => ['description' => '是否立刻生效', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '用于和Success同步，当Success为true时，Code为200', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'NO_PERMISSION', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'DynamicCode' => [ - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%s。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '可用区列表。', - 'type' => 'array', - 'items' => [ - 'description' => '可用区数据结构', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'LocalName' => [ - 'description' => '可用区本地名称。', - 'type' => 'string', - 'example' => 'I', - ], - 'SupportQat' => [ - 'type' => 'boolean', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '56D9E600-6348-4260-B35F-583413F****'], + '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', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除 zookeeper Sask 用户', + 'summary' => '删除ZooKeeper sasl用户', + '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' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '获取网关可用区列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"56D9E600-6348-4260-B35F-583413F****\\",\\n \\"Data\\": true\\n}","type":"json"}]', ], - 'AddGatewaySlb' => [ - 'summary' => '关联SLB。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'RestartCluster' => [ + 'summary' => '重启注册配置中心集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '71795', - 'abilityTreeNodes' => [ - 'FEATUREmseMNDRFM', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '17093', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], ], 'parameters' => [ [ - 'name' => 'SlbId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'SLB ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'lb-bp18t6jjskwxh6wy1****', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'Type', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '类型。'."\n" - ."\n" - .'- PUB_NET: 公网。'."\n" - ."\n" - .'- PRIVATE_NET: 私网。', - 'type' => 'string', - 'required' => false, - 'example' => 'PUB_NET', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-78v1l83****'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'VServerGroupId', + 'name' => 'PodNameList', 'in' => 'query', - 'schema' => [ - 'description' => 'http虚拟服务组ID。', - 'type' => 'string', - 'required' => false, - 'example' => '353', - ], + 'schema' => ['description' => 'PodName，支持多个podName传入，多个用英文"," 分隔；'."\n" + .'如："mse-a8aba010-1629719288255-reg-center-0-1,mse-a8aba010-1629719288255-reg-center-0-2"'."\n" + ."\n" + .'传入的Pod必须属于当前集群，与instanceId绑定，否则重启异常'."\n", 'type' => 'string', 'required' => false, 'example' => 'mse-a8aba010-1629719288255-reg-center-0-1'], ], [ - 'name' => 'ServiceWeight', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '服务权重。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'HttpPort', - 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP端口（虚拟服务组）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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":"\\n请求成功\\n5B170A0D-2C5D-4CF8-B808-03966B86****\\nmse-100-000\\ntrue\\n","errorExample":""}]', + 'title' => '重启集群', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'HttpsPort', - 'in' => 'query', - 'schema' => [ - 'description' => 'HTTPS端口（虚拟服务组）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '443', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:RestartCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], + ], + ], + 'RetryCluster' => [ + 'summary' => '创建超时时，调用RetryCluster接口重试集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17094', + 'abilityTreeNodes' => ['FEATUREmseYGMCYE'], + ], + 'parameters' => [ [ - 'name' => 'HttpsVServerGroupId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => 'https虚拟服务组ID。', - 'type' => 'string', - 'required' => false, - 'example' => '353', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'VServiceList', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'SLB监听信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VServerGroupId' => [ - 'description' => '虚拟服务器组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rsp-bp1j**t0fyl**', - ], - 'VServerGroupName' => [ - 'description' => ' 虚拟服务器组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'k8s/31**0/***/istio-system/clusterid', - ], - 'Port' => [ - 'description' => '端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '443', - ], - 'Protocol' => [ - 'description' => '协议类型：'."\n" - .'- HTTP'."\n" - .'- HTTPS', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTPS', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-st21ri2****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'string', - 'example' => 'lb-uf6dqr4ondqi5w3df7hdf', - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoPermission'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '重试集群', + '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\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"lb-uf6dqr4ondqi5w3df7hdf\\"\\n}","type":"json"}]', - 'title' => '关联网关SLB', ], - 'AddSecurityGroupRule' => [ - 'summary' => '添加网关安全组规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'SelectGatewaySlb' => [ + 'summary' => '接口，查询用户已有（启动中状态无监听）SLB。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -39364,111 +27187,60 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'SecurityGroupId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '安全组ID', - 'description' => '安全组ID', - 'type' => 'string', - 'required' => true, - 'example' => 'sg-wz929kxhcdpw9z8idqd8', - ], + 'schema' => ['description' => 'SLB名称。', 'type' => 'string', 'required' => false, 'example' => 'test-slb'], ], [ - 'name' => 'PortRange', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '端口范围', - 'description' => '端口范围', - 'type' => 'string', - 'required' => true, - 'example' => '1/65535', - ], + 'schema' => ['description' => 'SLB类型。', 'type' => 'string', 'required' => false, 'example' => 'PUB_NET'], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '网关ID', - 'description' => '网关ID', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-492af9b04bb4474cae9d645be850****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + ."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E00C6D90-A28A-5813-8981-0459AA436F46'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '返回数据。', - 'type' => 'string', - 'example' => '12', + 'description' => '数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'SlbId' => ['description' => 'SLB ID。', 'type' => 'string', 'example' => 'lb-bp14lqiw5n96hq2****'], + 'SlbName' => ['description' => 'SLB名称。', 'type' => 'string', 'example' => 'MseGatewaySlb-gw'], + ], + ], ], ], ], @@ -39476,828 +27248,501 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关SLB', + '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\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"12\\"\\n}","type":"json"}]', - 'title' => '添加网关安全组规则', ], - 'DeleteGateway' => [ - 'summary' => '删除指定网关。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'TagResources' => [ + 'summary' => '为指定的资源打上标签。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '24808', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '143129', + 'abilityTreeNodes' => ['FEATUREmseHJJ9Z1'], ], 'parameters' => [ [ - 'name' => 'DeleteSlb', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域', 'description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['title' => '资源类型', 'description' => '资源类型：'."\n" + ."\n" + .'- CLUSTER 注册配置中心。'."\n" + .'- GATEWAY 云原生网关。'."\n" + .'- GOVERNANCEAPPLICATION 微服务治理应用', 'type' => 'string', 'required' => true, 'example' => 'CLUSTER、GATEWAY、GOVERNANCEAPPLICATION'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '删除网关时是否同时删除代购的SLB。', - 'type' => 'boolean', + 'description' => '资源ID。'."\n" + ."\n" + .'- *注册配置中心*：实例ID'."\n" + .'- *云原生网关*：网关唯一ID'."\n" + .'- *微服务治理应用*：微服务治理应用AppID（注意不是LicenseKey）'."\n" + ."\n" + .'>表示传入第几个实例ID。例如： '."\n" + .'- **ResourceId.0**表示传入第一个实例ID。'."\n" + .' - **ResourceId.1**表示传入第二个实例ID。', + 'type' => 'array', + 'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-7pp2st29t16'."\n" + .'hkhon1****@0932f4959f8****'], 'required' => false, - 'example' => 'true', + 'maxItems' => 51, ], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '网关唯一标识。', - 'type' => 'string', + 'title' => '标签列表，最多包含20个子项', + 'description' => '标签列表，最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息集合。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '资源的标签键。N的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'prd'], + ], + 'required' => false, + ], 'required' => true, - 'docRequired' => true, - 'example' => 'gw-0fe488252dc44d55a9dd57875193a1d7', + 'maxItems' => 21, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6', - ], - 'HttpStatusCode' => [ - 'description' => 'http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因，例如：TaskId not found。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码。状态码为200表示成功，其余取值表示失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '主键ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => '网关名称。', - 'type' => 'string', - 'example' => 'mse-bc1a29b0-reg-center-0-1', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'Region' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'PrimaryUser' => [ - 'description' => '用户信息。', - 'type' => 'string', - 'example' => '1231254', - ], - 'Status' => [ - 'description' => '网关状态：'."\n" - .'0: 创建中'."\n" - .'1: 创建失败'."\n" - .'2: 运行中'."\n" - .'3: 变更中'."\n" - .'4: 缩容中'."\n" - .'6: 扩容中'."\n" - .'8: 删除中'."\n" - .'10: 重启中'."\n" - .'11: 重建中'."\n" - .'12: 升级中'."\n" - .'13: 升级失败', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Vpc' => [ - 'description' => '网关归属的VpcId', - 'type' => 'string', - 'example' => 'vpc-bp1328cm01m6uel42b5zb', - ], - 'Vswitch' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-bp18zeqxx6mpuq843z4n5', - ], - 'SecurityGroup' => [ - 'description' => '安全组。', - 'type' => 'string', - 'example' => 'sg-bp11ufzqn6mmb8dtzz82', - ], - 'Spec' => [ - 'description' => '网关规格。', - 'type' => 'string', - 'example' => 'MSE_GTW_16_32_200_c', - ], - 'Replica' => [ - 'description' => '网关副本数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '最后一次更新网关实例的时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E0A79810-9396-521C-A09D-E757B3E2BAF4'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Succ'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '添加标签', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除网关信息', ], - 'DeleteGatewaySlb' => [ - 'summary' => '取消关联SLB。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UntagResources' => [ + 'summary' => '删标签接口。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '71802', - 'abilityTreeNodes' => [ - 'FEATUREmseMNDRFM', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '关联记录ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '395', - ], + 'schema' => ['title' => '地域', 'description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DeleteSlb', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '删除网关时是否同时删除代购的SLB。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '资源类型', 'description' => '资源类型：'."\n" + ."\n" + .'- CLUSTER注册配置中心。'."\n" + ."\n" + .'- GATEWAY云原生网关。', 'type' => 'string', 'required' => true, 'example' => 'CLUSTER'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'All', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], + 'schema' => ['title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', 'description' => '是否全部删除，只针对TagKey.N为空时有效。 '."\n" + .'取值范围：'."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'默认取值为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'SlbId', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '待取消关联的SlbId。', - 'type' => 'string', + 'title' => '资源ID，最多50个子项', + 'description' => '资源ID，最多50个子项。', + 'type' => 'array', + 'items' => ['description' => '实例ID。'."\n" + .'>表示传入第几个实例ID。例如： '."\n" + .'- **ResourceId.0**表示传入第一个实例ID。'."\n" + .' - **ResourceId.1**表示传入第二个实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-7pp2st29t16'], 'required' => true, - 'docRequired' => true, - 'example' => 'lb-uf6duug6s13x4abc8****', + 'maxItems' => 51, ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - ."\n" - .'- en：英文', - 'type' => 'string', + 'title' => '标签键，最多20个子项', + 'description' => '标签键，最多20个子项。', + 'type' => 'array', + 'items' => ['description' => '资源的标签键。N的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含***http://*** 或者 ***https://***。', 'type' => 'string', 'required' => false, 'example' => 'env'], 'required' => false, - 'example' => 'zh', + 'maxItems' => 21, ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '删除结果。', - 'type' => 'string', - 'example' => '28', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '删除标签', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '取消关联网关SLB', ], - 'DeleteSecurityGroupRule' => [ - 'summary' => '删除网关安全组规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateAcl' => [ + 'summary' => '修改白名单。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'update', + 'abilityTreeCode' => '17096', + 'abilityTreeNodes' => ['FEATUREmse3FEC0V'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c', - ], - ], - [ - 'name' => 'Id', + 'name' => 'AclEntryList', 'in' => 'query', - 'schema' => [ - 'description' => '目标ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '93', - ], + 'schema' => ['description' => '白名单列表。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '192.168.0.0/XX,192.168.0.0/XX'], ], [ - 'name' => 'CascadingDelete', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-78v1l83****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '43E50CB7-258E-5AFF-9B93-ECC19928C699', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'SecurityGroupId' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-uf6hgwe067prhg68agfa', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'PortRange' => [ - 'description' => '目的端安全组开放的传输层协议相关的端口范围。取值范围： '."\n" - .' '."\n" - .'- TCP/UDP协议：取值范围为1~65535。使用斜线（/）隔开起始端口和终止端口。例如：1/200'."\n" - .'- ICMP协议：-1/-1'."\n" - .'- GRE协议：-1/-1'."\n" - .'- all：-1/-1', - 'type' => 'string', - 'example' => '8443/8443', - ], - 'IpProtocol' => [ - 'description' => '传输层协议。不区分大小写。取值范围： '."\n" - .' '."\n" - .'- icmp'."\n" - .'- gre'."\n" - .'- tcp'."\n" - .'- udp'."\n" - .'- all：支持所有协议', - 'type' => 'string', - 'example' => 'tcp', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2022-01-11T14:12:55.000+0000', - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => 'auto-description1', - ], - ], - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-100'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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":"\\n请求处理成功\\n7466566F-F30F-4A29-965D-3E0AF21D****\\nmse-100-100\\ntrue\\n","errorExample":""}]', + 'title' => '更新白名单', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateAcl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除网关安全组规则', ], - 'UpdateGatewayOption' => [ - 'summary' => '更新网关参数。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateAuthPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '17097', + 'abilityTreeNodes' => ['FEATUREmseDB5C9P'], ], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '421', - ], + 'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => false, 'example' => 'demo-test'], ], [ - 'name' => 'GatewayOption', + 'name' => 'Source', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '网关操作详情。'."\n" - ."\n" - .'- **TraceDetails**：XTrace采样描述。内容：TraceEnabled为是否开通XTrace，Sample为XTrace的采样率。'."\n" - ."\n" - .'- **LogConfigDetails**：日志投递服务描述。内容：LogEnabled为是否开启日志投递SLS服务，ProjectName为日志投递的目的，LogStoreName为日志存储名称。'."\n" - ."\n" - .'- **EnableHardwareAcceleration**：是否开启硬件加速。'."\n" - ."\n" - .'- **DisableHttp2Alpn**：是否关闭HTTP 2.0协议。'."\n" - ."\n" - .'- **EnableWaf**：是否开启waf。', - 'required' => false, - '$ref' => '#/components/schemas/GatewayOption', - ], + 'schema' => ['description' => '应用接入来源。', 'type' => 'string', 'required' => false, 'example' => 'edasmsc'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c4****', - ], + 'schema' => ['description' => '规则ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '432'], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => '是否开启。', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'abcde@12345'], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => '协议类型。取值：'."\n" + ."\n" + .'- **SPRING_CLOUD**。'."\n" + .'- **DUBBO**。'."\n" + .'- **istio**。', 'type' => 'string', 'required' => false, 'example' => 'SPRING_CLOUD'], + ], + [ + 'name' => 'AuthRule', + 'in' => 'query', + 'schema' => ['description' => '服务鉴权规则内容。', 'type' => 'string', 'required' => false, 'example' => '[{\\"all\\":true,\\"appIds\\":[\\"f6xqzbao96@4adfaf3c92c947a\\"],\\"black\\":false}]'], + ], + [ + 'name' => 'K8sNamespace', + 'in' => 'query', + 'schema' => ['description' => 'k8s集群的命名空间ID。', 'type' => 'string', 'required' => false, 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - ."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '124D02EB-DBDD-534D-A701-B4A95D3D****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': True}, \'TraceDetails\': {\'Sample\': 17, \'TraceEnabled\': True}}', - '$ref' => '#/components/schemas/GatewayOption', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '83E3909D-D26F-5D97-B73B-407A26***'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Data' => ['description' => '数据概览。', 'type' => 'string', 'example' => '{}'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'Success' => ['description' => '请求结果，取值如下：- true：请求成功。- false：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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' => '更新服务鉴权规则', + 'summary' => '通过UpdateAuthPolicy接口更新服务鉴权规则。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '更新网关参数', ], - 'UpdateGatewayName' => [ - 'summary' => '修改网关名称。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateBlackWhiteList' => [ + 'summary' => '更新网关黑白名单。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -40307,47 +27752,82 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '66628', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36595', + 'abilityTreeNodes' => ['FEATUREmseWSG2U5'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '网关名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'demo-test', - ], + 'schema' => ['description' => '黑名ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => '网关唯一ID。', + 'description' => '绑定资源作用范围。', 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'gw-1cef54brvecdb419fb264d4f9b8c', + 'enumValueTitles' => [], + 'example' => 'GATEWAY', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '黑白名单资源类型。', 'type' => 'string', 'required' => false, 'example' => 'IP'], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => '黑名单内容。', 'type' => 'string', 'required' => false, 'example' => '127.0.2.11'], + ], + [ + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', + 'description' => '是否开启状态。', 'type' => 'string', 'required' => false, - 'example' => 'zh', + 'enumValueTitles' => ['off' => '关闭', 'on' => '开启'], + 'example' => 'on', ], ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => ['description' => '是否白名单（默认为否）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'ResourceIdJsonList', + 'in' => 'query', + 'schema' => ['description' => '资源ID列表JSON。', 'type' => 'string', 'required' => false, 'example' => '[123]'], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => ['description' => '备注。', 'type' => 'string', 'required' => false, 'example' => 'this is a note'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'name'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ @@ -40356,384 +27836,415 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8C95711F-E702-5395-BFAA-21BA946CDE47', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AD5DEDA0-C82A-50D9-AF54-BD3576CCFB4C'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '请求消息', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '记录ID。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - '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' => '更新网关名称', - ], - 'QueryGatewayRegion' => [ - 'summary' => '查询网关支持的地域。', - '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' => '更新网关黑白名单', + 'changeSet' => [ + ['createdAt' => '2023-07-17T07:11:19.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-15T07:39:53.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-09-28T13:10:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-01-13T03:28:15.000Z', 'description' => '请求参数发生变更'], ], - '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' => [ + 'summary' => '更新熔断规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '167822', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AcceptLanguage', + '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' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', + 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', + 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', + 'type' => 'number', + 'format' => 'float', 'required' => false, - 'example' => 'zh', + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => '0.8', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'title' => '规则的启用状态。', + 'description' => '规则的启用状态。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522bXXXXX'], + ], + [ + 'name' => 'Strategy', + 'in' => 'query', + 'schema' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => ['慢调用比例', '异常比例'], + 'example' => '0', ], ], + [ + 'name' => 'RetryTimeoutMs', + 'in' => 'query', + 'schema' => ['title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'], + ], + [ + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => ['title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20000'], + ], + [ + 'name' => 'MaxAllowedRtMs', + 'in' => 'query', + 'schema' => ['title' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', 'description' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => ['title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'HalfOpenBaseAmountPerStep', + 'in' => 'query', + 'schema' => ['title' => '熔断恢复每步最小通过数目，默认值为1。', 'description' => '熔断恢复每步最小通过数目，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'HalfOpenRecoveryStepNum', + 'in' => 'query', + 'schema' => ['title' => '熔断恢复阶段数，默认值为1。', 'description' => '熔断恢复阶段数，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命名空间。', 'type' => 'string', 'example' => 'default'], + 'Id' => ['title' => '规则ID。', 'description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AppName' => ['title' => '应用名称。', 'description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'description' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', 'type' => 'string', 'example' => '/a'], + 'Strategy' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['慢调用比例', '异常比例'], + 'example' => '0', + ], + 'Threshold' => ['title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', 'description' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', 'type' => 'number', 'format' => 'float', 'example' => '0.8'], + 'Enable' => ['title' => '规则的启用状态。', 'description' => '规则的启用状态。', 'type' => 'boolean', 'example' => 'true'], + 'RetryTimeoutMs' => ['title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', 'description' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'StatIntervalMs' => ['title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', 'description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '20000'], + 'AppId' => ['title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@c3df23522bXXXXX'], + 'MaxAllowedRtMs' => ['title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', 'description' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'MinRequestAmount' => ['title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', 'description' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'HalfOpenBaseAmountPerStep' => ['title' => '熔断恢复每步最小通过数目。', 'description' => '熔断恢复每步最小通过数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'HalfOpenRecoveryStepNum' => ['title' => '熔断恢复阶段数。', 'description' => '熔断恢复阶段数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', + 'title' => '请求结果。', + 'description' => '请求结果。', 'type' => 'boolean', + 'enumValueTitles' => ['true' => '请求成功', 'false' => '请求失败'], 'example' => 'true', ], - 'Data' => [ - 'description' => '返回数据信息。', - 'type' => 'array', - 'items' => [ - 'description' => '返回地域信息集合。', - 'type' => 'string', - 'example' => '{"cn-hanghzou"}', - ], - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '更新熔断规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询网关支持地域', ], - 'QueryGatewayType' => [ - 'summary' => '查询网关可用类型。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateCluster' => [ + 'summary' => '修改集群信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '17098', + 'abilityTreeNodes' => ['FEATUREmseY3D6DK'], ], 'parameters' => [ [ - 'name' => 'AcceptLanguage', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', + [ + 'name' => 'ClusterAliasName', + 'in' => 'query', + 'schema' => ['description' => '集群别名。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cluster-1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-cn-78v1l83****'], + ], + [ + 'name' => 'MaintenanceStartTime', + 'in' => 'query', + 'schema' => ['description' => '运维窗口开始时间', 'type' => 'string', 'required' => false, 'example' => '02:00'], + ], + [ + 'name' => 'MaintenanceEndTime', + 'in' => 'query', + 'schema' => ['description' => '运维窗口结束时间', 'type' => 'string', 'required' => false, 'example' => '06:00'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '数据结构。', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码。状态码为200表示成功，其余取值表示失败。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '网关类型，参数数据类型为list。', - 'type' => 'array', - 'items' => [ - 'description' => '网关类型。', - 'type' => 'string', - 'example' => 'Ingress', - ], - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-100'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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":"\\n请求处理成功\\n5B170A0D-2C5D-4CF8-B808-03966B86****\\nmse-100-100\\ntrue\\n","errorExample":""}]', + 'title' => '更新集群信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询网关可用类型', ], - 'GetGateway' => [ - 'summary' => '获取网关的所属VPC，所属交换机等基本信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateClusterSpec' => [ + 'summary' => '更新注册配置中心集群节点数或规格（支持按量付费和包年包月）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '92862', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], - ], + 'systemTags' => ['operationType' => 'update', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['title' => '网关名称', 'description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '节点规格', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'mse-cn-st21ri2****'], + ], + [ + 'name' => 'InstanceCount', + 'in' => 'query', + 'schema' => ['title' => '节点数量', 'description' => '目标节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'ClusterSpecification', 'in' => 'query', 'schema' => [ - 'description' => '网关唯一标识ID。', + 'description' => '目标引擎规格。', 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'gw-685f661467b54f48b7b7a76605ce****', + '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'], + 'example' => 'MSE_SC_2_4_200_c', ], ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => ['description' => 'MSE版本。', 'type' => 'string', 'required' => false, 'example' => 'mse_pro'."\n"], + ], + [ + 'name' => 'PubNetworkFlow', + 'in' => 'query', + 'schema' => ['title' => '公网带宽', 'description' => '公网带宽', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1'], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => ['title' => '是否下单之后自动支付，如果此值为false，此接口将会返回订单支付url，可手动确认支付', 'description' => '是否下单之后自动支付，如果此值为false，此接口将会返回订单支付url，可手动确认支付', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -40743,1976 +28254,1049 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '请求是否成功的描述信息', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码。说明 200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '网关信息。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => '网关名称。', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'Region' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'PrimaryUser' => [ - 'description' => '创建主用户User ID。', - 'type' => 'string', - 'example' => '1231254', - ], - 'Status' => [ - 'description' => '获取数据集成同步任务的结果状态。取值如下：'."\n" - .'* 0: 创建中'."\n" - .'* 1: 创建失败'."\n" - .'* 2: 运行中'."\n" - .'* 3: 变更中'."\n" - .'* 4: 缩容中'."\n" - .'* 6: 扩容中'."\n" - .'* 8: 删除中'."\n" - .'* 10: 重启中'."\n" - .'* 11: 重建中'."\n" - .'* 12: 升级中'."\n" - .'* 13: 升级失败', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Vpc' => [ - 'description' => 'VPC网络ID。', - 'type' => 'string', - 'example' => 'vpc-bp1328cm01m6uel42b5zb', - ], - 'Vswitch' => [ - 'description' => '交换机。', - 'type' => 'string', - 'example' => 'vsw-bp18zeqxx6mpuq843z4n5', - ], - 'SecurityGroup' => [ - 'description' => '安全组。', - 'type' => 'string', - 'example' => 'sg-bp11ufzqn6mmb8dtzz82', - ], - 'Spec' => [ - 'description' => '网关规格。', - 'type' => 'string', - 'example' => 'MSE_GTW_16_32_200_c', - ], - 'Replica' => [ - 'description' => '网关副本数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => '网关设备的创建时间，GMT格式，是用户所在地的当地时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '最后一次更新实例的时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'XtraceDetails' => [ - 'description' => 'XTrace详情。', - 'type' => 'object', - 'properties' => [ - 'Sample' => [ - 'description' => 'XTrace采样率。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TraceOn' => [ - 'description' => '是否开启XTrace采样。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Vswitch2' => [ - 'description' => '交换机2。', - 'type' => 'string', - 'example' => 'vpc-bp1j6ivhav15ve7q54kq2', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse-cn-st21ri2****', - ], - 'ChargeType' => [ - 'description' => '付费模式，包括包年包月和按量付费。', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'EndDate' => [ - 'description' => '网关结束时间。', - 'type' => 'string', - 'example' => '2021-08-01 00:00:00', - ], - 'StatusDesc' => [ - 'description' => '状态描述。', - 'type' => 'string', - 'example' => '正在重启中。', - ], - 'LogConfigDetails' => [ - 'description' => '日志配置。', - 'type' => 'object', - 'properties' => [ - 'LogEnabled' => [ - 'description' => '是否开启日志投递', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ProjectName' => [ - 'description' => '项目名称。', - 'type' => 'string', - 'example' => 'k8s-log-c173117256e934a96b7fefdf2ef8a8057', - ], - 'LogStoreName' => [ - 'description' => 'logstore名称。', - 'type' => 'string', - 'example' => 'mse_access_log', - ], - ], - ], - 'MseTag' => [ - 'description' => '资源标签。', - 'type' => 'string', - 'example' => '{"TagKey":"TagValue"}', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfm34x43l*****', - ], - 'TotalReplica' => [ - 'description' => '总副本数（包括自动扩容副本数）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Elastic' => [ - 'description' => '是否开启自动扩容。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ElasticReplica' => [ - 'description' => '自动扩容副本数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ElasticType' => [ - 'description' => '自动扩容类型，目前支持：'."\n" - ."\n" - .'* CronHPA：按时间扩容', - 'type' => 'string', - 'example' => 'CronHPA', - ], - 'ElasticPolicy' => [ - 'description' => '自动扩容策略。', - 'type' => 'object', - 'properties' => [ - 'MaxReplica' => [ - 'description' => '自动扩容最大实例数（水平扩容时使用）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'ElasticType' => [ - 'description' => '自动扩容类型，目前支持：'."\n" - ."\n" - .'- CronHPA：按时间扩容', - 'type' => 'string', - 'example' => 'CronHPA', - ], - 'TimePolicyList' => [ - 'description' => '按时间扩容策略。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DesiredReplica' => [ - 'description' => '期望副本数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'StartTime' => [ - 'description' => '自动扩容起始时间。', - 'type' => 'string', - 'example' => '16:00', - ], - 'EndTime' => [ - 'description' => '自动扩容结束时间。', - 'type' => 'string', - 'example' => '18:00', - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '如果AutoPay设置为false，则此值为订单支付的URL', 'description' => '保留字段。', 'type' => 'string', 'example' => 'null'], + 'ErrorCode' => ['description' => '错误码。取值说明如下：'."\n" + ."\n" + .'- 请求成功：不返回**ErrorCode**字段。'."\n" + .'- 请求失败：返回**ErrorCode**字段。具体信息，请参见本文的**错误码**目录。', 'type' => 'string', 'example' => 'mse-100-000'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新集群规格', + 'description' => '更新注册配置中心集群节点数或规格（支持按量付费和包年包月，增加节点或升级规格会产生相应资费，具体详情，请参见[价格说明]（[`~~1806469~~`]））。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateClusterSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询网关信息', ], - 'ListGateway' => [ - 'summary' => '查询该网关列表信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateConfig' => [ + 'summary' => '更新集群配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24675', - 'abilityTreeNodes' => [ - 'FEATUREmseYEACIS', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17099', + 'abilityTreeNodes' => ['FEATUREmseY3D6DK'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'PageSize', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'OrderItem', + 'name' => 'ConfigType', 'in' => 'query', - 'schema' => [ - 'description' => '订单信息。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '配置格式，包括TEXT、JSON、XML、HTML等。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TEXT'], ], [ - 'name' => 'DescSort', + 'name' => 'TickTime', 'in' => 'query', - 'schema' => [ - 'description' => '排序（暂时未使用）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'zookeeper配置，时间单元，默认为2000毫秒。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2000'], ], [ - 'name' => 'FilterParams', + 'name' => 'InitLimit', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'zookeeper配置，实例最长连接时间，单位：秒。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '100'], + ], + [ + 'name' => 'SyncLimit', + 'in' => 'query', + 'schema' => ['description' => 'zookeeper配置，实例连接超时时间，单位：秒。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxClientCnxns', + 'in' => 'query', + 'schema' => ['description' => 'zookeeper配置，单个客户端与单台服务器之间的连接数。 '."\n" + .'如果设置为0，表示不作任何限制。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0'], + ], + [ + 'name' => 'OpenSuperAcl', + 'in' => 'formData', + 'schema' => ['description' => 'zookeeper配置，超级权限开关，取值如下：'."\n" + .'- `true`：打开'."\n" + .'- `false`：关闭', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'true'], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => '用户名称。'."\n" + .'> 当OpenSuperAcl为true时，需要填写此值。', 'type' => 'string', 'required' => false, 'example' => 'name'], + ], + [ + 'name' => 'PassWord', + 'in' => 'query', + 'schema' => ['description' => '用户密码。'."\n" + .'> 当OpenSuperAcl为true时，需要填写此值。', 'type' => 'string', 'required' => false, 'example' => 'password'], + ], + [ + 'name' => 'JuteMaxbuffer', + 'in' => 'query', + 'schema' => ['description' => 'zookeeper配置，每个节点最大数据量，默认是1M，单位：字节。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1048575'], + ], + [ + 'name' => 'AutopurgePurgeInterval', + 'in' => 'query', + 'schema' => ['description' => '保留字段。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'none'], + ], + [ + 'name' => 'AutopurgeSnapRetainCount', + 'in' => 'query', + 'schema' => ['description' => '保留字段。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'none'], + ], + [ + 'name' => 'ConfigAuthEnabled', + 'in' => 'query', + 'schema' => ['description' => 'nacos配置，是否开启配置中心ram鉴权：'."\n" + .'- `true`：开启'."\n" + .'- `false`：关闭'."\n" + ."\n" + .'> 设置此值前需要调用QueryConfig接口，获取ConfigAuthSupported参数，以查看当前集群是否支持此功能。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'NamingAuthEnabled', + 'in' => 'query', + 'schema' => ['description' => 'nacos配置，是否开启注册中心ram鉴权：'."\n" + .'- `true`：开启'."\n" + .'- `false`：关闭'."\n" + ."\n" + .'> 设置此值前需要调用QueryConfig接口，获取NamingAuthSupporte参数，以查看当前集群是否支持此功能。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'MCPEnabled', + 'in' => 'query', + 'schema' => ['description' => 'nacos配置，MCP是否生效，取值如下：'."\n" + .'- `true`：生效'."\n" + .'- `false`：不生效'."\n" + .'> 设置此值前需要调用QueryConfig接口，获取MCPSupported参数，以查看当前集群是否支持此功能。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse_prepaid_public_cn-st2212****'], + ], + [ + 'name' => 'ConfigSecretEnabled', + 'in' => 'query', + 'schema' => ['description' => 'nacos配置，是否打开配置中心配置加密功能，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。'."\n" + ."\n" + .'> 设置此值前需要调用QueryConfig接口，获取ConfigSecretSupported参数，以查看当前集群是否支持此功能。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'MinSessionTimeout', + 'in' => 'query', + 'schema' => ['title' => '最小超时时间', 'description' => 'zookeeper配置，最小超时时间，单位：秒。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxSessionTimeout', + 'in' => 'query', + 'schema' => ['title' => '最大超时时间', 'description' => 'zookeeper配置，最大超时时间，单位：秒。', 'type' => 'string', 'required' => false, 'example' => '1000'], + ], + [ + 'name' => 'SnapshotCount', + 'in' => 'query', + 'schema' => ['description' => 'zookeeper配置，生成快照的频率', 'type' => 'string', 'required' => false, 'example' => '100000'], + ], + [ + 'name' => 'ExtendedTypesEnable', + 'in' => 'query', + 'schema' => ['description' => 'zookeeper参数，是否开启TTL配置。', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'EurekaSupported', + 'in' => 'query', + 'schema' => ['description' => 'Nacos是否开启支持Eurka协议', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'TLSEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Nacos是否开启TLS传输链路加密', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'ConsoleUIEnabled', + 'in' => 'query', + 'schema' => ['description' => '是否开启Nacos开源控制台', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Enable4lw', + 'in' => 'query', + 'schema' => ['description' => '是否开启四字命令访问', 'type' => 'boolean', 'required' => false], + ], + [ + 'name' => 'AuthEnabled', + 'in' => 'query', + 'schema' => ['description' => '是否启用强制SASL身份认证，启用之后，没有进行SASL身份认证的客户端将无法访问集群', 'type' => 'boolean', 'required' => false], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '参数信息。', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'GatewayType' => [ - 'description' => '网关类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Ingress', - ], - 'Name' => [ - 'description' => '网关名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'rutain-test', - ], - 'Vpc' => [ - 'description' => '专有网络。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp13hhyjntbab7w****', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_ingresspre-cn-****', - ], - 'MseTag' => [ - 'description' => '资源标签。', - 'type' => 'string', - 'required' => false, - 'example' => '[{"key":"tagkey","value":"tagvalue"}]', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-7y2uye*****', - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'HttpStatusCode' => ['description' => 'HTTP返回码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\nCB889254-0C8B-49B2-8465-4CDAB08A****\\n请求处理成功\\nmse-100-100\\ntrue\\n","errorExample":""}]', + 'title' => '更新集群配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'UpdateEngineNamespace' => [ + 'summary' => '更新引擎命名空间。', + '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' => '集群名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'name'], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => ['description' => '集群描述。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'public'], + ], + [ + 'name' => 'ServiceCount', + 'in' => 'query', + 'schema' => ['description' => '活跃服务数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '3'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****'], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mse-09k1q11****'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21ri2****'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34300B3-52EC-5049-8C96-914098CF****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], 'Data' => [ - 'description' => 'Meta返回信息。', + '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' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '153', - ], - 'Name' => [ - 'description' => '网关名称。', - 'type' => 'string', - 'example' => 'tesa-test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-5017305290e14cebb8ce5cb6a4****', - ], - 'GatewayType' => [ - 'description' => '网关类型。', - 'type' => 'string', - 'example' => 'Ingress', - ], - 'Region' => [ - 'description' => '地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'PrimaryUser' => [ - 'description' => '用户信息。', - 'type' => 'string', - 'example' => '18278117654342', - ], - 'Status' => [ - 'description' => '网关状态'."\n" - ."\n" - .'- 0 创建中'."\n" - .'- 1 创建失败'."\n" - .'- 2 运行中'."\n" - .'- 3 变更中'."\n" - .'- 4 缩容中'."\n" - .'- 6 扩容中'."\n" - .'- 8 删除中'."\n" - .'- 9 停服待释放'."\n" - .'- 10 重启中'."\n" - .'- 11 重建中'."\n" - .'- 12 升级中'."\n" - .'- 13 升级失败', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AhasOn' => [ - 'description' => '是否开启AHAS。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ArmsOn' => [ - 'description' => '是否开启ARMS。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Spec' => [ - 'description' => '规格。', - 'type' => 'string', - 'example' => 'MSE_GTW_1_2_200_c', - ], - 'Replica' => [ - 'description' => '备份。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-09-13 19:24:23', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2021-09-13 19:24:23', - ], - 'StatusDesc' => [ - 'description' => '状态描述。', - 'type' => 'string', - 'example' => '重启中', - ], - 'Slb' => [ - 'description' => 'SLB集合。', - 'type' => 'array', - 'items' => [ - 'description' => 'SLB集合信息。', - 'type' => 'object', - 'properties' => [ - 'SlbIp' => [ - 'description' => 'SLB IP。', - 'type' => 'string', - 'example' => '153.12.XX.XX', - ], - 'SlbPort' => [ - 'description' => 'SLB端口。', - 'type' => 'string', - 'example' => '80', - ], - 'SlbSpec' => [ - 'description' => 'SLB规格。', - 'type' => 'string', - 'example' => 'slb.s2.small', - ], - 'Type' => [ - 'description' => '网络类型'."\n" - ."\n" - .'- PUB_NET：公网'."\n" - .'- PRIVATE_NET：私网', - 'type' => 'string', - 'example' => 'PUB_NET', - ], - 'GatewaySlbStatus' => [ - 'description' => '网关SLB状态。', - 'type' => 'string', - 'example' => 'Ready', - ], - 'StatusDesc' => [ - 'description' => '状态描述。', - 'type' => 'string', - 'example' => '创建中', - ], - 'GatewaySlbMode' => [ - 'description' => '网关SLB模式。', - 'type' => 'string', - 'example' => 'UserHost', - ], - 'SlbId' => [ - 'description' => 'SLB ID。', - 'type' => 'string', - 'example' => 'lb-bp1ut8asdfgucjk****', - ], - ], - ], - ], - 'InternetSlb' => [ - 'description' => '互联网SLB。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'SlbIp' => [ - 'description' => 'SLB IP。', - 'type' => 'string', - 'example' => '153.12.XX.XX', - ], - 'SlbPort' => [ - 'description' => 'SLB端口。', - 'type' => 'string', - 'example' => 'slb.s2.small', - ], - 'SlbSpec' => [ - 'description' => 'SLB规格。', - 'type' => 'string', - 'example' => 'slb.s2.small', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'PUB_NET', - ], - 'InternetNetworkFlow' => [ - 'description' => '网关流量。', - 'type' => 'string', - 'example' => '20', - ], - 'GatewaySlbStatus' => [ - 'description' => '网关SLB状态。', - 'type' => 'string', - 'example' => 'Ready', - ], - 'StatusDesc' => [ - 'description' => '状态描述。', - 'type' => 'string', - 'example' => '创建中', - ], - 'GatewaySlbMode' => [ - 'description' => '网关SLB模式。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'UserHost', - ], - 'SlbId' => [ - 'description' => 'SLB ID。', - 'type' => 'string', - 'example' => 'lb-bp1ut8asdfgucjk****', - ], - ], - ], - ], - 'Upgrade' => [ - 'description' => '升级。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'MustUpgrade' => [ - 'description' => '强制升级。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SupportWasm' => [ - 'description' => '是否支持WASM。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CurrentVersion' => [ - 'description' => '当前版本。', - 'type' => 'string', - 'example' => '0.1.0-mse-gw', - ], - 'AppVersion' => [ - 'description' => '应用版本。', - 'type' => 'string', - 'example' => '1.0.1.0', - ], - 'LatestVersion' => [ - 'description' => '最新版本。', - 'type' => 'string', - 'example' => '0.1.0-mse-gw', - ], - 'Vswitch2' => [ - 'description' => '交换机2。', - 'type' => 'string', - 'example' => 'vsw-bpbrveck45nf****', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse_ingresspost-cn-0jbvrcex****', - ], - 'ChargeType' => [ - 'description' => '付费类型。', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'EndDate' => [ - 'description' => '到期日期。', - 'type' => 'string', - 'example' => '4792060800000', - ], - 'Tag' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => 'test', - ], - 'InitConfig' => [ - 'description' => '配置信息。', - 'type' => 'object', - 'properties' => [ - 'EnableWaf' => [ - 'description' => '是否开启WAF。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SupportWaf' => [ - 'description' => '是否支持WAF。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'GatewayVersion' => [ - 'description' => '网关版本。', - 'type' => 'string', - 'example' => '1.2.9', - ], - 'RollBack' => [ - 'description' => '是否支持回滚。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'MseTag' => [ - 'description' => '资源标签。', - 'type' => 'string', - 'example' => '{"tagKey":"tagValue"}', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-97hg87vi****', - ], - 'TotalReplica' => [ - 'description' => '总副本数（包括自动扩容副本数）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Elastic' => [ - 'description' => '是否开启自动扩容。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ElasticReplica' => [ - 'description' => '自动扩容副本数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ElasticType' => [ - 'description' => '自动扩容类型，目前支持：'."\n" - ."\n" - .'- CronHPA：按时间扩容', - 'type' => 'string', - 'example' => 'CronHPA', - ], - 'ElasticPolicy' => [ - 'description' => '自动扩容策略。', - 'type' => 'object', - 'properties' => [ - 'Elastic' => [ - 'description' => '是否开启自动扩容。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MaxReplica' => [ - 'description' => '自动扩容最大实例数（水平扩容时使用）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ElasticType' => [ - 'description' => '自动扩容类型，目前支持：'."\n" - ."\n" - .'* CronHPA：按时间扩容', - 'type' => 'string', - 'example' => 'CronHPA', - ], - 'TimePolicyList' => [ - 'description' => '自动扩容时间策略列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DesiredReplica' => [ - 'description' => '自动扩容期望副本数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'StartTime' => [ - 'description' => '自动扩容起始时间。', - 'type' => 'string', - 'example' => '07:00', - ], - 'EndTime' => [ - 'description' => '自动扩容结束时间。', - 'type' => 'string', - 'example' => '09:00', - ], - ], - ], - ], - 'LoadWarningThreshold' => [ - 'title' => '网关按负载弹性的水位设置，true表示开启警戒水位，false表示开启安全水位', - 'description' => '网关按负载弹性的水位设置，true表示开启警戒水位，false表示开启安全水位', - 'type' => 'boolean', - ], - 'EnableScaleTimePolicyList' => [ - 'title' => '允许缩容时间段', - 'description' => '允许缩容时间段', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'ElasticInstanceId' => [ - 'description' => '网关弹性实例ID，使用自动扩容时返回。', - 'type' => 'string', - 'example' => 'mse_ingresselastic_public_cn-uqm3d0*****', - ], - 'VpcId' => [ - 'description' => '网关VPC ID。', - 'type' => 'string', - 'example' => 'vpc-uf6heojei217tv14*****', - ], - 'MseVersion' => [ - 'type' => 'string', - ], - 'MaintenancePeriod' => [ - 'type' => 'object', - 'properties' => [ - 'TimeZone' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - ], - ], - 'GatewayEntry' => [ - 'title' => '网关入口地址（适用普通实例专业版）', - 'description' => '网关入口地址（适用普通实例专业版）', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NetType' => [ - 'title' => '入口网络类型'."\n" - ."\n" - .'- PRIVATE_NET：私网'."\n" - ."\n" - .'- PUB_NET：公网', - 'description' => '入口网络类型'."\n" - ."\n" - .'- PRIVATE_NET：私网'."\n" - ."\n" - .'- PUB_NET：公网', - 'type' => 'string', - 'example' => 'PUB_NET', - ], - 'EntryDomain' => [ - 'title' => '入口域名', - 'description' => '入口域名', - 'type' => 'string', - 'example' => 'gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com', - ], - 'IpList' => [ - 'title' => '入口IP列表', - 'description' => '入口IP列表', - 'type' => 'array', - 'items' => [ - 'title' => '入口IP', - 'description' => '入口IP', - 'type' => 'string', - 'example' => '1.2.3.4', - ], - ], - 'HttpPorts' => [ - 'title' => 'HTTP监听端口列表', - 'description' => 'HTTP监听端口列表', - 'type' => 'array', - 'items' => [ - 'title' => 'HTTP监听端口', - 'description' => 'HTTP监听端口', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - ], - 'HttpsPorts' => [ - 'title' => 'HTTPS监听端口列表', - 'description' => 'HTTPS监听端口列表', - 'type' => 'array', - 'items' => [ - 'title' => 'HTTPS监听端口', - 'description' => 'HTTPS监听端口', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '443', - ], - ], - 'Status' => [ - 'title' => '网关入口就绪状态', - 'description' => '网关入口就绪状态', - 'type' => 'string', - 'example' => 'Ready', - 'enum' => [ - 'Ready', - 'NotReady', - ], - ], - 'Ipv6List' => [ - 'title' => 'ipv6地址', - 'description' => 'ipv6地址', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'VersionLifecycle' => [ - 'type' => 'string', - ], - ], - ], - ], + 'Type' => ['description' => '命名空间类型，取值如下：'."\n" + .'- `0`：全局配置'."\n" + .'- `1`：默认命名空间'."\n" + .'- `2`：自定义命名空间', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NamespaceShowName' => ['description' => '命名空间描述名称。', 'type' => 'string', 'example' => 'mytestshowname'], + 'Quota' => ['description' => '配额。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'public'], + 'NamespaceDesc' => ['description' => '命名空间描述。', 'type' => 'string', 'example' => 'mytest'], + 'ConfigCount' => ['description' => '配额数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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":"\\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' => '更新引擎命名空间', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询网关信息列表', ], - 'ListGatewaySlb' => [ - 'summary' => '查询网关入口SLB。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateFlowRule' => [ + 'summary' => '更新流控规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '159855', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => '规则的 ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13'], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => '流控规则阈值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '30'], + ], + [ + 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', + 'description' => '规则的启用状态。', + 'type' => 'boolean', 'required' => false, - 'docRequired' => true, - 'example' => 'gw-1cef5440bf2d484db419fb264d4f****', + 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'], + 'example' => 'true', ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'ControlBehavior', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', + 'description' => '流控效果。', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'zh', + 'docRequired' => false, + 'enumValueTitles' => ['快速失败', 2 => '排队等待'], + 'example' => '0', ], ], + [ + 'name' => 'MaxQueueingTimeMs', + 'in' => 'query', + 'schema' => ['description' => '超时时间，单位毫秒。当controlBehavior类型为（排队等待）时，需要设置该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522******'], + ], + [ + 'name' => 'LimitApp', + 'in' => 'query', + 'schema' => ['description' => '请求来源应用。', 'type' => 'string', 'required' => false, 'example' => 'Spring-cloud-a'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EAB345F4-3AC3-560C-B653-65717703****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****'], + 'Code' => ['description' => '返回值。', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'description' => '节点数据列表。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => '接口资源名。', 'type' => 'string', 'example' => '/c'], + 'ControlBehavior' => [ + 'description' => '流控效果。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['快速失败', 2 => '排队等待'], + 'example' => '0', + ], + 'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'Threshold' => ['description' => '流控规则阈值。', 'type' => 'number', 'format' => 'float', 'example' => '5'], + 'Enable' => [ + 'description' => '规则的启用状态。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '开启', 'fasle' => '关闭'], + 'example' => 'true', + ], + 'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => 'hpn9ac29kz@e31a4b871******'], + 'LimitApp' => ['description' => '请求来源应用。', 'type' => 'string', 'example' => 'Spring-cloud-a'], + ], ], 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', + 'description' => '请求结果。', 'type' => 'boolean', + 'enumValueTitles' => ['true' => '请求成功', 'false' => '请求失败'], 'example' => 'true', ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID', - 'type' => 'string', - 'example' => 'ID', - ], - 'SlbId' => [ - 'description' => 'SLB ID', - 'type' => 'string', - 'example' => 'lb-bp1kmnli3hdpreptw2ah3', - ], - 'SlbIp' => [ - 'description' => 'SLB IP', - 'type' => 'string', - 'example' => '121.199.XX.XX', - ], - 'SlbPort' => [ - 'description' => 'SLB端口。', - 'type' => 'string', - 'example' => '80,443', - ], - 'Type' => [ - 'description' => '网络类型'."\n" - ."\n" - .'- PUB_NET：公网'."\n" - .'- PRIVATE_NET：私网', - 'type' => 'string', - 'example' => 'PUB_NET', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'string', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-14 14:39:16', - ], - 'GatewaySlbMode' => [ - 'description' => '来源。', - 'type' => 'string', - 'example' => 'UserSelect', - ], - 'GatewaySlbStatus' => [ - 'description' => '关联状态。', - 'type' => 'string', - 'example' => 'Ready', - ], - 'StatusDesc' => [ - 'description' => '状态备注。', - 'type' => 'string', - 'example' => '关联中', - ], - 'VServerGroupId' => [ - 'description' => 'http虚拟服务组ID。', - 'type' => 'string', - 'example' => '353', - ], - 'HttpPort' => [ - 'description' => 'HTTP端口（虚拟服务组）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'HttpsPort' => [ - 'description' => 'HTTPS端口（虚拟服务组）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '443', - ], - 'ServiceWeight' => [ - 'description' => '服务权重。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'EditEnable' => [ - 'description' => '是否可编辑。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'HttpsVServerGroupId' => [ - 'description' => 'https虚拟服务组ID。', - 'type' => 'string', - 'example' => '353', - ], - 'VsMetaInfo' => [ - 'description' => '虚拟服务器组元信息。', - 'type' => 'string', - 'example' => '[{"protocol":"HTTP","vServerGroupName":"k8s/80/****","port":80,"vServerGroupId":"rsp-bp***"},{"protocol":"HTTPS","vServerGroupName":"k8s/443/***","port":443,"vServerGroupId":"rsp-bp*****"}]', - ], - 'VServiceList' => [ - 'description' => 'SLB监听信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Port' => [ - 'description' => '端口。', - 'type' => 'string', - 'example' => '443', - ], - 'Protocol' => [ - 'description' => '协议类型。'."\n" - ."\n" - .'- HTTPS'."\n" - .'- HTTP', - 'type' => 'string', - 'example' => 'HTTPS', - ], - 'VServerGroupId' => [ - 'description' => '虚拟服务器组ID。', - 'type' => 'string', - 'example' => 'rsp-bp183l2x70***', - ], - 'VServerGroupName' => [ - 'description' => ' 虚拟服务器组名称。', - 'type' => 'string', - 'example' => 'k8s/31**0/***/istio-system/clusterid', - ], - ], - ], - ], - 'SlbType' => [ - 'type' => 'string', - ], - ], - ], - ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新流控规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询网关入口SLB', ], - 'GetGatewayOption' => [ - 'summary' => '获取网关全局参数。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayAuthConsumer' => [ + 'summary' => '更新网关鉴权消费者。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '92787', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '429', - ], + 'schema' => ['description' => '网关唯一ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-90392d768a3847a7b804c505254d****'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'EncodeType', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', - ], + 'schema' => ['description' => '加密类型：'."\n" + ."\n" + .'- RSA'."\n" + ."\n" + .'- OCT', 'type' => 'string', 'required' => false, 'example' => 'RSA'], + ], + [ + 'name' => 'Jwks', + 'in' => 'query', + 'schema' => ['description' => 'JWT公钥，支持JSON格式。', '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"}]}'], + ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => ['description' => '要校验的Token参数信息的名称，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'required' => false, 'example' => 'Authorization'], + ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => ['description' => '是否透传。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'TokenPosition', + 'in' => 'query', + 'schema' => ['description' => '要校验的Token参数信息的位置，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'required' => false, 'example' => 'HEADER'], + ], + [ + 'name' => 'TokenPrefix', + 'in' => 'query', + 'schema' => ['description' => '要校验的Token参数信息的前缀，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', 'type' => 'string', 'required' => false, 'example' => 'Bearer '], + ], + [ + 'name' => 'KeyName', + 'in' => 'query', + 'schema' => ['description' => 'JWT内身份标识KeyName。', 'type' => 'string', 'required' => false, 'example' => 'iss'], + ], + [ + 'name' => 'KeyValue', + 'in' => 'query', + 'schema' => ['description' => 'JWT内身份标识KeyValue。', 'type' => 'string', 'required' => false, 'example' => 'abcd'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '鉴权消费者描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description.'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '63'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C92F4A4D-A2FD-593E-839E-F3D4DFD2****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因，例如：TaskId not found。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码。说明：200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '网关操作详情。'."\n" - ."\n" - .'- **TraceDetails**：XTrace采样描述。内容：TraceEnabled为是否开通XTrace，Sample为XTrace的采样率。'."\n" - ."\n" - .'- **LogConfigDetails**：日志投递服务描述。内容：LogEnabled为是否开启日志投递SLS服务，ProjectName为日志投递的目的，LogStoreName为日志存储名称。'."\n" - ."\n" - .'- **EnableHardwareAcceleration**：是否开启硬件加速。'."\n" - ."\n" - .'- **DisableHttp2Alpn**：是否关闭HTTP 2.0协议。'."\n" - ."\n" - .'- **EnableWaf**：是否开启waf。', - 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': False}, \'TraceDetails\': {\'TraceEnabled\': False}}', - '$ref' => '#/components/schemas/GatewayOption', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n", 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '鉴权消费者ID。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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\\": \\"The request is processed successfully.\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": 2\\n}","type":"json"}]', + 'title' => '更新网关鉴权消费者', + '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\\": \\"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' => '查询网关选项', ], - 'ListSecurityGroupRule' => [ - 'summary' => '查询网关安全组列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayAuthConsumerResource' => [ + 'summary' => '更新网关鉴权消费者的授权列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '网关ID', - 'description' => '网关唯一ID', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c', - ], + 'schema' => ['description' => 'UpdateGatewayAuthConsumerResource', 'type' => 'string', 'required' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'ConsumerId', 'in' => 'query', + 'schema' => ['description' => '网关鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'ResourceList', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表。', + 'type' => 'object', + 'properties' => [ + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7816'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'required' => false, 'example' => 'helo'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], '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' => '9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => '返回代码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '安全组授权记录ID。', - 'type' => 'string', - 'example' => '21', - ], - 'SecurityGroupId' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-bp1cg6qlyjepj0y6cf2c', - ], - 'PortRange' => [ - 'description' => '端口范围。', - 'type' => 'string', - 'example' => '8000/8000', - ], - 'IpProtocol' => [ - 'description' => '协议类型', - 'type' => 'string', - 'example' => 'tcp', - ], - 'AuthCidrs' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-12a432a1f5da423997d8880bd32c304d', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'Description' => [ - 'description' => '规则描述。', - 'type' => 'string', - 'example' => '测试', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%**s**。'."\n" + ."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则表示所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '执行是否成功：'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新网关鉴权消费者的授权列表', + '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\\": \\"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' => '查询网关安全组列表', ], - 'ListSecurityGroup' => [ - 'summary' => '获取安全组列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayAuthConsumerResourceStatus' => [ + 'summary' => '更新网关鉴权消费者的授权状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '网关ID', - 'description' => '网关ID', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e98e40675aaf49bda082137d158e1585', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-2a99625886d54722be94d92e9a69****'], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => ['description' => '网关鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'IdList', + 'in' => 'query', + 'schema' => ['description' => '用户更新指定的授权ID列表。', 'type' => 'string', 'required' => true, 'example' => '1,2,3,4'], + ], + [ + 'name' => 'ResourceStatus', + 'in' => 'query', + 'schema' => ['description' => '资源状态：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：停用', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], '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' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'array', - 'items' => [ - 'description' => '节点数据。', - 'type' => 'object', - 'properties' => [ - 'SecurityGroupId' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-8vb8gsmrqyc35k645rk6', - ], - 'SecurityGroupName' => [ - 'description' => '安全组名称。', - 'type' => 'string', - 'example' => 'sg2', - ], - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-bp1b', - ], - 'SecurityGroupType' => [ - 'description' => '安全组类型，分为普通安全组与企业安全组。取值范围：'."\n" - ."\n" - .'- normal：普通安全组。'."\n" - .'- enterprise：企业安全组。更多详情，请参见[企业安全组概述](~~120621~~)。', - 'type' => 'string', - 'example' => 'enterprise', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数 `ErrMessage` 错误信息中的 `%s`。'."\n" + ."\n" + .'> 如果`ErrMessage`返回`The Value of Input Parameter %s is not valid`，且`DynamicMessage`返回`DtsJobId`，则代表所传入的请求参数`DtsJobId`不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '执行是否成功：'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新网关鉴权消费者的授权状态', + '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\\": \\"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' => '获取安全组列表', ], - 'UpdateGatewaySpec' => [ - 'summary' => '更新云原生网关集群节点数或规格（支持按量付费和包年包月）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayAuthConsumerStatus' => [ + 'summary' => '更新网关鉴权消费者状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'title' => '网关名称', - 'description' => '网关ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], + 'schema' => ['description' => '网关唯一ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-685f661467b54f48b7b7a76605ce****'], ], [ - 'name' => 'Spec', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '节点规格', - 'description' => '节点规格。', - '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' => '鉴权消费者ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'Replica', + 'name' => 'ConsumerStatus', 'in' => 'query', - 'schema' => [ - 'title' => '节点数量', - 'description' => '节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => '鉴权消费者状态：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：停用', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '执行结果信息。', - 'type' => 'string', - 'example' => 'gw-892ehbv7gg56******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '56D9E600-6348-4260-B35F-583413F****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '执行是否成功：'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新网关鉴权消费者状态', + '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\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"gw-892ehbv7gg56******\\"\\n}","type":"json"}]', - 'title' => '更新网关规格', - 'description' => '更新云原生网关集群节点数或规格，支持按量付费和包年包月，增加节点或升级规格会产生相应资费。具体详情，请参见[价格说明](~~250950~~)。', ], - 'SelectGatewaySlb' => [ - 'summary' => '接口，查询用户已有（启动中状态无监听）SLB。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayCircuitBreakerRule' => [ + 'summary' => '更新该网关熔断规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -42720,113 +29304,173 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'SLB名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-slb', - ], + 'schema' => ['description' => '熔断规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '369'], ], [ - 'name' => 'Type', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => 'SLB类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'PUB_NET', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407'], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-492af9b04bb4474cae9d645be850****', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-c9bc5afd61014165bd58f621b491****'], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => ['description' => '路由ID。', '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' => '阈值类型。'."\n" + ."\n" + .'0：慢调用类型。'."\n" + ."\n" + .'1：异常类型。', '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' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定文本'."\n" + ."\n" + .'1：跳转到指定页面', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429'], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'HTTP返回文本。', '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' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - ."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E00C6D90-A28A-5813-8981-0459AA436F46', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'], 'Data' => [ - 'description' => '数据结构。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'SlbId' => [ - 'description' => 'SLB ID。', - 'type' => 'string', - 'example' => 'lb-bp14lqiw5n96hq2****', - ], - 'SlbName' => [ - 'description' => 'SLB名称。', - 'type' => 'string', - 'example' => 'MseGatewaySlb-gw', - ], + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '熔断规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '369'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14407'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-c9bc5afd61014165bd58f621b491****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '645'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeName'], + 'Strategy' => ['description' => '阈值类型。'."\n" + ."\n" + .'0：慢调用类型。'."\n" + ."\n" + .'1：异常类型。', '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' => '阈值转化模式。'."\n" + ."\n" + .'0：单机。'."\n" + ."\n" + .'1：集群。'."\n" + ."\n" + .'2：集群转单机。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BehaviorType' => ['description' => 'Web fallbaco行为类型。'."\n" + ."\n" + .'0：返回指定文本。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本。'."\n" + ."\n" + .'1：JSON。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '201'], + 'ResponseContentBody' => ['description' => 'HTTP返回文本。', 'type' => 'string', 'example' => 'text'], + 'ResponseRedirectUrl' => ['description' => '跳转地址。', 'type' => 'string', 'example' => 'www.******.com'], + 'ResponseAdditionalHeaders' => ['description' => '自定义header，输入为key-value键值对。', 'type' => 'string', 'example' => 'key=value'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '筛选规则id', + 'type' => 'array', + 'items' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '369'], ], ], ], @@ -42836,256 +29480,240 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '更新网关熔断规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询网关SLB', ], - 'AddServiceSource' => [ - 'summary' => '创建Nacos服务来源。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayConfig' => [ + 'summary' => '更新网关配置', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'update', + 'abilityTreeCode' => '261694', + 'abilityTreeNodes' => ['FEATUREmseS26K2N'], ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '服务注册类型，按来源类型填写对应的值：'."\n" - .'- 容器服务：K8S'."\n" - .'- MSE Nacos：NACOS'."\n" - .'- MSE ZooKeeper：ZOOKEEPER'."\n" - .'- SAE 注册中心：NACOS'."\n" - .'- EDAS 注册中心：NACOS', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'NACOS'."\n", - ], - ], - [ - 'name' => 'Source', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '服务来源类型：'."\n" - .'- 容器服务：K8S'."\n" - .'- MSE Nacos：MSE'."\n" - .'- MSE ZooKeeper：MSE_ZK'."\n" - .'- SAE 注册中心：SAE'."\n" - .'- EDAS 注册中心：EDAS', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'MSE', - ], + 'schema' => ['title' => '网关唯一ID', 'description' => '网关唯一ID', 'type' => 'string', 'required' => true, 'example' => 'gw-b525dc1adf3c486ab96224a6346*****'], ], [ - 'name' => 'Address', + 'name' => 'ConfigName', 'in' => 'query', - 'schema' => [ - 'description' => '访问地址（必填）：'."\n" - .'* 容器服务：对应容器服务集群ID'."\n" - .'* MSE Nacos：实例内网访问地址'."\n" - .'* MSE ZooKeeper：实例内网访问地址'."\n" - .'* SAE 注册中心：命名空间TID'."\n" - .'* EDAS 注册中心：微服务空间Namespace', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'mse-********-nacos-ans.mse.aliyuncs.com:8848', - ], + 'schema' => ['title' => '参数配置名称', 'description' => '参数配置名称，支持的配置项：'."\n" + ."\n" + .'- EnableHttp2'."\n" + ."\n" + .'- DownstreamIdleTime'."\n" + ."\n" + .'- PreserveHeaderFormat'."\n" + ."\n" + .'- UpstreamIdleTimeout'."\n" + ."\n" + .'- EnableXffTrustedCidrs'."\n" + ."\n" + .'- EnableK8sSourceWorkloadFilter', 'type' => 'string', 'required' => true, 'example' => 'EnableK8sSourceWorkloadFilter'], ], [ - 'name' => 'Name', + 'name' => 'ConfigValue', 'in' => 'query', - 'schema' => [ - 'description' => '名称。'."\n" - ."\n\n" - .'> 不同来源类型描述。'."\n" - .'- 类型为K8s时入参为名称。'."\n" - .'- 类型为NACOS时入参为实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'nacos', - ], + 'schema' => ['title' => '参数配置值', 'description' => '参数配置值，配置示例：'."\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\\n2.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"}'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'IngressOptionsRequest', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Ingress配置（服务来源类型为K8s时使用）。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'EnableIngress' => [ - 'description' => '是否开启Ingress。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'IngressClass' => [ - 'description' => '监听Ingress Class。', - 'type' => 'string', - 'required' => false, - 'example' => 'com.test.xxx', - ], - 'WatchNamespace' => [ - 'description' => '监听目标命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'EnableStatus' => [ - 'description' => '是否更新Ingress Status。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****'], ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'ToAuthorizeSecurityGroups', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '待授权安全组列表，用于在创建来源时打通后端服务的安全组限制', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SecurityGroupId' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-bp1acepclex0vmi1****', - ], - 'PortRange' => [ - 'description' => '安全组的授权端口范围，可多选，使用,分隔。', - 'type' => 'string', - 'required' => false, - 'example' => '8080/8080,9000/10000', - ], - 'Description' => [ - 'description' => '授权记录描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'rule for xxx', - ], - ], - 'required' => false, + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4D****\\"\\n}","type":"json"}]', + 'title' => '更新网关参数配置', + '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}'], ], - 'required' => false, ], ], + ], + ], + 'UpdateGatewayDomain' => [ + 'summary' => '修改关联域名信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'GroupList', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '35640', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], + ], + 'parameters' => [ + [ + 'name' => 'Protocol', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '服务分组列表。', - 'type' => 'array', - 'items' => [ - 'description' => '服务分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'NACOS', - ], - 'required' => false, - ], + 'schema' => ['description' => '协议类型。'."\n" + ."\n" + .'- HTTPS'."\n" + .'- HTTP', 'type' => 'string', 'required' => false, 'example' => 'HTTPS'], ], [ - 'name' => 'PathList', + 'name' => 'MustHttps', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '服务根路径数组。', - 'type' => 'array', - 'items' => [ - 'description' => '服务根路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'required' => false, - ], + 'schema' => ['description' => '强制HTTPS', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => ['description' => '证书ID。', 'type' => 'string', 'required' => false, 'example' => '6209108-cn-hangzhou'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '需要更新的域名id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '94'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****'], + ], + [ + 'name' => 'Http2', + 'in' => 'query', + 'schema' => ['description' => '是否开启`Http2`。'."\n" + .'- `open`：开启`Http2`。'."\n" + .'- `close`：关闭`Http2`。'."\n" + .'- `globalConfig`：使用全局配置。', 'type' => 'string', 'required' => false, 'example' => 'close'], + ], + [ + 'name' => 'TlsMax', + 'in' => 'query', + 'schema' => ['description' => 'Tls最大版本。', 'type' => 'string', 'required' => false, 'example' => 'TLS 1.3'], + ], + [ + 'name' => 'TlsMin', + 'in' => 'query', + 'schema' => ['description' => 'Tls最小版本。', 'type' => 'string', 'required' => false, 'example' => 'TLS 1.0'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '支持的语言。包括以下取值：'."\n" - ."\n" - .'- 中文：zh-CN（默认值）。'."\n" - .'- 英文：en-US。'."\n" - .'- 日文：ja。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -43095,93 +29723,58 @@ 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - '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' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- true：请求成功。'."\n" - .'- false：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '63', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '403'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '94'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - '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' => '创建服务来源', - ], - 'AddGatewayServiceVersion' => [ - 'summary' => '添加服务版本。', - 'methods' => [ - 'post', - 'get', - ], - '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' => '更新关联域名信息', + 'changeSet' => [ + ['createdAt' => '2026-03-12T02:35:25.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2026-03-03T08:16:53.000Z', 'description' => 'OpenAPI 下线'], ], - '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}'], + ], + ], + ], ], + ], + 'UpdateGatewayFlowRule' => [ + 'summary' => '更新该网关流控规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -43189,105 +29782,138 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '90280', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '33', - ], + 'schema' => ['description' => '流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '549'], ], [ - 'name' => 'ServiceVersion', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{\\"name\\":\\"v1\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v1\\"}]}', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407'], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-913a49bab6c5461187a3305fb8da****', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => ['description' => '路由ID。', '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' => '总体QPS阈值。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => ['description' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定文本'."\n" + ."\n" + .'1：跳转到指定页面', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429'], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'Http返回文本。', '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' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA4046B6-CFC6-583C-B608-DD75011A590F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - ], - 'Message' => [ - 'description' => '错误消息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码。说明：200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****'], 'Data' => [ - 'description' => '网关服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '330', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '549'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14407'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '48811'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeA'], + 'Threshold' => ['description' => '总体QPS阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'StatDurationMs' => ['description' => '统计持续时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'LimitMode' => ['description' => '阈值转化模式。'."\n" + ."\n" + .'0：单机。'."\n" + ."\n" + .'1：集群。'."\n" + ."\n" + .'2：集群转单机。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BehaviorType' => ['description' => 'Web fallbaco行为类型。'."\n" + ."\n" + .'0：返回指定文本。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本'."\n" + ."\n" + .'1：JSON', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '429'], + 'ResponseContentBody' => ['description' => 'HTTP返回文本。', 'type' => 'string', 'example' => 'Text'], + 'ResponseRedirectUrl' => ['description' => '跳转地址。', 'type' => 'string', 'example' => 'www.******.com'], + 'ResponseAdditionalHeaders' => ['description' => '自定义header，输入为key-value键值对。', 'type' => 'string', 'example' => 'key=value'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '筛选规则id', + 'type' => 'array', + 'items' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '549'], + ], + ], ], ], ], @@ -43295,50 +29921,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新网关流控规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '添加网关服务版本', ], - 'DeleteServiceSource' => [ - 'summary' => '删除网关服务来源。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayIsolationRule' => [ + 'summary' => '更新该网关并发规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -43346,88 +29963,137 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '24910', - 'abilityTreeNodes' => [ - 'FEATUREmseQRG9VI', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'SourceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '数据源ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '17', - ], + 'schema' => ['description' => '并发规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '358'], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14407'], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-492af9b04bb4474cae9d645be850****', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'RouteId', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => '路由ID。', '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' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本。'."\n" + ."\n" + .'1：JSON。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '429'], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => ['description' => 'HTTP返回文本。', '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' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2CEF593F-D60C-5449-9E98-15CA6ECD9189', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '并发规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '358'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14407'], + 'GatewayUniqueId' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****'], + 'RouteId' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '52853'], + 'RouteName' => ['description' => '路由名称。', 'type' => 'string', 'example' => 'routeName'], + 'MaxConcurrency' => ['description' => '总体并发数阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'LimitMode' => ['description' => '阈值转化模式。'."\n" + ."\n" + .'0：单机。'."\n" + ."\n" + .'1：集群。'."\n" + ."\n" + .'2：集群转单机。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BehaviorType' => ['description' => 'Web fallback行为类型。'."\n" + ."\n" + .'0：返回指定内容。'."\n" + ."\n" + .'1：跳转到指定页面。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'BodyEncoding' => ['description' => '编码类型。'."\n" + ."\n" + .'0：普通文本。'."\n" + ."\n" + .'1：JSON。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResponseStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '429'], + 'ResponseContentBody' => ['description' => 'HTTP返回文本。', 'type' => 'string', 'example' => 'text'], + 'ResponseRedirectUrl' => ['description' => '跳转路径。', 'type' => 'string', 'example' => 'www.******.com'], + 'ResponseAdditionalHeaders' => ['description' => '自定义header，输入为key-value键值对。', 'type' => 'string', 'example' => 'key=value'], + 'Enable' => ['description' => '是否开启。'."\n" + ."\n" + .'0：不开启。'."\n" + ."\n" + .'1：开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '筛选规则id', + 'type' => 'array', + 'items' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '358'], + ], + ], ], ], ], @@ -43435,50 +30101,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新网关并发规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '删除网关服务来源', ], - 'DeleteGatewayServiceVersion' => [ - 'summary' => '删除网关服务版本。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayName' => [ + 'summary' => '修改网关名称。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -43487,159 +30144,89 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '90283', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '66628', + 'abilityTreeNodes' => ['FEATUREmseYEACIS'], ], 'parameters' => [ [ - 'name' => 'ServiceId', - 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '777', - ], - ], - [ - 'name' => 'ServiceVersion', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{\\"name\\":\\"app\\",\\"labels\\":[{\\"key\\":\\"app\\",\\"value\\":\\"demo-server\\"}]}', - ], + 'schema' => ['description' => '网关名称。', 'type' => 'string', 'required' => false, 'example' => 'demo-test'], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-b6988bd16920479d9104e1729f97****', - ], + 'schema' => ['description' => '网关唯一ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'gw-1cef54brvecdb419fb264d4f9b8c'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '29D52777-BE96-563E-BC6B-796ACE47A7A5', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因，例如：TaskId not found。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8C95711F-E702-5395-BFAA-21BA946CDE47'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '更新网关名称', + '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\\": \\"29D52777-BE96-563E-BC6B-796ACE47A7A5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": 1\\n}","type":"json"}]', - 'title' => '删除网关服务版本', ], - 'DeleteGatewayService' => [ - 'summary' => '删除网关服务。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayOption' => [ + 'summary' => '更新网关参数。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -43647,233 +30234,108 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '25194', - 'abilityTreeNodes' => [ - 'FEATUREmse5GGXKF', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '190', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '421'], ], [ - 'name' => 'GatewayId', + 'name' => 'GatewayOption', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], + 'style' => 'json', + 'schema' => ['description' => '网关操作详情。'."\n" + ."\n" + .'- **TraceDetails**：XTrace采样描述。内容：TraceEnabled为是否开通XTrace，Sample为XTrace的采样率。'."\n" + ."\n" + .'- **LogConfigDetails**：日志投递服务描述。内容：LogEnabled为是否开启日志投递SLS服务，ProjectName为日志投递的目的，LogStoreName为日志存储名称。'."\n" + ."\n" + .'- **EnableHardwareAcceleration**：是否开启硬件加速。'."\n" + ."\n" + .'- **DisableHttp2Alpn**：是否关闭HTTP 2.0协议。'."\n" + ."\n" + .'- **EnableWaf**：是否开启waf。', 'required' => false, '$ref' => '#/components/schemas/GatewayOption'], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c4****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + ."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求响应结构。', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求唯一ID', - 'type' => 'string', - 'example' => 'B3545F76-6ED1-586F-8DB9-ECE07985F381', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190', - ], - 'Name' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SourceType' => [ - 'description' => '服务来源', - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'SourceId' => [ - 'description' => '来源ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServiceNameInRegistry' => [ - 'description' => '服务注册到注册中心的名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'MetaInfo' => [ - 'description' => '服务的基本信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'Ips' => [ - 'description' => 'IP', - 'type' => 'array', - 'items' => [ - 'description' => 'IP', - 'type' => 'string', - 'example' => '127.0.1.12', - ], - ], - 'GmtCreate' => [ - 'description' => '服务创建时间。', - 'type' => 'string', - 'example' => '2022-01-14 14:39:16', - ], - 'GmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '124D02EB-DBDD-534D-A701-B4A95D3D****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': True}, \'TraceDetails\': {\'Sample\': 17, \'TraceEnabled\': True}}', '$ref' => '#/components/schemas/GatewayOption'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - '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' => '删除网关服务', - ], - 'UpdateGatewayServiceTrafficPolicy' => [ - 'summary' => '更新服务流量策略。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - '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' => '更新网关参数', + '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' => '更新网关路由。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -43883,71 +30345,271 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '113905', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], + 'abilityTreeCode' => '25973', + 'abilityTreeNodes' => ['FEATUREmseVZLJSD'], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '501'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '路由名称（已废弃，不支持修改路由名称，填入和当前不同的路由名称会导致更新失败）', 'description' => '路由名称。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'route-web'], + ], + [ + 'name' => 'RouteOrder', + 'in' => 'query', + 'schema' => ['description' => '路由顺序。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Predicates', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '429', + 'description' => '路由匹配条件。', + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'Path匹配。', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => '路由Path路径。', 'type' => 'string', 'required' => false, 'example' => '/test'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'required' => false, 'example' => 'PRE'], + 'IgnoreCase' => ['description' => '忽略大小写。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + 'required' => true, + 'docRequired' => true, + ], + 'MethodPredicates' => [ + 'description' => '方法匹配。', + 'type' => 'array', + 'items' => ['description' => '具体方法。', 'type' => 'string', 'required' => false, 'example' => 'GET'], + 'required' => false, + ], + 'HeaderPredicates' => [ + 'description' => '请求头匹配。', + 'type' => 'array', + 'items' => [ + 'description' => '请求头。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '请求头Key。', 'type' => 'string', 'required' => false, 'example' => 'debug'], + 'Value' => ['description' => '对应的Value。', 'type' => 'string', 'required' => false, 'example' => 'on'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'required' => false, 'example' => 'PRE'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'QueryPredicates' => [ + 'description' => '参数匹配。', + 'type' => 'array', + 'items' => [ + 'description' => 'URL参数。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '参数名。', 'type' => 'string', 'required' => false, 'example' => 'userid'], + 'Value' => ['description' => '匹配值。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'required' => false, 'example' => 'PRE'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + 'docRequired' => true, ], ], [ - 'name' => 'ServiceId', + 'name' => 'Services', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '目标服务（路由指向为单服务、多服务、标签路由时填写）。', + 'type' => 'array', + 'items' => [ + 'description' => '服务列表。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Percent' => ['description' => '当前服务/服务版本分流百分比（只在使用多服务、标签路由时填写）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], + 'Version' => ['description' => '服务版本（只在使用标签路由时填写）。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'web'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'required' => false, 'example' => 'MSE'], + 'Namespace' => ['description' => '服务所在命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'GroupName' => ['description' => '服务分组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'AgreementType' => ['description' => '协议类型。', 'type' => 'string', 'required' => false, 'example' => 'DUBBO'."\n"], + 'HttpDubboTranscoder' => [ + 'description' => 'Dubbo协议转换体。', + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => ['description' => 'Dubbo服务名称。', 'type' => 'string', 'required' => false, 'example' => 'org.apache.dubbo.samples.basic.api.DemoService'], + 'DubboServiceVersion' => ['description' => 'Dubbot服务版本。', 'type' => 'string', 'required' => false, 'example' => '0.0.0'], + 'DubboServiceGroup' => ['description' => 'Dubbo服务组。', 'type' => 'string', 'required' => false, 'example' => 'service name'], + 'MothedMapList' => [ + 'description' => 'Dubbo转发规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '方法映射体。', + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => ['description' => 'Dubbo方法名。', 'type' => 'string', 'required' => false, 'example' => 'sayHello'], + 'HttpMothed' => ['description' => 'Http方法。'."\n" + .'> 支持http方法参数值。'."\n" + .'> - ALL_GET。'."\n" + .'> - ALL_POST。'."\n" + .'> - ALL_PUT。'."\n" + .'> - ALL_DELETE。'."\n" + .'> - ALL_PATCH。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL_GET'], + 'Mothedpath' => ['description' => '方法匹配路径。', 'type' => 'string', 'required' => false, 'example' => '/mytestzbk/sayhello'."\n"], + 'PassThroughAllHeaders' => ['description' => 'Header透传类型。'."\n" + .'> 透传类型枚举值。'."\n" + .'> - 透传所有：PASS_ALL。'."\n" + .'> - 不透传：PASS_NOT。'."\n" + .'> - 指定参数：PASS_ASSIGN。'."\n", 'type' => 'string', 'required' => false, 'example' => 'PASS_NOT'."\n"], + 'PassThroughList' => [ + 'description' => '指定透传Header列表。', + 'type' => 'array', + 'items' => ['description' => '指定Header透传值。', 'type' => 'string', 'required' => false, 'example' => 'x-forward'."\n"], + 'required' => false, + ], + 'ParamMapsList' => [ + 'description' => '参数映射列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数映射体。', + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => ['description' => '入参位置。'."\n" + .'> 入参位置枚举值。'."\n" + .'> - 请求参数：`ALL_QUERY_PARAMETER`'."\n" + .'> - 请求头：`ALL_HEADER`'."\n" + .'> - 请求路径：`ALL_PATH`'."\n" + .'> - 请求体：`ALL_BODY`'."\n", 'type' => 'string', 'required' => false, 'example' => 'ALL_QUERY_PARAMETER'."\n"], + 'ExtractKey' => ['description' => '入参位提取Key。', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'MappingType' => ['description' => '后端参数类型。', 'type' => 'string', 'required' => false, 'example' => 'java.lang.String'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ServicePort' => ['description' => 'Dubbo端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20880'], + ], + 'required' => false, + ], 'required' => false, - 'docRequired' => true, - 'example' => '411', ], ], [ - 'name' => 'GatewayTrafficPolicy', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '139'], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => ['description' => '目标服务类型。', 'type' => 'string', 'required' => false, 'example' => 'Mock'], + ], + [ + 'name' => 'DirectResponseJSON', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '网关流量控制策略。', - 'required' => true, - '$ref' => '#/components/schemas/TrafficPolicy', + 'description' => 'Mock内容。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Mock返回码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'], + 'Body' => ['description' => 'Mock返回值。', 'type' => 'string', 'required' => false, 'example' => 'hello'], + ], + 'required' => false, ], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392a2c4'], + ], + [ + 'name' => 'DomainIdListJSON', + 'in' => 'query', + 'schema' => ['description' => '关联域名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[90]'], + ], + [ + 'name' => 'RedirectJSON', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-75c5036c083e4f89ba8ef9fafff2e902', + 'description' => '重定向。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '302'], + 'Host' => ['description' => '重定向主机名。', 'type' => 'string', 'required' => false, 'example' => 'test.com'], + 'Path' => ['description' => '重定向路径。', 'type' => 'string', 'required' => false, 'example' => '/test'], + ], + 'required' => false, ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'EnableWaf', + 'in' => 'query', + 'schema' => ['title' => '请使用UpdateGatewayRouteWafStatus更新路由WAF状态', 'description' => '已废弃，请使用UpdateGatewayRouteWafStatus更新路由WAF状态。', 'type' => 'boolean', 'deprecated' => true, 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Fallback', + 'in' => 'query', + 'schema' => ['description' => '是否开启Fallback服务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'FallbackServices', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回值的语言，取值：'."\n" - ."\n" - .'- **zh-CN**：中文，默认值。'."\n" - .'- **en-US**：英文。', - 'type' => 'string', + 'description' => 'Fallback服务。', + 'type' => 'array', + 'items' => [ + 'description' => '数据对象。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'Percent' => ['description' => '权重百分比。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], + 'Version' => ['description' => '服务版本。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'SourceType' => ['description' => '来源类型。', 'type' => 'string', 'required' => false, 'example' => 'MSE'], + 'Namespace' => ['description' => '服务所在命名空间。', 'type' => 'string', 'required' => false, 'example' => 'Namespace'."\n"], + 'GroupName' => ['description' => '服务分组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'AgreementType' => ['description' => '协议类型。', 'type' => 'string', 'required' => false, 'example' => 'DUBBO'."\n"], + 'ServicePort' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8848'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '路由描述', 'description' => '路由描述', 'type' => 'string', 'required' => false, 'example' => 'a route for xxx'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ @@ -43956,14971 +30618,484 @@ 'description' => '数据结构', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '11A61389-F896-5231-A4FB-074D9E2E0055', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '表示是否调用成功。'."\n" - .'- **true**：调用成功。'."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据概览。', - 'example' => '{\'GatewayUniqueId\': \'gw-2b8ebd75dc554c37a4279ba9917379f2\', \'Id\': 417, \'GatewayTrafficPolicy\': {\'LoadBalancerSettings\': {\'LoadbalancerType\': \'ROUND_ROBIN\'}, \'TlsSetting\': {\'TlsMode\': \'DISABLE\'}}}', - '$ref' => '#/components/schemas/GatewayService', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '73785414-2C5B-5E28-BD91-B2C742269C48'], + 'HttpStatusCode' => ['description' => 'HTTP返回码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应描述', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '337'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoPermission'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '更新网关路由', + '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\\": \\"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' => '更新服务流量策略', ], - 'UpdateGatewayServiceVersion' => [ - 'summary' => '更新修改服务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteAuth' => [ + 'summary' => '更新路由鉴权配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '90281', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '575', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****'], ], [ - 'name' => 'ServiceVersion', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{\\"name\\":\\"v3\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v3\\"}]}', - ], + 'schema' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '109'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102'], + ], + [ + 'name' => 'AuthJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', + 'description' => '鉴权配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '鉴权类型（传空字符串代表关闭）：'."\n" + ."\n" + .'- JWT', 'type' => 'string', 'required' => false, 'example' => 'JWT'], + ], 'required' => true, - 'docRequired' => true, - 'example' => 'gw-eccf313e2224438ba53d95d039e5****', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'title' => 'RestResult>', + 'description' => 'RestResult>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D6580AA6-E285-58D2-B00B-12C051B3B7BF', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '节点数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '614', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'DynamicCode' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" + .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", 'type' => 'string', 'example' => 'The specified parameter is invalid.'], + 'Data' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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 \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": 123\\n}","type":"json"}]', + 'title' => '更新路由鉴权配置', + '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\\": \\"D6580AA6-E285-58D2-B00B-12C051B3B7BF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": 614\\n}","type":"json"}]', - 'title' => '更新服务版本', ], - 'ListServiceSource' => [ - 'summary' => '查询已关联来源列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteCORS' => [ + 'summary' => '修改网关路由跨域策略。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24908', - 'abilityTreeNodes' => [ - 'FEATUREmse5GGXKF', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '101484', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c51a15c7ee934a4fb945ccf35fe1****', - ], + 'schema' => ['description' => '关联记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '55'], ], [ - 'name' => 'Source', + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85'], + ], + [ + 'name' => 'CorsJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '获取指定服务来源类型（为空返回所有类型）：'."\n" - .'- 容器服务：K8s'."\n" - .'- MSE Nacos：MSE'."\n" - .'- MSE ZooKeeper：MSE_ZK'."\n" - .'- SAE 注册中心：SAE'."\n" - .'- EDAS 注册中心：EDAS', - 'type' => 'string', + 'description' => '跨域信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '开启状态。', 'type' => 'string', 'required' => false, 'example' => 'off'], + 'AllowOrigins' => ['description' => '允许的域。', 'type' => 'string', 'required' => false, 'example' => 'https://api.aliyun-inc.com/'], + 'AllowMethods' => ['description' => '允许的方法。', 'type' => 'string', 'required' => false, 'example' => 'GET,POST'], + 'AllowHeaders' => ['description' => '允许的Header。', 'type' => 'string', 'required' => false, 'example' => 'content-type'], + 'ExposeHeaders' => ['description' => '允许的响应头部。', 'type' => 'string', 'required' => false, 'example' => '*'], + 'TimeUnit' => ['description' => '时间单位。', 'type' => 'string', 'required' => false, 'example' => 'h'], + 'UnitNum' => ['description' => '时间数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24'], + 'AllowCredentials' => ['description' => '允许携带凭证。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], 'required' => false, - 'example' => 'MSE', ], ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-f70a6ddf2f0941a2bb997b2d16028f37'], + ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '参照国际标准 [RFC7231](https://tools.ietf.org/html/rfc7231)，后端服务需要按用户语言要求返回结果'."\n" + .'* 默认值：无'."\n" + .'* 中文：zh-CN'."\n" + .'* 英文：en-US', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B8C4B0D8-EBB9-5F20-8295-04224FBE5529', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Address' => [ - 'description' => 'ACK ID或MSE注册中心地址。', - 'type' => 'string', - 'example' => '***', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'NACOS', - ], - 'Source' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'example' => 'MSE', - ], - 'BindingWithGateway' => [ - 'description' => '是否完成绑定。'."\n" - .'（数值1表示完成绑定）', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'SourceUniqueId' => [ - 'description' => '来源唯一标识。', - 'type' => 'string', - 'example' => 'mse-cn-***', - ], - 'IngressOptions' => [ - 'description' => '应用路由Ingress支持。', - 'type' => 'object', - 'properties' => [ - 'EnableIngress' => [ - 'description' => '开启或关闭Ingress。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IngressClass' => [ - 'description' => 'Ingress Class。', - 'type' => 'string', - 'example' => 'com.test.xxx', - ], - 'WatchNamespace' => [ - 'description' => '监听命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'EnableStatus' => [ - 'description' => '是否更新IngressStatus。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'GatewayUniqueId' => [ - 'description' => '网关UniqueId。', - 'type' => 'string', - 'example' => 'gw-2u9uhd9283hd92hgd39g239dg2*****', - ], - 'GroupList' => [ - 'description' => '服务分组数组。', - 'type' => 'array', - 'items' => [ - 'description' => '服务分组。', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - ], - 'PathList' => [ - 'description' => '服务列表根路径数组。', - 'type' => 'array', - 'items' => [ - 'description' => '服务列表根路径。', - 'type' => 'string', - 'example' => '/path', - ], - ], - 'Invalid' => [ - 'title' => '来源是否有效', - 'description' => '来源是否有效', - 'type' => 'boolean', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '41BE990E-44E4-5ED3-AEEB-A276941B1854'], + 'HttpStatusCode' => ['description' => 'HTTP返回码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '报错信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation. '], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。 '."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '数据结构。', 'type' => 'integer', 'format' => 'int64', 'example' => '618'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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' => '修改网关路由跨域策略', + '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\\": \\"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' => '查询网关已关联的服务来源列表', ], - 'ListGatewayService' => [ - 'summary' => '查询网关已订阅的服务列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteHTTPRewrite' => [ + 'summary' => '更新网关路由的重写策略。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '25193', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '59359', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '路由ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '238'], ], [ - 'name' => 'PageSize', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '430'], ], [ - 'name' => 'OrderItem', + 'name' => 'HttpRewriteJSON', 'in' => 'query', - 'schema' => [ - 'description' => '排序属性。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreate', - ], + 'schema' => ['description' => 'HTTP重写信息，支持JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"pathType":"PRE","path":"/","status":"off"}'], ], [ - 'name' => 'DescSort', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '排序。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '网关唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-90392d768a3847a7b804c505254da96d'], ], [ - 'name' => 'FilterParams', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '过滤条件，格式为{"key1":"value1"}。', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '服务名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => '分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'ServiceProtocol' => [ - 'description' => '服务协议。'."\n" - ."\n" - .'- HTTP'."\n" - ."\n" - .'- HTTPS'."\n" - ."\n" - .'- HTTP2'."\n" - ."\n" - .'- GRPC'."\n" - ."\n" - .'- DUBBO', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'HTTP2' => 'HTTP2', - 'HTTPS' => 'HTTPS', - 'HTTP' => 'HTTP', - 'DUBBO' => 'DUBBO', - 'GRPC' => 'GRPC', - ], - 'example' => 'HTTP', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F46CDBA4-B1EE-5C94-8A48-51C10177****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '每页最大记录数，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => '返回集合。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => '服务名。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => '分组。', - 'type' => 'string', - 'example' => 'test', - ], - 'SourceId' => [ - 'description' => '来源ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ServiceNameInRegistry' => [ - 'description' => '注册中心中原服务名。', - 'type' => 'string', - 'example' => 'test', - ], - 'MetaInfo' => [ - 'description' => '元信息或IP列表。', - 'type' => 'string', - 'example' => '{}', - ], - 'Ips' => [ - 'description' => 'IP列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'IP。', - 'type' => 'string', - 'example' => '127.0.2.1', - ], - ], - 'GmtCreate' => [ - 'description' => '记录创建时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => '记录修改时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'Versions' => [ - 'description' => '服务版本。', - 'type' => 'array', - 'items' => [ - 'description' => '版本。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '版本名。', - 'type' => 'string', - 'example' => 'v1', - ], - ], - ], - ], - 'ServiceProtocol' => [ - 'description' => '服务协议。', - 'type' => 'string', - 'example' => 'HTTP', - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'HealehStatus' => [ - 'description' => '健康状态。'."\n" - ."\n" - .'- Health'."\n" - ."\n" - .'- Unhealthy'."\n" - ."\n" - .'- Unknown', - 'type' => 'string', - 'example' => 'Unhealthy', - ], - 'HealthStatus' => [ - 'description' => '健康状态。'."\n" - ."\n" - .'- Health'."\n" - ."\n" - .'- Unhealthy'."\n" - ."\n" - .'- Unknown', - 'type' => 'string', - 'example' => 'Unhealthy', - ], - 'HealthCheck' => [ - 'description' => '是否进行健康检查。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HealthCheckInfo' => [ - 'description' => '健康检查信息。', - 'type' => 'object', - 'properties' => [ - 'Check' => [ - 'description' => '是否检查。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Protocol' => [ - 'description' => '网络协议。', - 'type' => 'string', - 'example' => 'TCP', - ], - 'Timeout' => [ - 'description' => '超时时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Interval' => [ - 'description' => '健康检查间隔。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'HealthyThreshold' => [ - 'description' => '健康阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UnhealthyThreshold' => [ - 'description' => '非健康阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'HttpPath' => [ - 'description' => '健康检查HTTP请求路径。', - 'type' => 'string', - 'example' => '/health', - ], - 'HttpHost' => [ - 'description' => '健康检查HTTP请求地址。', - 'type' => 'string', - 'example' => 'http://172.168.0.1', - ], - 'ExpectedStatuses' => [ - 'description' => '健康检查期望状态值。', - 'type' => 'array', - 'items' => [ - 'description' => '期望的HttpStatus。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - ], - ], - ], - 'UnhealthyEndpoints' => [ - 'description' => '非健康endpoint数组', - 'type' => 'array', - 'items' => [ - 'description' => '非健康endpoint', - 'type' => 'string', - 'example' => '172.168.0.1', - ], - ], - 'GatewayTrafficPolicy' => [ - 'description' => '流量管理策略。', - 'type' => 'object', - 'properties' => [ - 'Tls' => [ - 'description' => 'TLS。', - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => 'DISABLE, SIMPLE, MUTUAL, ISTIO_MUTUAL', - 'description' => 'TLS模式。'."\n" - ."\n" - .'- DISABLE'."\n" - ."\n" - .' - SIMPLE'."\n" - ."\n" - .'- MUTUAL'."\n" - ."\n" - .'- ISTIO_MUTUAL', - 'type' => 'string', - 'example' => 'SIMPLE', - ], - 'CertId' => [ - 'description' => '证书ID。', - 'type' => 'string', - 'example' => '5******-cn-hangzhou', - ], - 'CaCertId' => [ - 'description' => 'CA证书ID。', - 'type' => 'string', - 'example' => '5******-cn-hangzhou', - ], - 'CaCertContent' => [ - 'description' => 'CA证书公钥。', - 'type' => 'string', - 'example' => 'content', - ], - 'SubjectAltNames' => [ - 'description' => '主体别名数组。', - 'type' => 'array', - 'items' => [ - 'description' => '主体别名。', - 'type' => 'string', - 'example' => 'name', - ], - ], - 'Sni' => [ - 'description' => '服务名称标识。', - 'type' => 'string', - 'example' => 'name-sni', - ], - ], - ], - 'LoadBalancerSettings' => [ - 'description' => '负载均衡设置。', - 'type' => 'object', - 'properties' => [ - 'LoadbalancerType' => [ - 'title' => 'ROUND_ROBIN, LEAST_CONN, RANDOM, CONSISTENT_HASH', - 'description' => '负载均衡策略'."\n" - ."\n" - .'- ROUND_ROBIN'."\n" - ."\n" - .' - LEAST_CONN'."\n" - ."\n" - .' - RANDOM'."\n" - ."\n" - .' - CONSISTENT_HASH', - 'type' => 'string', - 'example' => 'RANDOM', - ], - 'ConsistentHashLBConfig' => [ - 'description' => '一致性哈希配置。', - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'param', - ], - 'HttpCookie' => [ - 'description' => '基于Cookie的参数。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'cookie名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'Path' => [ - 'description' => 'cookie路径。', - 'type' => 'string', - 'example' => '/path', - ], - 'Ttl' => [ - 'description' => 'cookie生命周期。', - 'type' => 'string', - 'example' => '360', - ], - ], - ], - 'MinimumRingSize' => [ - 'description' => '哈希环最小值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ConsistentHashLBType' => [ - 'title' => 'HEADER, COOKIE, SOURCE_IP, QUERY_PARAMETER', - 'description' => '一致性哈希的方式。'."\n" - ."\n" - .'- HEADER'."\n" - ."\n" - .' - COOKIE'."\n" - ."\n" - .' - SOURCE_IP'."\n" - ."\n" - .' - QUERY_PARAMETER', - 'type' => 'string', - 'example' => 'HEADER', - ], - ], - ], - 'WarmupDuration' => [ - 'description' => '最小请求数的预热时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - 'Ports' => [ - 'description' => '端口数组。', - 'type' => 'array', - 'items' => [ - 'description' => '端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - ], - 'ServiceFQDN' => [ - 'type' => 'string', - ], - 'DnsServerList' => [ - 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'description' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'type' => 'array', - 'items' => [ - 'title' => 'DNS服务器地址（IP+端口）', - 'description' => 'DNS服务器地址（IP+端口）', - 'type' => 'string', - 'example' => '1.1.1.1:80', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AE60DA1E-B234-5105-897B-68372453A5A2'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据', 'type' => 'integer', 'format' => 'int64', 'example' => '411'], ], ], ], ], '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', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], ], - ], - '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' => '查询网关已订阅的服务列表', - ], - 'GetMseSource' => [ - 'summary' => '查询已有MSE Nacos。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24939', - 'abilityTreeNodes' => [ - 'FEATUREmseZM8SC5', - 'FEATUREmseRZJSHZ', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1t50e045b5g7i3p****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'MSE引擎类型：'."\n" - ."\n" - .'- NACOS'."\n" - ."\n" - .'- ZOOKEEPER', - 'type' => 'string', - 'required' => false, - 'example' => 'NACOS', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '英文', - 'zh' => '中文', - ], - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5EB2D865-B43F-5526-8F92-857718CF73A2', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n" - .'- 当请求成功时，返回成功信息。'."\n" - .'- 当请求失败时，返回失败原因，例如：TaskId not found。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'mse_prepaid_public_cn-7pp2eec****', - ], - 'Address' => [ - 'description' => '链接地址。', - 'type' => 'string', - 'example' => 'mse-af1****-nacos-ans.mse.aliyuncs.com:8848', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'Nacos', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'ClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'mse_', - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '查询MSE Nacos来源', - ], - 'GetKubernetesSource' => [ - 'summary' => '获取当前所有ACK集群来源信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '24906', - 'abilityTreeNodes' => [ - 'FEATUREmseE7U1OL', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c5d1aadb7df646cfb7065fbf75c1****', - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => '专有网络vpcid。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1t50e045b5g7i3p****', - ], - ], - [ - 'name' => 'IsAll', - 'in' => 'query', - 'schema' => [ - 'description' => '是否获取所有K8s集群（false时只获取未被关联的集群）。', - 'type' => 'boolean', - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'ACK集群名称。', - 'type' => 'string', - 'example' => 'k8s-demo', - ], - 'Cluster' => [ - 'description' => 'ACK集群ID。', - 'type' => 'string', - 'example' => 'cbc1efca895a64af097ff00b26f3f****', - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '查询ACK集群来源信息', - ], - 'GetGatewayServiceDetail' => [ - 'summary' => '查询服务详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '39518', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], - 'parameters' => [ - [ - 'name' => 'ServiceId', - 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '35', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-f4c960ad071a48a790b36324394c****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9802C54E-5CC5-5706-927B-993DBB6DCF2F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SourceType' => [ - 'description' => '服务来源', - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'SourceId' => [ - 'description' => '来源ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServiceNameInRegistry' => [ - 'description' => '服务注册到注册中心的名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'MetaInfo' => [ - 'description' => '服务的基本信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'Ips' => [ - 'description' => '服务IP地址。', - 'type' => 'array', - 'items' => [ - 'description' => 'IP。', - 'type' => 'string', - 'example' => '127.0.1.12', - ], - ], - 'Versions' => [ - 'description' => '服务版本号（已废弃）。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Label' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => 'version', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'v1', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'LabelDetails' => [ - 'description' => '标签详情。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => 'label', - ], - 'Values' => [ - 'description' => '标签值。', - 'type' => 'array', - 'items' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'v1', - ], - ], - ], - ], - ], - 'VersionDetails' => [ - 'description' => '版本详细。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'ServiceVersion' => [ - 'description' => '服务版本。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '版本名。', - 'type' => 'string', - 'example' => 'v2', - ], - 'Labels' => [ - 'description' => '标签。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签。', - 'type' => 'string', - 'example' => 'version', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'v2', - ], - ], - ], - ], - ], - ], - 'EndpointNum' => [ - 'description' => '实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EndpointNumPercent' => [ - 'description' => '实例百分比。', - 'type' => 'string', - 'example' => '20%', - ], - ], - ], - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GatewayTrafficPolicy' => [ - 'description' => '服务流量策略。', - 'example' => '{}', - '$ref' => '#/components/schemas/TrafficPolicy', - ], - 'HealthStatus' => [ - 'description' => '健康检查状态。', - 'type' => 'string', - 'example' => 'true', - ], - 'HealthCheck' => [ - 'description' => '是否健康检查。', - 'type' => 'string', - 'example' => 'true', - ], - 'ServiceProtocol' => [ - 'description' => '服务协议。', - 'type' => 'string', - 'example' => 'HTTP', - ], - 'Ports' => [ - 'description' => '服务端口数组。', - 'type' => 'array', - 'items' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - ], - 'PortTrafficPolicyList' => [ - 'description' => '服务端口流量策略。', - 'type' => 'array', - 'items' => [ - 'description' => '端口流量策略对象。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '端口配置ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - 'GatewayUniqueId' => [ - 'description' => '网关UniqueId。', - 'type' => 'string', - 'example' => 'gw-2837hfd91h34dbg87364g*****', - ], - 'TrafficPolicy' => [ - 'description' => '流量策略。', - '$ref' => '#/components/schemas/TrafficPolicy', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '1667460287386', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '1667460287386', - ], - ], - ], - ], - 'ServiceFQDN' => [ - 'type' => 'string', - ], - 'ServicePort' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DnsServerList' => [ - 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'description' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'type' => 'array', - 'items' => [ - 'title' => 'DNS服务器地址（IP+端口）', - 'description' => 'DNS服务器地址（IP+端口）', - 'type' => 'string', - 'example' => '1.1.1.1:80', - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '查询网关服务详情', - ], - 'UpdateServiceSource' => [ - 'summary' => '修改云原生网关服务来源，目前仅支持对含有Ingress监听配置的ACK容器服务进行修改操作。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '24909', - 'abilityTreeNodes' => [ - 'FEATUREmseQRG9VI', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '429', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '类型。'."\n" - ."\n" - .'- 容器服务为K8s。'."\n" - .'- NACOS为NACOS。', - 'type' => 'string', - 'required' => false, - 'example' => 'K8s', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '来源。'."\n" - ."\n" - .'- 容器服务为K8s。'."\n" - .'- NACOS为MSE。', - 'type' => 'string', - 'required' => false, - 'example' => 'K8s', - ], - ], - [ - 'name' => 'Address', - 'in' => 'query', - 'schema' => [ - 'description' => '地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'c9ad2a0717032427e920754e25b49e3b5', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '服务来源ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '63', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'istio', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-cdd1bb9bfb8341e9805f931a3ba1f4c6', - ], - ], - [ - 'name' => 'IngressOptionsRequest', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Ingress配置。', - 'type' => 'object', - 'properties' => [ - 'EnableIngress' => [ - 'description' => '是否开启Ingress。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'IngressClass' => [ - 'description' => '监听Ingress Class。', - 'type' => 'string', - 'required' => false, - 'example' => 'com.test.xxx', - ], - 'WatchNamespace' => [ - 'description' => '监听目标命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'EnableStatus' => [ - 'description' => '是否更新Ingress Status。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'PathList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '服务根路径数组。', - 'type' => 'array', - 'items' => [ - 'description' => '服务根路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/path', - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型。'."\n" - .'- zh：中文。'."\n" - .'- en：英文。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6AB2B0B6-4A86-54E2-A340-FC47A22EE659', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下。'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '63', - ], - ], - ], - ], - ], - '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\\": \\"6AB2B0B6-4A86-54E2-A340-FC47A22EE659\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 63\\n}","type":"json"}]', - 'title' => '更新服务来源', - ], - 'ImportServices' => [ - 'summary' => '订阅导入网关的服务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '25182', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], - 'parameters' => [ - [ - 'name' => 'ServiceList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '服务列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '服务名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => '分组。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Ips' => [ - 'description' => 'IP列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'IP。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.XX.XX', - ], - 'required' => false, - ], - 'ServicePort' => [ - 'title' => '服务的端口', - 'description' => '服务的端口。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8080', - ], - 'ServiceProtocol' => [ - 'title' => '服务的协议版本', - 'description' => '服务的协议版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'GRPC, HTTP', - ], - 'DnsServerList' => [ - 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'type' => 'array', - 'items' => [ - 'title' => 'DNS服务器地址（IP+端口）', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.1.1:80', - ], - 'required' => false, - ], - 'SaeAppId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - 'example' => 'DNS', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '服务来源', - 'description' => '服务来源：'."\n" - ."\n" - .'- MSE（MSE-NACOS）'."\n" - .'- K8s（ACK容器服务）'."\n" - .'- VIP（固定地址）'."\n" - .'- DNS（DNS域名）', - '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', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5', - ], - ], - [ - 'name' => 'TlsSetting', - 'in' => 'query', - 'schema' => [ - 'description' => 'TLS设定。'."\n" - ."\n" - .'- TLS模式：mode'."\n" - ."\n" - .'- 证书ID：certId'."\n" - ."\n" - .'- CA证书ID：caCertId'."\n" - ."\n" - .'- CA证书公钥：caCertContent'."\n" - ."\n" - .'- 服务名称标识：sni', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "mode": "MUTUAL",'."\n" - .' "certId": "1*****-cn-hangzhou",'."\n" - .' "caCertContent": "123",'."\n" - .' "sni": "ceshi"'."\n" - .'}', - ], - ], - [ - 'name' => 'FcServiceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'FC服务名称，服务来源为“FC 函数计算”时使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'guide', - ], - ], - [ - 'name' => 'FcVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'FC服务版本号，服务来源为“FC 函数计算”时使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'LATEST', - ], - ], - [ - 'name' => 'FcAlias', - 'in' => 'query', - 'schema' => [ - 'description' => 'FC服务别名，服务来源为“FC 函数计算”时使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-alias', - ], - ], - [ - 'name' => 'SourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '服务来源ID，指定来源添加服务时使用', - 'description' => '服务来源ID，指定来源添加服务时使用', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - '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\\": \\"0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => '创建网关服务', - ], - 'UpdateGatewayService' => [ - 'summary' => '编辑网关服务（仅适用于固定地址服务 / DNS域名服务）', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '25309', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '322', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '501', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '服务名称（已废弃，不支持修改，调用时需要和当前服务名称保持一致）。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'IpList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '服务地址列表（固定地址服务）/ 域名列表（DNS域名服务）', - 'type' => 'array', - 'items' => [ - 'description' => '服务地址（固定地址服务）/ 域名（DNS域名服务）', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.1:80', - ], - 'required' => false, - ], - ], - [ - 'name' => 'ServicePort', - 'in' => 'query', - 'schema' => [ - 'description' => '服务端口（DNS域名服务填写）。', - 'type' => 'string', - 'required' => false, - 'example' => '80', - ], - ], - [ - 'name' => 'ServiceProtocol', - 'in' => 'query', - 'schema' => [ - 'description' => '服务协议。'."\n" - ."\n" - .'- HTTP'."\n" - ."\n" - .'- HTTPS'."\n" - ."\n" - .'- HTTP2'."\n" - ."\n" - .'- GRPC'."\n" - ."\n" - .'- DUBBO', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', - ], - ], - [ - 'name' => 'TlsSetting', - 'in' => 'query', - 'schema' => [ - 'description' => 'TLS设定。'."\n" - ."\n" - .'- TLS模式：mode'."\n" - ."\n" - .'- 证书ID：certId'."\n" - ."\n" - .'- CA证书ID：caCertId'."\n" - ."\n" - .'- CA证书公钥：caCertContent'."\n" - ."\n" - .'- 服务名称标识：sni', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "mode": "MUTUAL",'."\n" - .' "certId": "1*****-cn-hangzhou",'."\n" - .' "caCertContent": "123",'."\n" - .' "sni": "ceshi"'."\n" - .'}', - ], - ], - [ - 'name' => 'DnsServerList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'description' => 'DNS服务器列表（仅供DNS域名服务使用）', - 'type' => 'array', - 'items' => [ - 'title' => 'DNS服务器地址（IP+端口）', - 'description' => 'DNS服务器地址（IP+端口）', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.1.1:80', - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '322', - ], - ], - ], - ], - ], - '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\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 322\\n}","type":"json"}]', - 'title' => '编辑网关服务', - ], - 'PullServices' => [ - 'summary' => '查询指定来源可导入服务信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '25181', - 'abilityTreeNodes' => [ - 'FEATUREmseY699NS', - ], - ], - 'parameters' => [ - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '服务来源类型。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'K8S' => 'K8S', - 'MSE' => 'MSE', - ], - 'example' => 'K8S', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-eccf313e2224438ba53d95d039e5****', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'public', - ], - ], - [ - 'name' => 'SourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '服务来源ID', - 'description' => '服务来源ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => '分组。', - 'type' => 'string', - 'example' => 'test', - ], - 'Services' => [ - 'description' => '服务列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。'."\n" - ."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '服务名。', - 'type' => 'string', - 'example' => 'test', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => '分组。', - 'type' => 'string', - 'example' => 'test', - ], - 'SourceId' => [ - 'description' => '来源ID。', - 'type' => 'string', - 'example' => '1', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'example' => 'MSE', - ], - 'SourceIdList' => [ - 'title' => '归属的服务来源ID列表', - 'description' => '归属的服务来源ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '归属的服务来源ID', - 'description' => '归属的服务来源ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - 'SaeAppId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'NamespaceShowName' => [ - 'description' => '命名空间别名。', - 'type' => 'string', - 'example' => 'public', - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '查询指定来源可导入服务信息', - ], - 'UpdateGatewayServiceCheck' => [ - 'summary' => '更新云原生网关指定服务的健康检查策略。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'ServiceId', - 'in' => 'query', - 'schema' => [ - 'title' => '服务ID', - 'description' => '服务ID', - 'type' => 'string', - 'required' => false, - 'example' => '12', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID', - 'description' => '网关唯一ID', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-8d410698bd7f4628ab76b*****72dd1d', - ], - ], - [ - 'name' => 'Check', - 'in' => 'query', - 'schema' => [ - 'title' => '是否开启健康检查', - 'description' => '是否开启健康检查', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'ExpectedStatuses', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '正常状态码（健康检查协议为HTTP时必填）', - 'description' => '正常状态码（健康检查协议为HTTP时必填）', - 'type' => 'array', - 'items' => [ - 'title' => '用于判断健康检查正常的HTTP状态码：'."\n" - .'- http_2xx: 200'."\n" - .'- http_3xx: 300'."\n" - .'- http_4xx: 400'."\n" - .'- http_5xx: 500', - 'description' => '用于判断健康检查正常的HTTP状态码（健康检查协议为HTTP时必填）：'."\n" - .'- http_2xx: 200'."\n" - .'- http_3xx: 300'."\n" - .'- http_4xx: 400'."\n" - .'- http_5xx: 500', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Protocol', - 'in' => 'query', - 'schema' => [ - 'title' => '健康检查协议，目前支持：'."\n" - .'- HTTP'."\n" - .'- TCP', - 'description' => '健康检查协议，目前支持：'."\n" - .'- HTTP'."\n" - .'- TCP', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], - ], - [ - 'name' => 'Timeout', - 'in' => 'query', - 'schema' => [ - 'title' => '健康检查响应超时时间（秒）', - 'description' => '健康检查响应超时时间（秒）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'title' => '健康检查间隔时间（秒）', - 'description' => '健康检查间隔时间（秒）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'HealthyThreshold', - 'in' => 'query', - 'schema' => [ - 'title' => '健康检查健康阈值', - 'description' => '健康检查健康阈值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'UnhealthyThreshold', - 'in' => 'query', - 'schema' => [ - 'title' => '健康检查不健康阈值', - 'description' => '健康检查不健康阈值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'HttpPath', - 'in' => 'query', - 'schema' => [ - 'title' => '健康检查路径（健康检查协议为HTTP时必填）', - 'description' => '健康检查路径（健康检查协议为HTTP时必填）', - 'type' => 'string', - 'required' => false, - 'example' => '/healthz', - ], - ], - [ - 'name' => 'HttpHost', - 'in' => 'query', - 'schema' => [ - 'title' => '健康检查域名', - 'description' => '健康检查域名（健康检查协议为HTTP时选填）', - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '62CBFCB8-DDC6-588C-BF1B-88828AF*****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：true：请求成功。 false：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '操作的服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - ], - ], - ], - ], - '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\\": \\"62CBFCB8-DDC6-588C-BF1B-88828AF*****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 12\\n}","type":"json"}]', - 'title' => '更新服务健康检查策略', - ], - 'UpdateGatewayRouteAuth' => [ - 'summary' => '更新路由鉴权配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '109', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '102', - ], - ], - [ - 'name' => 'AuthJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '鉴权配置。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '鉴权类型（传空字符串代表关闭）：'."\n" - ."\n" - .'- JWT', - 'type' => 'string', - 'required' => false, - 'example' => 'JWT', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], - ], - ], - '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\\": \\"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' => '更新路由鉴权配置', - ], - 'ListGatewayAuthConsumerResource' => [ - 'summary' => '获取网关鉴权消费者的授权列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], - ], - [ - 'name' => 'ConsumerId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - ], - [ - 'name' => 'RouteName', - 'in' => 'query', - 'schema' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'ResourceStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '资源状态：'."\n" - ."\n" - .'- true：启用'."\n" - ."\n" - .'- false：停用', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页的大小。', - 'type' => 'string', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - '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' => '鉴权消费者授权ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ConsumerId' => [ - 'description' => '网关鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3091', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceStatus' => [ - 'description' => '资源授权状态：'."\n" - ."\n" - .'- true：启用'."\n" - ."\n" - .'- false：停用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识。', - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '获取网关鉴权消费者的授权列表', - ], - 'UpdateGatewayAuthConsumer' => [ - 'summary' => '更新网关鉴权消费者。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-90392d768a3847a7b804c505254d****', - ], - ], - [ - 'name' => 'EncodeType', - 'in' => 'query', - 'schema' => [ - 'description' => '加密类型：'."\n" - ."\n" - .'- RSA'."\n" - ."\n" - .'- OCT', - 'type' => 'string', - 'required' => false, - 'example' => 'RSA', - ], - ], - [ - 'name' => 'Jwks', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT公钥，支持JSON格式。', - '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"}]}', - ], - ], - [ - 'name' => 'TokenName', - 'in' => 'query', - 'schema' => [ - 'description' => '要校验的Token参数信息的名称，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', - ], - ], - [ - 'name' => 'TokenPass', - 'in' => 'query', - 'schema' => [ - 'description' => '是否透传。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'TokenPosition', - 'in' => 'query', - 'schema' => [ - 'description' => '要校验的Token参数信息的位置，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', - ], - ], - [ - 'name' => 'TokenPrefix', - 'in' => 'query', - 'schema' => [ - 'description' => '要校验的Token参数信息的前缀，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer ', - ], - ], - [ - 'name' => 'KeyName', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT内身份标识KeyName。', - 'type' => 'string', - 'required' => false, - 'example' => 'iss', - ], - ], - [ - 'name' => 'KeyValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT内身份标识KeyValue。', - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者描述。', - 'type' => 'string', - 'required' => false, - 'example' => '这是描述', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '63', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。'."\n" - ."\n", - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - ], - ], - '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\\": \\"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' => '更新网关鉴权消费者', - ], - 'ListGatewayRouteOnAuth' => [ - 'summary' => '获取开启鉴权的路由列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT', - 'type' => 'string', - 'required' => true, - 'example' => 'JWT', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'array', - 'items' => [ - 'description' => '节点数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Name' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'ceshi', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'string', - 'example' => '399', - ], - 'RoutePredicates' => [ - 'description' => '路由匹配。', - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => '路由匹配。', - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'example' => '/api', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - ], - 'DomainId' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235', - ], - 'DomainName' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => '123.com', - ], - 'DomainIdList' => [ - 'description' => '域名ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '域名ID列表。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'DomainNameList' => [ - 'description' => '域名列表。', - 'type' => 'array', - 'items' => [ - 'description' => '域名列表。', - 'type' => 'string', - 'example' => 'test.com', - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '获取开启鉴权的路由列表', - ], - 'ListGatewayAuthConsumer' => [ - 'summary' => '获取网关鉴权消费者列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-0fe488252dc44d55a9dd57875193****', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT', - 'type' => 'string', - 'required' => false, - 'example' => 'JWT', - ], - ], - [ - 'name' => 'ConsumerStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者状态：'."\n" - ."\n" - .'- true：启用'."\n" - ."\n" - .'- false：停用', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页数值。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页的大小。', - 'type' => 'string', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'dc63-465d-8ef5-20dc18af****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%**s**。'."\n" - ."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则表示所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - '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' => '鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => '鉴权消费者名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'ConsumerStatus' => [ - 'description' => '鉴权消费者状态：'."\n" - ."\n" - .'- true：启用'."\n" - ."\n" - .'- false：停用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PrimaryUser' => [ - 'description' => '创建人。', - 'type' => 'string', - 'example' => '123', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'Type' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT', - 'type' => 'string', - 'example' => 'JWT', - ], - 'Description' => [ - 'description' => '鉴权消费者描述。', - 'type' => 'string', - 'example' => '描述', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-09-13 19:24:23', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '获取网关鉴权消费者列表', - ], - 'UpdateGatewayAuthConsumerResource' => [ - 'summary' => '更新网关鉴权消费者的授权列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => 'UpdateGatewayAuthConsumerResource', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], - ], - [ - 'name' => 'ConsumerId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - ], - [ - 'name' => 'ResourceList', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'json', - 'schema' => [ - 'description' => '资源列表。', - 'type' => 'array', - 'items' => [ - 'description' => '资源列表。', - 'type' => 'object', - 'properties' => [ - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '7816', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'helo', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%**s**。'."\n" - ."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则表示所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '执行是否成功：'."\n" - ."\n" - .'- true：成功'."\n" - ."\n" - .'- false：失败', - '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\\": \\"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' => [ - 'summary' => '更新网关鉴权消费者状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-685f661467b54f48b7b7a76605ce****', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'ConsumerStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者状态：'."\n" - ."\n" - .'- true：启用'."\n" - ."\n" - .'- false：停用', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '56D9E600-6348-4260-B35F-583413F****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '执行是否成功：'."\n" - ."\n" - .'- true：成功'."\n" - ."\n" - .'- false：失败', - '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\\": \\"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' => '更新网关鉴权消费者状态', - ], - 'AddGatewayAuthConsumer' => [ - 'summary' => '新增网关鉴权消费者。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT', - 'type' => 'string', - 'required' => true, - 'example' => 'JWT', - ], - ], - [ - 'name' => 'EncodeType', - 'in' => 'query', - 'schema' => [ - 'description' => '加密类型：'."\n" - ."\n" - .'- RSA'."\n" - ."\n" - .'- OCT', - 'type' => 'string', - 'required' => false, - 'example' => 'RSA', - ], - ], - [ - 'name' => 'Jwks', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT公钥，支持JSON格式。', - '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"}]}', - ], - ], - [ - 'name' => 'TokenName', - 'in' => 'query', - 'schema' => [ - 'description' => '要校验的Token参数信息的名称，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', - ], - ], - [ - 'name' => 'TokenPass', - 'in' => 'query', - 'schema' => [ - 'description' => '是否透传。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'TokenPosition', - 'in' => 'query', - 'schema' => [ - 'description' => '要校验的Token参数信息的位置，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', - ], - ], - [ - 'name' => 'TokenPrefix', - 'in' => 'query', - 'schema' => [ - 'description' => '要校验的Token参数信息的前缀，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer ', - ], - ], - [ - 'name' => 'KeyName', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT内身份标识KeyName。', - 'type' => 'string', - 'required' => false, - 'example' => 'iss', - ], - ], - [ - 'name' => 'KeyValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT内身份标识KeyValue。', - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP返回码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数 `ErrMessage` 错误信息中的 `%s`。'."\n" - ."\n" - .'> 如果`ErrMessage`返回`The Value of Input Parameter %s is not valid`，且`DynamicMessage`返回`DtsJobId`，则代表所传入的请求参数`DtsJobId`不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - ], - ], - '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\\": \\"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' => '新增网关鉴权消费者', - ], - 'DeleteGatewayAuthConsumerResource' => [ - 'summary' => '删除网关鉴权消费者的授权。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n", - ], - ], - [ - 'name' => 'ConsumerId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - ], - [ - 'name' => 'IdList', - 'in' => 'query', - 'schema' => [ - 'description' => '用户删除指定的授权ID列表。', - 'type' => 'string', - 'required' => true, - 'example' => '1,2,3,4', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '执行是否成功：'."\n" - ."\n" - .'- true：成功'."\n" - ."\n" - .'- false：失败', - '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\\": \\"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' => '删除网关鉴权消费者的授权', - ], - 'UpdateGatewayAuthConsumerResourceStatus' => [ - 'summary' => '更新网关鉴权消费者的授权状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-2a99625886d54722be94d92e9a69****', - ], - ], - [ - 'name' => 'ConsumerId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - ], - [ - 'name' => 'IdList', - 'in' => 'query', - 'schema' => [ - 'description' => '用户更新指定的授权ID列表。', - 'type' => 'string', - 'required' => true, - 'example' => '1,2,3,4', - ], - ], - [ - 'name' => 'ResourceStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '资源状态：'."\n" - ."\n" - .'- true：启用'."\n" - ."\n" - .'- false：停用', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数 `ErrMessage` 错误信息中的 `%s`。'."\n" - ."\n" - .'> 如果`ErrMessage`返回`The Value of Input Parameter %s is not valid`，且`DynamicMessage`返回`DtsJobId`，则代表所传入的请求参数`DtsJobId`不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '执行是否成功：'."\n" - ."\n" - .'- true：成功'."\n" - ."\n" - .'- false：失败', - '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\\": \\"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' => [ - 'summary' => '删除网关鉴权消费者。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '网关鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '执行是否成功：'."\n" - ."\n" - .'- true：成功'."\n" - ."\n" - .'- false：失败', - '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\\": \\"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' => '删除网关鉴权消费者', - ], - 'GetGatewayAuthConsumerDetail' => [ - 'summary' => '获取网关鉴权消费者细节。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-1a4ab101d5924b6f92c5ec98a84*****', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '120', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'mse-100-000', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => '鉴权消费者名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'ConsumerStatus' => [ - 'description' => '鉴权消费者状态：'."\n" - ."\n" - .'- true：启用'."\n" - ."\n" - .'- false：停用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PrimaryUser' => [ - 'description' => '创建人。', - 'type' => 'string', - 'example' => '123', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'Type' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT', - 'type' => 'string', - 'example' => 'JWT', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2023-02-01 14:17:57', - ], - 'GmtModified' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2023-03-01 14:17:57', - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => '描述', - ], - 'EncodeType' => [ - 'description' => '加密类型：'."\n" - ."\n" - .'- RSA'."\n" - ."\n" - .'- OCT', - 'type' => 'string', - 'example' => 'RSA', - ], - 'Jwks' => [ - 'description' => 'JWT公钥，支持JSON格式。', - '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' => '要校验的Token参数信息的名称，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'TokenPass' => [ - 'description' => '是否透传。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TokenPosition' => [ - 'description' => '要校验的Token参数信息的位置，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'example' => 'HEADER', - ], - 'TokenPrefix' => [ - 'description' => '要校验的Token参数信息的前缀，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'example' => 'Bearer ', - ], - 'KeyName' => [ - 'description' => 'JWT内身份标识KeyName。', - 'type' => 'string', - 'example' => 'iss', - ], - 'KeyValue' => [ - 'description' => 'JWT内身份标识KeyValue。', - 'type' => 'string', - 'example' => 'abcd', - ], - 'ResourceList' => [ - 'description' => '资源列表', - 'type' => 'array', - 'items' => [ - 'description' => '资源列表', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '鉴权消费者授权ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'ConsumerId' => [ - 'description' => '网关鉴权消费者ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3458', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceStatus' => [ - 'description' => '资源授权状态：'."\n" - ."\n" - .'- true：启用'."\n" - ."\n" - .'- false：停用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-4822033a8513496fa10f05c934f*****', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-12-06 01:38:03', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2022-12-06 01:38:03', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '获取网关鉴权消费者细节', - ], - 'AddBlackWhiteList' => [ - 'summary' => '添加黑白名单。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '36594', - 'abilityTreeNodes' => [ - 'FEATUREmseWSG2U5', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-0fe488252dc44d55a9dd57875193****', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '生效粒度：'."\n" - .'- GATEWAY：网关全局'."\n" - .'- DOMAIN：域名'."\n" - .'- ROUTE：路由', - 'type' => 'string', - 'required' => false, - 'example' => 'GATEWAY', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '黑白名单类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], - ], - [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'description' => '黑名单内容。', - 'type' => 'string', - 'required' => false, - 'example' => '1.117.115.51', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '黑名单状态描述。'."\n" - ."\n" - .'- on 开启'."\n" - .'- off 关闭', - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], - ], - [ - 'name' => 'IsWhite', - 'in' => 'query', - 'schema' => [ - 'description' => '是否白名单（默认为否）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ResourceIdJsonList', - 'in' => 'query', - 'schema' => [ - 'description' => '资源ID列表JSON。', - 'type' => 'string', - 'required' => false, - 'example' => '[123]', - ], - ], - [ - 'name' => 'Note', - 'in' => 'query', - 'schema' => [ - 'description' => '备注。', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a note', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '966F6CA7-16D0-50AB-AB02-E140934F90C1', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - ], - ], - '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\\": \\"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' => '添加黑白名单', - ], - 'UpdateBlackWhiteList' => [ - 'summary' => '更新网关黑白名单。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '36595', - 'abilityTreeNodes' => [ - 'FEATUREmseWSG2U5', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '黑名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '绑定资源作用范围。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'GATEWAY', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '黑白名单资源类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], - ], - [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'description' => '黑名单内容。', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.2.11', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启状态。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '关闭', - 'on' => '开启', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', - ], - ], - [ - 'name' => 'IsWhite', - 'in' => 'query', - 'schema' => [ - 'description' => '是否白名单（默认为否）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'ResourceIdJsonList', - 'in' => 'query', - 'schema' => [ - 'description' => '资源ID列表JSON。', - 'type' => 'string', - 'required' => false, - 'example' => '[123]', - ], - ], - [ - 'name' => 'Note', - 'in' => 'query', - 'schema' => [ - 'description' => '备注。', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a note', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AD5DEDA0-C82A-50D9-AF54-BD3576CCFB4C', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '请求消息', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], - ], - ], - ], - ], - '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\\": \\"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' => '更新网关黑白名单', - ], - 'GatewayBlackWhiteList' => [ - 'summary' => '获取网关黑白名单列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页数。取值范围：大于0的整数。默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页显示条数。默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], - ], - [ - 'name' => 'FilterParams', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'parse from filterParams', - 'description' => 'parse from filterParams', - 'type' => 'object', - 'properties' => [ - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '81', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID（和GatewayId同时存在时优先使用GatewayId）。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'ResourceType' => [ - 'description' => '暂未开放使用。', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'Type' => [ - 'description' => '暂未开放使用。', - 'type' => 'string', - 'required' => false, - 'example' => ' ""', - ], - 'IsWhite' => [ - 'description' => '暂未开放使用。', - 'type' => 'boolean', - 'required' => false, - 'example' => ' ""', - ], - 'SearchType' => [ - 'description' => '查询类型：'."\n" - ."\n" - .'- ROUTE：按路由搜索，SearchContent填写路由名'."\n" - ."\n" - .'- DOMAIN：按域名搜索，SearchContent填写域名'."\n" - ."\n" - .'- IP：按指定IP搜索，SearchContent填写IP', - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], - 'SearchContent' => [ - 'description' => '搜索内容。', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.1.1', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'OrderItem', - 'in' => 'query', - 'schema' => [ - 'description' => '暂未开放使用。', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - ], - [ - 'name' => 'DescSort', - 'in' => 'query', - 'schema' => [ - 'description' => '暂未开放使用。', - 'type' => 'boolean', - 'required' => false, - 'example' => '""', - 'default' => 'false', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - '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' => [ - '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' => '1', - ], - 'Result' => [ - 'description' => '返回集合。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '黑白名单ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'ResourceType' => [ - 'description' => '生效粒度：'."\n" - .'- GATEWAY：网关全局'."\n" - .'- DOMAIN：域名'."\n" - .'- ROUTE：路由', - 'type' => 'string', - 'example' => 'GATEWAY', - ], - 'Content' => [ - 'description' => '黑名单内容。', - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'IsWhite' => [ - 'description' => '是否白名单。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Type' => [ - 'description' => '黑白名单类型，当前固定为IP黑白名单。', - 'type' => 'string', - 'example' => 'IP', - ], - 'Status' => [ - 'description' => '黑白名单状态。'."\n" - ."\n" - .'- on：开启'."\n" - ."\n" - .'- off：关闭', - 'type' => 'string', - 'example' => 'on', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2024-08-02T02:43:40.000+0000', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2024-08-02T02:43:40.000+0000', - ], - 'ResourceIdJsonList' => [ - 'description' => '资源ID列表JSON。'."\n" - ."\n" - .'- 若ResourceType为ROUTE，则为路由ID列表'."\n" - ."\n" - .'- 若ResourceType为DOMAIN，则为域名ID列表', - 'type' => 'string', - 'example' => '[234]', - ], - 'Note' => [ - 'description' => '备注。', - 'type' => 'string', - 'example' => '禁止的IP列表', - ], - 'ResourceIdNameJson' => [ - 'description' => '资源名称描述。', - 'type' => 'string', - 'example' => '{}', - ], - 'Name' => [ - 'description' => '黑名单名称。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '获取网关黑白名单列表', - ], - 'DeleteBlackWhiteList' => [ - 'summary' => '删除黑白名单', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '36597', - 'abilityTreeNodes' => [ - 'FEATUREmseWSG2U5', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '430', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '黑白名单id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '120', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一id', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '黑白名单id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'ResourceId' => [ - 'description' => '已废弃', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ResourceType' => [ - 'description' => '生效粒度：'."\n" - ."\n" - .'- GATEWAY：网关全局'."\n" - ."\n" - .'- DOMAIN：域名'."\n" - ."\n" - .'- ROUTE：路由', - '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' => '开启状态：'."\n" - ."\n" - .'- 0：关闭'."\n" - ."\n" - .'- 1：开启', - 'type' => 'boolean', - 'example' => '1', - ], - 'GatewayId' => [ - 'description' => '网关id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '430', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一id', - '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', - ], - ], - ], - ], - ], - ], - ], - '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 \\"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"}]', - 'title' => '删除黑白名单', - ], - 'GetBlackWhiteList' => [ - 'summary' => '查询网关黑白名单。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '36934', - 'abilityTreeNodes' => [ - 'FEATUREmseWSG2U5', - ], - ], - 'parameters' => [ - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '范围类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'GATEWAY', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-32d5c9769c1842b1a2cc3426c59e****', - ], - ], - [ - 'name' => 'IsWhite', - 'in' => 'query', - 'schema' => [ - 'description' => '是否白名单。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '89CBC928-4F57-51FA-A413-EE0F4CD87200', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. ', - ], - 'Code' => [ - 'description' => '状态码。说明 200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '节点数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '275', - ], - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ResourceType' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'GATEWAY', - ], - 'Content' => [ - 'description' => '黑名单内容。', - 'type' => 'string', - 'example' => 'text', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'IP', - ], - 'IsWhite' => [ - 'description' => '是否为白名单。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => '黑白名单状态。', - 'type' => 'string', - 'example' => 'on', - ], - 'GatewayId' => [ - 'description' => '网关id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。'."\n", - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - ], - ], - ], - ], - ], - ], - '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' => [ - 'substitutions' => [ - 'mse::2019-05-31::GatewayBlackWhiteList', - ], - ], - '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' => '查询网关黑白名单', - ], - 'AddGatewayAuth' => [ - 'summary' => '创建网关鉴权。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '37105', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT'."\n" - .'- OIDC'."\n" - .'- IDaaS'."\n" - .'- ExternalAuthZ（自建的鉴权服务）', - 'type' => 'string', - 'required' => false, - 'example' => 'JWT', - ], - ], - [ - 'name' => 'Issuer', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型为JWT/OIDC时使用：'."\n" - ."\n" - .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" - .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', - 'type' => 'string', - 'required' => false, - 'example' => 'https://example.com/auth', - ], - ], - [ - 'name' => 'Jwks', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT公钥，支持JSON格式。', - '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"}]}', - ], - ], - [ - 'name' => 'TokenPosition', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT Token类型：'."\n" - ."\n" - .'- HEADER：通过Header传输'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：Authorization: Bearer token。', - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', - ], - ], - [ - 'name' => 'TokenName', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT Token保存的位置。'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', - ], - ], - [ - 'name' => 'TokenNamePrefix', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT Token的前缀。'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer ', - ], - ], - [ - 'name' => 'TokenPass', - 'in' => 'query', - 'schema' => [ - 'description' => '是否透传Token。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'IsWhite', - 'in' => 'query', - 'schema' => [ - 'description' => '授权黑白名单模式：'."\n" - ."\n" - .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" - .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '未开放参数，无需传递（鉴权创建后默认为关闭状态）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'RedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', - 'type' => 'string', - 'required' => false, - 'example' => 'https://test-.com/oauth2/callback', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => '服务注册的应用ID（OIDC/IDaaS使用）。', - 'type' => 'string', - 'required' => false, - 'example' => '23460e2fdd9bf9ad106****', - ], - ], - [ - 'name' => 'ClientSecret', - 'in' => 'query', - 'schema' => [ - 'description' => '服务注册的应用Secret（OIDC/IDaaS使用）。', - 'type' => 'string', - 'required' => false, - 'example' => '123****', - ], - ], - [ - 'name' => 'CookieDomain', - 'in' => 'query', - 'schema' => [ - 'description' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态。'."\n" - ."\n" - .'例如：设置`Cookie-domain=a.example.com`，则Cookie会发送到域名`a.example.com`；设置`Cookie-domain=.example.com`，则Cookie会发送到`example.com`的所有子域名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - ], - ], - [ - 'name' => 'ScopesList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'OIDC授权作用域（OIDC使用）。', - 'type' => 'array', - 'items' => [ - 'description' => 'OIDC授权作用域', - 'type' => 'string', - 'required' => false, - 'example' => 'openid', - ], - 'required' => false, - ], - ], - [ - 'name' => 'LoginUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'IDaaS实例用户登录页地址（IDaaS使用）。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://daxxxxcn.aliyunidaas.com/', - ], - ], - [ - 'name' => 'Sub', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型为JWT时使用；JWT claims 的sub（subject），即主体，请确保JWT的Payload中的sub字段的值与此处配置的值一致。如果该参数未设置或者为空，那么默认与Issuer参数设置的值一致', - 'type' => 'string', - 'required' => false, - 'example' => 'testing@secure.istio.io', - ], - ], - [ - 'name' => 'ExternalAuthZJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '自定义鉴权信息。', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '鉴权服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1343', - ], - 'PrefixPath' => [ - 'description' => '鉴权服务提供的鉴权API的Path，API的Path需是前缀匹配。', - 'type' => 'string', - 'required' => false, - 'example' => '/auth', - ], - 'TokenKey' => [ - 'description' => 'Token处于请求报文中哪个Header中，常见的有Authorization和Cookie。', - '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' => '自定义鉴权模式：'."\n" - ."\n" - .'- true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关拒绝客户端请求'."\n" - .'- false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关放过客户端请求', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'WithRequestBody' => [ - 'description' => '是否允许携带Body。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'BodyMaxBytes' => [ - 'description' => 'Body的最大字节数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4000000', - ], - 'WithRematchRoute' => [ - 'type' => 'boolean', - 'required' => false, - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-*****9b04bb4474cae9d645be850e3d7', - ], - ], - [ - 'name' => 'AuthResourceMode', - 'in' => 'query', - 'schema' => [ - 'title' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'description' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AuthResourceConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '复杂模式的YAML配置', - 'description' => '复杂模式的YAML配置', - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'AuthResourceList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', - 'type' => 'array', - 'items' => [ - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'DomainId' => [ - 'description' => '规则内域名的ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1765', - ], - 'Path' => [ - 'description' => '规则的匹配路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'MatchType' => [ - 'description' => '请求Path的匹配类型：'."\n" - ."\n" - .'- EQUAL：精确匹配'."\n" - .'- PRE：前缀匹配'."\n" - .'- ERGULAR：正则匹配', - 'type' => 'string', - 'required' => false, - 'example' => 'EQUAL', - ], - 'IgnoreCase' => [ - 'description' => '路径是否开启大小写敏感（创建自定义鉴权时使用，其他鉴权类型默认开启大小写敏感）'."\n" - ."\n" - .'- true：开启大小写敏感'."\n" - .'- false：关闭大小写敏感', - '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' => '匹配条件：'."\n" - ."\n" - .'- EQUAL：等于'."\n" - .'- NOT_EQUAL：不等于'."\n" - .'- EXIST：存在'."\n" - .'- NOT_EXIST：不存在'."\n" - .'- INCLUDE：包含'."\n" - .'- EXCLUDE：不包含'."\n" - .'- PREFIX：前缀'."\n" - .'- SUFFIX：后缀'."\n" - .'- REGREX：正则', - 'type' => 'string', - 'required' => false, - 'example' => 'EQUAL', - ], - 'HeaderValue' => [ - 'description' => '请求头的值。', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4279C00F-A5E1-53C6-A43B-751C1C524D0B', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => '用于和Success同步，当Success为true时，Code为200。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '创建的鉴权ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '333', - ], - ], - ], - ], - ], - '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', - ], - ], - ], - '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' => '创建网关鉴权', - ], - 'UpdateGatewayAuth' => [ - 'summary' => '更新网关鉴权', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '37106', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT'."\n" - .'- OIDC'."\n" - .'- IDaaS'."\n" - .'- ExternalAuthZ（自建的鉴权服务）', - 'type' => 'string', - 'required' => false, - 'example' => 'ExternalAuthZ', - ], - ], - [ - 'name' => 'Issuer', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型为JWT/OIDC时使用：'."\n" - ."\n" - .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" - .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Jwks', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT公钥，支持JSON格式。', - '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"}]}', - ], - ], - [ - 'name' => 'TokenPosition', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT Token类型：'."\n" - ."\n" - .'- HEADER：通过Header传输'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：Authorization: Bearer token。', - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', - ], - ], - [ - 'name' => 'TokenName', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT Token保存的位置。'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'Authorization', - ], - ], - [ - 'name' => 'TokenNamePrefix', - 'in' => 'query', - 'schema' => [ - 'description' => 'JWT Token的前缀。'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer', - ], - ], - [ - 'name' => 'TokenPass', - 'in' => 'query', - 'schema' => [ - 'description' => '是否透传Token。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '启用状态。'."\n" - ."\n" - .'- 未启用：false'."\n" - ."\n" - .'- 启用：true', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权规则id。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '719', - ], - ], - [ - 'name' => 'RedirectUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', - 'type' => 'string', - 'required' => false, - 'example' => 'https://test-.com/oauth2/callback', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => '服务注册的应用ID（OIDC/IDaaS使用）。', - 'type' => 'string', - 'required' => false, - 'example' => 'app_mnvxaavggw7hcdcnr6usi6***', - ], - ], - [ - 'name' => 'ClientSecret', - 'in' => 'query', - 'schema' => [ - 'description' => '在OIDC认证服务中注册的应用secret。', - 'type' => 'string', - 'required' => false, - 'example' => 'CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****', - ], - ], - [ - 'name' => 'CookieDomain', - 'in' => 'query', - 'schema' => [ - 'description' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态。'."\n" - ."\n" - .'例如：设置`Cookie-domain=a.example.com`，则Cookie会发送到域名`a.example.com`；设置`Cookie-domain=.example.com`，则Cookie会发送到`example.com`的所有子域名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - ], - ], - [ - 'name' => 'ScopesList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'OIDC授权作用域（OIDC使用）。', - 'type' => 'array', - 'items' => [ - 'description' => 'OIDC授权作用域（OIDC使用）。', - 'type' => 'string', - 'required' => false, - 'example' => 'openid', - ], - 'required' => false, - ], - ], - [ - 'name' => 'LoginUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'IDaaS实例用户登录页地址（IDaaS使用）。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://daxxxxcn.aliyunidaas.com/', - ], - ], - [ - 'name' => 'Sub', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权类型为JWT时使用；JWT claims 的sub（subject），即主体，请确保JWT的Payload中的sub字段的值与此处配置的值一致。如果该参数未设置或者为空，那么默认与Issuer参数设置的值一致', - 'type' => 'string', - 'required' => false, - 'example' => 'example-app', - ], - ], - [ - 'name' => 'ExternalAuthZJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '自定义鉴权信息。', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '鉴权服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '37396', - ], - 'PrefixPath' => [ - 'description' => '鉴权服务提供的鉴权API的Path，API的Path需是前缀匹配。', - 'type' => 'string', - 'required' => false, - 'example' => '/auth', - ], - 'TokenKey' => [ - 'description' => 'Token处于请求报文中哪个Header中，常见的有Authorization和Cookie。', - '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' => '自定义鉴权模式：'."\n" - ."\n" - .'- true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关拒绝客户端请求'."\n" - .'- false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关放过客户端请求', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'WithRequestBody' => [ - 'description' => '是否允许携带Body。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'BodyMaxBytes' => [ - 'description' => 'Body的最大字节数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4000000', - ], - 'WithRematchRoute' => [ - 'description' => '是否在鉴权完成后重新匹配路由。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', - ], - ], - [ - 'name' => 'IsWhite', - 'in' => 'query', - 'schema' => [ - 'description' => '授权黑白名单模式：'."\n" - ."\n" - .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" - .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AuthResourceMode', - 'in' => 'query', - 'schema' => [ - 'title' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'description' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AuthResourceConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '复杂模式的YAML配置', - 'description' => '复杂模式的YAML配置', - 'type' => 'string', - 'required' => false, - 'example' => '\'\'', - ], - ], - [ - 'name' => 'AuthResourceList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', - 'type' => 'array', - 'items' => [ - 'description' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '资源记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'DomainId' => [ - 'description' => '规则内域名的ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1765', - ], - 'Path' => [ - 'description' => '规则的匹配路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'MatchType' => [ - 'description' => '请求Path的匹配类型：'."\n" - ."\n" - .'- EQUAL：精确匹配'."\n" - .'- PRE：前缀匹配'."\n" - .'- ERGULAR：正则匹配', - 'type' => 'string', - 'required' => false, - 'example' => 'EQUAL', - ], - 'IgnoreCase' => [ - 'description' => '路径是否开启大小写敏感（创建自定义鉴权时使用，其他鉴权类型默认开启大小写敏感）'."\n" - ."\n" - .'- true：开启大小写敏感'."\n" - .'- false：关闭大小写敏感', - 'type' => 'boolean', - 'required' => false, - ], - 'AuthResourceHeaderList' => [ - 'description' => '规则的请求头（当前仅供自定义鉴权使用）', - 'type' => 'array', - 'items' => [ - 'description' => '规则的请求头（当前仅供自定义鉴权使用）', - 'type' => 'object', - 'properties' => [ - 'HeaderKey' => [ - 'description' => '请求头名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'x-req', - ], - 'HeaderMethod' => [ - 'description' => '匹配条件：'."\n" - ."\n" - .'- EQUAL：等于'."\n" - .'- NOT_EQUAL：不等于'."\n" - .'- EXIST：存在'."\n" - .'- NOT_EXIST：不存在'."\n" - .'- INCLUDE：包含'."\n" - .'- EXCLUDE：不包含'."\n" - .'- PREFIX：前缀'."\n" - .'- SUFFIX：后缀'."\n" - .'- REGREX：正则', - 'type' => 'string', - 'required' => false, - 'example' => 'EQUAL', - ], - 'HeaderValue' => [ - 'description' => '请求头的值。', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'DeleteResourceIdList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '删除的资源记录ID列表', - 'type' => 'array', - 'items' => [ - 'description' => '删除的资源记录ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => 'code仅仅用来和success同步。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '鉴权规则ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '719', - ], - ], - ], - ], - ], - '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', - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - '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"}]', - 'title' => '更新网关鉴权', - ], - 'GetGatewayAuthDetail' => [ - 'summary' => '获取网关鉴权详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '37108', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '鉴权ID', - 'description' => '鉴权ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1100', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'title' => '网关ID（和网关唯一ID二选一）', - 'description' => '网关ID（和网关唯一ID二选一）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2274', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID（和网关ID二选一，网关唯一ID不为空时优先使用网关唯一ID查询）', - 'description' => '网关唯一ID（和网关ID二选一，网关唯一ID不为空时优先使用网关唯一ID查询）', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：'."\n" - .'* zh（默认值）：中文'."\n" - .'* en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6', - ], - 'HttpStatusCode' => [ - 'title' => 'HTTP 状态码。', - 'description' => 'HTTP 状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '信息。', - 'description' => '信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'title' => '用于和Success同步，当Success为true时，Code为200', - 'description' => '用于和Success同步，当Success为true时，Code为200', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '请求是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'title' => '鉴权详情', - 'description' => '鉴权详情', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '鉴权ID', - 'description' => '鉴权ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1100', - ], - 'Name' => [ - 'title' => '鉴权名称', - 'description' => '鉴权名称', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'title' => '鉴权所属网关的唯一ID', - 'description' => '鉴权所属网关的唯一ID', - 'type' => 'string', - 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', - ], - 'GatewayId' => [ - 'title' => '鉴权所属网关的ID', - 'description' => '鉴权所属网关的ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2274', - ], - 'Type' => [ - 'title' => '鉴权类型：'."\n" - ."\n" - .'- JWT'."\n" - .'- OIDC'."\n" - .'- IDaaS'."\n" - .'- ExternalAuthZ（自建的鉴权服务）', - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT'."\n" - .'- OIDC'."\n" - .'- IDaaS'."\n" - .'- ExternalAuthZ（自建的鉴权服务）', - 'type' => 'string', - 'example' => 'JWT', - ], - 'Issuer' => [ - 'title' => '鉴权类型为JWT/OIDC时使用：'."\n" - ."\n" - .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" - .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', - 'description' => '鉴权类型为JWT/OIDC时使用：'."\n" - ."\n" - .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" - .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', - 'type' => 'string', - 'example' => 'https://example.com/auth', - ], - 'Jwks' => [ - 'title' => 'JWT公钥，JSON格式', - 'description' => 'JWT公钥，JSON格式', - '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' => '授权黑白名单模式：'."\n" - ."\n" - .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" - .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtCreate' => [ - 'title' => '鉴权创建的GMT时间', - 'description' => '鉴权创建的GMT时间', - 'type' => 'string', - 'example' => '2024-02-19T02:41:03.000+0000', - ], - 'GmtModified' => [ - 'title' => '鉴权修改的GMT时间', - 'description' => '鉴权修改的GMT时间', - 'type' => 'string', - 'example' => '2024-02-19T02:41:03.000+0000', - ], - 'TokenPosition' => [ - 'title' => 'JWT Token类型：'."\n" - ."\n" - .'- HEADER：通过Header传输', - 'description' => 'JWT Token类型：'."\n" - ."\n" - .'- HEADER：通过Header传输', - 'type' => 'string', - 'example' => 'HEADER', - ], - 'TokenName' => [ - 'title' => 'JWT Token保存的位置', - 'description' => 'JWT Token保存的位置', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'TokenNamePrefix' => [ - 'title' => 'JWT Token的前缀', - 'description' => 'JWT Token的前缀', - 'type' => 'string', - 'example' => 'Bearer ', - ], - 'TokenPass' => [ - 'title' => '是否透传Token', - 'description' => '是否透传Token', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'title' => '鉴权是否开启', - 'description' => '鉴权是否开启', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RedirectUrl' => [ - 'title' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', - 'description' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', - 'type' => 'string', - 'example' => 'https://yourdomain/path', - ], - 'ClientId' => [ - 'title' => '服务注册的应用ID（OIDC/IDaaS使用）。', - 'description' => '服务注册的应用ID（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'example-app', - ], - 'ClientSecret' => [ - 'title' => '服务注册的应用Secret（OIDC/IDaaS使用）。', - 'description' => '服务注册的应用Secret（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'CookieDomain' => [ - 'title' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态（OIDC/IDaaS使用）。', - 'description' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'hello.com', - ], - 'ScopesList' => [ - 'title' => 'OIDC 作用域（OIDC 使用）。', - 'description' => 'OIDC作用域（OIDC使用）。', - 'type' => 'string', - 'example' => '["openid","email"]', - ], - 'LoginUrl' => [ - 'title' => 'IDaaS实例用户登录页地址（IDaaS使用）。', - 'description' => 'IDaaS实例用户登录页地址（IDaaS使用）。', - 'type' => 'string', - 'example' => 'https://daxxxxcn.aliyunidaas.com/', - ], - 'Sub' => [ - 'title' => '鉴权类型为JWT时使用；JWT claims 的sub(subject)，即主体。', - 'description' => '鉴权类型为JWT时使用；JWT claims 的sub(subject)，即主体。', - 'type' => 'string', - 'example' => 'https://example.com/auth', - ], - 'ExternalAuthZ' => [ - 'title' => '自定义鉴权信息', - 'description' => '自定义鉴权信息', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'title' => '鉴权服务ID', - 'description' => '鉴权服务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15300', - ], - 'PrefixPath' => [ - 'title' => '鉴权API的Path', - 'description' => '鉴权API的Path', - 'type' => 'string', - 'example' => '/auth', - ], - 'TokenKey' => [ - 'title' => 'Token位置，表示Token位于请求报文中哪个Header中，常见的有Authorization和Cookie', - 'description' => 'Token位置，表示Token位于请求报文中哪个Header中，常见的有Authorization和Cookie', - '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' => '自定义鉴权模式：'."\n" - ."\n" - .'- true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关拒绝客户端请求'."\n" - .'- false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关放过客户端请求', - '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' => '是否允许携带Body', - 'type' => 'boolean', - 'example' => 'true', - ], - 'BodyMaxBytes' => [ - 'title' => 'Body的最大字节数', - 'description' => 'Body的最大字节数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4000000', - ], - 'WithRematchRoute' => [ - 'type' => 'boolean', - ], - ], - ], - 'ResourceList' => [ - 'title' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', - 'description' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', - 'type' => 'array', - 'items' => [ - 'description' => '鉴权的授权规则。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '授权规则ID', - 'description' => '授权规则ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1303', - ], - 'AuthId' => [ - 'title' => '规则所归属鉴权的ID', - 'description' => '规则所归属鉴权的ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2274', - ], - 'DomainId' => [ - 'title' => '规则内域名的ID', - 'description' => '规则内域名的ID', - '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' => '授权黑白名单模式：'."\n" - ."\n" - .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" - .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GatewayId' => [ - 'title' => '规则所属网关的ID', - 'description' => '规则所属网关的ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2274', - ], - 'GatewayUniqueId' => [ - 'title' => '规则所属网关的唯一ID', - 'description' => '规则所属网关的唯一ID', - 'type' => 'string', - 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', - ], - 'GmtCreate' => [ - 'title' => '授权规则的创建GMT时间', - 'description' => '授权规则的创建GMT时间', - 'type' => 'string', - 'example' => '2024-02-19T03:32:38.000+0000', - ], - 'GmtModified' => [ - 'title' => '授权规则的修改GMT时间', - 'description' => '授权规则的修改GMT时间', - 'type' => 'string', - 'example' => '2024-02-19T03:32:38.000+0000', - ], - 'MatchType' => [ - 'title' => '请求Path的匹配类型：'."\n" - ."\n" - .'- EQUAL：精确匹配'."\n" - .'- PRE：前缀匹配'."\n" - .'- ERGULAR：正则匹配', - 'description' => '请求Path的匹配类型：'."\n" - ."\n" - .'- EQUAL：精确匹配'."\n" - .'- PRE：前缀匹配'."\n" - .'- ERGULAR：正则匹配', - 'type' => 'string', - 'example' => 'EQUAL', - ], - 'IgnoreCase' => [ - 'title' => '路径是否开启大小写敏感'."\n" - ."\n" - .'- true：开启大小写敏感'."\n" - .'- false：关闭大小写敏感', - 'description' => '路径是否开启大小写敏感'."\n" - ."\n" - .'- true：开启大小写敏感'."\n" - .'- false：关闭大小写敏感', - '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' => '匹配条件：'."\n" - ."\n" - .'- EQUAL：等于'."\n" - .'- NOT_EQUAL：不等于'."\n" - .'- EXIST：存在'."\n" - .'- NOT_EXIST：不存在'."\n" - .'- INCLUDE：包含'."\n" - .'- EXCLUDE：不包含'."\n" - .'- PREFIX：前缀'."\n" - .'- SUFFIX：后缀'."\n" - .'- REGREX：正则', - 'type' => 'string', - 'example' => 'EQUAL', - ], - 'HeaderValue' => [ - 'title' => '请求头的值', - 'description' => '请求头的值', - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - ], - ], - ], - 'AuthResourceMode' => [ - 'title' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'description' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'AuthResourceConfig' => [ - 'title' => '复杂模式的YAML配置', - 'description' => '复杂模式的YAML配置', - 'type' => 'string', - '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', - ], - ], - ], - ], - ], - ], - ], - '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', - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - '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' => '获取网关鉴权详情', - ], - 'ListGatewayAuth' => [ - 'summary' => '获取网关鉴权列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '37107', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页展示实例数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'OrderItem', - 'in' => 'query', - 'schema' => [ - 'description' => '暂未开放使用。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'DescSort', - 'in' => 'query', - 'schema' => [ - 'description' => '排序。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'FilterParams', - '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' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-5017305290e14centbrveca****', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EC1EED4A-B147-597B-B949-FD3131AB4298', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码。说明 200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - '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' => '鉴权id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'Name' => [ - 'description' => '鉴权规则名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'GatewayId' => [ - 'description' => '网关id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Type' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT'."\n" - .'- OIDC'."\n" - .'- IDaaS'."\n" - .'- ExternalAuthZ（自建的鉴权服务）', - 'type' => 'string', - 'example' => 'JWT', - ], - 'Issuer' => [ - 'description' => '鉴权类型为JWT/OIDC时使用：'."\n" - ."\n" - .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" - .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', - 'type' => 'string', - 'example' => 'https://example.com/auth', - ], - 'Jwks' => [ - 'description' => 'JWT公钥，JSON格式', - 'type' => 'string', - 'example' => '{\\"keys\\":[{\\"kty\\":\\"oct\\",\\"k\\":\\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\\",\\"alg\\":\\"HS256\\"}]}', - ], - 'TokenPosition' => [ - 'description' => 'JWT Token类型：'."\n" - ."\n" - .'- HEADER：通过Header传输'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：Authorization: Bearer token。', - 'type' => 'string', - 'example' => 'HEADER', - ], - 'TokenName' => [ - 'description' => 'JWT Token保存的位置。'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'TokenNamePrefix' => [ - 'description' => 'JWT Token的前缀。'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - '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' => '是否透传Token。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsWhite' => [ - 'description' => '授权黑白名单模式：'."\n" - ."\n" - .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" - .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => '启用状态。'."\n" - ."\n" - .'- 未启用：false'."\n" - ."\n" - .'- 启用：true', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RedirectUrl' => [ - 'description' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', - 'type' => 'string', - 'example' => 'http://test.com/oauth2/callback', - ], - 'ClientId' => [ - 'description' => '服务注册的应用ID（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'app_mnvxaavggw7hcdcnr6usi6***', - ], - 'ClientSecret' => [ - 'description' => '服务注册的应用Secret（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****', - ], - 'CookieDomain' => [ - 'description' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'test.com', - ], - 'ScopesList' => [ - 'description' => 'OIDC授权作用域（OIDC使用）。', - 'type' => 'string', - 'example' => '["openid"]', - ], - 'LoginUrl' => [ - 'description' => 'IDaaS实例用户登录页地址（IDaaS使用）。', - 'type' => 'string', - 'example' => ' '."\n" - .'https://daxxxxcn.aliyunidaas.com/', - ], - 'Sub' => [ - 'description' => '鉴权类型为JWT时使用；JWT claims 的sub(subject)，即主体。', - 'type' => 'string', - 'example' => 'example-app', - ], - 'ExternalAuthZ' => [ - 'description' => '自定义鉴权信息', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '鉴权服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45186', - ], - 'PrefixPath' => [ - 'description' => '鉴权服务提供的鉴权API的Path，API的Path需是前缀匹配。', - 'type' => 'string', - 'example' => '/auth', - ], - 'TokenKey' => [ - 'description' => 'Token位置，表示Token位于请求报文中哪个Header中，常见的有Authorization和Cookie', - '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' => '是否允许携带Body。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'WithRematchRoute' => [ - 'description' => '是否在鉴权完成后重新匹配路由。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'BodyMaxBytes' => [ - 'description' => 'Body的最大字节数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'IsRestrict' => [ - 'description' => '自定义鉴权模式：'."\n" - ."\n" - .'- true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关拒绝客户端请求'."\n" - .'- false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关放过客户端请求', - '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' => '授权资源模式：'."\n" - ."\n" - .'- 0：简单模式'."\n" - .'- 1：复杂模式', - 'type' => 'integer', - 'format' => 'int32', - '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', - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - '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"}]', - 'title' => '获取网关鉴权列表', - ], - 'DeleteGatewayAuth' => [ - 'summary' => '删除网关鉴权', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '37109', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '鉴权id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '120', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一id', - 'type' => 'string', - 'required' => false, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Code' => [ - 'description' => '用于和Success同步，当Success为true时，Code为200', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '鉴权id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'Name' => [ - 'description' => '鉴权名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一id', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'GatewayId' => [ - 'description' => '网关id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '399', - ], - 'Type' => [ - 'description' => '鉴权类型：'."\n" - ."\n" - .'- JWT'."\n" - .'- OIDC'."\n" - .'- IDaaS'."\n" - .'- ExternalAuthZ（自建的鉴权服务）', - 'type' => 'string', - 'example' => 'JWT', - ], - 'Issuer' => [ - 'description' => '鉴权类型为JWT/OIDC时使用：'."\n" - ."\n" - .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" - .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', - 'type' => 'string', - 'example' => 'https://example.com/auth', - ], - 'Jwks' => [ - 'description' => 'JWT公钥，JSON格式', - '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' => '授权黑白名单模式：'."\n" - ."\n" - .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" - .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', - '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' => 'JWT Token类型：'."\n" - ."\n" - .'- HEADER：通过Header传输'."\n" - ."\n" - .'要校验的Token参数信息，默认是以Bearer为前缀放在Authorization header中，例如：Authorization: Bearer token。', - 'type' => 'string', - 'example' => 'HEADER', - ], - 'TokenName' => [ - 'description' => '要校验的Token参数信息的名称，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。', - 'type' => 'string', - 'example' => 'Authorization', - ], - 'TokenNamePrefix' => [ - 'description' => 'JWT Token的前缀', - 'type' => 'string', - 'example' => 'Bearer ', - ], - 'TokenPass' => [ - 'description' => '是否透传Token', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => '启用状态。'."\n" - ."\n" - .'- 未启用：false'."\n" - ."\n" - .'- 启用：true', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RedirectUrl' => [ - 'description' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', - 'type' => 'string', - 'example' => 'https://yourdomain/path', - ], - 'ClientId' => [ - 'description' => '服务注册的应用ID（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'example-app', - ], - 'ClientSecret' => [ - 'description' => '服务注册的应用Secret（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'CookieDomain' => [ - 'description' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态（OIDC/IDaaS使用）。', - 'type' => 'string', - 'example' => 'test.com', - ], - 'ScopesList' => [ - 'description' => 'OIDC作用域（OIDC使用）。', - 'type' => 'array', - 'items' => [ - 'description' => 'OIDC作用域（OIDC使用）。', - 'type' => 'string', - 'example' => 'openid', - ], - ], - 'LoginUrl' => [ - 'description' => 'IDaaS实例用户登录页地址（IDaaS使用）。', - 'type' => 'string', - 'example' => 'https://daxxxxcn.aliyunidaas.com/', - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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"}]', - 'title' => '删除网关鉴权', - ], - 'AddAuthResource' => [ - 'summary' => '网关鉴权-创建授权信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '37110', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], - ], - 'parameters' => [ - [ - 'name' => 'AuthId', - 'in' => 'query', - 'schema' => [ - 'description' => '授权ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '13', - ], - ], - [ - 'name' => 'DomainId', - 'in' => 'query', - 'schema' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '128', - ], - ], - [ - 'name' => 'Path', - 'in' => 'query', - 'schema' => [ - 'description' => '路径。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '/abc', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', - ], - ], - [ - 'name' => 'MatchType', - 'in' => 'query', - 'schema' => [ - 'description' => '匹配类型。'."\n" - ."\n" - .'- 精确匹配：EQUAL'."\n" - ."\n" - .'- 前缀匹配：PRE'."\n" - ."\n" - .'- 正则匹配：ERGULAR', - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - [ - 'name' => 'IgnoreCase', - 'in' => 'query', - 'schema' => [ - 'description' => '是否忽略大小写。（默认为true）', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AuthResourceHeaderList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '鉴权资源头列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'HeaderKey' => [ - 'description' => 'HTTP头参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'Access-Control-Allow-Origin', - ], - 'HeaderMethod' => [ - 'description' => 'Header匹配方式。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SUFFIX' => '后缀', - 'EXIST' => '存在', - 'PREFIX' => '前缀', - 'EQUAL' => '等于', - 'EXCLUDE' => '不包含', - 'NOT_EQUAL' => '不等于', - 'NOT_EXIST' => '不存在', - 'REGREX' => '正则', - 'INCLUDE' => '包含', - ], - 'example' => 'EQUAL', - ], - 'HeaderValue' => [ - 'description' => 'HTTP头参数的取值。', - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4BBCF560-4DD7-5DBD-B849-CCB135BBBAB7', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据结构。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - ], - ], - ], - ], - '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\\": \\"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' => '添加鉴权资源', - ], - 'DeleteAuthResource' => [ - 'summary' => '删除授权资源。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '37111', - 'abilityTreeNodes' => [ - 'FEATUREmseFZIQVY', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '目标ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '36', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '559412D1-BFCE-53CC-B88E-0192C331EF44', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '主键ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AuthId' => [ - 'description' => '鉴权ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '253', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'DomainId' => [ - 'description' => '域ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235', - ], - 'DomainName' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => 'name', - ], - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'example' => '/zookeeper', - ], - 'IsWhite' => [ - 'description' => '是否为白名单。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'GmtModified' => [ - 'description' => '修改日期', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '删除网关授权资源', - ], - 'AddGatewayRoute' => [ - 'summary' => '添加网关路由。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '25612', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '526', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'RouteOrder', - 'in' => 'query', - 'schema' => [ - 'description' => '路由顺序。（数值越小优先级越高）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Predicates', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '匹配规则。', - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => '路由匹配。', - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'Type' => [ - 'description' => '路由匹配：'."\n" - ."\n" - .'- 前缀：PRE。'."\n" - .'- 精确：EQUAL。'."\n" - .'- 正则：ERGULAR。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => '忽略大小写。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'MethodPredicates' => [ - 'description' => '方法匹配。', - 'type' => 'array', - 'items' => [ - 'description' => '具体方法。', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - 'required' => false, - ], - 'HeaderPredicates' => [ - 'description' => '请求头匹配。', - 'type' => 'array', - 'items' => [ - 'description' => '请求头。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '请求头Key。', - 'type' => 'string', - 'required' => false, - 'example' => 'debug', - ], - 'Value' => [ - 'description' => '对应的Value。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'QueryPredicates' => [ - 'description' => 'URL参数匹配。', - 'type' => 'array', - 'items' => [ - 'description' => 'URL参数。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '参数名。', - 'type' => 'string', - 'required' => false, - 'example' => 'userid', - ], - 'Value' => [ - 'description' => '匹配值。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'Services', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '服务列表（路由指向为单服务、多服务、标签路由时填写）。', - 'type' => 'array', - 'items' => [ - 'description' => '服务列表。', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '353', - ], - 'Percent' => [ - 'description' => '当前服务/服务版本分流百分比（只在使用多服务、标签路由时填写）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'Version' => [ - 'description' => '服务版本（只在使用标签路由时填写）。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '服务所在命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => '服务分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => '协议类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'DUBBO', - ], - 'HttpDubboTranscoder' => [ - 'description' => 'Dubbo协议转换体。', - 'type' => 'object', - 'properties' => [ - 'DubboServiceName' => [ - 'description' => 'Dubbo服务名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', - ], - 'DubboServiceVersion' => [ - 'description' => 'Dubbot服务版本。', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0', - ], - 'DubboServiceGroup' => [ - 'description' => '服务组。', - 'type' => 'string', - 'required' => false, - 'example' => 'group', - ], - 'MothedMapList' => [ - 'description' => 'Dubbo转发规则列表。', - 'type' => 'array', - 'items' => [ - 'description' => '方法映射。', - 'type' => 'object', - 'properties' => [ - 'DubboMothedName' => [ - 'description' => 'Dubbo方法名。', - 'type' => 'string', - 'required' => false, - 'example' => 'sayHello', - ], - 'HttpMothed' => [ - 'description' => 'HTTP方法。'."\n" - .'> 支持HTTP方法参数值。'."\n" - .'> - ALL_GET。'."\n" - .'> - ALL_POST。'."\n" - .'> - ALL_PUT。'."\n" - .'> - ALL_DELETE。'."\n" - .'> - ALL_PATCH。', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_GET', - ], - 'Mothedpath' => [ - 'description' => '方法匹配路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/mytestzbk/sayhello', - ], - 'PassThroughAllHeaders' => [ - 'description' => 'Header透传类型。'."\n" - .'> 透传类型枚举值。'."\n" - .'> - 透传所有：PASS_ALL。'."\n" - .'> - 不透传：PASS_NOT。'."\n" - .'> - 指定参数：PASS_ASSIGN。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PASS_NOT', - ], - 'PassThroughList' => [ - 'description' => '指定透传Header列表', - 'type' => 'array', - 'items' => [ - 'description' => '指定Header透传值。', - 'type' => 'string', - 'required' => false, - 'example' => 'x-forward', - ], - 'required' => false, - ], - 'ParamMapsList' => [ - 'description' => '参数映射列表。', - 'type' => 'array', - 'items' => [ - 'description' => '参数映射体。', - 'type' => 'object', - 'properties' => [ - 'ExtractKeySpec' => [ - 'description' => '入参位置。'."\n" - .'> 入参位置枚举值。'."\n" - .'> - 请求参数：`ALL_QUERY_PARAMETER`'."\n" - .'- 请求头：`ALL_HEADER`'."\n" - .'- 请求路径：`ALL_PATH`'."\n" - .'- 请求体：`ALL_BODY`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_QUERY_PARAMETER', - ], - 'ExtractKey' => [ - 'description' => '入参位提取Key。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'MappingType' => [ - 'description' => '后端参数类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'java.lang.String', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '443', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'DomainId', - 'in' => 'query', - 'schema' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'DestinationType', - 'in' => 'query', - 'schema' => [ - 'description' => '目标服务类型。'."\n" - .'- Single：单服务'."\n" - .'- Multiple：多服务'."\n" - .'- VersionOriented：标签路由'."\n" - .'- Mock：Mock'."\n" - .'- Redirect：重定向', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'VersionOriented' => 'VersionOriented', - 'Multiple' => 'Multiple', - 'Single' => 'Single', - 'Redirect' => 'Redirect', - 'Mock' => 'Mock', - ], - 'example' => 'Multiple', - ], - ], - [ - 'name' => 'DirectResponseJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Mock响应配置。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'Mock返回码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '403', - ], - 'Body' => [ - 'description' => 'Mock返回值。', - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-492af9b04bb4474cae9d645be8*****', - ], - ], - [ - 'name' => 'DomainIdListJSON', - 'in' => 'query', - 'schema' => [ - 'description' => '域名列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[0,94]', - ], - ], - [ - 'name' => 'RedirectJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '重定向配置。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '302', - ], - 'Host' => [ - 'description' => '重定向主机名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - ], - 'Path' => [ - 'description' => '重定向路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'EnableWaf', - 'in' => 'query', - 'schema' => [ - 'description' => '已废弃，请使用UpdateGatewayRouteWafStatus更新路由WAF状态。', - 'type' => 'boolean', - 'deprecated' => true, - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Fallback', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启Fallback服务。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'FallbackServices', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Fallback服务。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '353', - ], - 'Percent' => [ - 'description' => '权重百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'Version' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '服务所在命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => '服务分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => '协议类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'DUBBO', - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '443', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'RouteType', - 'in' => 'query', - 'schema' => [ - 'description' => '路由类型：'."\n" - ."\n" - .'Op：管控路由。', - 'type' => 'string', - 'required' => false, - 'example' => 'Op', - ], - ], - [ - 'name' => 'Policies', - 'in' => 'query', - 'schema' => [ - 'description' => '路由策略JSON字符串。', - '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\\"}]}"}', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '路由描述', - 'description' => '路由描述', - 'type' => 'string', - 'required' => false, - 'example' => 'a route for xxx', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回代码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '创建的路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '555', - ], - 'ErrorCode' => [ - 'description' => '错误码。'."\n" - ."\n" - .'- InvalidParameter：参数错误：缺失、格式不对'."\n" - .'- IllegalRequest：请求非法：参数越权'."\n" - .'- NoPermission：权限专用'."\n" - .'- NotFound：资源404'."\n" - .'- InternalError：内部错误', - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - ], - ], - ], - ], - '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\\": \\"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' => '添加网关路由', - ], - 'DeleteGatewayRoute' => [ - 'summary' => '删除网关路由。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '25970', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', - ], - ], - 'parameters' => [ - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '路由条目ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '252', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'gw-492af9b04bb4474cae9d645be850e3d7', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '报错信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-5017305290e14cebbrvec4a5****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '125', - ], - 'Predicates' => [ - 'description' => '匹配规则', - 'type' => 'string', - 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}', - ], - 'DefaultServiceId' => [ - 'description' => '默认服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RouteOrder' => [ - 'description' => '路由顺序。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => '路由状态。'."\n" - .'- 未发布：0'."\n" - .'- 发布中：2'."\n" - .'- 已发布：3'."\n" - .'- 编辑中(有更新未发布)：4'."\n" - .'- 下线中：5'."\n" - .'- 不可用：6', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2021-12-30T06:41:52.000+0000', - ], - ], - ], - ], - ], - ], - ], - '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\\": \\"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' => '删除网关路由', - ], - 'UpdateGatewayRouteHTTPRewrite' => [ - 'summary' => '更新网关路由的重写策略。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '59359', - 'abilityTreeNodes' => [ - 'FEATUREmseXCPJ75', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '路由ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '238', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '430', - ], - ], - [ - 'name' => 'HttpRewriteJSON', - 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP重写信息，支持JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{"pathType":"PRE","path":"/","status":"off"}', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-90392d768a3847a7b804c505254da96d', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AE60DA1E-B234-5105-897B-68372453A5A2', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '411', - ], - ], - ], - ], - ], - '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\\": \\"AE60DA1E-B234-5105-897B-68372453A5A2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 411\\n}","type":"json"}]', - 'title' => '更新网关路由的重写策略', - ], - 'UpdateGatewayRoute' => [ - 'summary' => '更新网关路由。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '25973', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', - ], - ], - 'parameters' => [ - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '501', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '路由名称（已废弃，不支持修改路由名称，填入和当前不同的路由名称会导致更新失败）', - 'description' => '路由名称。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'route-web', - ], - ], - [ - 'name' => 'RouteOrder', - 'in' => 'query', - 'schema' => [ - 'description' => '路由顺序。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Predicates', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '路由匹配条件。', - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => 'Path匹配。', - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => '路由Path路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => '忽略大小写。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => true, - 'docRequired' => true, - ], - 'MethodPredicates' => [ - 'description' => '方法匹配。', - 'type' => 'array', - 'items' => [ - 'description' => '具体方法。', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - 'required' => false, - ], - 'HeaderPredicates' => [ - 'description' => '请求头匹配。', - 'type' => 'array', - 'items' => [ - 'description' => '请求头。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '请求头Key。', - 'type' => 'string', - 'required' => false, - 'example' => 'debug', - ], - 'Value' => [ - 'description' => '对应的Value。', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'QueryPredicates' => [ - 'description' => '参数匹配。', - 'type' => 'array', - 'items' => [ - 'description' => 'URL参数。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '参数名。', - 'type' => 'string', - 'required' => false, - 'example' => 'userid', - ], - 'Value' => [ - 'description' => '匹配值。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'Services', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '目标服务（路由指向为单服务、多服务、标签路由时填写）。', - 'type' => 'array', - 'items' => [ - 'description' => '服务列表。', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'Percent' => [ - 'description' => '当前服务/服务版本分流百分比（只在使用多服务、标签路由时填写）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'Version' => [ - 'description' => '服务版本（只在使用标签路由时填写）。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'web', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '服务所在命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => '服务分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => '协议类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'DUBBO'."\n", - ], - 'HttpDubboTranscoder' => [ - 'description' => 'Dubbo协议转换体。', - 'type' => 'object', - 'properties' => [ - 'DubboServiceName' => [ - 'description' => 'Dubbo服务名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', - ], - 'DubboServiceVersion' => [ - 'description' => 'Dubbot服务版本。', - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0', - ], - 'DubboServiceGroup' => [ - 'description' => 'Dubbo服务组。', - 'type' => 'string', - 'required' => false, - 'example' => 'service name', - ], - 'MothedMapList' => [ - 'description' => 'Dubbo转发规则列表。', - 'type' => 'array', - 'items' => [ - 'description' => '方法映射体。', - 'type' => 'object', - 'properties' => [ - 'DubboMothedName' => [ - 'description' => 'Dubbo方法名。', - 'type' => 'string', - 'required' => false, - 'example' => 'sayHello', - ], - 'HttpMothed' => [ - 'description' => 'Http方法。'."\n" - .'> 支持http方法参数值。'."\n" - .'> - ALL_GET。'."\n" - .'> - ALL_POST。'."\n" - .'> - ALL_PUT。'."\n" - .'> - ALL_DELETE。'."\n" - .'> - ALL_PATCH。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_GET', - ], - 'Mothedpath' => [ - 'description' => '方法匹配路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/mytestzbk/sayhello'."\n", - ], - 'PassThroughAllHeaders' => [ - 'description' => 'Header透传类型。'."\n" - .'> 透传类型枚举值。'."\n" - .'> - 透传所有：PASS_ALL。'."\n" - .'> - 不透传：PASS_NOT。'."\n" - .'> - 指定参数：PASS_ASSIGN。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PASS_NOT'."\n", - ], - 'PassThroughList' => [ - 'description' => '指定透传Header列表。', - 'type' => 'array', - 'items' => [ - 'description' => '指定Header透传值。', - 'type' => 'string', - 'required' => false, - 'example' => 'x-forward'."\n", - ], - 'required' => false, - ], - 'ParamMapsList' => [ - 'description' => '参数映射列表。', - 'type' => 'array', - 'items' => [ - 'description' => '参数映射体。', - 'type' => 'object', - 'properties' => [ - 'ExtractKeySpec' => [ - 'description' => '入参位置。'."\n" - .'> 入参位置枚举值。'."\n" - .'> - 请求参数：`ALL_QUERY_PARAMETER`'."\n" - .'> - 请求头：`ALL_HEADER`'."\n" - .'> - 请求路径：`ALL_PATH`'."\n" - .'> - 请求体：`ALL_BODY`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_QUERY_PARAMETER'."\n", - ], - 'ExtractKey' => [ - 'description' => '入参位提取Key。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'MappingType' => [ - 'description' => '后端参数类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'java.lang.String', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'ServicePort' => [ - 'description' => 'Dubbo端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20880', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '139', - ], - ], - [ - 'name' => 'DestinationType', - 'in' => 'query', - 'schema' => [ - 'description' => '目标服务类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Mock', - ], - ], - [ - 'name' => 'DirectResponseJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Mock内容。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'Mock返回码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - 'Body' => [ - 'description' => 'Mock返回值。', - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392a2c4', - ], - ], - [ - 'name' => 'DomainIdListJSON', - 'in' => 'query', - 'schema' => [ - 'description' => '关联域名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[90]', - ], - ], - [ - 'name' => 'RedirectJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '重定向。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '302', - ], - 'Host' => [ - 'description' => '重定向主机名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - ], - 'Path' => [ - 'description' => '重定向路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'EnableWaf', - 'in' => 'query', - 'schema' => [ - 'title' => '请使用UpdateGatewayRouteWafStatus更新路由WAF状态', - 'description' => '已废弃，请使用UpdateGatewayRouteWafStatus更新路由WAF状态。', - 'type' => 'boolean', - 'deprecated' => true, - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'Fallback', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启Fallback服务。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'FallbackServices', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Fallback服务。', - 'type' => 'array', - 'items' => [ - 'description' => '数据对象。', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'Percent' => [ - 'description' => '权重百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'Version' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '服务所在命名空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'Namespace'."\n", - ], - 'GroupName' => [ - 'description' => '服务分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => '协议类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'DUBBO'."\n", - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8848', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '路由描述', - 'description' => '路由描述', - 'type' => 'string', - 'required' => false, - 'example' => 'a route for xxx', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '73785414-2C5B-5E28-BD91-B2C742269C48', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP返回码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应描述', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '337', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - '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' => '更新网关路由', - ], - 'UpdateGatewayRouteCORS' => [ - 'summary' => '修改网关路由跨域策略。', - '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' => '关联记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '55', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '85', - ], - ], - [ - 'name' => 'CorsJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '跨域信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '开启状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], - 'AllowOrigins' => [ - 'description' => '允许的域。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://api.aliyun-inc.com/', - ], - 'AllowMethods' => [ - 'description' => '允许的方法。', - 'type' => 'string', - 'required' => false, - 'example' => 'GET,POST', - ], - 'AllowHeaders' => [ - 'description' => '允许的Header。', - 'type' => 'string', - 'required' => false, - 'example' => 'content-type', - ], - 'ExposeHeaders' => [ - 'description' => '允许的响应头部。', - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - 'TimeUnit' => [ - 'description' => '时间单位。', - 'type' => 'string', - 'required' => false, - 'example' => 'h', - ], - 'UnitNum' => [ - 'description' => '时间数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '24', - ], - 'AllowCredentials' => [ - 'description' => '允许携带凭证。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-f70a6ddf2f0941a2bb997b2d16028f37', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '参照国际标准 [RFC7231](https://tools.ietf.org/html/rfc7231)，后端服务需要按用户语言要求返回结果'."\n" - .'* 默认值：无'."\n" - .'* 中文：zh-CN'."\n" - .'* 英文：en-US', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '41BE990E-44E4-5ED3-AEEB-A276941B1854', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP返回码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '报错信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation. ', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据结构。', - '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' => '修改网关路由跨域策略', - ], - 'UpdateGatewayRouteHeaderOp' => [ - 'summary' => '修改网关路由Header设置。', - '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' => '记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '411', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '324', - ], - ], - [ - 'name' => 'HeaderOpJSON', - 'in' => 'query', - 'schema' => [ - 'description' => '用户header设置描述。', - 'type' => 'string', - 'required' => false, - 'example' => '{"status":"on","headerOpItems":[{"directionType":"Request","opType":"Update","key":"hosts","value":"test.com"}]}', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-6bdc977deda44bf589c49d063b4c2d1d', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '7C8CB294-BED8-5F32-A416-7517725E8F27', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '报错信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '状态码。说明 200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - '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' => '修改网关路由Header设置', - ], - 'UpdateGatewayRouteTimeout' => [ - 'summary' => '修改网关路由超时策略。', - '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' => '关联记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '567', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '85', - ], - ], - [ - 'name' => 'TimeoutJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '超时时间。', - 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'description' => '超时时间数值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'TimeUnit' => [ - 'description' => '时间单元，如下：s：秒', - 'type' => 'string', - 'required' => false, - 'example' => 's', - ], - 'Status' => [ - 'description' => '开启状态', - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-533290d279c1405f9628c64f7c8272ee', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '5359729E-A059-5942-98AF-E981E89C99FA', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应描述', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '操作是否成功。取值：true：成功。false：失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '节点数据。', - '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' => '修改网关路由超时策略', - ], - 'UpdateGatewayRouteRetry' => [ - 'summary' => '修改网关路由重试策略。', - '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' => '关联记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '508', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '501', - ], - ], - [ - 'name' => 'RetryJSON', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '重试。', - 'type' => 'object', - 'properties' => [ - 'Attempts' => [ - 'description' => '重试次数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'RetryOn' => [ - 'description' => '重试触发条件', - 'type' => 'array', - 'items' => [ - 'description' => '具体条件', - 'type' => 'string', - 'required' => false, - 'example' => '5xx', - ], - 'required' => false, - ], - 'HttpCodes' => [ - 'description' => 'HTTP状态码。', - 'type' => 'array', - 'items' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'required' => false, - ], - 'required' => false, - ], - 'Status' => [ - 'description' => '开启状态', - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], - ], - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1d10a', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP返回码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '报错信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '返回代码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - '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' => '修改网关路由重试策略', - ], - 'GetGatewayRouteDetail' => [ - 'summary' => '查询网关路由详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1050', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-5d3a78a53ec947aa928212d671d400ac', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FDF2D16C-5D28-5FAA-A56B-30BDE3559880', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '状态码。说明 200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1050', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597c****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DefaultServiceId' => [ - 'description' => '默认服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'DefaultServiceName' => [ - 'description' => '默认服务名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'description' => '路由状态。'."\n" - ."\n" - .'- 未发布：0'."\n" - ."\n" - .'- 发布中：2'."\n" - ."\n" - .'- 已发布：3'."\n" - ."\n" - .'- 编辑中(有更新未发布)：4'."\n" - ."\n" - .'- 下线中：5'."\n" - ."\n" - .'- 不可用：6', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'GmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2022-01-07T10:07:57.000+0000', - ], - 'RouteOrder' => [ - 'description' => '路由顺序。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Predicates' => [ - 'description' => '匹配条件。', - 'type' => 'string', - 'example' => '{}', - ], - 'RoutePredicates' => [ - 'description' => '路由匹配。', - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => '路由匹配。', - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'example' => '/api', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => '是否忽略大小写。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'MethodPredicates' => [ - 'description' => '方法匹配。', - 'type' => 'array', - 'items' => [ - 'description' => '方法。', - 'type' => 'string', - 'example' => 'GET', - ], - ], - 'HeaderPredicates' => [ - 'description' => '头匹配。', - 'type' => 'array', - 'items' => [ - 'description' => '请求头。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '请求头KEY。', - 'type' => 'string', - 'example' => 'id', - ], - 'Value' => [ - 'description' => '匹配值。', - 'type' => 'string', - 'example' => '200', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - 'QueryPredicates' => [ - 'description' => '参数匹配。', - 'type' => 'array', - 'items' => [ - 'description' => '参数。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'userid', - ], - 'Value' => [ - 'description' => '匹配值。', - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - ], - ], - 'DomainId' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235', - ], - 'DomainName' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => '123.com', - ], - 'Services' => [ - 'description' => '服务的配置信息。', - 'type' => 'string', - 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]', - ], - 'RouteServices' => [ - 'description' => '服务。', - 'type' => 'array', - 'items' => [ - 'description' => '服务。', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '782', - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'xkc-crm', - ], - 'Percent' => [ - 'description' => '权重。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Version' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'dubbo4', - ], - 'SourceType' => [ - 'description' => '服务来源。', - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'GroupName' => [ - 'description' => '服务组名称。', - 'type' => 'string', - 'example' => 'api', - ], - 'AgreementType' => [ - 'description' => '协议类型。', - 'type' => 'string', - 'example' => 'DUBBO', - ], - 'HttpDubboTranscoder' => [ - 'description' => 'Dubbo协议转换体。', - 'type' => 'object', - 'properties' => [ - 'DubboServiceName' => [ - 'description' => 'Dubbo服务名称。', - 'type' => 'string', - 'example' => 'org.apache.dubbo.samples.basic.api.DemoService'."\n", - ], - 'DubboServiceVersion' => [ - 'description' => 'Dubbo服务版本。', - 'type' => 'string', - 'example' => '0.0.0', - ], - 'MothedMapList' => [ - 'description' => 'Dubbo转发规则列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DubboMothedName' => [ - 'description' => 'Dubbo方法名。', - 'type' => 'string', - 'example' => 'sayHello', - ], - 'HttpMothed' => [ - 'description' => 'Http方法。'."\n" - .'> 支持http方法参数值。'."\n" - .'> - ALL_GET'."\n" - .'> - ALL_POST'."\n" - .'> - ALL_PUT'."\n" - .'> - ALL_DELETE'."\n" - .'> - ALL_PATCH'."\n", - 'type' => 'string', - 'example' => 'ALL_GET', - ], - 'Mothedpath' => [ - 'description' => '方法匹配路径。', - 'type' => 'string', - 'example' => '/mytestzbk/sayhello', - ], - 'PassThroughAllHeaders' => [ - 'description' => 'Header透传类型。'."\n" - .'> 透传类型枚举值。'."\n" - .'> - 透传所有：PASS_ALL'."\n" - .'> - 不透传：PASS_NOT'."\n" - .'> - 指定参数：PASS_ASSIGN', - 'type' => 'string', - 'example' => 'PASS_NOT', - ], - 'PassThroughList' => [ - 'description' => '指定Header透传列表。', - 'type' => 'array', - 'items' => [ - 'description' => '指定Header透传值。', - 'type' => 'string', - 'example' => 'x-forward', - ], - ], - 'ParamMapsList' => [ - 'description' => '参数映射列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ExtractKeySpec' => [ - 'description' => '入参位置。'."\n" - .'> 入参位置枚举值。'."\n" - .'> - 请求参数：`ALL_QUERY_PARAMETER`'."\n" - .'> - 请求头：`ALL_HEADER`'."\n" - .'> - 请求路径：`ALL_PATH`'."\n" - .'> - 请求体：`ALL_BODY`'."\n", - 'type' => 'string', - 'example' => 'ALL_QUERY_PARAMETER', - ], - 'ExtractKey' => [ - 'description' => '入参位提取Key。', - 'type' => 'string', - 'example' => 'name', - ], - 'MappingType' => [ - 'description' => '后端参数类型。', - 'type' => 'string', - 'example' => 'java.lang.String', - ], - ], - ], - ], - ], - ], - ], - 'DubboServiceGroup' => [ - 'description' => 'Dubbo服务组。', - 'type' => 'string', - 'example' => 'service group', - ], - ], - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20880', - ], - 'HealthStatus' => [ - 'title' => '健康状态'."\n" - ."\n" - .'- Health'."\n" - ."\n" - .'- Unhealthy'."\n" - ."\n" - .'- Checking'."\n" - ."\n" - .'- Unknown', - 'description' => '健康状态'."\n" - ."\n" - .'- Health'."\n" - ."\n" - .'- Unhealthy'."\n" - ."\n" - .'- Checking'."\n" - ."\n" - .'- Unknown', - 'type' => 'string', - 'example' => 'Health', - ], - 'UnhealthyEndpoints' => [ - 'title' => '非健康Endpoint列表', - 'description' => '非健康Endpoint列表', - 'type' => 'array', - 'items' => [ - 'title' => '非健康Endpoint', - 'description' => '非健康Endpoint', - 'type' => 'string', - 'example' => '192.168.1.2', - ], - ], - ], - ], - ], - 'HTTPRewrite' => [ - 'description' => '重写策略信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '开启状态。', - 'type' => 'string', - 'example' => 'off', - ], - 'Path' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'example' => '/test/client', - ], - 'Host' => [ - 'description' => '实例地址。', - 'type' => 'string', - 'example' => 'aliyuncs.com', - ], - 'PathType' => [ - 'description' => '重写类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - 'Pattern' => [ - 'description' => '匹配Pattern。', - 'type' => 'string', - 'example' => '/test', - ], - 'Substitution' => [ - 'description' => '替换。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'HeaderOp' => [ - 'description' => 'Header设置信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'off', - ], - 'HeaderOpItems' => [ - 'description' => '头字段对象。', - 'type' => 'array', - 'items' => [ - 'description' => '设置策略。', - 'type' => 'object', - 'properties' => [ - 'DirectionType' => [ - 'description' => '请求或响应。', - 'type' => 'string', - 'example' => 'Response', - ], - 'OpType' => [ - 'description' => '操作类型。', - 'type' => 'string', - 'example' => 'Add', - ], - 'Key' => [ - 'description' => 'Header Key。', - 'type' => 'string', - 'example' => 'debug', - ], - 'Value' => [ - 'description' => '设置值。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], - 'DestinationType' => [ - 'description' => '目标服务类型。', - 'type' => 'string', - 'example' => 'Single', - ], - 'DirectResponse' => [ - 'description' => 'Mock信息。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Body' => [ - 'description' => 'Mock返回值。', - 'type' => 'string', - 'example' => '{}', - ], - ], - ], - 'Cors' => [ - 'description' => '跨域配置。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'off', - ], - 'AllowOrigins' => [ - 'description' => '跨域。', - 'type' => 'string', - 'example' => '*', - ], - 'AllowMethods' => [ - 'description' => '跨域方法。', - 'type' => 'string', - 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH', - ], - 'AllowHeaders' => [ - 'description' => '跨域Header。', - 'type' => 'string', - 'example' => '*', - ], - 'ExposeHeaders' => [ - 'description' => '响应头。', - 'type' => 'string', - 'example' => '*', - ], - 'TimeUnit' => [ - 'description' => '时间单位。', - 'type' => 'string', - 'example' => 'h', - ], - 'UnitNum' => [ - 'description' => '时间数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'AllowCredentials' => [ - 'description' => '允许携带凭证。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Timeout' => [ - 'description' => '超时配置。', - 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'description' => '时间数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TimeUnit' => [ - 'description' => '时间单位。', - 'type' => 'string', - 'example' => 's', - ], - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'off', - ], - ], - ], - 'Retry' => [ - 'description' => '重试配置。', - 'type' => 'object', - 'properties' => [ - 'Attempts' => [ - 'description' => '重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RetryOn' => [ - 'description' => '重试条件。', - 'type' => 'array', - 'items' => [ - 'description' => '重试条件。', - 'type' => 'string', - 'example' => '5xx', - ], - ], - 'HttpCodes' => [ - 'description' => 'HTTP状态码。', - 'type' => 'array', - 'items' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '500', - ], - ], - 'Status' => [ - 'description' => '重试状态。', - 'type' => 'string', - 'example' => 'on', - ], - ], - ], - 'DomainIdList' => [ - 'description' => '域名列表', - 'type' => 'array', - 'items' => [ - 'description' => '域名ID列表。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'DomainNameList' => [ - 'description' => '域名列表', - 'type' => 'array', - 'items' => [ - 'description' => '域名列表。', - 'type' => 'string', - 'example' => 'test.com', - ], - ], - 'Redirect' => [ - 'description' => '重定向配置', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Host' => [ - 'description' => '主机。', - 'type' => 'string', - 'example' => '16', - ], - 'Path' => [ - 'description' => '路径。', - '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' => '是否开启Waf。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AhasStatus' => [ - 'description' => 'Ahas状态。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Fallback' => [ - 'description' => '是否开启Fallback服务。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FallbackServices' => [ - 'description' => 'Fallback服务。', - 'type' => 'array', - 'items' => [ - 'description' => '数据对象。', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'Percent' => [ - 'description' => '权重百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Version' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '服务所在命名空间。', - 'type' => 'string', - 'example' => 'namespace', - ], - 'GroupName' => [ - 'description' => '服务分组名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => '协议类型。', - 'type' => 'string', - 'example' => 'DUBBO', - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8848', - ], - ], - ], - ], - 'Policies' => [ - 'description' => '路由策略Json字符串。', - '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' => '路由描述', - 'description' => '路由描述', - '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' => '查询网关路由详情', - ], - 'ListGatewayRoute' => [ - 'summary' => '查询网关路由列表。', - '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' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页展示实例数（暂未生效，默认查询全量）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'OrderItem', - 'in' => 'query', - 'schema' => [ - 'description' => '排序属性。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreate', - ], - ], - [ - 'name' => 'DescSort', - 'in' => 'query', - 'schema' => [ - 'description' => '排序。该字段目前不可用，下线中。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'FilterParams', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '过滤条件，格式为{"key1":"value1"}。', - 'type' => 'object', - 'properties' => [ - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '81', - ], - 'Name' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Status' => [ - 'description' => '路由状态：'."\n" - ."\n" - .'- 未发布：0'."\n" - .'- 发布中：2'."\n" - .'- 已发布：3'."\n" - .'- 编辑中(有更新未发布)：4'."\n" - .'- 下线中：5'."\n" - .'- 不可用：6', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'DefaultServiceId' => [ - 'title' => '默认服务ID（已废弃）', - 'description' => '缺省服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '1', - ], - 'RouteOrder' => [ - 'description' => '顺序（未使用）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'DomainId' => [ - 'description' => '域名id。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '284', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-30a0106924c94bca8712ec4e79fc5acc', - ], - 'DomainName' => [ - 'description' => '关联域名', - 'type' => 'string', - 'required' => false, - 'example' => '*.alites.com', - ], - 'Path' => [ - 'title' => '按路由路径模糊搜索', - 'description' => '路由路径。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据结构。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '83F02EAB-ECDF-55C6-B332-8649E5E7AF2C', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'You are not authorized to perform this operation.', - ], - 'Code' => [ - 'description' => '代码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'TotalSize' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Result' => [ - 'description' => '数据结构。', - 'type' => 'array', - 'items' => [ - 'description' => '返回集合。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '47', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识。', - 'type' => 'string', - 'example' => 'gw-cf0e7f52ecc7429dbc7ba4d5e3656100', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '496', - ], - 'Status' => [ - 'description' => '状态。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RouteOrder' => [ - 'description' => '顺序', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DefaultServiceName' => [ - 'description' => '默认服务名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'DefaultServiceId' => [ - 'description' => '默认服务id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Predicates' => [ - 'description' => '匹配规则', - 'type' => 'string', - 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/rpc/compute \\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":true}}', - ], - 'RoutePredicates' => [ - 'description' => '匹配规则', - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => '路由Path匹配。', - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => '节点路径。', - 'type' => 'string', - 'example' => '/getIp', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => '忽略大小写', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'MethodPredicates' => [ - 'description' => 'HTTP方法匹配', - 'type' => 'array', - 'items' => [ - 'description' => '方法', - 'type' => 'string', - 'example' => 'GET', - ], - ], - 'HeaderPredicates' => [ - 'description' => 'Header匹配', - 'type' => 'array', - 'items' => [ - 'description' => 'Header列表', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'Header KEY ', - 'type' => 'string', - 'example' => 'userid', - ], - 'Value' => [ - 'description' => '匹配值', - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => '匹配类型', - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - 'QueryPredicates' => [ - 'description' => '参数匹配', - 'type' => 'array', - 'items' => [ - 'description' => '参数列表', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '参数名称', - 'type' => 'string', - 'example' => 'userid', - ], - 'Value' => [ - 'description' => '匹配值', - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => '匹配类型', - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - ], - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-25T07:14:01.817+0000', - ], - 'GmtModified' => [ - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2022-01-07 18:07:57', - ], - 'Services' => [ - 'description' => '服务。', - 'type' => 'string', - 'example' => '[]', - ], - 'RouteServices' => [ - 'description' => '服务。', - 'type' => 'array', - 'items' => [ - 'description' => '服务列表', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1563', - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'hu', - ], - 'Percent' => [ - 'description' => '权重百分比', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'Version' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'SourceType' => [ - 'description' => '来源类型', - 'type' => 'string', - 'example' => 'MSE', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => '服务组名称。', - 'type' => 'string', - 'example' => 'api', - ], - 'AgreementType' => [ - 'description' => '协议类型。', - 'type' => 'string', - 'example' => 'DUBBO', - ], - 'HttpDubboTranscoder' => [ - 'description' => 'Dubbo协议转换体。', - 'type' => 'object', - 'properties' => [ - 'DubboServiceName' => [ - 'description' => 'Dubbo服务名称。', - 'type' => 'string', - 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', - ], - 'DubboServiceVersion' => [ - 'description' => 'Dubbo服务版本。', - 'type' => 'string', - 'example' => '0.0.0', - ], - 'MothedMapList' => [ - 'description' => 'Dubbo转发规则列表。', - 'type' => 'array', - 'items' => [ - 'description' => '方法映射体。', - 'type' => 'object', - 'properties' => [ - 'DubboMothedName' => [ - 'description' => 'Dubbo方法名。', - 'type' => 'string', - 'example' => 'sayHello', - ], - 'HttpMothed' => [ - 'description' => 'Http方法。'."\n" - .'> 支持http方法参数值。'."\n" - .'> - ALL_GET'."\n" - .'> - ALL_POST'."\n" - .'> - ALL_PUT'."\n" - .'> - ALL_DELETE'."\n" - .'> - ALL_PATCH'."\n", - 'type' => 'string', - 'example' => 'ALL_GET', - ], - 'Mothedpath' => [ - 'description' => '方法匹配路径。', - 'type' => 'string', - 'example' => '/mytestzbk/sayhello', - ], - 'PassThroughAllHeaders' => [ - 'description' => 'Header透传类型。'."\n" - .'> 透传类型枚举值。'."\n" - .'> - 透传所有：PASS_ALL'."\n" - .'> - 不透传：PASS_NOT'."\n" - .'> - 指定参数：PASS_ASSIGN', - 'type' => 'string', - 'example' => 'PASS_NOT', - ], - 'PassThroughList' => [ - 'description' => '指定透传Header列表。', - 'type' => 'array', - 'items' => [ - 'description' => '指定Header透传值。', - 'type' => 'string', - 'example' => 'x-forward', - ], - ], - 'ParamMapsList' => [ - 'description' => '参数映射列表。', - 'type' => 'array', - 'items' => [ - 'description' => '参数映射体。', - 'type' => 'object', - 'properties' => [ - 'ExtractKeySpec' => [ - 'description' => '入参位置。'."\n" - .'> 入参位置枚举值。'."\n" - .'> - 请求参数：`ALL_QUERY_PARAMETER`'."\n" - .'> - 请求头：`ALL_HEADER`'."\n" - .'> - 请求路径：`ALL_PATH`'."\n" - .'> - 请求体：`ALL_BODY`'."\n", - 'type' => 'string', - 'example' => 'ALL_QUERY_PARAMETER', - ], - 'ExtractKey' => [ - 'description' => '入参位提取Key。', - 'type' => 'string', - 'example' => 'name', - ], - 'MappingType' => [ - 'description' => '后端参数类型。', - 'type' => 'string', - 'example' => 'java.lang.String', - ], - ], - ], - ], - ], - ], - ], - 'DubboServiceGroup' => [ - 'description' => 'Dubbo服务组。', - 'type' => 'string', - 'example' => 'service group', - ], - ], - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20880', - ], - 'HealthStatus' => [ - 'title' => '健康状态'."\n" - ."\n" - .'- Health'."\n" - ."\n" - .'- Unhealthy'."\n" - ."\n" - .'- Checking'."\n" - ."\n" - .'- Unknown', - 'description' => '健康状态'."\n" - ."\n" - .'- Health'."\n" - ."\n" - .'- Unhealthy'."\n" - ."\n" - .'- Checking'."\n" - ."\n" - .'- Unknown', - 'type' => 'string', - 'example' => 'Health', - ], - 'UnhealthyEndpoints' => [ - 'title' => '非健康Endpoint列表', - 'description' => '非健康Endpoint列表', - 'type' => 'array', - 'items' => [ - 'title' => '非健康Endpoint', - 'description' => '非健康Endpoint', - 'type' => 'string', - 'example' => '192.168.1.2', - ], - ], - ], - ], - ], - 'DomainId' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '265', - ], - 'DomainName' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => 'y.com', - ], - 'DestinationType' => [ - 'description' => '目标类型。', - 'type' => 'string', - 'example' => 'Single', - ], - 'DirectResponse' => [ - 'description' => 'Mock配置', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Body' => [ - 'description' => 'Mock返回值', - 'type' => 'string', - 'example' => 'hello', - ], - ], - ], - 'DomainIdList' => [ - 'description' => '域名列表。', - 'type' => 'array', - 'items' => [ - 'description' => '域名ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - 'DomainNameList' => [ - 'description' => '域名列表。', - 'type' => 'array', - 'items' => [ - 'description' => '域名', - 'type' => 'string', - 'example' => 'test.com', - ], - ], - 'Redirect' => [ - 'description' => '重定向', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Host' => [ - 'description' => '重定向主机名', - 'type' => 'string', - 'example' => 'test.com', - ], - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'example' => '/test', - ], - ], - ], - 'Type' => [ - 'description' => '路由类型', - 'type' => 'string', - 'example' => 'Op', - ], - 'Comment' => [ - 'description' => '路由备注（ingress）', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'error', - ], - ], - ], - 'EnableWaf' => [ - 'description' => '是否开启waf', - 'type' => 'string', - 'example' => 'false', - ], - 'Fallback' => [ - 'description' => '是否开启Fallback服务。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FallbackServices' => [ - 'description' => 'Fallback服务。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '353'."\n", - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'service name', - ], - 'Percent' => [ - 'description' => '权重百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Version' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'SourceType' => [ - 'description' => '来源类型。', - 'type' => 'string', - 'example' => 'MSE'."\n", - ], - 'Namespace' => [ - 'description' => '服务所在命名空间。', - 'type' => 'string', - 'example' => 'Namespace', - ], - 'GroupName' => [ - 'description' => '服务分组名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'AgreementType' => [ - 'description' => '协议类型。', - 'type' => 'string', - 'example' => 'DUBBO', - ], - 'ServicePort' => [ - 'description' => '服务端口。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8848', - ], - ], - ], - ], - 'DynamicRoute' => [ - 'title' => '是否开启动态路由', - 'description' => '是否开启动态路由', - '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' => '网关路由列表', - ], - 'UpdateGatewayRouteWafStatus' => [ - 'summary' => '更新路由waf状态。', - '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' => '路由条目ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '645', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', - ], - ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'EnableWaf', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启WAF。', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the Request。', - 'type' => 'string', - 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => '状态码。说明200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Name' => [ - 'description' => '消息路由名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102', - ], - 'DefaultServiceId' => [ - 'description' => '默认服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DefaultServiceName' => [ - 'description' => '默认服务名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Status' => [ - 'description' => '路由状态。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-01-26T09:52:41.000+0000', - ], - 'GmtModified' => [ - 'description' => '修改日期。'."\n" - ."\n", - 'type' => 'string', - 'example' => '2022-02-24T06:08:29.230+0000', - ], - 'RouteOrder' => [ - 'description' => '路由顺序。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Predicates' => [ - 'description' => '匹配规则。', - 'type' => 'string', - 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}', - ], - 'RoutePredicates' => [ - 'description' => '路由匹配。', - 'type' => 'object', - 'properties' => [ - 'PathPredicates' => [ - 'description' => '路由匹配。', - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'example' => '/zookeeper/mmgw/unlogined/common.getBu', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - 'IgnoreCase' => [ - 'description' => '是否忽略大小写。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'MethodPredicates' => [ - 'description' => '匹配方法。', - 'type' => 'array', - 'items' => [ - 'description' => '方法。', - 'type' => 'string', - 'example' => 'GET', - ], - ], - 'HeaderPredicates' => [ - 'description' => '请求头匹配规则。', - 'type' => 'array', - 'items' => [ - 'description' => '请求头。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '请求头KEY。', - 'type' => 'string', - 'example' => 'alibo', - ], - 'Value' => [ - 'description' => '值。', - 'type' => 'string', - 'example' => '200', - ], - 'Type' => [ - 'description' => '匹配类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - 'QueryPredicates' => [ - 'description' => '参数匹配规则。', - 'type' => 'array', - 'items' => [ - 'description' => '参数。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'instanceId', - ], - 'Value' => [ - 'description' => '匹配值。', - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => '类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - ], - ], - ], - ], - ], - 'DomainId' => [ - 'description' => '域名ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '235', - ], - 'DomainName' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => 'nbhamster.com', - ], - 'Services' => [ - 'description' => '服务。', - 'type' => 'string', - 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]', - ], - 'RouteServices' => [ - 'description' => '服务。', - 'type' => 'array', - 'items' => [ - 'description' => '服务。', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'description' => '服务id。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '547', - ], - 'ServiceName' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'b-service', - ], - 'Percent' => [ - 'description' => '权重。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Version' => [ - 'description' => '服务版本。', - 'type' => 'string', - 'example' => 'v1', - ], - 'Name' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'test-aixue-gray', - ], - 'SourceType' => [ - 'description' => '服务来源。', - 'type' => 'string', - 'example' => 'K8s', - ], - 'Namespace' => [ - 'description' => '命名空间。', - 'type' => 'string', - 'example' => 'default', - ], - 'GroupName' => [ - 'description' => '服务分组名称。', - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - ], - ], - ], - 'HTTPRewrite' => [ - 'description' => '重写策略信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'HTTP状态。', - 'type' => 'string', - 'example' => 'off', - ], - 'Path' => [ - 'description' => 'HTTP请求路径。', - 'type' => 'string', - 'example' => '/test/client', - ], - 'Host' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => 'aliyuncs.com', - ], - 'PathType' => [ - 'description' => 'HTTP请求路径类型。', - 'type' => 'string', - 'example' => 'PRE', - ], - 'Pattern' => [ - 'description' => '匹配Pattern。', - 'type' => 'string', - 'example' => '/test', - ], - 'Substitution' => [ - 'description' => '替换。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'HeaderOp' => [ - 'description' => 'Header设置信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'off', - ], - 'HeaderOpItems' => [ - 'description' => '设置策略。', - 'type' => 'array', - 'items' => [ - 'description' => '设置策略。', - 'type' => 'object', - 'properties' => [ - 'DirectionType' => [ - 'description' => '请求或者响应。', - 'type' => 'string', - 'example' => 'Response', - ], - 'OpType' => [ - 'description' => '操作类型。', - 'type' => 'string', - 'example' => 'Add', - ], - 'Key' => [ - 'description' => 'Header Key。', - 'type' => 'string', - 'example' => 'debug', - ], - 'Value' => [ - 'description' => '设置值。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], - 'DestinationType' => [ - 'description' => '目标服务类型。', - 'type' => 'string', - 'example' => 'Single', - ], - 'DirectResponse' => [ - 'description' => 'Mock信息。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '返回值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Body' => [ - 'description' => 'Mock返回值。', - 'type' => 'string', - 'example' => '[{\\"key\\":\\"h68d13466.sqa.eu95\\",\\"dims\\":\\"groupName=All}]', - ], - ], - ], - 'Cors' => [ - 'description' => '跨域配置。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'off', - ], - 'AllowOrigins' => [ - 'description' => '跨域。', - 'type' => 'string', - 'example' => '*', - ], - 'AllowMethods' => [ - 'description' => '跨域方法。', - 'type' => 'string', - 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH', - ], - 'AllowHeaders' => [ - 'description' => '跨域Header。', - 'type' => 'string', - 'example' => '*', - ], - 'ExposeHeaders' => [ - 'description' => '响应头。', - 'type' => 'string', - 'example' => '*', - ], - 'TimeUnit' => [ - 'description' => '时间单位。', - 'type' => 'string', - 'example' => 's', - ], - 'UnitNum' => [ - 'description' => '时间数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AllowCredentials' => [ - 'description' => '允许携带凭证。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Timeout' => [ - 'description' => '超时配置。', - 'type' => 'object', - 'properties' => [ - 'UnitNum' => [ - 'description' => '时间数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TimeUnit' => [ - 'description' => '时间单位。', - 'type' => 'string', - 'example' => 's', - ], - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'off', - ], - ], - ], - 'Retry' => [ - 'description' => '重试配置。', - 'type' => 'object', - 'properties' => [ - 'Attempts' => [ - 'description' => '给定请求允许的重试次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RetryOn' => [ - 'description' => '重试条件。', - 'type' => 'array', - 'items' => [ - 'description' => '重试条件。', - 'type' => 'string', - 'example' => '5xx', - ], - ], - 'HttpCodes' => [ - 'description' => 'HTTP状态码。', - 'type' => 'array', - 'items' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '500', - ], - ], - 'Status' => [ - 'description' => '重试状态。', - 'type' => 'string', - 'example' => 'on', - ], - ], - ], - 'DomainIdList' => [ - 'description' => '域名ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '域名ID列表。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'DomainNameList' => [ - 'description' => '域名列表。', - 'type' => 'array', - 'items' => [ - 'description' => '域名列表。', - 'type' => 'string', - 'example' => 'test.com', - ], - ], - 'Redirect' => [ - 'description' => '重定向配置。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Host' => [ - 'description' => '主机。', - 'type' => 'string', - 'example' => 'ww.al.c', - ], - 'Path' => [ - 'description' => '路径。', - 'type' => 'string', - 'example' => '/', - ], - ], - ], - 'EnableWaf' => [ - 'description' => '是否开启WAF。', - 'type' => 'boolean', - 'example' => '0', - ], - ], - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '更新网关路由的重写策略', + '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}'], + ], + ], + ], + ], + ], + 'UpdateGatewayRouteHeaderOp' => [ + 'summary' => '修改网关路由Header设置。', + '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' => '记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '411'], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '324'], + ], + [ + 'name' => 'HeaderOpJSON', + 'in' => 'query', + 'schema' => ['description' => '用户header设置描述。', 'type' => 'string', 'required' => false, 'example' => '{"status":"on","headerOpItems":[{"directionType":"Request","opType":"Update","key":"hosts","value":"test.com"}]}'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-6bdc977deda44bf589c49d063b4c2d1d'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7C8CB294-BED8-5F32-A416-7517725E8F27'], + 'HttpStatusCode' => ['description' => 'HTTP返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '报错信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新路由防护状态', - ], - 'ApplyGatewayRoute' => [ - 'summary' => '发布网关路由。', - 'methods' => [ - 'get', - 'post', - ], - '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' => '修改网关路由Header设置', + 'changeSet' => [ + ['createdAt' => '2022-11-15T07:39:53.000Z', 'description' => '请求参数发生变更'], ], - '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' => '修改网关路由重试策略。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -58930,141 +31105,120 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '28369', - 'abilityTreeNodes' => [ - 'FEATUREmseVZLJSD', - ], + 'abilityTreeCode' => '114051', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], ], 'parameters' => [ [ - 'name' => 'RouteId', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '关联记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '508'], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '501'], + ], + [ + 'name' => 'RetryJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '路由条目ID。', - 'type' => 'string', + 'description' => '重试。', + 'type' => 'object', + 'properties' => [ + 'Attempts' => ['description' => '重试次数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + 'RetryOn' => [ + 'description' => '重试触发条件', + 'type' => 'array', + 'items' => ['description' => '具体条件', 'type' => 'string', 'required' => false, 'example' => '5xx'], + 'required' => false, + ], + 'HttpCodes' => [ + 'description' => 'HTTP状态码。', + 'type' => 'array', + 'items' => ['description' => 'HTTP状态码。', 'type' => 'string', 'required' => false], + 'required' => false, + ], + 'Status' => ['description' => '开启状态', 'type' => 'string', 'required' => false, 'example' => 'off'], + ], 'required' => true, 'docRequired' => true, - 'example' => '950', ], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1d10a'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1DB1AB36-8395-540E-AACC-7571D6B2057A', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '节点数据。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879'], + 'HttpStatusCode' => ['description' => 'HTTP返回码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '报错信息。', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '返回代码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '640'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '修改网关路由重试策略', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteRetry', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], ], - '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' => '发布网关路由', ], - 'OfflineGatewayRoute' => [ - 'summary' => '下线网关路由。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteTimeout' => [ + 'summary' => '修改网关路由超时策略。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -59072,43 +31226,49 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '114050', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], + ], 'parameters' => [ [ - 'name' => 'RouteId', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '关联记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '567'], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85'], + ], + [ + 'name' => 'TimeoutJSON', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '路由条目ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '645', + 'description' => '超时时间。', + 'type' => 'object', + 'properties' => [ + 'UnitNum' => ['description' => '超时时间数值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'TimeUnit' => ['description' => '时间单元，如下：s：秒', 'type' => 'string', 'required' => false, 'example' => 's'], + 'Status' => ['description' => '开启状态', 'type' => 'string', 'required' => false, 'example' => 'off'], + ], + 'required' => false, ], ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5', - ], + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-533290d279c1405f9628c64f7c8272ee'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回信息的语言类型：'."\n" - ."\n" - .'- zh：中文'."\n" - .'- en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ @@ -59116,513 +31276,294 @@ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => '数据结构。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8EB24742-AB15-5953-BEFB-1FA18E770EEE', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '报错信息。', - 'type' => 'string', - 'example' => '请求处理成功', - ], - 'Code' => [ - 'description' => '返回码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - ."\n" - .'- `true`：请求成功。 '."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '下线是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5359729E-A059-5942-98AF-E981E89C99FA'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应描述', 'type' => 'string', 'example' => 'You are not authorized to perform this operation.'], + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '操作是否成功。取值：true：成功。false：失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '节点数据。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '修改网关路由超时策略', + '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\\": \\"8EB24742-AB15-5953-BEFB-1FA18E770EEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => '下线网关路由', ], - 'GetGatewayConfig' => [ - 'summary' => '获取网关参数配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayRouteWafStatus' => [ + 'summary' => '更新路由waf状态。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '141101', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '131361', + 'abilityTreeNodes' => ['FEATUREmseXCPJ75'], ], 'parameters' => [ + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => ['description' => '路由条目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '645'], + ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-61f465fa2dd044069e2208c4912*****', - ], + 'schema' => ['description' => '网关唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + [ + 'name' => 'EnableWaf', + 'in' => 'query', + 'schema' => ['description' => '是否开启WAF。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F6092602-C357-4750-89D9-E572FBEA****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - '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.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the Request。', 'type' => 'string', 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => '状态码。说明200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '数据概览。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'GatewayUniqueId' => [ - 'description' => '网关唯一ID', - 'type' => 'string', - 'example' => 'gw-61f465fa2dd044069e2208c4912*****', - ], - 'EnableGenerateRequestId' => [ - 'title' => '是否生成requestId', - 'description' => '作用于请求范围，根据配置会在请求头中生成requestId，以便追踪请求。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableGzip' => [ - 'title' => '是否启用gzip进行压缩', - 'description' => '作用于请求与响应环节，启用gzip会对请求响应进行压缩，会减少网关流量，增加网关cpu消耗。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'EnableSlashMerge' => [ - 'title' => '是否合并‘/’, 开启后www.a.com//b多余的\'/\'会被合并，将会同www.a.com/b一致', - 'description' => '作用于请求环节，是否合并请求中多余的‘/’, 开启后www.a.com//b多余的\'/\'会被合并，将会同www.a.com/b一致。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DownstreamIdleTime' => [ - 'title' => '客户端到网关处于指定的时间内[0-600]没有请求，则会断开链接', - 'description' => '作用于网关连接，客户端到网关处于指定的时间内没有请求，则会断开链接。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '180', - ], - 'PreserveHeaderFormat' => [ - 'title' => '是否保持header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写', - 'description' => '作用于请求和响应环节，是否保持请求header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DownstreamConnectionBufferLimits' => [ - 'title' => '单条链接的buffer大小', - 'description' => '作用于网关连接，单条链接的buffer大小，配置后会影响吞吐和网关的内存使用（单位：Byte）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32768', - ], - 'EnableHardwareAccelerate' => [ - 'title' => '是否开启硬件加速(若您的地域处于底层不支持地域，或购买时未指定硬件加速会生效失败)', - 'description' => '是否开启硬件加速(若您的地域处于底层不支持地域，或购买时未指定硬件加速会生效失败)。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'XffTrustedNum' => [ - 'title' => '网关前可信任的设备个数', - 'description' => '作用于请求环节，网关前可信任的代理个数，会影响网关是否会使用客户端产生的x-forwarded-for和x-request-id等请求头。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'EnableHttp2' => [ - 'title' => '是否默认开启http2', - 'description' => '作用于请求环节，服务端与客户端协商时是否使用http2（修改后1～2分钟后生效）。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DownstreamHttp2MaxConcurrentStream' => [ - 'title' => '下游http最大并发数', - 'description' => '作用于请求环节，客户端使用http2时一条链接上最大并发数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'InitialStreamWindowSize' => [ - 'title' => 'http2 stream 初始窗口大小', - 'description' => '作用于请求环节，网关同客户端使用http2时协商的stream初始窗口大小（单位：Byte）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '65535', - ], - 'InitialConnectionWindowSize' => [ - 'title' => 'http2 连接 初始窗口大小', - 'description' => '作用于请求环节，网关同客户端使用http2时连接级别初始窗口大小（单位：Byte）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1048576', - ], - 'XtraceDetails' => [ - 'description' => '链路追踪信息。', + 'Id' => ['description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'Name' => ['description' => '消息路由名称。', 'type' => 'string', 'example' => 'test'], + 'GatewayUniqueId' => ['description' => '网关唯一ID。', 'type' => 'string', 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****'], + 'GatewayId' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'], + 'DefaultServiceId' => ['description' => '默认服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DefaultServiceName' => ['description' => '默认服务名称。', 'type' => 'string', 'example' => 'test'], + 'Status' => ['description' => '路由状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-26T09:52:41.000+0000'], + 'GmtModified' => ['description' => '修改日期。'."\n" + ."\n", 'type' => 'string', 'example' => '2022-02-24T06:08:29.230+0000'], + 'RouteOrder' => ['description' => '路由顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Predicates' => ['description' => '匹配规则。', 'type' => 'string', 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}'], + 'RoutePredicates' => [ + 'description' => '路由匹配。', 'type' => 'object', 'properties' => [ - 'TraceOn' => [ - 'description' => '是否开启链路追踪。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => '链路追踪信息ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '255', - ], - 'Sample' => [ - 'description' => '采样率（%）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'example' => 'gw-61f465fa2dd044069e2208c4912*****', - ], - 'GmtCreate' => [ - 'description' => '链路追踪信息创建时间。', - 'type' => 'string', - 'example' => '2024-08-12T09:39:07.000+0000', + 'PathPredicates' => [ + 'description' => '路由匹配。', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => '路径。', 'type' => 'string', 'example' => '/zookeeper/mmgw/unlogined/common.getBu'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'example' => 'PRE'], + 'IgnoreCase' => ['description' => '是否忽略大小写。', 'type' => 'boolean', 'example' => 'true'], + ], ], - 'GmtModified' => [ - 'description' => '链路追踪信息修改时间。', - 'type' => 'string', - 'example' => '2024-08-12T09:39:07.000+0000', + 'MethodPredicates' => [ + 'description' => '匹配方法。', + 'type' => 'array', + 'items' => ['description' => '方法。', 'type' => 'string', 'example' => 'GET'], ], - 'TraceType' => [ - 'description' => '链路追踪类型：'."\n" - ."\n" - .'- XTRACE：可观测链路OpenTelemetry版，链路追踪协议Zipkin'."\n" - ."\n" - .'- SKYWALKING：自建Skywalking'."\n" - ."\n" - .'- OPENTELEMETRY：可观测链路OpenTelemetry版，链路追踪协议OpenTelemetry'."\n" - ."\n" - .'- OTSKYWALKING：可观测链路OpenTelemetry版，链路追踪协议Skywalking', - 'type' => 'string', - 'example' => 'OPENTELEMETRY', + 'HeaderPredicates' => [ + 'description' => '请求头匹配规则。', + 'type' => 'array', + 'items' => [ + 'description' => '请求头。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '请求头KEY。', 'type' => 'string', 'example' => 'alibo'], + 'Value' => ['description' => '值。', 'type' => 'string', 'example' => '200'], + 'Type' => ['description' => '匹配类型。', 'type' => 'string', 'example' => 'PRE'], + ], + ], ], - 'ServiceId' => [ - 'description' => '自建Skywalking，Skywalking服务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '333', + 'QueryPredicates' => [ + 'description' => '参数匹配规则。', + 'type' => 'array', + 'items' => [ + 'description' => '参数。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'instanceId'], + 'Value' => ['description' => '匹配值。', 'type' => 'string', 'example' => 'test'], + 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'PRE'], + ], + ], ], - 'ServicePort' => [ - 'description' => '自建Skywalking，Skywalking服务端口。', - 'type' => 'string', - 'example' => '8888', + ], + ], + 'DomainId' => ['description' => '域名ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '235'], + 'DomainName' => ['description' => '域名。', 'type' => 'string', 'example' => 'nbhamster.com'], + 'Services' => ['description' => '服务。', 'type' => 'string', 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]'], + 'RouteServices' => [ + 'description' => '服务。', + 'type' => 'array', + 'items' => [ + 'description' => '服务。', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['description' => '服务id。', 'type' => 'integer', 'format' => 'int64', 'example' => '547'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'b-service'], + 'Percent' => ['description' => '权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'Version' => ['description' => '服务版本。', 'type' => 'string', 'example' => 'v1'], + 'Name' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'test-aixue-gray'], + 'SourceType' => ['description' => '服务来源。', 'type' => 'string', 'example' => 'K8s'], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'GroupName' => ['description' => '服务分组名称。', 'type' => 'string', 'example' => 'DEFAULT_GROUP'], ], ], ], - 'SlsConfigDetails' => [ - 'description' => '日志投递信息。', + 'HTTPRewrite' => [ + 'description' => '重写策略信息。', 'type' => 'object', 'properties' => [ - 'LogOn' => [ - 'description' => '是否开启日志投递。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => '未开放使用。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ProjectName' => [ - 'description' => '日志投递目标Project', - 'type' => 'string', - 'example' => 'test', - ], - 'LogStoreName' => [ - 'description' => '日志投递目标Logstore，取值：'."\n" - ."\n" - .'- 未开启兼容Nginx Ingress：mse_gw_access_log'."\n" - ."\n" - .'- 开启兼容Nginx Ingress：nginx-ingress', - 'type' => 'string', - 'example' => 'mse_gw_access_log', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一ID。', - 'type' => 'string', - 'example' => 'gw-61f465fa2dd044069e2208c4912*****'."\n", - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', - ], - 'GmtCreate' => [ - 'description' => '未开放使用。', - 'type' => 'string', - 'example' => '""', - ], - 'GmtModified' => [ - 'description' => '未开放使用。', - 'type' => 'string', - 'example' => ' ""', - ], - 'NginxCompatible' => [ - 'description' => '是否开启兼容 Nginx Ingress', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Status' => ['description' => 'HTTP状态。', 'type' => 'string', 'example' => 'off'], + 'Path' => ['description' => 'HTTP请求路径。', 'type' => 'string', 'example' => '/test/client'], + 'Host' => ['description' => '域名。', 'type' => 'string', 'example' => 'aliyuncs.com'], + 'PathType' => ['description' => 'HTTP请求路径类型。', 'type' => 'string', 'example' => 'PRE'], + 'Pattern' => ['description' => '匹配Pattern。', 'type' => 'string', 'example' => '/test'], + 'Substitution' => ['description' => '替换。', 'type' => 'string', 'example' => 'test'], ], ], - 'SupportWaf' => [ - 'description' => '网关是否支持WAF。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableWaf' => [ - 'description' => '是否开启WAF。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessLogHeader' => [ - 'description' => '自定义日志格式。', - 'type' => 'string', - 'example' => '{"requestMetadata":[],"responseHeaders":[],"requestHeaders":["x-test"],"responseMetadata":[]}', - ], - 'EnableHttp3' => [ - 'description' => '是否支持http3协议。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UpstreamIdleTimeout' => [ - 'description' => '默认到上游的idle时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'ZipAlgorithm' => [ - 'description' => '开启压缩后使用的算法，可以选择brotli，gzip，如果此时EnableGzip未开启，将自动开启EnableGzip选项。', - 'type' => 'string', - 'example' => '["gzip"]', - ], - 'PathWithEscapedSlashes' => [ - 'description' => '确定 URI 路径中包含 %2F、%2f、%5C 或 %5c 这些转义的请求的操作, 默认为KEEP_UNCHANGED(保持不变)'."\n" - ."\n" - .'取值：'."\n" - ."\n" - .'- KEEP_UNCHANGED'."\n" - ."\n" - .'- REJECT_REQUEST'."\n" - ."\n" - .'- UNESCAPE_AND_REDIRECT'."\n" - ."\n" - .'- UNESCAPE_AND_FORWARD', - 'type' => 'string', - 'example' => 'KEEP_UNCHANGED', - ], - 'NoSupportedConfigList' => [ - 'description' => '不支持的配置列表。', - 'type' => 'string', - 'example' => '"EnableProxyProtocol,EnableCustomAuthConfigPush"', - ], - 'LogFilterConfig' => [ - 'description' => '未开放使用。', - 'type' => 'string', - 'example' => ' ""', - ], - 'EnableProxyProtocol' => [ - 'description' => '是否开启Proxy协议，如果网关入口流量使用NLB接入，如果不开启则无法获取客户端的真实IP，开启后对于非Proxy协议请求没有影响。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableCustomAuthConfigPush' => [ - 'description' => '作用于使用自建的鉴权服务的场景，开启后鉴权规则变更不会引起连接中断，适用于WebSocket和在线业务场景。', - 'type' => 'string', - 'example' => 'false', + 'HeaderOp' => [ + 'description' => 'Header设置信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'off'], + 'HeaderOpItems' => [ + 'description' => '设置策略。', + 'type' => 'array', + 'items' => [ + 'description' => '设置策略。', + 'type' => 'object', + 'properties' => [ + 'DirectionType' => ['description' => '请求或者响应。', 'type' => 'string', 'example' => 'Response'], + 'OpType' => ['description' => '操作类型。', 'type' => 'string', 'example' => 'Add'], + 'Key' => ['description' => 'Header Key。', 'type' => 'string', 'example' => 'debug'], + 'Value' => ['description' => '设置值。', 'type' => 'string', 'example' => 'test'], + ], + ], + ], + ], ], - 'KeepaliveHeaderTimeout' => [ - 'description' => '用于生成Keep-Alive响应头返回给客户端，告知连接的保活时间。例如配置为10时，会返回响应头: `keep-alive: timeout=10`。配置为0时，不会返回该响应头。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'DestinationType' => ['description' => '目标服务类型。', 'type' => 'string', 'example' => 'Single'], + 'DirectResponse' => [ + 'description' => 'Mock信息。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '返回值。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Body' => ['description' => 'Mock返回值。', 'type' => 'string', 'example' => '[{\\"key\\":\\"h68d13466.sqa.eu95\\",\\"dims\\":\\"groupName=All}]'], + ], ], - 'WebsocketTermGracePeriod' => [ - 'title' => '', - 'description' => '当网关实例升级、重启等需要关闭连接的场景下，为Websocket连接维持的保活时间（单位：s）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', + 'Cors' => [ + 'description' => '跨域配置。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'off'], + 'AllowOrigins' => ['description' => '跨域。', 'type' => 'string', 'example' => '*'], + 'AllowMethods' => ['description' => '跨域方法。', 'type' => 'string', 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH'], + 'AllowHeaders' => ['description' => '跨域Header。', 'type' => 'string', 'example' => '*'], + 'ExposeHeaders' => ['description' => '响应头。', 'type' => 'string', 'example' => '*'], + 'TimeUnit' => ['description' => '时间单位。', 'type' => 'string', 'example' => 's'], + 'UnitNum' => ['description' => '时间数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AllowCredentials' => ['description' => '允许携带凭证。', 'type' => 'boolean', 'example' => 'true'], + ], ], - 'EnableK8sSourceWorkloadFilter' => [ + 'Timeout' => [ + 'description' => '超时配置。', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'type' => 'boolean', - ], - 'LabelKey' => [ - 'type' => 'string', - ], - 'LabelValue' => [ - 'type' => 'string', - ], - 'FilterOpt' => [ - 'type' => 'string', - ], + 'UnitNum' => ['description' => '时间数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TimeUnit' => ['description' => '时间单位。', 'type' => 'string', 'example' => 's'], + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'off'], ], ], - 'EnableXffTrustedCidrs' => [ + 'Retry' => [ + 'description' => '重试配置。', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'type' => 'boolean', + 'Attempts' => ['description' => '给定请求允许的重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RetryOn' => [ + 'description' => '重试条件。', + 'type' => 'array', + 'items' => ['description' => '重试条件。', 'type' => 'string', 'example' => '5xx'], ], - 'IpListContent' => [ - 'type' => 'string', + 'HttpCodes' => [ + 'description' => 'HTTP状态码。', + 'type' => 'array', + 'items' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '500'], ], + 'Status' => ['description' => '重试状态。', 'type' => 'string', 'example' => 'on'], ], ], - 'EnableGzipHardwareAccelerate' => [ - 'type' => 'boolean', + 'DomainIdList' => [ + 'description' => '域名ID列表。', + 'type' => 'array', + 'items' => ['description' => '域名ID列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], - 'PreserveExternalRequestID' => [ - 'type' => 'boolean', + 'DomainNameList' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => ['description' => '域名列表。', 'type' => 'string', 'example' => 'test.com'], ], - 'LiteMetrics' => [ - 'type' => 'boolean', + 'Redirect' => [ + 'description' => '重定向配置。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Host' => ['description' => '主机。', 'type' => 'string', 'example' => 'ww.al.c'], + 'Path' => ['description' => '路径。', 'type' => 'string', 'example' => '/'], + ], ], + 'EnableWaf' => ['description' => '是否开启WAF。', 'type' => 'boolean', 'example' => '0'], ], ], ], @@ -59631,209 +31572,348 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新路由防护状态', + 'changeSet' => [ + ['createdAt' => '2022-11-15T07:39:54.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-03-23T09:08:21.000Z', 'description' => 'OpenAPI 下线'], + ], + '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' => '编辑网关服务（仅适用于固定地址服务 / DNS域名服务）', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '25309', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => false, 'example' => '322'], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '501'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '服务名称（已废弃，不支持修改，调用时需要和当前服务名称保持一致）。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'IpList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '服务地址列表（固定地址服务）/ 域名列表（DNS域名服务）', + 'type' => 'array', + 'items' => ['description' => '服务地址（固定地址服务）/ 域名（DNS域名服务）', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1:80'], + 'required' => false, + ], + ], + [ + 'name' => 'ServicePort', + 'in' => 'query', + 'schema' => ['description' => '服务端口（DNS域名服务填写）。', 'type' => 'string', 'required' => false, 'example' => '80'], + ], + [ + 'name' => 'ServiceProtocol', + 'in' => 'query', + 'schema' => ['description' => '服务协议。'."\n" + ."\n" + .'- HTTP'."\n" + ."\n" + .'- HTTPS'."\n" + ."\n" + .'- HTTP2'."\n" + ."\n" + .'- GRPC'."\n" + ."\n" + .'- DUBBO', 'type' => 'string', 'required' => false, 'example' => 'HTTP'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => false, 'example' => 'gw-c9bc5afd61014165bd58f621b491*****'], + ], + [ + 'name' => 'TlsSetting', + 'in' => 'query', + 'schema' => ['description' => 'TLS设定。'."\n" + ."\n" + .'- TLS模式：mode'."\n" + ."\n" + .'- 证书ID：certId'."\n" + ."\n" + .'- CA证书ID：caCertId'."\n" + ."\n" + .'- CA证书公钥：caCertContent'."\n" + ."\n" + .'- 服务名称标识：sni', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "mode": "MUTUAL",'."\n" + .' "certId": "1*****-cn-hangzhou",'."\n" + .' "caCertContent": "123",'."\n" + .' "sni": "ceshi"'."\n" + .'}'], + ], + [ + 'name' => 'DnsServerList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'description' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'type' => 'array', + 'items' => ['title' => 'DNS服务器地址（IP+端口）', 'description' => 'DNS服务器地址（IP+端口）', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1:80'], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '322'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '编辑网关服务', + '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\\": \\"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' => '获取网关参数配置', ], - 'EnableProxyProtocol' => [ - 'summary' => '开启Proxy协议。如果网关入口流量使用NLB接入，如果不开启则无法获取客户端的真实IP，开启后对于非Proxy协议请求没有影响。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayServiceCheck' => [ + 'summary' => '更新云原生网关指定服务的健康检查策略。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['title' => '服务ID', 'description' => '服务ID', 'type' => 'string', 'required' => false, 'example' => '12'], + ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一ID', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', - ], + 'schema' => ['title' => '网关唯一ID', 'description' => '网关唯一ID', 'type' => 'string', 'required' => false, 'example' => 'gw-8d410698bd7f4628ab76b*****72dd1d'], ], [ - 'name' => 'EnableProxyProtocol', + 'name' => 'Check', 'in' => 'query', - 'schema' => [ - 'description' => '是否使用ProxyProtocol方式开启保持客户端源IP功能，取值：'."\n" - ."\n" - .'- **true**：开启保持客户端源IP功能。'."\n" - ."\n" - .'- **false**（默认值）：不开启保持客户端源IP功能。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['title' => '是否开启健康检查', 'description' => '是否开启健康检查', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'ExpectedStatuses', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', + 'title' => '正常状态码（健康检查协议为HTTP时必填）', + 'description' => '正常状态码（健康检查协议为HTTP时必填）', + 'type' => 'array', + 'items' => ['title' => '用于判断健康检查正常的HTTP状态码：'."\n" + .'- http_2xx: 200'."\n" + .'- http_3xx: 300'."\n" + .'- http_4xx: 400'."\n" + .'- http_5xx: 500', 'description' => '用于判断健康检查正常的HTTP状态码（健康检查协议为HTTP时必填）：'."\n" + .'- http_2xx: 200'."\n" + .'- http_3xx: 300'."\n" + .'- http_4xx: 400'."\n" + .'- http_5xx: 500', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['title' => '健康检查协议，目前支持：'."\n" + .'- HTTP'."\n" + .'- TCP', 'description' => '健康检查协议，目前支持：'."\n" + .'- HTTP'."\n" + .'- TCP', 'type' => 'string', 'required' => false, 'example' => 'HTTP'], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['title' => '健康检查响应超时时间（秒）', 'description' => '健康检查响应超时时间（秒）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['title' => '健康检查间隔时间（秒）', 'description' => '健康检查间隔时间（秒）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'HealthyThreshold', + 'in' => 'query', + 'schema' => ['title' => '健康检查健康阈值', 'description' => '健康检查健康阈值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'UnhealthyThreshold', + 'in' => 'query', + 'schema' => ['title' => '健康检查不健康阈值', 'description' => '健康检查不健康阈值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'HttpPath', + 'in' => 'query', + 'schema' => ['title' => '健康检查路径（健康检查协议为HTTP时必填）', 'description' => '健康检查路径（健康检查协议为HTTP时必填）', 'type' => 'string', 'required' => false, 'example' => '/healthz'], + ], + [ + 'name' => 'HttpHost', + 'in' => 'query', + 'schema' => ['title' => '健康检查域名', 'description' => '健康检查域名（健康检查协议为HTTP时选填）', 'type' => 'string', 'required' => false, 'example' => 'example.com'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', + 'title' => 'Schema of Response', + 'description' => '返回体结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的 **%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '是否操作成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '62CBFCB8-DDC6-588C-BF1B-88828AF*****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Code' => ['description' => 'code仅仅用来和success同步。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：true：请求成功。 false：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '操作的服务ID。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新服务健康检查策略', + '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\\": \\"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' => '开启Proxy协议', ], - 'EnableHttp2' => [ - 'summary' => '服务端与客户端协商时是否使用http2（修改后1～2分钟后生效）', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayServiceTrafficPolicy' => [ + 'summary' => '更新服务流量策略。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -59843,155 +31923,96 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '142072', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', - ], + 'abilityTreeCode' => '113905', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '429'], ], [ - 'name' => 'EnableHttp2', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '服务端与客户端协商时是否使用http2。取值：'."\n" - .'- **true**：是。'."\n" - .'- **false**：否。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '411'], + ], + [ + 'name' => 'GatewayTrafficPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '网关流量控制策略。', 'required' => true, '$ref' => '#/components/schemas/TrafficPolicy'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-75c5036c083e4f89ba8ef9fafff2e902'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回值的语言，取值：'."\n" + ."\n" + .'- **zh-CN**：中文，默认值。'."\n" + .'- **en-US**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => '数据结构', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。'."\n", - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '是否开启成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '11A61389-F896-5231-A4FB-074D9E2E0055'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '返回码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '表示是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '数据概览。', 'example' => '{\'GatewayUniqueId\': \'gw-2b8ebd75dc554c37a4279ba9917379f2\', \'Id\': 417, \'GatewayTrafficPolicy\': {\'LoadBalancerSettings\': {\'LoadbalancerType\': \'ROUND_ROBIN\'}, \'TlsSetting\': {\'TlsMode\': \'DISABLE\'}}}', '$ref' => '#/components/schemas/GatewayService'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '更新服务流量策略', + '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\\": \\"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' => '开启HTTP 2', ], - 'PreserveHeaderFormat' => [ - 'summary' => '作用于请求和响应环节，是否保持请求header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewayServiceVersion' => [ + 'summary' => '更新修改服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -60001,1460 +32022,927 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '142071', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', - ], + 'abilityTreeCode' => '90281', + 'abilityTreeNodes' => ['FEATUREmseY699NS'], ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', - ], + 'schema' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '575'], ], [ - 'name' => 'PreserveHeaderFormat', + 'name' => 'ServiceVersion', 'in' => 'query', - 'schema' => [ - 'description' => '是否保持请求header头大小写。取值：'."\n" - ."\n" - .'- **true**：是。'."\n" - .'- **false**：否。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '服务版本。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"name\\":\\"v3\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v3\\"}]}'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-eccf313e2224438ba53d95d039e5****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => 'code仅仅用来和success同步', - 'description' => 'code仅仅用来和success同步', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'DynamicCode' => [ - 'title' => '动态错误信息中的占位符', - 'description' => '动态错误信息中的占位符。', - 'type' => 'string', - 'example' => 'code', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n" - .'> 如果**ErrMessage**返回**The Value of Input Parameter %s is not valid**，且**DynamicMessage**返回**DtsJobId**，则代表所传入的请求参数**DtsJobId**不合法。', - 'type' => 'string', - 'example' => 'The specified parameter is invalid.', - ], - 'Data' => [ - 'description' => '是否开启成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D6580AA6-E285-58D2-B00B-12C051B3B7BF'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '节点数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '614'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新服务版本', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayServiceVersion', + '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\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => '开启保持请求header头大小写', ], - 'CreateGatewayFlowRule' => [ - 'summary' => '创建网关流控规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateGatewaySpec' => [ + 'summary' => '更新云原生网关集群节点数或规格（支持按量付费和包年包月）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], + 'schema' => ['title' => '网关名称', 'description' => '网关ID。', 'type' => 'string', 'required' => true, 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Spec', 'in' => 'query', 'schema' => [ - 'description' => '网关唯一标识ID。', + 'title' => '节点规格', + 'description' => '节点规格。', 'type' => 'string', 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + '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' => 'RouteId', + 'name' => 'Replica', 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '52853', - ], + 'schema' => ['title' => '节点数量', 'description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'], ], [ - 'name' => 'RouteName', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], - [ - 'name' => 'Threshold', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '总体QPS阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', + 'title' => 'Schema of Response', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '执行结果信息。', 'type' => 'string', 'example' => 'gw-892ehbv7gg56******'], + ], ], ], - [ - 'name' => 'BehaviorType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Web fallbac行为类型。'."\n" - ."\n" - .'0：返回指定文本。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], ], [ - 'name' => 'BodyEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本。'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新网关规格', + 'description' => '更新云原生网关集群节点数或规格，支持按量付费和包年包月，增加节点或升级规格会产生相应资费。具体详情，请参见[价格说明](~~250950~~)。', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'ResponseStatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'Http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewaySpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], ], ], + ], + ], + 'UpdateImage' => [ + 'summary' => '升级目标集群的版本号。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'ResponseContentBody', - 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '43431', + 'abilityTreeNodes' => ['FEATUREmseLINUSD'], + ], + 'parameters' => [ [ - 'name' => 'ResponseRedirectUrl', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], + 'schema' => ['title' => '目标集群的id', 'description' => '目标集群的ID。', 'type' => 'string', 'required' => true, 'example' => 'mse-8e8e9060'], ], [ - 'name' => 'Enable', + 'name' => 'VersionCode', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => '想修改的镜像版本code', 'description' => '目标版本号。'."\n" + ."\n" + .'> 需调用GetImage接口获取可升级的版本号MaxVersionCode。', 'type' => 'string', 'required' => true, 'example' => 'ZooKeeper_3_5_5'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '72FC625E-9629-591B-9C01-3F0BFDAB****', - ], - 'Data' => [ - 'description' => '返回规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '608', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3855D475-2B66-5CFF-9A51-3D698E52C472'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新集群镜像', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateImage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Cluster', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72FC625E-9629-591B-9C01-3F0BFDAB****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', - 'title' => '创建网关流控规则', ], - 'DeleteGatewayFlowRule' => [ - 'summary' => '删除该网关流控规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'UpdateIsolationRule' => [ + 'summary' => '更新隔离规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'tags' => [ - 'gateway', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '163571', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], - 'security' => [ + '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' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], [ - 'AK' => [], + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['title' => '隔离规则并发数阈值。', 'description' => '隔离规则并发数阈值。', 'type' => 'number', 'format' => 'float', 'required' => false, 'docRequired' => false, 'example' => '3'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], + 'schema' => ['title' => '规则的启用状态。', 'description' => '规则的启用状态。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'RouteId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11151', - ], + 'schema' => ['title' => '应用ID。', 'description' => '应用ID。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522******'], ], [ - 'name' => 'RuleId', + 'name' => 'LimitApp', 'in' => 'query', - 'schema' => [ - 'description' => '流控规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '请求来源应用。', 'type' => 'string', 'required' => false], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****', - ], + 'Message' => ['title' => '响应信息。', 'description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'Code' => ['title' => '响应码。', 'description' => '响应码。', 'type' => 'string', 'example' => '200'], 'Data' => [ - 'description' => '返回数据。', - 'type' => 'boolean', - 'example' => 'True', + 'title' => '规则信息。', + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['title' => '应用所属的微服务命名空间。', 'description' => '应用所属的微服务命空间。', 'type' => 'string', 'example' => 'default'], + 'Id' => ['title' => '规则ID。', 'description' => '规则ID。', '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' => '应用ID。', 'type' => 'string', 'example' => 'hkhon1po62@c3df23522bXXXXX'], + 'LimitApp' => ['description' => '请求来源应用。', 'type' => 'string'], + ], ], + 'Success' => ['title' => '请求结果。', 'description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '更新隔离规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B74E7F7-DF54-5AB1-B8F2-67391B83****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => '删除网关流控规则', ], - 'UpdateGatewayFlowRule' => [ - 'summary' => '更新该网关流控规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateLocalityRule' => [ + 'summary' => '更新同可用区优先路由规则', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '流控规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '549', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - ], - [ - 'name' => 'RouteId', - 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '48811', - ], - ], - [ - 'name' => 'RouteName', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'routeA', - ], + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Threshold', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '总体QPS阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'myNamespace', 'maxLength' => 64], ], [ - 'name' => 'BehaviorType', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定文本'."\n" - ."\n" - .'1：跳转到指定页面', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 64], ], [ - 'name' => 'BodyEncoding', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1po62@c3df23522******'], ], [ - 'name' => 'ResponseStatusCode', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'Http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], + 'schema' => ['description' => '是否开启同可用区优先。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], [ - 'name' => 'ResponseContentBody', + 'name' => 'Rules', 'in' => 'query', - 'schema' => [ - 'description' => 'Http返回文本。', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], + 'schema' => ['description' => '保留参数，暂未使用。', 'type' => 'string', 'required' => false, 'example' => 'No input required'], ], [ - 'name' => 'ResponseRedirectUrl', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], + 'schema' => ['description' => '规则来源', 'type' => 'string', 'required' => false, 'example' => 'edasmsc'], ], [ - 'name' => 'Enable', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => '同可用区优先生效阈值。当前应用在某个可用区部署的实例占比超过此阈值时，才会开启该可用区的同可用区优先路由功能。即Consumer向该应用发起请求时，会优先将请求路由到与Consumer同一个可用区的实例上。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.2'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '流控规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48811', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeA', - ], - 'Threshold' => [ - 'description' => '总体QPS阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'StatDurationMs' => [ - 'description' => '统计持续时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'LimitMode' => [ - 'description' => '阈值转化模式。'."\n" - ."\n" - .'0：单机。'."\n" - ."\n" - .'1：集群。'."\n" - ."\n" - .'2：集群转单机。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => 'Web fallbaco行为类型。'."\n" - ."\n" - .'0：返回指定文本。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'Http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'example' => 'Text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '自定义header，输入为key-value键值对。', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '筛选规则id', - 'type' => 'array', - 'items' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - ], - ], - ], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '78F05E89-D387-50CE-8186-2E27A8AB****'], + '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' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'string', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'http状态码。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新网关流控规则', - ], - 'ListGatewayFlowRule' => [ - 'summary' => '查询该网关流控规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', + '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' => '更新同可用区优先路由规则', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateLocalityRule', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateMessageQueueRoute' => [ + 'summary' => '更新应用消息灰度的配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'FilterParams', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'just for POP', - 'description' => 'just for POP', - 'type' => 'string', - 'required' => true, - 'example' => 'param', + 'description' => '此应用的未打标环境，忽略的标签。', + 'type' => 'array', + 'items' => ['description' => '此应用的未打标环境，忽略的标签。', 'type' => 'string', 'required' => false, 'example' => 'gray'], + 'required' => false, + 'docRequired' => true, ], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => '消息灰度的启用状态。取值：'."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => 'hkhon1po62@c3df23522baa898'], + ], + [ + 'name' => 'FilterSide', 'in' => 'query', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '消息灰度过滤侧。', 'type' => 'string', 'required' => false, - 'example' => 'zh', + 'example' => 'Server', + 'default' => 'Server', + 'enum' => ['Server', 'Client'], ], ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['title' => 'MSE命名空间名字', 'description' => 'MSE命名空间名字', 'type' => 'string', 'required' => false, 'example' => 'default', 'maxLength' => 64], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['title' => '应用名称', 'description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'example-app', 'maxLength' => 64], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0951EBF0-798E-5E0B-8D38-460A14AD****', - ], - 'Data' => [ - 'description' => 'Meta返回信息。', - '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' => '路由流控规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48811', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeA', - ], - 'Threshold' => [ - 'description' => '总体QPS阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'BehaviorType' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容'."\n" - ."\n" - .'1：跳转到指定页面', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'Http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => 'Http返回文本。', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - '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' => '路由流控规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48811', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeA', - ], - 'Threshold' => [ - 'description' => '总体QPS阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'StatDurationMs' => [ - 'description' => '统计持续时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'LimitMode' => [ - 'description' => '阈值转化模式。'."\n" - ."\n" - .'0：单机。'."\n" - ."\n" - .'1：集群。'."\n" - ."\n" - .'2：集群转单机。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容'."\n" - ."\n" - .'1：跳转到指定页面', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'Http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => 'Http返回文本。', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '自定义header，输入为key-value键值对。', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '筛选规则id。', - 'type' => 'array', - 'items' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '549', - ], - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'E3919C62-876A-5926-A0BC-18351A24FA35'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Data' => ['description' => '节点数据。', 'type' => 'string', 'example' => 'True'], + 'Code' => ['description' => '状态码。状态码为200表示成功，其余取值表示失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '查询网关流控规则', - ], - 'CreateGatewayCircuitBreakerRule' => [ - 'summary' => '创建网关熔断规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '更新应用消息灰度的配置', + 'changeSet' => [ + ['createdAt' => '2023-03-30T09:31:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更、错误码发生变更'], + ['createdAt' => '2023-01-11T04:12:31.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-11-04T02:39:19.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-09-13T01:52:40.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-09-13T01:52:40.000Z', 'description' => '请求参数发生变更'], ], - 'tags' => [ - 'gateway', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateMessageQueueRoute', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateMigrationTask' => [ + 'summary' => '调用接口更新迁移上云任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'abilityTreeCode' => '155125', + 'abilityTreeNodes' => ['FEATUREmseKDDXNL'], ], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', - ], + 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'RouteId', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '645', - ], + 'schema' => ['description' => '集群类型。'."\n" + ."\n" + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', 'type' => 'string', 'required' => false, 'example' => 'Nacos-Ans'], + ], + [ + 'name' => 'OriginInstanceAddress', + 'in' => 'query', + 'schema' => ['description' => '源实例节点地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1:8848'], + ], + [ + 'name' => 'OriginInstanceName', + 'in' => 'query', + 'schema' => ['description' => '源实例名称。', 'type' => 'string', 'required' => false, 'example' => 'Source cluster'], + ], + [ + 'name' => 'OriginInstanceNamespace', + 'in' => 'query', + 'schema' => ['description' => '命名空间列表，当来源集群是Nacos时选填。', 'type' => 'string', 'required' => false, 'example' => 'namesapceId1,namesapceId2'], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'query', + 'schema' => ['description' => '目标实例ID。', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-ud82*****'], + ], + [ + 'name' => 'TargetClusterName', + 'in' => 'query', + 'schema' => ['description' => '目标实例名称。', 'type' => 'string', 'required' => false, 'example' => 'Target cluster'], + ], + [ + 'name' => 'TargetClusterUrl', + 'in' => 'query', + 'schema' => ['description' => '目标实例Url。', 'type' => 'string', 'required' => false, 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848'], + ], + [ + 'name' => 'ProjectDesc', + 'in' => 'query', + 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description.'], ], [ - 'name' => 'RouteName', + 'name' => 'SyncType', 'in' => 'query', 'schema' => [ - 'description' => '路由名称。', + 'description' => '同步类型', 'type' => 'string', - 'required' => true, - 'example' => 'routeName', + 'required' => false, + 'enumValueTitles' => ['All' => 'All', 'Config' => 'Config', 'Service' => 'Service'], + 'example' => 'All', ], ], [ - 'name' => 'Strategy', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '阈值类型。'."\n" - ."\n" - .'0：慢调用类型。'."\n" - ."\n" - .'1：异常类型。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '1'], + 'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '183876217*****'], + 'ClusterType' => ['description' => '集群类型。'."\n" + ."\n" + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', 'type' => 'string', 'example' => 'Nacos-Ans'], + 'OriginInstanceAddress' => ['description' => '源实例节点地址。', 'type' => 'string', 'example' => '192.168.100.2:2181'], + 'OriginInstanceName' => ['description' => '源实例名称。', 'type' => 'string', 'example' => 'src'], + 'OriginInstanceNamespace' => ['description' => '命名空间列表，当来源集群是Nacos时选填。', 'type' => 'string', 'example' => 'fsdfsdfdsf'], + 'TargetInstanceId' => ['description' => '目标实例ID。', 'type' => 'string', 'example' => 'mse-cn-zvp2u*****'], + 'TargetClusterName' => ['description' => '目标实例名称。', 'type' => 'string', 'example' => 'multiple-nacos'], + 'TargetClusterUrl' => ['description' => '目标实例Url。', 'type' => 'string', 'example' => 'mse-0b*****-nacos-ans.mse.aliyuncs.com:8848'], + 'ProjectDesc' => ['description' => '描述。', 'type' => 'string', 'example' => '1232345'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'GmtModified' => ['description' => '修改日期。'."\n" + ."\n", 'type' => 'string', 'example' => '2022-01-07T10:07:57.000+0000'], + 'SyncType' => ['description' => '同步类型', 'type' => 'string', 'example' => 'All'], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'TriggerRatio', - 'in' => 'query', - 'schema' => [ - 'description' => '触发熔断百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], ], + ], + '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' => '更新迁移上云任务', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'StatDurationSec', - 'in' => 'query', - 'schema' => [ - 'description' => '熔断统计时长。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '11', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateNacosCluster' => [ + 'summary' => '更新Nacos集群信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], + 'security' => [ [ - 'name' => 'RecoveryTimeoutSec', - 'in' => 'query', - 'schema' => [ - 'description' => '熔断恢复时长。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '105189', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], + ], + 'parameters' => [ [ - 'name' => 'MinRequestAmount', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '触发熔断的最小请求数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '实例id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-123456'], ], [ - 'name' => 'MaxAllowedMs', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '慢调用模式下慢调用阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '服务名', 'description' => '服务名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello_service'], ], [ - 'name' => 'BehaviorType', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'Web fallbac行为类型。'."\n" - ."\n" - .'0：返回指定文本。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => '分组名', 'description' => '分组名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'BodyEncoding', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本。'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '命名空间id', 'description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], ], [ - 'name' => 'ResponseStatusCode', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], + 'schema' => ['title' => 'Nacos集群名', 'description' => 'Nacos集群名。', 'type' => 'string', 'required' => true, 'example' => 'DEFAULT'], ], [ - 'name' => 'ResponseContentBody', + 'name' => 'CheckPort', 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], + 'schema' => ['title' => '健康检查端口', 'description' => '健康检查端口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], ], [ - 'name' => 'ResponseRedirectUrl', + 'name' => 'UseInstancePortForCheck', 'in' => 'query', - 'schema' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], + 'schema' => ['title' => '是否使用实例端口进行健康检查', 'description' => '是否使用实例端口进行健康检查。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Enable', + 'name' => 'HealthChecker', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => '健康检查类型', 'description' => '健康检查类型。', 'type' => 'string', 'required' => false, 'example' => '{"type":"none"}'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Data' => [ - 'description' => '返回规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], + 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'Message' => ['title' => '响应信息', 'description' => '响应信息。', 'type' => 'string', 'example' => 'Request succeeded.'], + 'Code' => ['title' => '响应码', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '成功标志', 'description' => '成功标志。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '修改结果', 'description' => '返回结果。', 'type' => 'string', 'example' => 'ok'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新Nacos集群', + '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}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": 28\\n}","type":"json"}]', - 'title' => '创建网关熔断规则', ], - 'DeleteGatewayCircuitBreakerRule' => [ - 'summary' => '删除该网关熔断规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateNacosConfig' => [ + 'summary' => '更新一个Nacos配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], @@ -61463,1131 +32951,627 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', + 'abilityTreeCode' => '17102', + 'abilityTreeNodes' => ['FEATUREmse0BR2XQ'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'GatewayUniqueId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-1cef5440bf2d484db419fb264d4f****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-7pp2a****'], ], [ - 'name' => 'RouteId', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11151', - ], + 'schema' => ['description' => '配置ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ky-check-****.yml'], ], [ - 'name' => 'RuleId', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'description' => '熔断规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分组。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'resource'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'postoffice'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => 'Tag列表。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2021-10-20'], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => ['description' => '配置的描述信息。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Base configuration'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '配置格式，包括text、json、xml、html等。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'text'], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => '配置内容', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '78b7af66-d15f-4541-b886-11ed81ecb6c0'], + ], + [ + 'name' => 'Md5', + 'in' => 'query', + 'schema' => ['description' => 'md5信息。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '045439703a273a94306422b****'], + ], + [ + 'name' => 'BetaIps', + 'in' => 'query', + 'schema' => ['description' => 'Beta发布的IP列表。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '196.168.XX.XX'], + ], + [ + 'name' => 'EncryptedDataKey', + 'in' => 'query', + 'schema' => ['description' => '加密密钥。', 'type' => 'string', 'required' => false, 'example' => '122wdwe****'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'boolean', - 'example' => 'True', - ], + 'HttpCode' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NoPermission'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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' => '更新Nacos配置', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'changeSet' => [], + 'ramActions' => [ [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => '删除网关熔断规则', ], - 'UpdateGatewayCircuitBreakerRule' => [ - 'summary' => '更新该网关熔断规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateNacosGrayConfig' => [ + 'summary' => '更新灰度配置，包含基于Beta发布和标签灰度的灰度配置信息更新', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215876', + 'abilityTreeNodes' => ['FEATUREmseK09GZC'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '熔断规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '369', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], - ], - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - ], - [ - 'name' => 'RouteId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '645', - ], + 'schema' => ['title' => '实例id', 'description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'mse_prepaid_public_cn-st2212****'], ], [ - 'name' => 'RouteName', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], + 'schema' => ['title' => '命名空间ID，默认为public', 'description' => '命名空间ID，默认为public', 'type' => 'string', 'required' => false, 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba'], ], [ - 'name' => 'Strategy', + 'name' => 'Group', 'in' => 'query', - 'schema' => [ - 'description' => '阈值类型。'."\n" - ."\n" - .'0：慢调用类型。'."\n" - ."\n" - .'1：异常类型。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => '配置分组，默认为DEFAULT_GROUP', 'description' => '配置分组，默认为DEFAULT_GROUP', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'TriggerRatio', + 'name' => 'DataId', 'in' => 'query', - 'schema' => [ - 'description' => '触发熔断百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '配置dataId', 'description' => '配置dataId', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ - 'name' => 'StatDurationSec', + 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => '熔断统计时长。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['title' => '配置内容', 'description' => '配置内容', 'type' => 'string', 'required' => false, 'example' => 'asdf'], ], [ - 'name' => 'RecoveryTimeoutSec', + 'name' => 'GrayType', 'in' => 'query', 'schema' => [ - 'description' => '熔断恢复时长。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '灰度类型，支持Beta灰度(根据IP灰度)和标签灰度', + 'description' => '灰度类型，支持Beta灰度(根据IP灰度)和标签灰度', + 'type' => 'string', 'required' => true, - 'example' => '12', + 'example' => 'Tags', + 'enum' => ['Beta', 'Tags'], ], ], [ - 'name' => 'MinRequestAmount', + 'name' => 'GrayRule', 'in' => 'query', - 'schema' => [ - 'description' => '触发熔断的最小请求数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '灰度规则，如果是Beta灰度，此处是灰度的客户端的ip，使用逗号分隔；如果是标签灰度，此处是 标签名=标签值，多个标签值使用逗号分隔', 'description' => '灰度规则，如果是Beta灰度，此处是灰度的客户端的ip，使用逗号分隔；如果是标签灰度，此处是 标签名=标签值，多个标签值使用逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'key=value1,value2'], ], [ - 'name' => 'MaxAllowedMs', + 'name' => 'StopGray', 'in' => 'query', - 'schema' => [ - 'description' => '慢调用模式下慢调用阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '是否停止灰度', 'description' => '是否停止灰度', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ - 'name' => 'BehaviorType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定文本'."\n" - ."\n" - .'1：跳转到指定页面', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'BodyEncoding', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '参数弃用，无需填写', 'description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'ResponseStatusCode', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], + 'schema' => ['title' => '应用名', 'description' => '应用名', 'type' => 'string', 'required' => false, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'ResponseContentBody', + 'name' => 'GrayRuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], + 'schema' => ['title' => '灰度版本名称', 'description' => '灰度版本名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'], ], [ - 'name' => 'ResponseRedirectUrl', + 'name' => 'GrayRulePriority', 'in' => 'query', - 'schema' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], + 'schema' => ['title' => '灰度版本优先级', 'description' => '灰度版本优先级', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ - 'name' => 'Enable', + 'name' => 'OpType', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => '操作类型，Create（创建新的灰度配置），Update（更新存在的灰度配置）', 'description' => '操作类型，Create（创建新的灰度配置），Update（更新存在的灰度配置）', 'type' => 'string', 'required' => false, 'example' => 'Create'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'RestResult', + 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '熔断规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '369', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-c9bc5afd61014165bd58f621b491****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '645', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeName', - ], - 'Strategy' => [ - 'description' => '阈值类型。'."\n" - ."\n" - .'0：慢调用类型。'."\n" - ."\n" - .'1：异常类型。', - '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' => '阈值转化模式。'."\n" - ."\n" - .'0：单机。'."\n" - ."\n" - .'1：集群。'."\n" - ."\n" - .'2：集群转单机。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => 'Web fallbaco行为类型。'."\n" - ."\n" - .'0：返回指定文本。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本。'."\n" - ."\n" - .'1：JSON。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '201', - ], - 'ResponseContentBody' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '自定义header，输入为key-value键值对。', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '筛选规则id', - 'type' => 'array', - 'items' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '369', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Data' => ['title' => '是否更新成功', 'description' => '是否更新成功', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '更新Nacos灰度配置信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '更新网关熔断规则', ], - 'ListGatewayCircuitBreakerRule' => [ - 'summary' => '查询该网关熔断规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateNacosInstance' => [ + 'summary' => '更新注册在Nacos中的实例信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'abilityTreeCode' => '18554', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'FilterParams', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'just for POP', - 'description' => 'just for POP', - 'type' => 'string', - 'required' => true, - 'example' => 'param', - ], + 'schema' => ['title' => '实例id', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-123456'], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['title' => '服务名', 'description' => '服务名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello_service'], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['title' => '分组名', 'description' => '分组名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DEFAULT_GROUP'], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => ['title' => '命名空间id', 'description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9e78a671-4b9b-4dd4-99c1-0****'], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => ['title' => 'Nacos集群名', 'description' => 'Nacos集群名称。', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => ['title' => 'Nacos实例ip', 'description' => 'Nacos实例IP。', 'type' => 'string', 'required' => true, 'example' => '1.2.X.X'], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['title' => 'Nacos实例端口', 'description' => 'Nacos实例端口。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12281'], + ], + [ + 'name' => 'Ephemeral', + 'in' => 'query', + 'schema' => ['title' => '临时节点标志', 'description' => '是否为非持久化节点，取值如下：'."\n" + .'- `true`：是。'."\n" + .'- `false`：否。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + ], + [ + 'name' => 'Weight', + 'in' => 'query', + 'schema' => ['title' => '权重', 'description' => '权重，为范围0～10000的整数。值越大，访问到该实例的频率越高。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => ['title' => '服务禁用标志', 'description' => '是否启用此服务，取值如下：'."\n" + ."\n" + .'- `true`：是。'."\n" + .'- `false`：否。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], + [ + 'name' => 'Metadata', + 'in' => 'formData', + 'schema' => ['title' => '节点元数据', 'description' => '节点元数据。', 'type' => 'string', 'required' => false, 'example' => '[int]'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '熔断规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '467', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11919', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-5017305290e14centbrveca****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3091', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeName', - ], - 'Strategy' => [ - 'description' => '阈值模式。'."\n" - ."\n" - .'0：慢调用模式。'."\n" - ."\n" - .'1：异常模式。', - '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' => '阈值转化模式。'."\n" - ."\n" - .'0：单机。'."\n" - ."\n" - .'1：集群。'."\n" - ."\n" - .'2：集群转单机。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'Http状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '204', - ], - 'ResponseContentBody' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '自定义header，输入为key-value键值对。', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '筛选规则id', - 'type' => 'array', - 'items' => [ - 'description' => '规则ID。', - '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' => '熔断规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '467', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11919', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-1ee34548c68f4778a25c05abd657****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3450', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeName', - ], - 'Strategy' => [ - 'description' => '阈值模式。'."\n" - ."\n" - .'0：慢调用模式。'."\n" - ."\n" - .'1：异常模式。', - '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' => '阈值转化模式。'."\n" - ."\n" - .'0：单机。'."\n" - ."\n" - .'1：集群。'."\n" - ."\n" - .'2：集群转单机。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容'."\n" - ."\n" - .'1：跳转到指定页面', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本'."\n" - ."\n" - .'1：JSON', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '204', - ], - 'ResponseContentBody' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '自定义header，输入为key-value键值对。', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '筛选规则id', - 'type' => 'array', - 'items' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '467', - ], - ], - ], - ], - ], - ], - ], + 'description' => '字符串对象。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec'], + 'Message' => ['title' => '响应信息', 'description' => '返回信息。', 'type' => 'string', 'example' => 'Request succeeded.'], + 'Code' => ['title' => '响应码', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['title' => '成功标志', 'description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['title' => '修改结果', 'description' => '修改结果。', 'type' => 'string', 'example' => 'ok'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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":"\\n 200\\n 9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\n 请求成功\\n 200\\n true\\n ok\\n","errorExample":""}]', + 'title' => '更新Nacos实例信息', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询网关熔断规则', ], - 'CreateGatewayIsolationRule' => [ - 'summary' => '创建网关并发规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateNacosService' => [ + 'summary' => '更新Nacos服务。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'abilityTreeCode' => '105086', + 'abilityTreeNodes' => ['FEATUREmseU5ZGQF'], ], 'parameters' => [ [ - 'name' => 'GatewayId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], + 'schema' => ['description' => '实例ID。'."\n" + .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。'."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => 'mse-cn-st21ri2****'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], + 'schema' => ['description' => '服务名称。', 'type' => 'string', 'required' => true, 'example' => 'com.dingtalk.doc.thumbnails.pdf.ThumbnailService'], ], [ - 'name' => 'RouteId', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '52853', - ], + 'schema' => ['description' => '分组名称。', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT_GROUP'], ], [ - 'name' => 'RouteName', + 'name' => 'NamespaceId', 'in' => 'query', - 'schema' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], + 'schema' => ['description' => '命名空间ID。', 'type' => 'string', 'required' => false, 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26'], ], [ - 'name' => 'MaxConcurrency', + 'name' => 'ProtectThreshold', 'in' => 'query', - 'schema' => [ - 'description' => '总体并发数阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => '保护阈值。', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'BehaviorType', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 此接口同时有InstanceId与ClusterId，则其中一项必填。'."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => 'mse-09k1q11****'], ], [ - 'name' => 'BodyEncoding', + 'name' => 'AcceptLanguage', 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本。'."\n" - ."\n" - .'1：JSON。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => '数据概览。', 'type' => 'string', 'example' => '6'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'True'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], [ - 'name' => 'ResponseStatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], + ], + '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' => '更新Nacos服务', + 'description' => '> 当前的OpenAPI并非是Nacos-SDK API，Nacos-SDK API相关内容，请参见[官方文档](https://nacos.io/zh-cn/docs/sdk.html)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdatePluginConfig' => [ + 'summary' => '更新插件配置。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ [ - 'name' => 'ResponseContentBody', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '128635', + 'abilityTreeNodes' => ['FEATUREmseKZMVG1'], + ], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], + 'schema' => ['description' => '插件配置ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ResponseRedirectUrl', + 'name' => 'GatewayId', 'in' => 'query', - 'schema' => [ - 'description' => '跳转路径。', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关UniqueId。', 'type' => 'string', 'required' => false, 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'], + ], + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => ['description' => '网关插件ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => '是否开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'Config', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false], + ], + [ + 'name' => 'ConfigLevel', + 'in' => 'query', + 'schema' => ['description' => '插件应用范围。'."\n" + ."\n" + .'- 全局：0'."\n" + ."\n" + .'- 路由：1'."\n" + ."\n" + .'- 域名：2', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0'], + ], + [ + 'name' => 'ResourceIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', + 'title' => '域名ID/路由ID列表（根据ConfigLevel区分）', + 'description' => '域名ID/路由ID列表（根据ConfigLevel区分）', + 'type' => 'array', + 'items' => ['title' => 'ID值', 'description' => 'ID值', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'], 'required' => false, - 'example' => 'zh', ], ], + [ + 'name' => 'GmtCreate', + 'in' => 'query', + 'schema' => ['description' => '创建时间。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '1667309705000'], + ], + [ + 'name' => 'GmtModified', + 'in' => 'query', + 'schema' => ['description' => '更新时间。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '1667309705000'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'zh：中文'."\n" + .'en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], ], 'responses' => [ 200 => [ @@ -62596,67 +33580,150 @@ 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', - ], - 'Data' => [ - 'description' => '返回规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '608', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => 'code仅仅用来和success同步', 'description' => 'Code。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '500'], + 'HttpStatusCode' => ['description' => 'HTTP STATUS编码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '接口信息。', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['title' => '动态错误信息中的占位符', 'description' => '动态错误信息中的占位符。', 'type' => 'string', 'example' => 'code'], + 'Data' => ['description' => 'id值。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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 \\"DynamicMessage\\": \\"code\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => '更新插件配置', + '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\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', - 'title' => '创建网关并发规则', ], - 'DeleteGatewayIsolationRule' => [ - 'summary' => '删除该网关并发规则。', - 'methods' => [ - 'get', - 'post', + 'UpdateSSLCert' => [ + 'summary' => '更换证书。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '35702', + 'abilityTreeNodes' => ['FEATUREmseM77BTJ'], + ], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => ['description' => '域名ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '210'], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => ['description' => '证书ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5951436-cn-hangzhou'], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => ['description' => '网关唯一标识ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gw-2a99625886d54722be94d92e9a69****'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'CA689BED-08F3-54C2-A206-A0924E2ACA0A'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + ."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '是否更新成功。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation:%s', 'description' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%s'], + ], ], - 'tags' => [ - 'gateway', + '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' => '更换证书', + '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}'], + ], + ], + ], ], + ], + 'UpdateServiceSource' => [ + 'summary' => '修改云原生网关服务来源，目前仅支持对含有Ingress监听配置的ACK容器服务进行修改操作。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['gateway'], 'security' => [ [ 'AK' => [], @@ -62665,3304 +33732,4058 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', + 'abilityTreeCode' => '24909', + 'abilityTreeNodes' => ['FEATUREmseQRG9VI'], ], 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => ['description' => '网关ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '429'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '类型。'."\n" + ."\n" + .'- 容器服务为K8s。'."\n" + .'- NACOS为NACOS。', 'type' => 'string', 'required' => false, 'example' => 'K8s'], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => '来源。'."\n" + ."\n" + .'- 容器服务为K8s。'."\n" + .'- NACOS为MSE。', 'type' => 'string', 'required' => false, 'example' => 'K8s'], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => ['description' => '地址。', 'type' => 'string', 'required' => false, 'example' => 'c9ad2a0717032427e920754e25b49e3b5'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '服务来源ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '63'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'istio'], + ], [ 'name' => 'GatewayUniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], + 'schema' => ['description' => '网关唯一ID。', 'type' => 'string', 'required' => false, 'example' => 'gw-cdd1bb9bfb8341e9805f931a3ba1f4c6'], ], [ - 'name' => 'RouteId', + 'name' => 'IngressOptionsRequest', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11151', + 'description' => 'Ingress配置。', + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => ['description' => '是否开启Ingress。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'IngressClass' => ['description' => '监听Ingress Class。', 'type' => 'string', 'required' => false, 'example' => 'com.test.xxx'], + 'WatchNamespace' => ['description' => '监听目标命名空间。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'EnableStatus' => ['description' => '是否更新Ingress Status。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + 'required' => false, + 'example' => 'zh', ], ], [ - 'name' => 'RuleId', + 'name' => 'PathList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '并发规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'description' => '服务根路径数组。', + 'type' => 'array', + 'items' => ['description' => '服务根路径。', 'type' => 'string', 'required' => false, 'example' => '/path'], + 'required' => false, ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型。'."\n" + .'- zh：中文。'."\n" + .'- en：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', + 'title' => 'Schema of Response', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6AB2B0B6-4A86-54E2-A340-FC47A22EE659'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'], + 'Code' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Success' => ['description' => '请求结果，取值如下。'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => '返回数据。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新服务来源', + '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\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => '删除网关并发规则', ], - 'UpdateGatewayIsolationRule' => [ - 'summary' => '更新该网关并发规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateWebFlowRule' => [ + 'summary' => '更新热点参数防护规则（HTTP 请求）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['msc'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'abilityTreeCode' => '164287', + 'abilityTreeNodes' => ['FEATUREmse6JRV3O'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '并发规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '358', - ], + 'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'default', 'default' => 'default'], ], [ - 'name' => 'GatewayId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14407', - ], + 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'spring-cloud-a'], ], [ - 'name' => 'GatewayUniqueId', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], + 'schema' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'required' => false, 'docRequired' => true, 'example' => '20'], ], [ - 'name' => 'RouteId', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '52853', - ], + 'schema' => ['description' => '规则状态'."\n" + .'- true(开启)'."\n" + .'- false(关闭)', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'RouteName', + 'name' => 'Burst', 'in' => 'query', - 'schema' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'routeName', - ], + 'schema' => ['description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], ], [ - 'name' => 'MaxConcurrency', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '总体并发数阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => '应用Id。', 'type' => 'string', 'required' => false, 'example' => 'hkhon1****@c3df23522******'], ], [ - 'name' => 'BehaviorType', + 'name' => 'ControlBehavior', 'in' => 'query', - 'schema' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => '流控方式'."\n" + ."\n" + .'- 0(快速失败)'."\n" + .'- 2(排队等待)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '0', 'default' => '0'], ], [ - 'name' => 'BodyEncoding', + 'name' => 'MaxQueueingTimeMs', 'in' => 'query', - 'schema' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本。'."\n" - ."\n" - .'1：JSON。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '超时时间，流控效果为排队等待时需要设置，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'], ], [ - 'name' => 'ResponseStatusCode', + 'name' => 'ResourceMode', 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '429', - ], + 'schema' => ['description' => '资源模式'."\n" + ."\n" + .'- 0(资源名模式)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'ResponseContentBody', + 'name' => 'ParamItem', 'in' => 'query', - 'schema' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], + 'schema' => ['description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" + .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" + .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" + .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" + .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', 'type' => 'string', 'required' => false, 'example' => '{"fieldName":"key","matchStrategy":2,"parseStrategy":2,"pattern":"value"}'], ], [ - 'name' => 'ResponseRedirectUrl', + 'name' => 'MetricType', 'in' => 'query', - 'schema' => [ - 'description' => '跳转路径。', - 'type' => 'string', - 'required' => false, - 'example' => 'www.******.com', - ], + 'schema' => ['description' => '阈值类型'."\n" + ."\n" + .'- 1(请求数)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Enable', + 'name' => 'StatIntervalMs', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => '规则Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', - ], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求Id。', 'type' => 'string', 'example' => '54973C90-F379-4372-9AA5-053A3F7****'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200'], 'Data' => [ - 'description' => '返回数据。', + 'description' => '返回集合。', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '并发规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52853', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeName', - ], - 'MaxConcurrency' => [ - 'description' => '总体并发数阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'LimitMode' => [ - 'description' => '阈值转化模式。'."\n" - ."\n" - .'0：单机。'."\n" - ."\n" - .'1：集群。'."\n" - ."\n" - .'2：集群转单机。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本。'."\n" - ."\n" - .'1：JSON。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转路径。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '自定义header，输入为key-value键值对。', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '筛选规则id', - 'type' => 'array', - 'items' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - ], + 'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'], + 'StatIntervalMs' => ['description' => '统计窗口时长（单位毫秒）：统计的时间窗口长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'Id' => ['description' => '规则Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AppName' => ['description' => '应用名', 'type' => 'string', 'example' => 'spring-cloud-a'], + 'Resource' => ['description' => '接口资源名。', 'type' => 'string', 'example' => '/flow'], + 'ControlBehavior' => ['description' => '流控方式'."\n" + .'- 0(快速失败)'."\n" + .'- 2(排队等待)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ReourceMode' => ['description' => '资源模式'."\n" + .'- 0(资源名模式)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Threshold' => ['description' => '阈值。', 'type' => 'number', 'format' => 'float', 'example' => '20'], + 'Enable' => ['description' => '规则状态'."\n" + .'- true(开启)'."\n" + .'- false(关闭)', 'type' => 'boolean', 'example' => 'true'], + 'AppId' => ['description' => '应用Id。', 'type' => 'string', 'example' => 'hkhon1XXXX@54e1f42f37cXXXX'], + 'MetricType' => ['description' => '阈值类型'."\n" + ."\n" + .'- 1(请求数)', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RegionId' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Burst' => ['description' => '针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ParamItem' => ['description' => '参数描述项，JSON格式的字符串，包含以下键值对'."\n" + .'- parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL参数）'."\n" + .'- fieldName：Header名称/URL参数名称，仅在参数属性为2、3时填写'."\n" + .'- matchStrategy：属性值匹配方式，仅在参数属性为2、3且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串）'."\n" + .'- pattern：匹配串，仅在参数属性为2、3且需要属性值匹配时填写', 'type' => 'string', 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}'], ], ], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '更新热点参数防护规则（HTTP 请求）', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateWebFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '更新网关并发规则', ], - 'ListGatewayIsolationRule' => [ - 'summary' => '查询该网关并发规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'gateway', - ], + 'UpdateZnode' => [ + 'summary' => '更新Zookeeper数据节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'abilityTreeCode' => '17105', + 'abilityTreeNodes' => ['FEATUREmseINOH9I'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'FilterParams', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'title' => 'just for POP', - 'description' => 'just for POP', - 'type' => 'string', - 'required' => true, - 'example' => 'param', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-09k1q11****'], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => ['description' => '节点路径。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/zookeeper'], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'schema' => ['description' => '节点数据。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'data'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RestResult>', - 'description' => 'RestResult>', + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '并发规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52853', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeName', - ], - 'MaxConcurrency' => [ - 'description' => '总体并发数阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'LimitMode' => [ - 'description' => '阈值转化模式。'."\n" - ."\n" - .'0：单机'."\n" - ."\n" - .'1：集群'."\n" - ."\n" - .'2：集群转单机', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BehaviorType' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本。'."\n" - ."\n" - .'1：JSON。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '自定义header，输入为key-value键值对', - 'type' => 'string', - 'example' => 'key:value', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '筛选规则id', - 'type' => 'array', - 'items' => [ - 'description' => '规则ID。', - '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' => '并发规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - 'GatewayId' => [ - 'description' => '网关ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14407', - ], - 'GatewayUniqueId' => [ - 'description' => '网关唯一标识ID。', - 'type' => 'string', - 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', - ], - 'RouteId' => [ - 'description' => '路由ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52853', - ], - 'RouteName' => [ - 'description' => '路由名称。', - 'type' => 'string', - 'example' => 'routeName', - ], - 'MaxConcurrency' => [ - 'description' => '总体并发数阈值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'LimitMode' => [ - 'description' => '阈值转化类型。'."\n" - ."\n" - .'0：单机。'."\n" - ."\n" - .'1：集群。'."\n" - ."\n" - .'2：单机转集群。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BehaviorType' => [ - 'description' => 'Web fallback行为类型。'."\n" - ."\n" - .'0：返回指定内容。'."\n" - ."\n" - .'1：跳转到指定页面。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BodyEncoding' => [ - 'description' => '编码类型。'."\n" - ."\n" - .'0：普通文本。'."\n" - ."\n" - .'1：JSON。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResponseStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '429', - ], - 'ResponseContentBody' => [ - 'description' => 'HTTP返回文本。', - 'type' => 'string', - 'example' => 'text', - ], - 'ResponseRedirectUrl' => [ - 'description' => '跳转地址。', - 'type' => 'string', - 'example' => 'www.******.com', - ], - 'ResponseAdditionalHeaders' => [ - 'description' => '自定义header，输入为key-value键值对', - 'type' => 'string', - 'example' => 'key=value', - ], - 'Enable' => [ - 'description' => '是否开启。'."\n" - ."\n" - .'0：不开启。'."\n" - ."\n" - .'1：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IdList' => [ - 'title' => '筛选规则id', - 'description' => '筛选规则id', - 'type' => 'array', - 'items' => [ - 'description' => '规则ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '358', - ], - ], - ], - ], - ], - ], - ], + 'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', - ], + ['errorCode' => 'ZooKeeper.IllegalRequest', 'errorMessage' => 'ZooKeeper operation is illegal.', 'description' => '当前ZooKeeper操作非法，请重新检查后进行操作'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', 'errorMessage' => 'No permission to operate current Znode.', 'description' => '无权限操作当前节点。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', 'errorMessage' => 'The current instance already has this Znode.', 'description' => '当前节点已经存在，请检查后重新操作。'], + ['errorCode' => 'ZooKeeper.IllegalRequest.NoNode', 'errorMessage' => 'The current instance does not have this Znode.', 'description' => '当前操作的节点不存在，可能已经被删除。'], + ['errorCode' => 'ZooKeeper.Timeout', 'errorMessage' => 'ZooKeeper operation timeout.', 'description' => 'ZooKeeper 操作超时，可能由于当前操作的Znode数据过大，子节点过多，Server处理请求时间消耗过长，或者集群当前正在选主，无法处理请求。'], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Invalid request:%s', 'description' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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":"\\n316F5F64-F73D-42DC-8632-01E308B6****\\n请求处理成功\\nmse-100-000\\ntrue\\n","errorExample":""}]', + 'title' => '更新ZooKeeper数据节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateZooKeeperSaslUser' => [ + 'summary' => '修改ZooKeeper sasl 用户信息', + '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' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例Id', 'description' => '实例Id', 'type' => 'string', 'required' => true, 'example' => 'mse_prepaid_public_cn-tl327w****'], + ], + [ + 'name' => 'SaslUser', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '需要更新的用户列表', + 'description' => '需要更新的用户列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserName' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Password' => ['title' => '密码', 'description' => '密码', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx'], + 'Description' => ['title' => '用户描述', 'description' => '用户描述', 'type' => 'string', 'required' => false, 'example' => 'test', 'maxLength' => 128], + 'OriginPassword' => ['title' => '如果要修改密码，需要提供原密码', 'description' => '如果要修改密码，需要提供原密码', 'type' => 'string', 'required' => false, 'example' => 'origin-password'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, ], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + 'name' => 'Reload', + 'in' => 'query', + 'schema' => ['description' => '是否立刻生效', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '316F5F64-F73D-42DC-8632-01E308B6****'], + 'Data' => ['description' => '返回数据。', 'type' => 'boolean', 'example' => 'True'], + ], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新 zookeeper Sasl 用户', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '查询网关并发规则', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": true\\n}","type":"json"}]', ], - 'InitializeServiceLinkRole' => [ - 'summary' => '创建MSE SLR。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'common', - ], + 'UpgradeCluster' => [ + 'summary' => '升级集群版本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'tags' => ['cluster'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '17049', - 'abilityTreeNodes' => [ - 'FEATUREmseRIJL6U', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Token', + 'name' => 'RequestPars', 'in' => 'query', - 'schema' => [ - 'description' => '保留参数，暂未使用', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], + 'schema' => ['description' => '扩展请求参数，JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'RoleName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '服务角色名称，固定为AliyunServiceRoleForMSE', - 'type' => 'string', - 'required' => false, - 'example' => 'AliyunServiceRoleForMSE', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mse-cn-nif1w51wi0c'], + ], + [ + 'name' => 'UpgradeVersion', + 'in' => 'query', + 'schema' => ['description' => '升级目标版本', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.2.1'], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', 'description' => '返回信息的语言类型：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '数据结构。', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '信息。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A5E7D4E3-D30C-56C1-817F-F2B8CE6BXXXX', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'RoleName' => [ - 'description' => '创建的角色名称。', - 'type' => 'string', - 'example' => 'AliyunServiceRoleForMSE', - ], - 'RequiredPermission' => [ - 'description' => '调用接口的RAM权限点。', - 'type' => 'string', - 'example' => 'ram:CreateServiceLinkedRole', - ], - 'ServiceName' => [ - 'description' => '归属服务。', - 'type' => 'string', - 'example' => 'mse.aliyuncs.com', - ], - ], - ], - 'Code' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => '返回信息。'."\n" + ."\n" + .'- 当请求成功时，返回成功信息。'."\n" + .'- 当请求失败时，返回失败原因。', 'type' => 'string', 'example' => 'The request is processed successfully.'], + 'HttpCode' => ['description' => '响应码。', 'type' => 'string', 'example' => '202'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8D855418-177B-5FF8-A021-75B930AD890A'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'mse-100-000'], + 'Success' => ['description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', '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' => '非法请求： %s'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error:%s', 'description' => '请求参数错误：%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' => '没有权限使用此接口：%s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found:%s', 'description' => '资源不存在：%s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'Console error. Try again later:%s', 'description' => '控制台错误.稍后重试：%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' => '升级集群', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpgradeCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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' => '创建MSE SLR', ], - 'CloneSentinelRuleFromAhas' => [ - 'summary' => 'AHAS规则迁移。', - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'mse.cn-wulanchabu.aliyuncs.com', 'vpc' => 'mse-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-beijing.aliyuncs.com', 'endpoint' => 'mse.cn-beijing.aliyuncs.com', 'vpc' => 'mse-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => '郑州（联通合营）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-qingdao.aliyuncs.com', 'endpoint' => 'mse.cn-qingdao.aliyuncs.com', 'vpc' => 'mse-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'regionName' => '华中1（武汉-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-shanghai.aliyuncs.com', 'endpoint' => 'mse.cn-shanghai.aliyuncs.com', 'vpc' => 'mse-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-hongkong.aliyuncs.com', 'endpoint' => 'mse.cn-hongkong.aliyuncs.com', 'vpc' => 'mse-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => '华南2（河源）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-heyuan.aliyuncs.com', 'endpoint' => 'mse.cn-heyuan.aliyuncs.com', 'vpc' => 'mse-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'mse.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'mse-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-shenzhen.aliyuncs.com', 'endpoint' => 'mse.cn-shenzhen.aliyuncs.com', 'vpc' => 'mse-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华东6（福州-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-fuzhou.aliyuncs.com', 'endpoint' => 'mse.cn-fuzhou.aliyuncs.com', 'vpc' => 'mse-vpc.cn-fuzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-chengdu.aliyuncs.com', 'endpoint' => 'mse.cn-chengdu.aliyuncs.com', 'vpc' => 'mse-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-guangzhou.aliyuncs.com', 'endpoint' => 'mse.cn-guangzhou.aliyuncs.com', 'vpc' => 'mse-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-huhehaote.aliyuncs.com', 'endpoint' => 'mse.cn-huhehaote.aliyuncs.com', 'vpc' => 'mse-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '泰国（曼谷）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mse.cn-hangzhou.aliyuncs.com', 'endpoint' => 'mse.cn-hangzhou.aliyuncs.com', 'vpc' => 'mse-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', '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' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', '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' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '找不到此集群'], + ['code' => 'configCenterConnectError', 'message' => 'configCenter connect error:%s', 'http_code' => 400, 'description' => '连接注册配置中心引擎失败：%s'], + ['code' => 'duplicatedClusterAliasName', 'message' => 'duplicated cluster alias name', 'http_code' => 400, 'description' => '实例名称已重复，请换一个'], + ['code' => 'illegalRequest', 'message' => 'illegal request:%s', 'http_code' => 400, 'description' => '非法请求：%s'], + ['code' => 'IllegalRequest', 'message' => 'Invalid request:%s', 'http_code' => 400, 'description' => '非法请求： %s'], + ['code' => 'InternalError', 'message' => 'Console error. Try again later:%s', 'http_code' => 500, 'description' => '控制台错误.稍后重试：%s'], + ['code' => 'InvalidParameter', 'message' => 'Parameter error:%s', 'http_code' => 400, 'description' => '请求参数错误：%s'], + ['code' => 'InvalidResourceGroup', 'message' => 'The specified ResourceGroupId is invalid.', 'http_code' => 400, 'description' => '资源组错误'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation:%s', 'http_code' => 403, 'description' => '没有权限使用此接口：%s'], + ['code' => 'NotFound', 'message' => 'Not found:%s', 'http_code' => 404, 'description' => '资源不存在：%s'], + ['code' => 'OperationNotSupport', 'message' => 'The current cluster does not support this operation, %s.', 'http_code' => 400, 'description' => '当前集群不支持此操作, %s'], + ['code' => 'PARAMETER.ILLEGALL', 'message' => 'Parameters are invalid.', 'http_code' => 400, 'description' => '配额中心回调Mse指定的错误码，API调用参数异常'], + ['code' => 'QUOTA.NOT.FOUND', 'message' => 'Quota not found.', 'http_code' => 404, 'description' => '配额不存在'], + ['code' => 'regcenterError', 'message' => 'register center error:%s', 'http_code' => 500, 'description' => '注册配置中心请求错误：%s'], + ['code' => 'Resource.exist', 'message' => 'Resource %s already exists, cannot be created repeatedly.', 'http_code' => 400, 'description' => '资源已经存在，无法重复创建'], + ['code' => 'systemError', 'message' => 'system error', 'http_code' => 500, 'description' => '系统开小差了，请稍后重试'], + ['code' => 'ZooKeeper.IllegalRequest', 'message' => 'ZooKeeper operation is illegal.', 'http_code' => 400, 'description' => '当前ZooKeeper操作非法，请重新检查后进行操作'], + ['code' => 'ZooKeeper.IllegalRequest.NoAuth', 'message' => 'No permission to operate current Znode.', 'http_code' => 400, 'description' => '无权限操作当前节点。'], + ['code' => 'ZooKeeper.IllegalRequest.NodeExist', 'message' => 'The current instance already has this Znode.', 'http_code' => 400, 'description' => '当前节点已经存在，请检查后重新操作。'], + ['code' => 'ZooKeeper.IllegalRequest.NoNode', 'message' => 'The current instance does not have this Znode.', 'http_code' => 400, 'description' => '当前操作的节点不存在，可能已经被删除。'], + ['code' => 'ZooKeeper.Timeout', 'message' => 'ZooKeeper operation timeout.', 'http_code' => 400, 'description' => 'ZooKeeper 操作超时，可能由于当前操作的Znode数据过大，子节点过多，Server处理请求时间消耗过长，或者集群当前正在选主，无法处理请求。'], + ['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' => '请求被安全护栏检测拦截，请检查请求内容后修改重试，拦截原因：%s，拦截内容：%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' => '请求被安全护栏检测拦截，请检查请求内容后修改重试，拦截详情: %s.'], + ['code' => 'PromptNotSupported', 'message' => 'The current instance does not support prompt registry.', 'http_code' => 400, 'description' => '当前实例不支持 Prompt 管理功能'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GetGatewayConfig'], + ], + 'createdAt' => '2026-06-30T13:59:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GetGatewayConfig'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2026-06-30T13:57:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GetGatewayConfig'], ], - 'tags' => [ - 'msc', + 'createdAt' => '2026-06-30T13:57:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GetGatewayConfig'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2026-06-30T08:46:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'AddGatewayDomain'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateGatewayDomain'], + ['description' => 'OpenAPI 下线', 'api' => 'GetGatewayDomainDetail'], + ], + 'createdAt' => '2026-03-12T02:35:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GetGatewayDomainDetail'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateGatewayDomain'], + ['description' => 'OpenAPI 下线', 'api' => 'AddGatewayDomain'], + ], + 'createdAt' => '2026-03-03T08:16:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'QueryBusinessLocations'], + ['description' => 'OpenAPI 下线', 'api' => 'QueryBusinessLocations'], + ], + 'createdAt' => '2026-02-27T05:54:51.000Z', + 'description' => '', + ], + ], + 'ram' => [ + 'productCode' => 'MSE', + 'productName' => '微服务引擎', + 'ramCodes' => ['mse', 'microgw'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'QueryZnodeDetail', + 'description' => '查询ZooKeeper数据节点', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryZnodeDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryGatewayType', + 'description' => '查询网关可用类型', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGatewayType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetServiceList', + 'description' => '查询应用服务信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNacosConfig', + 'description' => '获取Nacos配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'EngineNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}'], + ], + ], + ], + [ + 'apiName' => 'FetchLosslessRuleList', + 'description' => '获取无损上下线规则列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:FetchLosslessRuleList', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'GetTagsBySwimmingLaneGroupId', + 'description' => '获取当前泳道组内的所有标签', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetTagsBySwimmingLaneGroupId', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMseSource', + 'description' => '查询MSE Nacos来源', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetMseSource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceCount', + 'description' => '集群可开通的节点数', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListInstanceCount', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAppBySwimmingLaneGroupTag', + 'description' => '获取当前泳道组内的指定标签的应用列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListAppBySwimmingLaneGroupTag', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'DeleteSwimmingLane', + 'description' => '删除全链路泳道', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteSwimmingLane', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneSentinelRuleFromAhas', + 'description' => 'AHAS规则迁移', 'operationType' => 'create', - 'abilityTreeCode' => '209225', - 'abilityTreeNodes' => [ - 'FEATUREmseHJJ9Z1', + 'ramAction' => [ + 'action' => 'mse:CloneSentinelRuleFromAhas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间', - 'description' => '命名空间', - 'type' => 'string', - 'required' => true, - 'example' => 'default', + [ + 'apiName' => 'DeleteNacosConfig', + 'description' => '删除Nacos配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'MseAppName', - 'in' => 'query', - 'schema' => [ - 'description' => '迁移后目标 mse 应用名。未填写的情况下默认和 ahas 应用名一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'spring-cloud-a', + ], + [ + 'apiName' => 'GetOverview', + 'description' => '查询应用概览', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:GetOverview', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名称', - 'description' => '应用名称', - 'type' => 'string', - 'required' => false, - 'example' => 'spring-cloud-a', + ], + [ + '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}'], ], ], - [ - 'name' => 'AhasNamespace', - 'in' => 'query', - 'schema' => [ - 'title' => 'AHAS侧命名空间（环境）。', - 'description' => 'AHAS侧命名空间（环境）。', - 'type' => 'string', - 'required' => true, - 'example' => 'default', + ], + [ + '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}'], ], ], - [ - 'name' => 'IsAHASPublicRegion', - 'in' => 'query', - 'schema' => [ - 'title' => 'AHAS侧是否为公网地域。', - 'description' => 'AHAS侧是否为公网地域。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + ], + [ + 'apiName' => 'ListGatewayFlowRule', + 'description' => '查询网关流控规则', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'UpdateConfig', + 'description' => '更新集群配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult>>', - 'description' => 'RestResult>>', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id。', - 'description' => '请求Id。', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Data' => [ - 'title' => '返回结果。', - 'description' => '返回结果。', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '执行结果。', - 'description' => '执行结果。', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => '"完成 AHAS prod:spring-cloud-b -> MSE prod:spring-cloud-b 应用的流控规则迁移。AHAS 侧总规则数: 14 ；成功迁移的规则数: 7 ；完成迁移但存在异常的规则数: 2 ；迁移失败的规则数: 5"', - 'description' => '执行结果详情', - ], - ], - ], - ], + [ + 'apiName' => 'ImportServices', + 'description' => '创建网关服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:ImportServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'QuerySwimmingLaneById', + 'description' => '通过泳道ID查询泳道信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QuerySwimmingLaneById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'GovernanceNamespace', 'arn' => 'acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}'], + ], + ], + ], + [ + 'apiName' => 'UpdateIsolationRule', + 'description' => '更新隔离规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'UpdateNacosInstance', + 'description' => '更新Nacos实例信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + '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}'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListGatewayIsolationRule', + 'description' => '查询网关并发规则', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'DeleteIsolationRules', + 'description' => '删除隔离规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteIsolationRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'DeleteCluster', + 'description' => '删除集群', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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' => 'AHAS规则迁移', - ], - 'ChangeResourceGroup' => [ - 'summary' => '资源转组', - 'methods' => [ - 'post', - 'get', + [ + '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}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'tags' => [ - 'common', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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/*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListClusterTypes', + 'description' => '查询引擎类型', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListClusterTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListZkTrack', + 'description' => '查询ZooKeeper轨迹数据', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZkTrack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMigrationTask', + 'description' => '更新迁移上云任务', 'operationType' => 'update', - 'abilityTreeCode' => '150111', - 'abilityTreeNodes' => [ - 'FEATUREmseYGMCYE', + 'ramAction' => [ + 'action' => 'mse:UpdateMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型，例如注册配置中心集群、网关实例', - 'type' => 'string', - 'required' => false, - 'example' => 'Cluster,Gateway', - 'default' => 'Cluster', + [ + 'apiName' => 'UpdateCluster', + 'description' => '更新集群信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源Id', - 'description' => '资源Id，即注册配置中心实例ID或网关唯一ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-xxxxxxxxxxx，'."\n" - .'gw-xxxxxxxxxxxxxxxxxxxx', + ], + [ + '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}'], ], ], - [ - 'name' => 'ResourceRegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域Id', - 'description' => '地域Id', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + ], + [ + '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}'], ], ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '目标资源组', - 'description' => '目标资源组', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acfm34x43l*****', + ], + [ + 'apiName' => 'ListClusterHealthCheckTask', + 'description' => '获取风险评估任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusterHealthCheckTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'TagResources', + 'description' => '添加标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '54973C90-F379-4372-9AA5-053A3F7****', - ], - ], + [ + 'apiName' => 'GetLocalityRule', + 'description' => '获取同可用区优先路由规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetLocalityRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NoPermission.ChangeResourceGroup', - 'errorMessage' => 'You are not authorized to change resourcegroup', + [ + 'apiName' => 'QueryClusterInfo', + 'description' => '查询集群静态信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'MissingParameter.ResourceRegionId', - 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + ], + [ + 'apiName' => 'ListIsolationRules', + 'description' => '获取隔离规则列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListIsolationRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'MissingParameter.ResourceId', - 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + ], + [ + '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}'], ], - [ - 'errorCode' => 'MissingParameter.ResourceGroupId', - 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + ], + [ + 'apiName' => 'QueryMonitor', + 'description' => '查询监控信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryMonitor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidResourceGroup', - 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + ], + [ + 'apiName' => 'AddAuthPolicy', + 'description' => '创建服务鉴权规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:AddAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred while processing your request', + ], + ], + [ + 'apiName' => 'AddGatewaySlb', + 'description' => '关联网关SLB', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => ' The specified resource is not found', + ], + ], + [ + 'apiName' => 'DeleteEngineNamespace', + 'description' => '删除引擎命名空间', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + ], + ], + [ + '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}'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'ListNacosMcpServers', + 'description' => '查询 MCP 服务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListNacosMcpServers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListEurekaServices', + 'description' => '查询Eureka服务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListEurekaServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'QueryInstancesInfo', + 'description' => '查询集群静态信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryInstancesInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'GetAppMessageQueueRoute', + 'description' => '获取应用消息灰度信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetAppMessageQueueRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\"\\n}","type":"json"}]', - 'title' => '更改实例所在资源组', - ], - 'UpdateNacosGrayConfig' => [ - 'summary' => '更新灰度配置，包含基于Beta发布和标签灰度的灰度配置信息更新', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'CreateGatewayIsolationRule', + 'description' => '创建网关并发规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListZnodeChildren', + 'description' => '查询ZooKeeper子节点', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZnodeChildren', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'AddMigrationTask', + 'description' => '添加迁移上云任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '215876', - 'abilityTreeNodes' => [ - 'FEATUREmseK09GZC', + [ + 'apiName' => 'ListConfigTrack', + 'description' => '获取Nacos配置中心推送轨迹', + '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}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例id', - 'description' => '实例id', - 'type' => 'string', - 'required' => true, - 'example' => 'mse_prepaid_public_cn-st2212****', + [ + '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}'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间ID，默认为public', - 'description' => '命名空间ID，默认为public', - 'type' => 'string', - 'required' => false, - 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba', + ], + [ + '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}'], ], ], - [ - 'name' => 'Group', - 'in' => 'query', - 'schema' => [ - 'title' => '配置分组，默认为DEFAULT_GROUP', - 'description' => '配置分组，默认为DEFAULT_GROUP', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', + ], + [ + 'apiName' => 'ListGateway', + 'description' => '查询网关信息列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'title' => '配置dataId', - 'description' => '配置dataId', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + ], + [ + 'apiName' => 'CloneNacosConfig', + 'description' => '克隆Nacos配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CloneNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'title' => '配置内容', - 'description' => '配置内容', - 'type' => 'string', - 'required' => false, - 'example' => 'asdf', + ], + [ + 'apiName' => 'QueryAllSwimmingLaneGroup', + 'description' => '查询所有泳道组', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryAllSwimmingLaneGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'GrayType', - 'in' => 'query', - 'schema' => [ - 'title' => '灰度类型，支持Beta灰度(根据IP灰度)和标签灰度', - 'description' => '灰度类型，支持Beta灰度(根据IP灰度)和标签灰度', - 'type' => 'string', - 'required' => true, - 'example' => 'Tags', - 'enum' => [ - 'Beta', - 'Tags', - ], + ], + [ + 'apiName' => 'UpdateNacosConfig', + 'description' => '更新Nacos配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'GrayRule', - 'in' => 'query', - 'schema' => [ - 'title' => '灰度规则，如果是Beta灰度，此处是灰度的客户端的ip，使用逗号分隔；如果是标签灰度，此处是 标签名=标签值，多个标签值使用逗号分隔', - 'description' => '灰度规则，如果是Beta灰度，此处是灰度的客户端的ip，使用逗号分隔；如果是标签灰度，此处是 标签名=标签值，多个标签值使用逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'key=value1,value2', + ], + [ + 'apiName' => 'GetNacosMcpServer', + 'description' => '获取MCP Server详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosMcpServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'StopGray', - 'in' => 'query', - 'schema' => [ - 'title' => '是否停止灰度', - 'description' => '是否停止灰度', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', + ], + [ + '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' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + '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' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'title' => '参数弃用，无需填写', - 'description' => '扩展请求参数，JSON格式。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'ListClusters', + 'description' => '查询集群列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateEngineNamespace', + 'description' => '创建引擎命名空间', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'title' => '应用名', - 'description' => '应用名', - 'type' => 'string', - 'required' => false, - 'example' => 'spring-cloud-a', + ], + [ + 'apiName' => 'DeleteGatewayCircuitBreakerRule', + 'description' => '删除网关熔断规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'GrayRuleName', - 'in' => 'query', - 'schema' => [ - 'title' => '灰度版本名称', - 'description' => '灰度版本名称', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'CreateMseServiceApplication', + 'description' => '创建应用', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateMseServiceApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'GrayRulePriority', - 'in' => 'query', - 'schema' => [ - 'title' => '灰度版本优先级', - 'description' => '灰度版本优先级', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', + ], + [ + 'apiName' => 'ExportZookeeperData', + 'description' => 'zookeeper发起导出数据任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ExportZookeeperData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'OpType', - 'in' => 'query', - 'schema' => [ - 'title' => '操作类型，Create（创建新的灰度配置），Update（更新存在的灰度配置）', - 'description' => '操作类型，Create（创建新的灰度配置），Update（更新存在的灰度配置）', - 'type' => 'string', - 'required' => false, - 'example' => 'Create', + ], + [ + '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' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'UpdateMessageQueueRoute', + 'description' => '更新应用消息灰度的配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateMessageQueueRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', - ], - 'Data' => [ - 'title' => '是否更新成功', - 'description' => '是否更新成功', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + '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}'], ], ], ], - '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', + [ + '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}'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'GetGovernanceKubernetesCluster', + 'description' => '查询已接入服务治理的集群信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + '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}'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'GetApplicationInstanceList', + 'description' => '获取应用实例信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetApplicationInstanceList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'ListGatewayAuth', + 'description' => '获取网关鉴权列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewayAuth', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + '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}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => '更新Nacos灰度配置信息', - ], - 'UpdateGatewayConfig' => [ - 'summary' => '更新网关配置', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DeleteNacosService', + 'description' => '删除Nacos服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'UpdateZooKeeperSaslUser', + 'description' => '更新 zookeeper Sasl 用户', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'gateway', + [ + 'apiName' => 'AddZooKeeperSaslUser', + 'description' => '增加 zookeeper Sasl 用户', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteMigrationTask', + 'description' => '删除迁移上云任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteMigrationTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '261694', - 'abilityTreeNodes' => [ - 'FEATUREmseS26K2N', + [ + 'apiName' => 'DeleteWebFlowRules', + 'description' => '删除热点参数防护（HTTP）规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteWebFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GatewayUniqueId', - 'in' => 'query', - 'schema' => [ - 'title' => '网关唯一ID', - 'description' => '网关唯一ID', - 'type' => 'string', - 'required' => true, - 'example' => 'gw-b525dc1adf3c486ab96224a6346*****', + [ + 'apiName' => 'GetServiceListeners', + 'description' => '获取nacos服务监听者', + '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' => '参数配置名称，支持的配置项：'."\n" - ."\n" - .'- EnableHttp2'."\n" - ."\n" - .'- DownstreamIdleTime'."\n" - ."\n" - .'- PreserveHeaderFormat'."\n" - ."\n" - .'- UpstreamIdleTimeout'."\n" - ."\n" - .'- EnableXffTrustedCidrs'."\n" - ."\n" - .'- EnableK8sSourceWorkloadFilter', - 'type' => 'string', - 'required' => true, - 'example' => 'EnableK8sSourceWorkloadFilter', + ], + [ + 'apiName' => 'CreateNacosInstance', + 'description' => '创建Nacos实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ConfigValue', - 'in' => 'query', - 'schema' => [ - 'title' => '参数配置值', - 'description' => '参数配置值，配置示例：'."\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\\n2.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"}', + ], + [ + 'apiName' => 'GetNacosHistoryConfig', + 'description' => '查询Nacos配置历史', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosHistoryConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListWebFlowRules', + 'description' => '查询热点参数防护规则（HTTP）', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListWebFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'CreateNacosMcpServer', + 'description' => '创建MCP服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateNacosMcpServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'UpdateNacosGrayConfig', + 'description' => '更新Nacos灰度配置信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ListNacosConfigs', + 'description' => '查询Nacos配置列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNacosConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '全部资源', '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' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4D****\\"\\n}","type":"json"}]', - 'title' => '更新网关参数配置', - ], - 'CreateSentinelBlockFallbackDefinition' => [ - 'summary' => '创建行为管理', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListTagResources', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '创建Nacos配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListApplicationsWithTagRules', + 'description' => '获取应用的路由规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListApplicationsWithTagRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateZnode', + 'description' => '更新ZooKeeper数据节点', 'operationType' => 'update', - 'abilityTreeCode' => '163988', - 'abilityTreeNodes' => [ - 'FEATUREmse6JRV3O', + 'ramAction' => [ + 'action' => 'mse:UpdateZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '获取微服务治理K8s集群信息列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryGovernanceKubernetesCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => '语言，如 Java、Go。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'JAVA', + ], + [ + 'apiName' => 'GetMseFeatureSwitch', + 'description' => '获取MSE能力开关', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetMseFeatureSwitch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'MSE命名空间名字', - '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' => '应用id，可省略', - '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' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Scenario', - 'in' => 'query', - 'schema' => [ - 'description' => '场景，统一填写 default', - 'type' => 'string', - 'required' => false, - 'example' => 'default', + ], + [ + 'apiName' => 'QueryNacosGrayConfig', + 'description' => '查询Nacos灰度配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetNacosConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceClassification', - 'in' => 'query', - 'schema' => [ - 'description' => '针对的资源类型', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1 Web'."\n" - .'2 Rpc', + ], + [ + 'apiName' => 'DeleteNacosConfigs', + 'description' => '批量删除Nacos配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '查询网关入口SLB', + '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' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListAnsInstances', + 'description' => '查询Nacos服务实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'ResourceClassification' => [ - 'description' => '针对的资源类型', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UserId' => [ - 'description' => '用户id', - 'type' => 'string', - 'example' => '123456', - ], - 'AppName' => [ - 'description' => '应用名称。', - 'type' => 'string', - 'example' => 'spring-cloud-a', - ], - 'Id' => [ - 'description' => '行为ID。', - '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' => '请求结果，取值如下：'."\n" - .'- `true`：请求成功。'."\n" - .'- `false`：请求失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - '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' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'RemoveZooKeeperSaslUser', + 'description' => '删除 zookeeper Sask 用户', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:RemoveZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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"}]', - 'title' => '创建流量防护自定义行为', - ], - 'CreateNacosMcpServer' => [ - 'summary' => '创建一个MCP Server。', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'QueryClusterSpecification', + 'description' => '查询集群规格', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:QueryClusterSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => 'Zookeeper导出任务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListExportZookeeperData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateGatewayFlowRule', + 'description' => '创建网关流控规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateZnode', + 'description' => '创建ZooKeeper数据节点', 'operationType' => 'create', - 'abilityTreeCode' => '273078', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', + 'ramAction' => [ + 'action' => 'mse:CreateZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - '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' => 'Server描述的JSON字符串', - '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' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ToolSpecification', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Tool的描述的JSON字符串', - 'description' => 'Tool的描述的JSON字符串', - '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' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'EndpointSpecification', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Endpoint描述的Json字符串', - 'description' => 'Endpoint描述的Json字符串', - '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' => '实例ID。', - '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' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'YamlConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'AI 网关 Yaml 配置，选填。', - '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', - 'required' => false, + ], + [ + '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' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListSecurityGroupRule', + 'description' => '查询网关安全组列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListSecurityGroupRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '查询SLB类型', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:QuerySlbSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + ], + ], + [ + 'apiName' => 'QueryNamespace', + 'description' => '查询MSE命名空间', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '全部资源', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'ImportZookeeperData', + 'description' => '发起Zookeeper数据导入', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ImportZookeeperData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => '全部资源', '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' => '获取Nacos注册中心推送轨迹', + '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"}]', - 'title' => '创建MCP服务', - ], - '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' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + '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}'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '273079', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', + [ + 'apiName' => 'QueryConfig', + 'description' => '查询集群配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-u0t2xzvxa06', + [ + '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}'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'fc0f6e40-****-946b-45e3af313707', + ], + [ + '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}'], ], ], - [ - 'name' => 'McpServerId', - 'in' => 'query', - 'schema' => [ - 'description' => 'MCP Server 的 Id', - 'type' => 'string', - 'required' => false, - 'example' => '5e3c5211-d365-4013-8540-c4106ec2a5dc', + ], + [ + 'apiName' => 'GetZookeeperDataImportUrl', + 'description' => '获取Zookeeper数据导入URL', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetZookeeperDataImportUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'OrderClusterHealthCheckRiskNotice', + 'description' => '订阅风险项通知', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:OrderClusterHealthCheckRiskNotice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'ListAnsServices', + 'description' => '查询Nacos服务详情', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListAnsServices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'DeleteGatewaySlb', + 'description' => '取消关联网关SLB', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + '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}'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + '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}'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'UpdateNacosService', + 'description' => '更新Nacos服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + 'apiName' => 'DeleteNacosInstance', + 'description' => '删除Nacos实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetServiceListPage', + 'description' => '获取服务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceListPage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => '删除 MCP Server', - ], - 'GetNacosMcpServer' => [ - 'summary' => '获取MCP Server的详情', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ListAuthPolicy', + 'description' => '获取服务鉴权规则列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + '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}'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'CreateApplication', + 'description' => '创建应用', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryGatewayRegion', + 'description' => '查询网关支持地域', 'operationType' => 'get', - 'abilityTreeCode' => '273076', - 'abilityTreeNodes' => [ - 'FEATUREmseU5ZGQF', + 'ramAction' => [ + 'action' => 'mse:QueryGatewayRegion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'mse_prepaid_public_cn-tl327w****', + [ + 'apiName' => 'ApplyTagPolicies', + 'description' => '修改标签路由规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ApplyTagPolicies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', + ], + [ + '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}'], ], ], - [ - 'name' => 'McpServerId', - 'in' => 'query', - 'schema' => [ - 'description' => 'MCP Server 的 Id', - 'type' => 'string', - 'required' => false, - 'example' => '5e3c5211-d365-4013-8540-c4106ec2a5dc', + ], + [ + 'apiName' => 'CreateGatewayCircuitBreakerRule', + 'description' => '创建网关熔断规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'McpServerVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'MCP Server的版本', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', + ], + [ + 'apiName' => 'UpdateGatewayRouteHeaderOp', + 'description' => '修改网关路由Header设置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayRouteHeaderOp', + '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' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ImportNacosConfig', + 'description' => '导入Nacos配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:ImportNacosConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '72FC625E-9629-591B-9C01-3F0BFDAB****', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'RemoteServerConfig' => [ - 'description' => 'Remote Server配置', - 'type' => 'object', - 'properties' => [ - 'ServiceRef' => [ - 'description' => '服务引用', - 'type' => 'object', - 'properties' => [ - 'NamespaceId' => [ - 'description' => '命名空间ID。', - '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' => 'Local MCP Server 的配置', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '具体的LocalServer配置', - 'example' => '{'."\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", - ], - ], - 'BackendEndpoints' => [ - 'description' => '后端服务 endpoint', - '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' => 'Tool的描述', - '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' => 'Tool 入参结构', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '{"type":"object","properties":{"name":{"type":"string","description":"name"}}}', - 'description' => '具体的参数结构', - ], - ], - ], - ], - ], - 'ToolsMeta' => [ - 'description' => 'Tool 的元信息MAP', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Enabled' => [ - 'type' => 'boolean', - 'example' => 'true', - 'description' => 'Tool 是否启用', - ], - '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' => '当前 MCP Server 的所有版本信息', - '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' => '该网关是否处于启用状态。'."\n" - ."\n" - .'- true：启用状态。'."\n" - ."\n" - .'- false：停用状态。', - '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' => '当前 MCP Server 的能力', - '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' => 'AI 网关 Yaml 配置。', - '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' => '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}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'GetImage', + 'description' => '查询本地单个镜像信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + '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}'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + '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}'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + '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}'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + '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/*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + '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}'], + ], + ], ], - '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"}]', - 'title' => '获取MCP Server详细信息', - ], - 'ListNacosMcpServers' => [ - 'summary' => '获取McpServer列表', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DeleteFlowRules', + 'description' => '删除流控规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryClusterDetail', + 'description' => '查询集群详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewayFlowRule', + 'description' => '更新网关流控规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'UpdateLocalityRule', + 'description' => '更新同可用区优先路由规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateLocalityRule', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'CreateNamespace', + 'description' => '创建微服务治理命名空间', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryClusterDiskSpecification', + 'description' => '查询集群磁盘规格', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:QueryClusterDiskSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'RemoveAuthPolicy', + 'description' => '删除服务鉴权规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:RemoveAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewayCircuitBreakerRule', + 'description' => '更新网关熔断规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + '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' => '删除MSE命名空间', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteNacosMcpServer', + 'description' => '删除 MCP Server', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteNacosMcpServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SelectGatewaySlb', + 'description' => '查询网关SLB', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:SelectGatewaySlb', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'AddGatewayAuthConsumer', + 'description' => '新增网关鉴权消费者', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:AddGatewayAuthConsumer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpgradeCluster', + 'description' => '升级集群', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:UpgradeCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExportNacosConfig', + 'description' => '导出Nacos配置', + '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' => '全部资源', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - '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' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '命名空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', + ], + [ + 'apiName' => 'CreateNacosService', + 'description' => '创建Nacos服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:CreateNacosService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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' => 'MCP Server名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'EnableProxyProtocol', + 'description' => '开启Proxy协议', + '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' => '全部资源', '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' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ListListenersByIp', + 'description' => '根据IP查询监听者列表', + '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' => '请求ID。', - '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' => '分页的mcp server列表', - 'type' => 'array', - 'items' => [ - 'description' => 'mcp server信息', - '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' => 'MCP Server的类型', - 'type' => 'string', - 'example' => 'stdio', - ], - 'FrontProtocol' => [ - 'description' => '前端协议类型', - 'type' => 'string', - 'example' => 'mcp-sse', - ], - 'Capabilities' => [ - 'description' => '当前 MCP Server 的能力', - 'type' => 'array', - 'items' => [ - 'description' => '当前 MCP Server 的能力', - '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' => '查询Eureka实例列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListEurekaInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateEngineNamespace', + 'description' => '更新引擎命名空间', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateEngineNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateFlowRule', + 'description' => '更新流控规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFlowRules', + 'description' => '获取流控规则列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListFlowRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'AddMockRule', + 'description' => '创建Mock规则', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:AddMockRule', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + '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}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGatewayIsolationRule', + 'description' => '更新网关并发规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateWebFlowRule', + 'description' => '创建热点参数防护（HTTP）规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateWebFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCircuitBreakerRules', + 'description' => '获取熔断规则列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListCircuitBreakerRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSwimmingLaneGroup', + 'description' => '删除全链路泳道组', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:DeleteSwimmingLaneGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetApplicationList', + 'description' => '获取应用列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetApplicationList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'ListNacosHistoryConfigs', + 'description' => '查询Nacos配置历史列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListNacosHistoryConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'CreateSentinelBlockFallbackDefinition', + 'description' => '创建流量防护自定义行为', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:CreateSentinelBlockFallbackDefinition', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + '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}'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + '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}'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Console error. Try again later:%s', + ], + [ + '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}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListClusterVersions', + 'description' => '查询集群版本', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'mse:ListClusterVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - '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"}]', - 'title' => '查询 MCP 服务列表', - ], - 'QueryNacosGrayConfig' => [ - 'summary' => '查询nacos灰度配置', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ListGatewayRoute', + 'description' => '网关路由列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListGatewayRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetLosslessRuleByApp', + 'description' => '获取指定应用无损上下线规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetLosslessRuleByApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'tags' => [ - 'cluster', + [ + 'apiName' => 'DeleteGatewayIsolationRule', + 'description' => '删除网关并发规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteGatewayIsolationRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetServiceMethodPage', + 'description' => '获取服务方法列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:GetServiceMethodPage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetGatewayAuthConsumerDetail', + 'description' => '获取网关鉴权消费者细节', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '216072', - 'abilityTreeNodes' => [ - 'FEATUREmseK09GZC', + 'ramAction' => [ + 'action' => 'mse:GetGatewayAuthConsumerDetail', + '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' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mse-cn-st21ri2****', + [ + 'apiName' => 'UpdateWebFlowRule', + 'description' => '更新热点参数防护规则（HTTP 请求）', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateWebFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'NamespaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间id', - 'description' => '命名空间id', - 'type' => 'string', - 'required' => false, - 'example' => '6bafdde3-4fa7-4d67-b3da-a607ab87f7e4', + ], + [ + '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}'], ], ], - [ - 'name' => 'Group', - 'in' => 'query', - 'schema' => [ - 'title' => '配置分组', - 'description' => '配置分组', - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT_GROUP', + ], + [ + '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}'], ], ], - [ - 'name' => 'DataId', - 'in' => 'query', - 'schema' => [ - 'title' => '配置dataId', - 'description' => '配置dataId', - 'type' => 'string', - 'required' => true, - 'example' => 'demo-develop', + ], + [ + 'apiName' => 'UpdateNacosCluster', + 'description' => '更新Nacos集群', + '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}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群所在地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'UpdateClusterSpec', + 'description' => '更新集群规格', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateClusterSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'RequestPars', - 'in' => 'query', - 'schema' => [ - 'description' => '字段弃用', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + ], + [ + '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}'], ], ], - [ - 'name' => 'GrayName', - 'in' => 'query', - 'schema' => [ - 'description' => '灰度规则名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'ModifyLosslessRule', + 'description' => '修改无损规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ModifyLosslessRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'AcceptLanguage', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'description' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '更改实例所在资源组', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'RestResult', - 'description' => 'RestResult', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'GrayType' => [ - 'title' => '灰度类型，Beta或者Tag', - 'description' => '灰度类型，Beta或者Tag', - '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' => '配置dataId', - 'type' => 'string', - 'example' => 'test.yaml', - ], - 'Content' => [ - 'title' => '配置内容', - 'description' => '配置内容', - 'type' => 'string', - 'example' => 'text', - ], - 'Md5' => [ - 'title' => '配置内容md5', - 'description' => '配置内容md5', - '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' => '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}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Invalid request:%s', + [ + 'apiName' => 'EnableHttp2', + 'description' => '开启HTTP 2', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:EnableHttp2', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => 'Gateway', 'arn' => 'acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error:%s', + ], + ], + [ + 'apiName' => 'ListZooKeeperSaslUser', + 'description' => '查询zookeeper Sasl 用户列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'mse:ListZooKeeperSaslUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + [ + 'apiName' => 'InitializeServiceLinkRole', + 'description' => '创建MSE SLR', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:InitializeServiceLinkRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found:%s', + ], + [ + 'apiName' => 'PreserveHeaderFormat', + 'description' => '开启保持请求header头大小写', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:PreserveHeaderFormat', + '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' => 'RemoveApplication', + 'description' => '删除应用', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:RemoveApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + '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}'], + ], + ], ], - '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' => '查询Nacos灰度配置', - ], - ], - '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' => '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' => '查询ACK集群来源信息', + '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' => '删除ZooKeeper数据节点', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'mse:DeleteZnode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateFlowRule', + 'description' => '创建流控规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'mse:CreateFlowRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListClusterConnectionTypes', + 'description' => '查询集群连接信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:ListClusterConnectionTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateCircuitBreakerRule', + 'description' => '更新熔断规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'mse:UpdateCircuitBreakerRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAuthPolicy', + 'description' => '更新服务鉴权规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'mse:UpdateAuthPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MSE', 'resourceType' => '全部资源', '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