diff options
Diffstat (limited to 'data/en_us/mse/2019-05-31')
| -rw-r--r-- | data/en_us/mse/2019-05-31/api-docs.php | 65758 |
1 files changed, 65758 insertions, 0 deletions
diff --git a/data/en_us/mse/2019-05-31/api-docs.php b/data/en_us/mse/2019-05-31/api-docs.php new file mode 100644 index 0000000..6e45654 --- /dev/null +++ b/data/en_us/mse/2019-05-31/api-docs.php @@ -0,0 +1,65758 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'mse', + 'version' => '2019-05-31', + ], + 'directories' => [ + [ + 'id' => 365620, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'UntagResources', + 'TagResources', + ], + ], + [ + 'id' => 365624, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 365625, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'UpdateMigrationTask', + 'AddMigrationTask', + 'ListMigrationTask', + 'DeleteMigrationTask', + ], + ], + [ + 'id' => 365630, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'PutClusterHealthCheckTask', + 'OrderClusterHealthCheckRiskNotice', + 'ListClusterHealthCheckTask', + ], + ], + [ + 'id' => 365634, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListConfigTrack', + 'CreateNacosConfig', + 'DeleteNacosConfig', + 'DeleteNacosConfigs', + 'UpdateNacosConfig', + 'ListListenersByConfig', + 'ListListenersByIp', + 'GetNacosConfig', + 'GetNacosHistoryConfig', + 'ListNacosConfigs', + 'ListNacosHistoryConfigs', + 'CloneNacosConfig', + 'ExportNacosConfig', + 'GetImportFileUrl', + 'ImportNacosConfig', + ], + ], + [ + 'id' => 365650, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListNamingTrack', + 'CreateNacosService', + 'ListAnsServices', + 'DeleteNacosService', + 'UpdateNacosService', + 'UpdateNacosCluster', + 'ListAnsServiceClusters', + 'CreateNacosInstance', + 'DeleteNacosInstance', + 'UpdateNacosInstance', + 'ListAnsInstances', + 'GetServiceListeners', + ], + ], + [ + 'id' => 365663, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListEurekaServices', + 'ListEurekaInstances', + ], + ], + [ + 'id' => 365666, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QueryMonitor', + ], + ], + [ + 'id' => 365668, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'UpdateAcl', + ], + ], + [ + 'id' => 365670, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QueryInstancesInfo', + 'QueryClusterInfo', + 'QueryClusterDetail', + 'CreateCluster', + 'DeleteCluster', + 'UpdateCluster', + 'UpdateConfig', + 'ListClusters', + 'ListClusterTypes', + 'ListClusterVersions', + 'QueryClusterSpecification', + 'QueryClusterDiskSpecification', + 'ListInstanceCount', + 'QueryConfig', + 'GetImage', + 'UpdateImage', + 'GetMseFeatureSwitch', + 'QueryBusinessLocations', + 'ListClusterConnectionTypes', + 'QuerySlbSpec', + 'UpdateClusterSpec', + 'RestartCluster', + 'RetryCluster', + 'UpgradeCluster', + ], + ], + [ + 'id' => 365695, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateEngineNamespace', + 'DeleteEngineNamespace', + 'UpdateEngineNamespace', + 'GetEngineNamepace', + 'ListEngineNamespaces', + ], + ], + [ + 'id' => 365701, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ImportZookeeperData', + 'GetZookeeperDataImportUrl', + 'ExportZookeeperData', + 'ListExportZookeeperData', + 'CreateZnode', + 'DeleteZnode', + 'UpdateZnode', + 'ListZnodeChildren', + 'QueryZnodeDetail', + 'ListZkTrack', + ], + ], + ], + ], + [ + 'id' => 365712, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 365713, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListSentinelBlockFallbackDefinitions', + 'BindSentinelBlockFallbackDefinition', + 'ListIsolationRules', + 'CreateIsolationRule', + 'DeleteIsolationRules', + 'UpdateIsolationRule', + 'DeleteCircuitBreakerRules', + 'DeleteFlowRules', + 'UpdateFlowRule', + 'ListFlowRules', + 'CreateFlowRule', + 'CreateCircuitBreakerRule', + 'ListCircuitBreakerRules', + 'UpdateCircuitBreakerRule', + 'ListWebFlowRules', + 'CreateWebFlowRule', + 'DeleteWebFlowRules', + 'UpdateWebFlowRule', + ], + ], + [ + 'id' => 365732, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListAuthPolicy', + 'UpdateAuthPolicy', + 'AddAuthPolicy', + 'RemoveAuthPolicy', + ], + ], + [ + 'id' => 365737, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetServiceMethodPage', + 'GetServiceListPage', + 'GetServiceList', + ], + ], + [ + 'id' => 365741, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateOrUpdateSwimmingLaneGroup', + 'DeleteSwimmingLaneGroup', + 'CreateOrUpdateSwimmingLane', + 'DeleteSwimmingLane', + 'QueryAllSwimmingLaneGroup', + 'QueryAllSwimmingLane', + 'GetTagsBySwimmingLaneGroupId', + 'QuerySwimmingLaneById', + 'ListAppBySwimmingLaneGroupTags', + 'ListAppBySwimmingLaneGroupTag', + ], + ], + [ + 'id' => 365752, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetLosslessRuleByApp', + 'ModifyLosslessRule', + 'FetchLosslessRuleList', + ], + ], + [ + 'id' => 365756, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetLocalityRule', + 'UpdateLocalityRule', + ], + ], + [ + 'id' => 365759, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetApplicationList', + 'CreateMseServiceApplication', + 'CreateApplication', + 'GetOverview', + 'RemoveApplication', + 'GetApplicationInstanceList', + ], + ], + [ + 'id' => 365766, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 365767, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QueryGovernanceKubernetesCluster', + 'ModifyGovernanceKubernetesCluster', + 'GetGovernanceKubernetesCluster', + ], + ], + [ + 'id' => 365771, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListNamespaces', + 'CreateNamespace', + 'DeleteNamespace', + 'QueryNamespace', + ], + ], + ], + ], + [ + 'id' => 365776, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ApplyTagPolicies', + 'ListApplicationsWithTagRules', + ], + ], + [ + 'id' => 365779, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetAppMessageQueueRoute', + 'UpdateMessageQueueRoute', + ], + ], + [ + 'id' => 365782, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddMockRule', + ], + ], + ], + ], + [ + 'id' => 365784, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 365785, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetPlugins', + 'GetPluginConfig', + 'CreatePluginConfig', + 'UpdatePluginConfig', + 'DeletePluginConfig', + ], + ], + [ + 'id' => 365791, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddSSLCert', + 'AddGatewayDomain', + 'DeleteGatewayDomain', + 'UpdateSSLCert', + 'UpdateGatewayDomain', + 'ListSSLCert', + 'ListGatewayDomain', + 'GetGatewayDomainDetail', + ], + ], + [ + 'id' => 365800, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddGateway', + 'ListGatewayZone', + 'AddGatewaySlb', + 'AddSecurityGroupRule', + 'DeleteGateway', + 'DeleteGatewaySlb', + 'DeleteSecurityGroupRule', + 'UpdateGatewayOption', + 'UpdateGatewayName', + 'QueryGatewayRegion', + 'QueryGatewayType', + 'GetGateway', + 'ListGateway', + 'ListGatewaySlb', + 'GetGatewayOption', + 'ListSecurityGroupRule', + 'ListSecurityGroup', + 'UpdateGatewaySpec', + 'SelectGatewaySlb', + ], + ], + [ + 'id' => 365820, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddServiceSource', + 'AddGatewayServiceVersion', + 'DeleteServiceSource', + 'DeleteGatewayServiceVersion', + 'DeleteGatewayService', + 'UpdateGatewayServiceTrafficPolicy', + 'UpdateGatewayServiceVersion', + 'ListServiceSource', + 'ListGatewayService', + 'GetMseSource', + 'GetKubernetesSource', + 'GetGatewayServiceDetail', + 'UpdateServiceSource', + 'ImportServices', + 'UpdateGatewayService', + 'PullServices', + 'UpdateGatewayServiceCheck', + ], + ], + [ + 'id' => 365838, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'UpdateGatewayRouteAuth', + 'ListGatewayAuthConsumerResource', + 'UpdateGatewayAuthConsumer', + 'ListGatewayRouteOnAuth', + 'ListGatewayAuthConsumer', + 'UpdateGatewayAuthConsumerResource', + 'UpdateGatewayAuthConsumerStatus', + 'AddGatewayAuthConsumer', + 'DeleteGatewayAuthConsumerResource', + 'UpdateGatewayAuthConsumerResourceStatus', + 'DeleteGatewayAuthConsumer', + 'GetGatewayAuthConsumerDetail', + 'AddBlackWhiteList', + 'UpdateBlackWhiteList', + 'GatewayBlackWhiteList', + 'DeleteBlackWhiteList', + 'GetBlackWhiteList', + 'AddGatewayAuth', + 'UpdateGatewayAuth', + 'GetGatewayAuthDetail', + 'ListGatewayAuth', + 'DeleteGatewayAuth', + 'AddAuthResource', + 'DeleteAuthResource', + ], + ], + [ + 'id' => 365863, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddGatewayRoute', + 'DeleteGatewayRoute', + 'UpdateGatewayRouteHTTPRewrite', + 'UpdateGatewayRoute', + 'UpdateGatewayRouteCORS', + 'UpdateGatewayRouteHeaderOp', + 'UpdateGatewayRouteTimeout', + 'UpdateGatewayRouteRetry', + 'GetGatewayRouteDetail', + 'ListGatewayRoute', + 'UpdateGatewayRouteWafStatus', + 'ApplyGatewayRoute', + 'OfflineGatewayRoute', + ], + ], + [ + 'id' => 365877, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetGatewayConfig', + 'EnableProxyProtocol', + 'EnableHttp2', + 'PreserveHeaderFormat', + ], + ], + [ + 'id' => 365882, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateGatewayFlowRule', + 'DeleteGatewayFlowRule', + 'UpdateGatewayFlowRule', + 'ListGatewayFlowRule', + 'CreateGatewayCircuitBreakerRule', + 'DeleteGatewayCircuitBreakerRule', + 'UpdateGatewayCircuitBreakerRule', + 'ListGatewayCircuitBreakerRule', + 'CreateGatewayIsolationRule', + 'DeleteGatewayIsolationRule', + 'UpdateGatewayIsolationRule', + 'ListGatewayIsolationRule', + ], + ], + ], + ], + [ + 'id' => 365895, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'InitializeServiceLinkRole', + 'CloneSentinelRuleFromAhas', + 'ChangeResourceGroup', + 'UpdateNacosGrayConfig', + 'UpdateGatewayConfig', + 'CreateSentinelBlockFallbackDefinition', + 'CreateNacosMcpServer', + 'DeleteNacosMcpServer', + 'GetNacosMcpServer', + 'ListNacosMcpServers', + 'QueryNacosGrayConfig', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'GatewayDomain' => [ + 'title' => 'A short description of struct', + 'description' => 'The data structure.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'Domain Id', + 'description' => 'The domain ID.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36', + 'backendName' => 'id', + ], + 'Name' => [ + 'title' => 'Domain Name', + 'description' => 'The domain name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test.com', + 'backendName' => 'name', + ], + 'Protocol' => [ + 'title' => '', + 'description' => 'The domain protocol.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'HTTPS', + 'backendName' => 'protocol', + ], + 'MustHttps' => [ + 'title' => '', + 'description' => 'Indicates whether HTTPS is forcibly used.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'true', + 'backendName' => 'mustHttps', + ], + 'CertIdentifier' => [ + 'title' => '', + 'description' => 'The ID of the certificate in use.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '595xx36-cn-hangzhou', + 'backendName' => 'certIdentifier', + ], + 'GatewayId' => [ + 'title' => '', + 'description' => 'The gateway ID.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'gatewayId', + ], + 'GatewayUniqueId' => [ + 'title' => '', + 'description' => 'The unique ID of the gateway.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'gw-c9bc5afd61014165bd58f621b491****', + 'backendName' => 'gatewayUniqueId', + ], + 'GmtCreate' => [ + 'title' => '', + 'description' => 'The time when the gateway was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-07-31 10:16:46', + 'backendName' => 'gmtCreate', + ], + 'GmtModified' => [ + 'title' => '', + 'description' => 'The time when the gateway was modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2022-08-11 15:28:47', + 'backendName' => 'gmtModified', + ], + 'GatewayName' => [ + 'title' => '', + 'description' => 'The name of the gateway.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'gatewayName', + ], + ], + ], + 'GatewayOption' => [ + 'title' => 'A short description of struct', + 'description' => 'The detailed configurations of the gateway.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'TraceDetails' => [ + 'title' => 'xtrace config option', + 'description' => 'The data structure.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'TraceEnabled' => [ + 'title' => '', + 'description' => 'Specifies whether to activate Tracing Analysis.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'false' => '', + 'true' => '', + ], + 'example' => 'true', + 'backendName' => 'traceOn', + ], + 'Sample' => [ + 'title' => '', + 'description' => 'The sampling rate of Tracing Analysis.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [], + 'example' => '10', + 'backendName' => 'sample', + 'default' => '10', + ], + 'TraceType' => [ + 'title' => '', + 'description' => 'The type of Tracing Analysis. Valid values: XTRACE and SKYWALKING.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'XTRACE', + 'backendName' => 'traceType', + 'default' => 'XTRACE', + ], + 'ServiceId' => [ + 'title' => '', + 'description' => 'The ID of the SkyWalking service. This parameter is required if TraceType is set to SKYWALKING.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10458', + 'backendName' => 'serviceId', + ], + 'ServicePort' => [ + 'title' => '', + 'description' => 'The port of the SkyWalking service. This parameter is required if TraceType is set to SKYWALKING.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '80', + 'backendName' => 'servicePort', + ], + ], + 'backendName' => 'xtraceDetails', + ], + 'LogConfigDetails' => [ + 'title' => '', + 'description' => 'The description of Simple Log Service.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'LogEnabled' => [ + 'title' => '', + 'description' => 'Specifies whether to activate Simple Log Service.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + 'backendName' => 'logOn', + ], + 'ProjectName' => [ + 'title' => '', + 'description' => 'The name of the destination Simple Log Service project.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'project', + 'backendName' => 'projectName', + ], + 'LogStoreName' => [ + 'title' => '', + 'description' => 'The name of the Logstore.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'name', + 'backendName' => 'logStoreName', + ], + ], + 'backendName' => 'slsConfigDetails', + ], + 'EnableHardwareAcceleration' => [ + 'title' => '', + 'description' => 'Specifies whether to enable hardware acceleration.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'enableHardwareAcceleration', + ], + 'DisableHttp2Alpn' => [ + 'title' => '', + 'description' => 'Specifies whether to disable the HTTP/2 protocol.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'disableHttp2Alpn', + ], + 'EnableWaf' => [ + 'title' => '', + 'description' => 'Specifies whether to enable Web Application Firewall (WAF).'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'enableWaf', + ], + ], + ], + 'GatewayService' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the gateway service.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '', + 'description' => 'The ID of the service.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'backendName' => 'id', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The name of the service.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'backendName' => 'name', + ], + 'SourceType' => [ + 'title' => '', + 'description' => 'The source type of the service.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'backendName' => 'sourceType', + ], + 'GatewayTrafficPolicy' => [ + 'title' => '', + 'description' => 'The traffic policy of the service.'."\n", + 'visibility' => 'public', + 'backendName' => 'gatewayTrafficPolicy', + '$ref' => '#/components/schemas/TrafficPolicy', + ], + 'GatewayUniqueId' => [ + 'title' => '', + 'description' => 'The unique ID of the gateway.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'backendName' => 'gatewayUniqueId', + ], + 'MetaInfo' => [ + 'title' => '', + 'description' => 'The metadata of the service.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'backendName' => 'metaInfo', + ], + 'Namespace' => [ + 'title' => '', + 'description' => 'The namespace to which the service belongs.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'backendName' => 'namespace', + ], + 'GroupName' => [ + 'title' => '', + 'description' => 'The name of the group to which the service belongs.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'backendName' => 'groupName', + ], + ], + ], + 'TrafficPolicy' => [ + 'title' => 'A short description of struct', + 'description' => 'The service traffic management.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'TlsSetting' => [ + 'title' => '', + 'description' => 'The data structure.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'TlsMode' => [ + 'title' => '', + 'description' => 'The Transport Layer Security (TLS) mode that is used to distribute traffic to backend services. Valid values:'."\n" + ."\n" + .'* DISABLE: TLS is disabled. Plaintext is used.'."\n" + .'* SIMPLE: TLS is enabled.'."\n" + .'* MUTUAL: Mutual Transport Layer Security (mTLS) is enabled.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'SIMPLE', + 'backendName' => 'mode', + ], + 'CertId' => [ + 'title' => '', + 'description' => 'The ID of the certificate that is managed in Alibaba Cloud Security.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '6456988-cn-hangzhou', + 'backendName' => 'certId', + ], + 'CaCertContent' => [ + 'title' => '', + 'description' => 'The trusted CA certificate chain. In mTLS, if the backend service certificate is issued by a private certificate authority (CA), you must add its CA certificate to the trusted CA certificate chain.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ 0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA 7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH 7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 -----END CERTIFICATE-----', + 'backendName' => 'caCertContent', + ], + 'Sni' => [ + 'title' => '', + 'description' => 'The server name indication (SNI) that is used to establish TLS links.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'www.aliyun.com', + 'backendName' => 'sni', + ], + ], + 'backendName' => 'tls', + ], + 'LoadBalancerSettings' => [ + 'title' => '', + 'description' => 'The load balancing settings.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'LoadbalancerType' => [ + 'title' => '', + 'description' => 'The load balancing type. Valid values:'."\n" + ."\n" + .'* ROUND_ROBIN: round robin '."\n" + .'* LEAST_CONN: least connection load balancing '."\n" + .'* RANDOM: random load balancing '."\n" + .'* CONSISTENT_HASH: consistent hashing load balancing '."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'RANDOM', + 'backendName' => 'loadbalancerType', + ], + 'ConsistentHashLBConfig' => [ + 'title' => '', + 'description' => 'The data structure.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'title' => '', + 'description' => 'The name of the object based on which consistent hashing is performed. If consistent hashing is performed based on a parameter, set the value to the parameter name. If consistent hashing is performed based on a header, set the value to the header name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'parameterName', + ], + 'HttpCookie' => [ + 'title' => '', + 'description' => 'You must specify this parameter only if ConsistentHashLBType is set to COOKIE.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '', + 'description' => 'The name of the cookie.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'name', + ], + 'Path' => [ + 'title' => 'cookie path', + 'description' => 'The path of the cookie.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '/path', + 'backendName' => 'path', + ], + 'TTL' => [ + 'title' => '', + 'description' => 'The lifecycle of the cookie.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '10s', + 'backendName' => 'ttl', + ], + ], + 'backendName' => 'httpCookie', + ], + 'ConsistentHashLBType' => [ + 'title' => 'HEADER, COOKIE, SOURCE_IP, QUERY_PARAMETER', + 'description' => 'The type of the object based on which consistent hashing is performed. Valid values:'."\n" + ."\n" + .'* QUERY_PARAMETER: request parameter'."\n" + .'* COOKIE: cookie'."\n" + .'* SOURCE_IP: the source IP address'."\n" + .'* HEADER: request header'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'QUERY_PARAMETER', + 'backendName' => 'consistentHashLBType', + ], + ], + 'backendName' => 'consistentHashLBConfig', + ], + 'WarmupDuration' => [ + 'title' => '', + 'description' => 'The prefetch duration. Unit: seconds.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'backendName' => 'warmupDuration', + ], + ], + 'enumValueTitles' => [], + 'backendName' => 'loadBalancerSettings', + ], + ], + ], + ], + ], + 'apis' => [ + 'ListTagResources' => [ + 'summary' => 'Queries tagged resources.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始Token', + 'description' => 'The token used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kywps2Ezza3n8HAAzCCqsi', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'* CLUSTER: MSE instance'."\n" + .'* GATEWAY: cloud-native gateway'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CLUSTER', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => 'The resource IDs. You can specify a maximum of 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of a resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-7pp2st29t16', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => 'The list of tags. A maximum number of 20 tags are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key-value pair of a tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'prd', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => 'The token that is required for the next query. If the NextToken parameter is empty, no subsequent query is required.'."\n", + 'type' => 'string', + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '92ED7C9C-84A2-595F-87FE-354F84C0F739', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '资源列表', + 'description' => 'The list of resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a resource and its tags, including the resource ID, the resource type, and the keys and values of the tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'title' => '资源ID', + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-7pp2st29t16', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'title' => '标签值', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'prd', + ], + 'TagKey' => [ + 'title' => '标签键', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'env', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T\\",\\n \\"RequestId\\": \\"92ED7C9C-84A2-595F-87FE-354F84C0F739\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceId\\": \\"mse-cn-7pp2st29t16\\",\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"prd\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListTagResources', + ], + 'UntagResources' => [ + 'summary' => 'Untags resources.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'* CLUSTER: MSE instance'."\n" + .'* GATEWAY: cloud-native gateway'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CLUSTER ', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', + 'description' => 'Specifies whether to delete all tags. This parameter takes effect only when the TagKey.N parameter is not specified. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID，最多50个子项', + 'description' => 'The resource IDs. A maximum of 50 resource IDs can be specified.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> This parameter specifies the instance ID that is passed. Examples:'."\n" + ."\n" + .'* **ResourceId.1** specifies that the first instance ID is passed.'."\n" + .'* **ResourceId.2** specifies that the second instance ID is passed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-7pp2st29t16', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签键，最多20个子项', + 'description' => 'The tag keys. A maximum of 20 tag keys are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key must be 1 to 128 characters in length. The tag key cannot start with acs: or aliyun or contain [http:// or https://.](http://https://。)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\": \\"58E06A0A-BD2C-47A0-99C2-B100F353****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UntagResources', + ], + 'TagResources' => [ + 'summary' => 'Tags a specified resource.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '143129', + 'abilityTreeNodes' => [ + 'FEATUREmseHJJ9Z1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The type of the resources. Valid values:'."\n" + ."\n" + .'* CLUSTER: Microservices Engine (MSE) instance'."\n" + .'* GATEWAY: cloud-native gateway'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CLUSTER', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The instance ID.'."\n" + ."\n" + .'> This parameter specifies the instance ID that is passed. Examples:'."\n" + ."\n" + .'- ResourceId.0 specifies the first instance ID that is passed.'."\n" + .'- ResourceId.1 specifies the second instance ID that is passed.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-7pp2st29t16', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => 'The list of tags. You can specify a maximum of 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details about the tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => 'The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key must be 1 to 128 characters in length. The tag key cannot start with acs: or aliyun or contain [http:// or https://.](http://https://。)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'prd', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E0A79810-9396-521C-A09D-E757B3E2BAF4', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\": \\"E0A79810-9396-521C-A09D-E757B3E2BAF4\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'TagResources', + ], + 'UpdateMigrationTask' => [ + 'summary' => 'Updates a migration task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '155125', + 'abilityTreeNodes' => [ + 'FEATUREmseKDDXNL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instance. Valid values:'."\n" + ."\n" + .'* Nacos-Ans'."\n" + .'* ZooKeeper'."\n" + .'* Eureka'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Nacos-Ans', + ], + ], + [ + 'name' => 'OriginInstanceAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The address of the source instance node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.1:8848', + ], + ], + [ + 'name' => 'OriginInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the source instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Source instance'."\n", + ], + ], + [ + 'name' => 'OriginInstanceNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of namespaces. This parameter is optional if you want to migrate applications from a Nacos instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'namesapceId1,namesapceId2', + ], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-ud82*****', + ], + ], + [ + 'name' => 'TargetClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Destination instance'."\n", + ], + ], + [ + 'name' => 'TargetClusterUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the destination instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848', + ], + ], + [ + 'name' => 'ProjectDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a description.'."\n", + ], + ], + [ + 'name' => 'SyncType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'UserId' => [ + 'description' => 'The ID of the user.'."\n", + 'type' => 'string', + 'example' => '183876217*****', + ], + 'ClusterType' => [ + 'description' => 'The type of the instance.'."\n" + ."\n" + .'* Nacos-Ans'."\n" + .'* ZooKeeper'."\n" + .'* Eureka'."\n", + 'type' => 'string', + 'example' => 'Nacos-Ans', + ], + 'OriginInstanceAddress' => [ + 'description' => 'The address of the source instance node.'."\n", + 'type' => 'string', + 'example' => '192.168.100.2:2181', + ], + 'OriginInstanceName' => [ + 'description' => 'The name of the source instance.'."\n", + 'type' => 'string', + 'example' => 'src', + ], + 'OriginInstanceNamespace' => [ + 'description' => 'The list of namespaces. This parameter is optional if applications are migrated from a Nacos instance.'."\n", + 'type' => 'string', + 'example' => 'fsdfsdfdsf', + ], + 'TargetInstanceId' => [ + 'description' => 'The ID of the destination instance.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-zvp2u*****', + ], + 'TargetClusterName' => [ + 'description' => 'The name of the destination instance.'."\n", + 'type' => 'string', + 'example' => 'multiple-nacos', + ], + 'TargetClusterUrl' => [ + 'description' => 'The URL of the destination instance.'."\n", + 'type' => 'string', + 'example' => 'mse-0b*****-nacos-ans.mse.aliyuncs.com:8848', + ], + 'ProjectDesc' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => '1232345', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'SyncType' => [ + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": \\"1\\",\\n \\"UserId\\": \\"183876217*****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.100.2:2181\\",\\n \\"OriginInstanceName\\": \\"src\\",\\n \\"OriginInstanceNamespace\\": \\"fsdfsdfdsf\\",\\n \\"TargetInstanceId\\": \\"mse-cn-zvp2u*****\\",\\n \\"TargetClusterName\\": \\"multiple-nacos\\",\\n \\"TargetClusterUrl\\": \\"mse-0b*****-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"1232345\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"SyncType\\": \\"All\\"\\n },\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateMigrationTask', + ], + 'AddMigrationTask' => [ + 'summary' => 'Create a new migration task', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '155122', + 'abilityTreeNodes' => [ + 'FEATUREmseKDDXNL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'Extended request parameters, in JSON format.', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster type.'."\n" + ."\n" + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', + 'type' => 'string', + 'required' => false, + 'example' => 'Nacos-Ans', + ], + ], + [ + 'name' => 'OriginInstanceAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source instance node address.', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.1:8848', + ], + ], + [ + 'name' => 'OriginInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source instance name.', + 'type' => 'string', + 'required' => false, + 'example' => 'Source instance'."\n", + ], + ], + [ + 'name' => 'OriginInstanceNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'Namespace list, required when the source cluster is Nacos.', + 'type' => 'string', + 'required' => false, + 'example' => 'namesapceId1,namesapceId2', + ], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Target instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-ud82*****', + ], + ], + [ + 'name' => 'TargetClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Target instance name.', + 'type' => 'string', + 'required' => false, + 'example' => 'Destination instance'."\n", + ], + ], + [ + 'name' => 'TargetClusterUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Target instance URL.', + 'type' => 'string', + 'required' => false, + 'example' => 'mse-66*****-nacos-ans.mse.aliyuncs.com:8848', + ], + ], + [ + 'name' => 'ProjectDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'Description.', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a description.'."\n", + ], + ], + [ + 'name' => 'SyncType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SyncType', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'All' => 'All', + 'Config' => 'Config', + 'Service' => 'Service', + ], + 'example' => 'Service', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'Language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Data structure.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Data structure.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Task ID.', + 'type' => 'string', + 'example' => '12', + ], + 'UserId' => [ + 'description' => 'User ID.', + 'type' => 'string', + 'example' => '183876217*****', + ], + 'ClusterType' => [ + 'description' => 'Cluster type.'."\n" + ."\n" + .'- Nacos-Ans'."\n" + .'- ZooKeeper'."\n" + .'- Eureka', + 'type' => 'string', + 'example' => 'Nacos-Ans', + ], + 'OriginInstanceAddress' => [ + 'description' => 'Source instance node address.', + 'type' => 'string', + 'example' => '192.168.1.1:8848'."\n", + ], + 'OriginInstanceName' => [ + 'description' => 'Source instance name.', + 'type' => 'string', + 'example' => 'Source instance'."\n", + ], + 'OriginInstanceNamespace' => [ + 'description' => 'Namespace list, required when the source cluster is Nacos.', + 'type' => 'string', + 'example' => 'namesapceId1,namesapceId2', + ], + 'TargetInstanceId' => [ + 'description' => 'Target instance ID.', + 'type' => 'string', + 'example' => 'mse-cn-7pp2w*****', + ], + 'TargetClusterName' => [ + 'description' => 'Target instance name.', + 'type' => 'string', + 'example' => 'Destination instance'."\n", + ], + 'TargetClusterUrl' => [ + 'description' => 'Target instance URL.', + 'type' => 'string', + 'example' => 'mse-94d****-nacos-ans.mse.aliyuncs.com:8848', + ], + 'ProjectDesc' => [ + 'description' => 'Description.', + 'type' => 'string', + 'example' => 'testsdfsdfsd', + ], + 'SyncType' => [ + 'description' => 'SyncType', + 'type' => 'string', + 'example' => 'Service', + ], + ], + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', + ], + 'Message' => [ + 'description' => 'Message.', + 'type' => 'string', + 'example' => 'The request is processed successfully.', + ], + 'ErrorCode' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => '请求结果，取值如下：'."\n" + .'- `true`：请求成功。'."\n" + .'- `false`：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"Data\\": {\\n \\"Id\\": \\"12\\",\\n \\"UserId\\": \\"183876217*****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.1.1:8848\\\\n\\",\\n \\"OriginInstanceName\\": \\"来源集群\\",\\n \\"OriginInstanceNamespace\\": \\"namesapceId1,namesapceId2\\",\\n \\"TargetInstanceId\\": \\"mse-cn-7pp2w*****\\",\\n \\"TargetClusterName\\": \\"目标集群\\",\\n \\"TargetClusterUrl\\": \\"mse-94d****-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"testsdfsdfsd\\",\\n \\"SyncType\\": \\"Service\\"\\n },\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"Message\\": \\"The request is processed successfully.\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AddMigrationTask', + 'translator' => 'machine', + ], + 'ListMigrationTask' => [ + 'summary' => 'Queries information about a migration task.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '155119', + 'abilityTreeNodes' => [ + 'FEATUREmseKDDXNL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'OriginInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the source instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'whdc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The array structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'UserId' => [ + 'description' => 'The ID of the user.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'ClusterType' => [ + 'description' => 'The type of the instance.'."\n" + ."\n" + .'* Nacos-Ans'."\n" + .'* ZooKeeper'."\n" + .'* Eureka'."\n", + 'type' => 'string', + 'example' => 'Nacos-Ans', + ], + 'OriginInstanceAddress' => [ + 'description' => 'The address of the source instance node.'."\n", + 'type' => 'string', + 'example' => '192.168.1.1:8848', + ], + 'OriginInstanceName' => [ + 'description' => 'The name of the source instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'OriginInstanceNamespace' => [ + 'description' => 'The list of namespaces. This parameter is optional if applications are migrated from a Nacos instance.'."\n", + 'type' => 'string', + 'example' => 'fsdfsdfdsf', + ], + 'TargetInstanceId' => [ + 'description' => 'The ID of the destination instance.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-zv*****', + ], + 'TargetClusterName' => [ + 'description' => 'The name of the destination instance.'."\n", + 'type' => 'string', + 'example' => 'multiple-nacos', + ], + 'TargetClusterUrl' => [ + 'description' => 'The URL of the destination instance.'."\n", + 'type' => 'string', + 'example' => 'mse-f1******-nacos-ans.mse.aliyuncs.com:8848', + ], + 'ProjectDesc' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2021-12-30T06:41:52.000+0000', + ], + 'SyncType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '451EBE59-5F33-5B15-83C1-78593B9*****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"UserId\\": \\"2\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"OriginInstanceAddress\\": \\"192.168.1.1:8848\\",\\n \\"OriginInstanceName\\": \\"test\\",\\n \\"OriginInstanceNamespace\\": \\"fsdfsdfdsf\\",\\n \\"TargetInstanceId\\": \\"mse-cn-zv*****\\",\\n \\"TargetClusterName\\": \\"multiple-nacos\\",\\n \\"TargetClusterUrl\\": \\"mse-f1******-nacos-ans.mse.aliyuncs.com:8848\\",\\n \\"ProjectDesc\\": \\"test\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2021-12-30T06:41:52.000+0000\\",\\n \\"SyncType\\": \\"Service\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"451EBE59-5F33-5B15-83C1-78593B9*****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListMigrationTask', + ], + 'DeleteMigrationTask' => [ + 'summary' => 'Deletes a migration task.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The deletion result.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteMigrationTask', + ], + 'PutClusterHealthCheckTask' => [ + 'summary' => 'Initiates a task to check risk evaluation for an instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-2r42o83h506', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'boolean', + 'example' => 'null', + ], + ], + ], + ], + ], + '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\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'PutClusterHealthCheckTask', + ], + 'OrderClusterHealthCheckRiskNotice' => [ + 'summary' => 'Subscribes to the notification feature if a risk is detected during a health check.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '150983', + 'abilityTreeNodes' => [ + 'FEATUREmseZDUZ1K', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'RiskCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the risk item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30010010001', + ], + ], + [ + 'name' => 'Mute', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to disable the notification feature if the risk item occurs.'."\n" + ."\n" + .'* true: disabled'."\n" + .'* false: enabled'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NoticeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the cluster resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Indicates whether the subscription was successful.'."\n", + 'type' => 'boolean', + 'example' => 'null', + ], + ], + ], + ], + ], + '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-B5ADEE4D****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'OrderClusterHealthCheckRiskNotice', + ], + 'ListClusterHealthCheckTask' => [ + 'summary' => 'Obtains information about historical health check tasks.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '150980', + 'abilityTreeNodes' => [ + 'FEATUREmseZDUZ1K', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-7pp2o4wfx01', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '查询第几页', + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页展示条数', + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<PageResult<ClusterHealthCheckTaskModel>>', + 'description' => 'RestResult\\<PageResult>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed. Take note of the following rules:'."\n" + ."\n" + .'* The **ErrorCode** parameter is not returned if the request is successful.'."\n" + .'* The **ErrorCode** parameter is returned if the request fails. For more information, see the **Error codes** section in this topic.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'title' => '实例列表的页码', + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TotalSize' => [ + 'title' => '查询到的实例总数', + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'PageSize' => [ + 'title' => '输入时设置的每页行数', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Result' => [ + 'description' => 'The list of health check tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The health check task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Score' => [ + 'description' => 'The total score.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'TotalItem' => [ + 'description' => 'The total number of check items.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalRisk' => [ + 'description' => 'The total number of risk items.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse_ingresspost-cn-0jbvrcex****', + ], + 'ClusterType' => [ + 'description' => 'The type of the cluster.'."\n", + 'type' => 'string', + 'example' => 'Nacos-Ans', + ], + 'Type' => [ + 'description' => 'A redundant parameter.'."\n", + 'type' => 'string', + 'example' => 'null'."\n", + ], + 'Status' => [ + 'description' => 'The status of the task.'."\n", + 'type' => 'string', + 'example' => 'FINISH', + ], + 'PrimaryUser' => [ + 'description' => 'The ID of the user to which the instance belongs.'."\n", + 'type' => 'string', + 'example' => '123456', + ], + 'Spec' => [ + 'description' => 'The specifications.'."\n", + 'type' => 'string', + 'example' => 'MSE_SC_2_4_200_c', + ], + 'Replica' => [ + 'description' => 'The number of nodes in the instance.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'VersionCode' => [ + 'description' => 'The version number.'."\n", + 'type' => 'string', + 'example' => 'NACOS_ANS_1_2_1_3', + ], + 'AppVersion' => [ + 'description' => 'The complete version number.'."\n", + 'type' => 'string', + 'example' => '1.2.1', + ], + 'ImageVersion' => [ + 'description' => 'A redundant parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'CreateTime' => [ + 'description' => 'The time when the task was created.'."\n", + 'type' => 'string', + 'example' => '2022-06-20T06:51:46Z', + ], + 'UpdateTime' => [ + 'description' => 'The last update time.'."\n", + 'type' => 'string', + 'example' => '2022-11-12 15:07:55', + ], + 'RiskList' => [ + 'description' => 'The list of risk items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about risk items.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3426', + ], + 'TaskId' => [ + 'description' => 'The ID of the associated parent task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RiskName' => [ + 'description' => 'The name of the risk.'."\n", + 'type' => 'string', + 'example' => 'The engine version is outdated.'."\n", + ], + 'RiskCode' => [ + 'description' => 'The risk code.'."\n", + 'type' => 'string', + 'example' => '22020010001', + ], + 'PrimaryUser' => [ + 'description' => 'The ID of the user to which the cluster belongs.'."\n", + 'type' => 'string', + 'example' => '123456', + ], + 'Type' => [ + 'description' => 'A redundant parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'Values' => [ + 'description' => 'A redundant parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'Module' => [ + 'description' => 'A redundant parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'RiskType' => [ + 'description' => 'The type of the risk.'."\n", + 'type' => 'string', + 'example' => 'Version risk'."\n", + ], + 'RiskLevel' => [ + 'title' => 'HIGH, MID, LOW, NONE', + 'description' => 'The severity of the risk. Valid values:'."\n" + ."\n" + .'* HIGH: high risk'."\n" + .'* MID: medium risk'."\n" + .'* LOW: low risk'."\n", + 'type' => 'string', + 'example' => 'MID', + ], + 'Suggestion' => [ + 'description' => 'The suggestion.'."\n", + 'type' => 'string', + 'example' => '{"desc": "Upgrade to the latest version at the earliest opportunity.", "links":\\[{"type": "upgrade", "desc": "Click to upgrade"}]}'."\n", + ], + 'Situation' => [ + 'description' => 'The situation.'."\n", + 'type' => 'string', + 'example' => '{\\\\"desc\\\\":\\\\"The engine version is outdated and a large number of features are not supported.\\\\",\\\\"links\\\\":\\[{\\\\"type\\\\":\\\\"url\\\\",\\\\"value\\\\":\\\\"https://xxxx"\\\\",\\\\"desc\\\\":\\\\"Release notes\\\\"}]}'."\n", + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => '{\\\\"desc\\\\":\\\\"The engine version is outdated and a large number of features are not supported. Upgrade the engine to the latest version at the earliest opportunity. \\\\"}'."\n", + ], + 'Mute' => [ + 'description' => 'Indicates whether the risk item notification feature is disabled.'."\n" + ."\n" + .'* true: disabled'."\n" + .'* false: enabled'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'NoticeFeature' => [ + 'description' => 'A redundant parameter.'."\n", + 'type' => 'boolean', + 'example' => 'null', + ], + 'RiskNameEn' => [ + 'type' => 'string', + ], + 'SuggestionEn' => [ + 'type' => 'string', + ], + 'SituationEn' => [ + 'type' => 'string', + ], + 'DescriptionEn' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ChargeType' => [ + 'description' => 'The billing method.'."\n", + 'type' => 'string', + 'example' => 'PREPAY', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 9,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"Score\\": 60,\\n \\"TotalItem\\": 10,\\n \\"TotalRisk\\": 3,\\n \\"InstanceId\\": \\"mse_ingresspost-cn-0jbvrcex****\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"Type\\": \\"null\\\\n\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"PrimaryUser\\": \\"123456\\",\\n \\"Spec\\": \\"MSE_SC_2_4_200_c\\",\\n \\"Replica\\": \\"3\\",\\n \\"VersionCode\\": \\"NACOS_ANS_1_2_1_3\\",\\n \\"AppVersion\\": \\"1.2.1\\",\\n \\"ImageVersion\\": \\"null\\",\\n \\"CreateTime\\": \\"2022-06-20T06:51:46Z\\",\\n \\"UpdateTime\\": \\"2022-11-12 15:07:55\\",\\n \\"RiskList\\": [\\n {\\n \\"Id\\": 3426,\\n \\"TaskId\\": 1,\\n \\"RiskName\\": \\"引擎版本过低\\",\\n \\"RiskCode\\": \\"22020010001\\",\\n \\"PrimaryUser\\": \\"123456\\",\\n \\"Type\\": 0,\\n \\"Values\\": \\"null\\",\\n \\"Module\\": \\"null\\",\\n \\"RiskType\\": \\"版本风险\\",\\n \\"RiskLevel\\": \\"MID\\",\\n \\"Suggestion\\": \\"{\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"请尽快升级至最新版本\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"links\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"upgrade\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"点击升级\\\\\\\\\\\\\\"}]}\\",\\n \\"Situation\\": \\"{\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"当前引擎版本过低，有大量功能缺失\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"links\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://xxxx\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"版本说明\\\\\\\\\\\\\\"}]}\\",\\n \\"Description\\": \\"{\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"引擎版本过低，有大量功能缺失，请尽快升级至最新版本！\\\\\\\\\\\\\\"}\\",\\n \\"Mute\\": false,\\n \\"NoticeFeature\\": true,\\n \\"RiskNameEn\\": \\"Low engine version\\",\\n \\"SuggestionEn\\": \\"Upgrade to the latest version\\",\\n \\"SituationEn\\": \\"The current engine version is low, and there are many missing features\\",\\n \\"DescriptionEn\\": \\"Upgrade to the latest version to ensure that all features are available!\\"\\n }\\n ],\\n \\"ChargeType\\": \\"PREPAY\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListClusterHealthCheckTask', + ], + 'ListConfigTrack' => [ + 'summary' => 'Obtains the track data of a Nacos configuration center.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '139046', + 'abilityTreeNodes' => [ + 'FEATUREmseU19WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mse_prepaid_public_cn-i7m2ne****', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ballot', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the configuration group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f3a510e2-df52-4fad-9815-42d8bc40****', + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1671010148', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1657178373', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable reverse ordering. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the listener.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.22.2', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Traces' => [ + 'description' => 'The track data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogDate' => [ + 'description' => 'The logging time.'."\n", + 'type' => 'string', + 'example' => '2022-11-28 15:09:15', + ], + 'Ts' => [ + 'description' => 'The timestamp that indicates the time when the metric value is collected.'."\n" + ."\n" + .'Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '1659666529', + ], + 'RequestIp' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'example' => '192.168.1.2', + ], + 'ResponseIp' => [ + 'description' => 'The response node.'."\n", + 'type' => 'string', + 'example' => 'mse-1973b9a0-1670834*****-reg-center-0-2', + ], + 'DataId' => [ + 'description' => 'The ID of the configuration.'."\n", + 'type' => 'string', + 'example' => 'eir-server.properties', + ], + 'Group' => [ + 'description' => 'The name of the configuration group.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_GROUP', + ], + 'Event' => [ + 'description' => 'The event. Valid values:'."\n" + ."\n" + .'* pull: configuration acquisition events'."\n" + .'* persist: persistence events'."\n", + 'type' => 'string', + 'example' => 'pull', + ], + 'Result' => [ + 'description' => 'The result.'."\n", + 'type' => 'string', + 'example' => 'ok', + ], + 'Delay' => [ + 'description' => 'The response latency. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Md5' => [ + 'description' => 'The MD5 value.'."\n", + 'type' => 'string', + 'example' => 'd21c9091c60daa0ff7ee2f420141e5a0', + ], + 'Type' => [ + 'description' => 'The release type. Valid values:'."\n" + ."\n" + .'* beta: beta release'."\n" + .'* tag: canary release'."\n" + .'* batch: batch release'."\n", + 'type' => 'string', + 'example' => 'beta', + ], + 'Push' => [ + 'description' => 'Indicates whether messages are pushed by a server. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Client' => [ + 'description' => 'Indicates whether the request is sent from the client. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0CE3ABD2-1E04-561F-A9B4-0423D50****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"LogDate\\": \\"2022-11-28 15:09:15\\",\\n \\"Ts\\": \\"1659666529\\",\\n \\"RequestIp\\": \\"192.168.1.2\\",\\n \\"ResponseIp\\": \\"mse-1973b9a0-1670834*****-reg-center-0-2\\",\\n \\"DataId\\": \\"eir-server.properties\\",\\n \\"Group\\": \\"DEFAULT_GROUP\\",\\n \\"Event\\": \\"pull\\",\\n \\"Result\\": \\"ok\\",\\n \\"Delay\\": \\"0\\",\\n \\"Md5\\": \\"d21c9091c60daa0ff7ee2f420141e5a0\\",\\n \\"Type\\": \\"beta\\",\\n \\"Push\\": false,\\n \\"Client\\": false\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"0CE3ABD2-1E04-561F-A9B4-0423D50****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListConfigTrack', + ], + 'CreateNacosConfig' => [ + 'summary' => 'Creates a Nacos configuration.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17005', + 'abilityTreeNodes' => [ + 'FEATUREmse0BR2XQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-tl32****', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'common.yaml', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alime-bridge-aliyun', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'saledatacenter-task', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags of the configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Basic configurations'."\n", + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Basic module configuration.'."\n", + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format of the configuration. Supported formats include TEXT, JSON, and XML.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The content of the configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'asdf', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '547fd2a0-d0d6-****-80db2a1afb82', + ], + ], + [ + 'name' => 'BetaIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of IP addresses where the beta release of the configuration is performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100.117.XX.XX,100.117.XX.XX', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '673DBD43-569E-510F-B3DE-20BB8DFEB20A', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The code returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + 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 \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"673DBD43-569E-510F-B3DE-20BB8DFEB20A\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": \\"1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateNacosConfig', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'DeleteNacosConfig' => [ + 'summary' => 'Delete specified Nacos configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17011', + 'abilityTreeNodes' => [ + 'FEATUREmse0BR2XQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-tl32epfyu18', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Configuration ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'user-ds.yml', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'Group type.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HALVIE_MICRO_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Namespace ID. Default is public.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '0e9d849b-****-8435da6c21ad', + ], + ], + [ + 'name' => 'Beta', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether it is a Beta release. Default is false.'."\n" + ."\n" + .'- `true`: Yes'."\n" + .'- `false`: No', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'Language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Data structure.', + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'string', + 'example' => '202', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84', + ], + 'Message' => [ + 'description' => 'Message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorCode' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Request result, with the following values: - `true`: The request was successful. - `false`: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"4FEFC13F-EB50-51E1-97D8-C5CBA8CD1B84\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete Nacos Configuration', + 'description' => '> The current OpenAPI is not the Nacos-SDK API. For information related to the Nacos-SDK API, please refer to the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'translator' => 'machine', + ], + 'DeleteNacosConfigs' => [ + 'summary' => 'Deletes multiple Nacos configurations at a time.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17012', + 'abilityTreeNodes' => [ + 'FEATUREmse0BR2XQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-i7m2e32pd0n', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of configurations.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '20024,20025,20026,20027,20034,20104,20394', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1ef93a21-3487-4367-a859-857d8****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '73EB5563-CBB3-5F48-999D-512F4EFB7377', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"200\\",\\n \\"RequestId\\": \\"73EB5563-CBB3-5F48-999D-512F4EFB7377\\",\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteNacosConfigs', + 'description' => '> The current API operation is not provided in Nacos SDK. For more information about the Nacos-SDK API, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'UpdateNacosConfig' => [ + 'summary' => 'Updates a Nacos configuration.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17102', + 'abilityTreeNodes' => [ + 'FEATUREmse0BR2XQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-7pp2a****', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the configuration.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ky-check-****.yml', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'resource', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'postoffice', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of tags.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2021-10-20', + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Basic configurations'."\n", + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format of the configuration. Supported formats include TEXT, JSON, XML, and HTML.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The content of the configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'attribute1=1221111\\r\\nattribute2=Chinese\\r\\nattribute3=abc11\\r\\nattribute4=1.00111'."\n", + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '78b7af66-d15f-4541-b886-11ed81ecb6c0', + ], + ], + [ + 'name' => 'Md5', + 'in' => 'query', + 'schema' => [ + 'description' => 'The MD5 value of the configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '045439703a273a94306422b****', + ], + ], + [ + 'name' => 'BetaIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of IP addresses where the beta release of the configuration is performed.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '196.168.XX.XX', + ], + ], + [ + 'name' => 'EncryptedDataKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '122wdwe****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + 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 \\"HttpCode\\": \\"200\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateNacosConfig', + 'description' => '> The current API operation is not provided in Nacos SDK. For more information about Nacos SDK, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'ListListenersByConfig' => [ + 'summary' => 'Queries listeners based on configuration information.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17070', + 'abilityTreeNodes' => [ + 'FEATUREmseHU6B10', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\\\"appGroup\\\\":\\\\"emas-zfive_prehost\\\\",\\\\"appName\\\\":\\\\"emas-zfive\\\\",\\\\"appStage\\\\":\\\\"PRE_PUBLISH\\\\",\\\\"appUnit\\\\":\\\\"\\\\",\\\\"bucId\\\\":\\\\"225902\\\\",\\\\"bucName\\\\":\\\\"Wireless\\\\",\\\\"provider\\\\":\\\\"aliyun\\\\"}'."\n", + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-m7r1yurp00e', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zeekr-clueboss.yml', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'prod', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1', + ], + ], + [ + 'name' => 'ExtGrayRules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GrayRuleType' => [ + 'type' => 'string', + 'enum' => [ + 'Tags', + 'Beta', + ], + ], + 'GrayRuleName' => [ + 'type' => 'string', + ], + 'GrayRule' => [ + 'type' => 'string', + ], + 'GrayRulePriority' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Listeners' => [ + 'description' => 'The information about listeners.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'Md5' => [ + 'description' => 'The verification string.'."\n", + 'type' => 'string', + 'example' => '23sdfdf', + ], + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'string', + 'example' => 'beta', + ], + 'Labels' => [ + 'description' => 'The label of the listener.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The key-value pairs of the label.'."\n", + ], + ], + 'Version' => [ + 'description' => 'The current version of the listener. Valid values: gray and normal.'."\n", + 'type' => 'string', + 'example' => 'gray', + ], + 'MatchRuleName' => [ + 'title' => '当前Listener匹配的灰度规则名称', + 'type' => 'string', + ], + 'MatchRuleType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '75E1442F-11EC-567A-9CF0-5A36F7904F39', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => 'ListListenersByConfig', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'ListListenersByIp' => [ + 'summary' => 'Queries the information about listeners based on IP addresses.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17071', + 'abilityTreeNodes' => [ + 'FEATUREmseHU6B10', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-i7m2cecji09', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the listener.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '172.22.0.240', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ea02a522-9482-4255-bb65-dc0636d783f2', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Listeners' => [ + 'description' => 'The information about listeners.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Md5' => [ + 'description' => 'The verification string.'."\n", + 'type' => 'string', + 'example' => '23sdfdf', + ], + 'DataId' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'string', + 'example' => 'test.yaml', + ], + 'Group' => [ + 'description' => 'The group.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'NamespaceId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '54973C90-F379-4372-9AA5-053A3F7****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'MSE-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 6,\\n \\"Listeners\\": [\\n {\\n \\"Md5\\": \\"23sdfdf\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"default\\",\\n \\"NamespaceId\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"MSE-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListListenersByIp', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'GetNacosConfig' => [ + 'summary' => 'Get Nacos Configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17035', + 'abilityTreeNodes' => [ + 'FEATUREmseEUE1FY', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-i7m2h0****', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Data ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'halvie-mp-item****', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'Configuration group information.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'common', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Namespace ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b', + ], + ], + [ + 'name' => 'Beta', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether it is a Beta release.'."\n" + ."\n" + .'- `true`: Yes'."\n" + .'- `false`: No', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'Language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Data structure.', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'Message.', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => 'B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD', + ], + 'Configuration' => [ + 'description' => 'Configuration information.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Format of the configuration content.', + 'type' => 'string', + 'example' => 'text', + ], + 'AppName' => [ + 'description' => 'Application name.', + 'type' => 'string', + 'example' => 'test', + ], + 'Tags' => [ + 'description' => 'Tags of the configuration.', + 'type' => 'string', + 'example' => 'context', + ], + 'Md5' => [ + 'description' => 'Message digest of the configuration.', + 'type' => 'string', + 'example' => '123rfsdf3', + ], + 'DataId' => [ + 'description' => 'Configuration ID.', + 'type' => 'string', + 'example' => 'log.yaml', + ], + 'Content' => [ + 'description' => 'Configuration content.', + 'type' => 'string', + 'example' => 'log.level=error', + ], + 'Group' => [ + 'description' => 'Configuration group name.', + 'type' => 'string', + 'example' => 'test', + ], + 'Desc' => [ + 'description' => 'Configuration description.', + 'type' => 'string', + 'example' => 'For testing'."\n", + ], + 'EncryptedDataKey' => [ + 'description' => 'Encrypted key.', + 'type' => 'string', + 'example' => 'key', + ], + 'BetaIps' => [ + 'description' => 'List of IPs for Beta release.', + 'type' => 'string', + 'example' => '1.1.XX.XX，2.2.XX.XX', + ], + 'GrayVersions' => [ + 'title' => '当前配置的灰度版本信息', + 'description' => 'Current gray version information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '灰度类型', + 'description' => 'Gray type', + 'type' => 'string', + 'example' => 'Beta', + ], + 'Name' => [ + 'title' => '灰度版本名称', + 'description' => 'Gray version name', + 'type' => 'string', + 'example' => 'test', + ], + 'Rule' => [ + 'title' => '当前灰度版本的规则', + 'description' => 'Rules of the current gray version', + 'type' => 'string', + 'example' => 'a=b', + ], + 'Priority' => [ + 'title' => '当前灰度规则的优先级', + 'description' => 'The priority of the current gray rule.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'The result of the request, with values as follows:'."\n" + .'- `true`: The request was successful.'."\n" + .'- `false`: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B4EAB48C-BB4B-5B8D-B33B-35D69606C5AD\\",\\n \\"Configuration\\": {\\n \\"Type\\": \\"text\\",\\n \\"AppName\\": \\"test\\",\\n \\"Tags\\": \\"context\\",\\n \\"Md5\\": \\"123rfsdf3\\",\\n \\"DataId\\": \\"log.yaml\\",\\n \\"Content\\": \\"log.level=error\\",\\n \\"Group\\": \\"test\\",\\n \\"Desc\\": \\"测试专用\\",\\n \\"EncryptedDataKey\\": \\"key\\",\\n \\"BetaIps\\": \\"1.1.XX.XX，2.2.XX.XX\\",\\n \\"GrayVersions\\": [\\n {\\n \\"Type\\": \\"Beta\\",\\n \\"Name\\": \\"test\\",\\n \\"Rule\\": \\"a=b\\",\\n \\"Priority\\": 20\\n }\\n ]\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Get Nacos Configuration', + 'description' => '> This OpenAPI is not the Nacos-SDK API. For information related to the Nacos-SDK API, please refer to the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'translator' => 'machine', + ], + 'GetNacosHistoryConfig' => [ + 'summary' => 'Queries the historical details of Nacos configuration changes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-st220g9ka02', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'msg-center.main.yaml', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba', + ], + ], + [ + 'name' => 'Nid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version ID of the configuration.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '40****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Configuration' => [ + 'description' => 'The configuration information.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Md5' => [ + 'description' => 'The MD5 value of the configuration.'."\n", + 'type' => 'string', + 'example' => '23sdf32f****', + ], + 'DataId' => [ + 'description' => 'The ID of the configuration.'."\n", + 'type' => 'string', + 'example' => 'test.yaml', + ], + 'Content' => [ + 'description' => 'The content of the configuration.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Group' => [ + 'description' => 'The name of the configuration group.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + 'OpType' => [ + 'description' => 'The configuration type.'."\n", + 'type' => 'string', + 'example' => 'text', + ], + 'EncryptedDataKey' => [ + 'description' => 'The encryption key.'."\n", + 'type' => 'string', + 'example' => '23fds****', + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Configuration\\": {\\n \\"AppName\\": \\"test\\",\\n \\"Md5\\": \\"23sdf32f****\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Content\\": \\"test\\",\\n \\"Group\\": \\"public\\",\\n \\"OpType\\": \\"text\\",\\n \\"EncryptedDataKey\\": \\"23fds****\\"\\n },\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetNacosHistoryConfig', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'ListNacosConfigs' => [ + 'summary' => 'Queries Nacos configurations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17072', + 'abilityTreeNodes' => [ + 'FEATUREmse8153EN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters. The JSON format is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\\\"appGroup\\\\":\\\\"sm_zk_asi_na610\\\\",\\\\"appName\\\\":\\\\"sm-zk\\\\",\\\\"appStage\\\\":\\\\"PUBLISH\\\\",\\\\"appUnit\\\\":\\\\"center\\\\",\\\\"bucId\\\\":\\\\"193554\\\\",\\\\"bucName\\\\":\\\\"Alibaba Mobile Business Group-UC\\\\",\\\\"provider\\\\":\\\\"aliyun\\\\"}'."\n", + 'title' => '参数弃用，无需填写', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '200', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-7mz2fj****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'zeekr-*', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group. Default value: `default`'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'crm', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'fpx-pds-pns', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'billing', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'fad732a7-ff1a-4f21-8126-4edd4****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4081087F-3429-5873-A1E7-D4B5479D0B84', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Configurations' => [ + 'description' => 'The configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DataId' => [ + 'description' => 'The ID of the configuration.'."\n", + 'type' => 'string', + 'example' => 'log.yaml', + ], + 'Id' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => '132****', + ], + 'Group' => [ + 'description' => 'The ID of the group.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ConfigTags' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + 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 \\"HttpCode\\": \\"200\\",\\n \\"TotalCount\\": 12,\\n \\"RequestId\\": \\"4081087F-3429-5873-A1E7-D4B5479D0B84\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Configurations\\": [\\n {\\n \\"AppName\\": \\"test\\",\\n \\"DataId\\": \\"log.yaml\\",\\n \\"Id\\": \\"132****\\",\\n \\"Group\\": \\"public\\",\\n \\"Description\\": \\"\\",\\n \\"ConfigTags\\": \\"\\"\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListNacosConfigs', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'ListNacosHistoryConfigs' => [ + 'summary' => 'Queries the configuration history of a Microservices Engine (MSE) Nacos instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17073', + 'abilityTreeNodes' => [ + 'FEATUREmseEUE1FY', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\\\"appGroup\\\\":\\\\"aliyun-phecda-service-staging\\\\",\\\\"appName\\\\":\\\\"aliyun-phecda-service\\\\",\\\\"appStage\\\\":\\\\"DAILY\\\\",\\\\"appUnit\\\\":\\\\"center\\\\",\\\\"bucId\\\\":\\\\"250858\\\\",\\\\"bucName\\\\":\\\\"Alibaba Cloud\\\\",\\\\"provider\\\\":\\\\"aliyun\\\\"}'."\n", + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-2r42e3bk20n', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'user-prod.yaml', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the configuration group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'fc-dev-cluster-1', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'fc0f6e40-****-946b-45e3af313707', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '53338ECA-F880-54D8-A9B3-5606355A1B89', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HistoryItems' => [ + 'description' => 'The configuration items.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => 'The application tag.'."\n", + 'type' => 'string', + 'example' => 'gateway', + ], + 'DataId' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'string', + 'example' => 'test.yaml', + ], + 'Group' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'LastModifiedTime' => [ + 'description' => 'The timestamp when the configuration was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16434400', + ], + 'Id' => [ + 'description' => 'The ID of the configuration.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23fdsf', + ], + 'OpType' => [ + 'description' => 'The format of the configuration file.'."\n", + 'type' => 'string', + 'example' => 'yaml', + ], + 'SrcUser' => [ + 'type' => 'string', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"200\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"53338ECA-F880-54D8-A9B3-5606355A1B89\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"HistoryItems\\": [\\n {\\n \\"AppName\\": \\"gateway\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"default\\",\\n \\"LastModifiedTime\\": 1643440066000,\\n \\"Id\\": 0,\\n \\"OpType\\": \\"yaml\\",\\n \\"SrcUser\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListNacosHistoryConfigs', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'CloneNacosConfig' => [ + 'summary' => 'Copy Nacos Configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '76154', + 'abilityTreeNodes' => [ + 'FEATUREmseYJ44D3', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-i7m25igg403', + ], + ], + [ + 'name' => 'OriginNamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source namespace ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'be821963-6d48-4ea5-9910-6057d****', + ], + ], + [ + 'name' => 'TargetNamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Target namespace ID.', + 'type' => 'string', + 'required' => false, + 'example' => '08be4b5d-2d1c-4e6e-aa85-83b9****', + ], + ], + [ + 'name' => 'Policy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The strategy used when a write conflict occurs.'."\n" + ."\n" + .'- ABORT'."\n" + .'- SKIP'."\n" + .'- OVERWRITE', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'ABORT' => '终止', + 'OVERWRITE' => '覆盖', + 'SKIP' => '跳过', + ], + 'example' => 'OVERWRITE', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of configuration IDs.', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => false, + 'example' => '253661,253662', + ], + ], + [ + 'name' => 'DataIds', + 'in' => 'query', + 'schema' => [ + 'title' => '需要克隆的配置项，格式为 dataId+group，多个配置项使用 , 分隔', + 'description' => 'Configuration items to be cloned, in the format of dataId+group, with multiple items separated by commas.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test+test,test1+test1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'Language type of the returned message:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Data structure.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '6678DBA9-5600-5948-ACF8-ED3105B288A3', + ], + 'Success' => [ + 'description' => 'Request result, with the following values:'."\n" + .'- `true`: Request succeeded.'."\n" + .'- `false`: Request failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'Response code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Response message.', + 'type' => 'string', + 'example' => 'Clone Completed Successfully', + ], + 'DynamicMessage' => [ + 'description' => 'Dynamic error message, used to replace the **%s** in the **ErrMessage** error message.'."\n" + .'> If **ErrMessage** returns **The Value of Input Parameter %s is not valid**, and **DynamicMessage** returns **DtsJobId**, it indicates that the input request parameter **DtsJobId** is invalid.', + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Data overview.', + 'type' => 'object', + 'properties' => [ + 'SuccCount' => [ + 'description' => 'Number of successes.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SkipCount' => [ + 'description' => 'Number of skips.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SkipData' => [ + 'description' => 'Skipped configuration information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data structure.', + 'type' => 'object', + 'properties' => [ + 'DataId' => [ + 'description' => 'Data ID.', + 'type' => 'string', + 'example' => 'test.yaml', + ], + 'Group' => [ + 'description' => 'Group ID.', + 'type' => 'string', + 'example' => 'public ', + ], + ], + ], + ], + 'FailData' => [ + 'description' => 'Failed configuration information.', + 'type' => 'array', + 'items' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'DataId' => [ + 'description' => 'Data ID.', + 'type' => 'string', + 'example' => 'test2.yaml', + ], + 'Group' => [ + 'description' => 'Group ID.', + 'type' => 'string', + 'example' => 'test', + ], + 'Reason' => [ + 'description' => 'The reason for the current operation.', + 'type' => 'string', + 'example' => 'param not support', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"6678DBA9-5600-5948-ACF8-ED3105B288A3\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Clone Completed Successfully\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"SuccCount\\": 100,\\n \\"SkipCount\\": 1,\\n \\"SkipData\\": [\\n {\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"public \\"\\n }\\n ],\\n \\"FailData\\": [\\n {\\n \\"DataId\\": \\"test2.yaml\\",\\n \\"Group\\": \\"test\\",\\n \\"Reason\\": \\"当前导入配置格式非法\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'CloneNacosConfig', + 'description' => '> This OpenAPI is not the Nacos-SDK API. For information related to the Nacos-SDK API, please refer to the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).', + 'translator' => 'machine', + ], + 'ExportNacosConfig' => [ + 'summary' => 'Exports specified Nacos configurations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '76155', + 'abilityTreeNodes' => [ + 'FEATUREmse8153EN', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-2r42ddc****', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ae77c258-4d4f-478f-baaa-084aee0****', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the primary key of a configuration item.'."\n" + ."\n" + .'> - Multiple export methods are supported. You must specify this parameter if you want to export multiple configurations. - You can obtain the value of this parameter by calling the ListNacosConfigs operation. - If you specify this parameter, multiple configurations are exported. The DataId and Group parameters are invalid.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '1709,1710', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data that you want to export.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Multiple export methods are supported.'."\n" + ."\n" + .'* If you want to export a single configuration, you must leave the Ids parameter empty and specify the DataID and Group parameters.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => false, + 'example' => 'sms-mes-develop.prop****', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the configuration group.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'TIMEDTASK_COMMON_GROUP', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application tag.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'qjl-gateway-openapi', + ], + ], + [ + 'name' => 'DataIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration group name and the ID of the configuration that you want to export. Separate multiple configurations with comma (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testGroup+testDataId1,testGroup+testDataId2', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '92245803-49B7-54CF-8D49-01A34A0E1CD6', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace **%s** in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => 'The URL that is used to download the exported configurations.'."\n", + 'type' => 'string', + 'example' => 'http://xxxxxxxxx', + ], + ], + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"92245803-49B7-54CF-8D49-01A34A0E1CD6\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'ExportNacosConfig', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'GetImportFileUrl' => [ + 'summary' => 'Obtains the URL that is used to upload a configuration file when you import the configuration file into a Microservices Engine (MSE) Nacos instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76156', + 'abilityTreeNodes' => [ + 'FEATUREmseEPOTV0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ContentType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The file type.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'application/zip', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-7pp2b****', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.', + 'type' => 'string', + 'required' => false, + 'example' => '12788f73-9848-4388-98f1-507778f2****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '19488A00-4AF5-55E1-A689-98BA9F5E7441', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + .'* `true`: The request was successful. '."\n" + .'* `false`: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.', + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The error code returned if the request failed.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.', + 'type' => 'string', + 'example' => 'The request was successfully processed.', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\\\*\\\\*%s\\\\*\\\\* variable in the **ErrMessage** parameter.\\n\\n> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.', + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The details of the data.', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => 'The URL that is used to upload the configuration file.', + 'type' => 'string', + 'example' => 'http://xxxxxxx', + ], + ], + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"19488A00-4AF5-55E1-A689-98BA9F5E7441\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetImportFileUrl', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).\\n', + ], + 'ImportNacosConfig' => [ + 'summary' => 'Imports Nacos configurations as a file.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '76157', + 'abilityTreeNodes' => [ + 'FEATUREmseEPOTV0', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-****', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f5cdc80a-****-8094-282f5650fc00', + ], + ], + [ + 'name' => 'Policy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ABORT'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* OVERWRITE'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* SKIP'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + 'ABORT' => 'ABORT', + 'OVERWRITE' => 'OVERWRITE', + 'SKIP' => 'SKIP', + ], + 'example' => 'overwrite', + ], + ], + [ + 'name' => 'FileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http://mse-shared.oss-xxx.aliyuncs.com/cfg/import/xxxx/2021/01/11/xxxx.zip', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'string', + 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', + ], + 'Success' => [ + 'description' => 'The error code that is returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The code returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-100', + ], + 'Code' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Message' => [ + 'description' => 'The request is successfully processed.'."\n", + 'type' => 'string', + 'example' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + ], + 'DynamicMessage' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The number of configurations that are imported.'."\n", + 'type' => 'object', + 'properties' => [ + 'SuccCount' => [ + 'description' => 'The number of configurations that are skipped.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SkipCount' => [ + 'description' => 'The information about skipped configurations.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SkipData' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'DataId' => [ + 'description' => 'The ID of the group.'."\n", + 'type' => 'string', + 'example' => 'test.yaml', + ], + 'Group' => [ + 'description' => 'The information about configurations that are failed to be imported.'."\n", + 'type' => 'string', + 'example' => 'public ', + ], + ], + ], + ], + 'FailData' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'DataId' => [ + 'description' => 'The ID of the group.'."\n", + 'type' => 'string', + 'example' => 'test2.yaml', + ], + 'Group' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'Reason' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Code\\": 1,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"SuccCount\\": 100,\\n \\"SkipCount\\": 10,\\n \\"SkipData\\": [\\n {\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Group\\": \\"public \\"\\n }\\n ],\\n \\"FailData\\": [\\n {\\n \\"DataId\\": \\"test2.yaml\\",\\n \\"Group\\": \\"test\\",\\n \\"Reason\\": \\"导入配置格式错误\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ImportNacosConfig', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'ListNamingTrack' => [ + 'summary' => 'Obtains the trajectory data of a Nacos registry.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '137915', + 'abilityTreeNodes' => [ + 'FEATUREmseN8I3PF', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mse_prepaid_public_cn-tl32d*****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fpx-xms-baseinfo', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'group', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cd4d3703-e2a6-46b5-85c6-4447e4f****', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the client.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172.16.183.232', + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1660238450', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1665299698', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: `false`.'."\n" + ."\n" + .'* `true`: sorts the query results in reverse chronological order.'."\n" + .'* `false`: sorts the query results in chronological order.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Traces' => [ + 'description' => 'The data information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PushTime' => [ + 'description' => 'The push time.'."\n", + 'type' => 'string', + 'example' => '2022-12-16 11:48:07', + ], + 'NodeName' => [ + 'description' => 'The name of the node.'."\n", + 'type' => 'string', + 'example' => 'mse-197*****-167083******-reg-center-0-0', + ], + 'ClientIp' => [ + 'description' => 'The IP address of the client.'."\n", + 'type' => 'string', + 'example' => '120.40.32.235', + ], + 'ServerName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'fpx-xms-baseinfo', + ], + 'Group' => [ + 'description' => 'The group.'."\n", + 'type' => 'string', + 'example' => 'prod', + ], + 'InstanceSize' => [ + 'description' => 'The number of instances.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PushTimeAll' => [ + 'description' => 'The total push time.'."\n", + 'type' => 'string', + 'example' => '628ms', + ], + 'PushTimeNetwork' => [ + 'description' => 'The push time for the network.'."\n", + 'type' => 'string', + 'example' => '37ms', + ], + 'SlaTime' => [ + 'description' => 'The duration that is specified in the service-level agreement (SLA).'."\n", + 'type' => 'string', + 'example' => '628ms', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9916CBED-B2D5-5685-9129-4592FE1*****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 202 => [ + [ + 'errorCode' => 'TrackRegionNotSupport', + 'errorMessage' => '推送轨迹功能在当前Region暂未开放', + ], + ], + 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 \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"PushTime\\": \\"2022-12-16 11:48:07\\",\\n \\"NodeName\\": \\"mse-197*****-167083******-reg-center-0-0\\",\\n \\"ClientIp\\": \\"120.40.32.235\\",\\n \\"ServerName\\": \\"fpx-xms-baseinfo\\",\\n \\"Group\\": \\"prod\\",\\n \\"InstanceSize\\": \\"1\\",\\n \\"PushTimeAll\\": \\"628ms\\",\\n \\"PushTimeNetwork\\": \\"37ms\\",\\n \\"SlaTime\\": \\"628ms\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"9916CBED-B2D5-5685-9129-4592FE1*****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListNamingTrack', + ], + 'CreateNacosService' => [ + 'summary' => 'Creates a Nacos service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '104937', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'com.alibabacloud.hipstershop.cartserviceapi.service.CartService', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'production', + ], + ], + [ + 'name' => 'ProtectThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protection threshold.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Ephemeral', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the instance is marked as a temporary node. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-3691a080', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'example' => 'data', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + '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\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"data\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'CreateNacosService', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'ListAnsServices' => [ + 'summary' => 'Queries Nacos services.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17058', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => '查询指定的服务名信息', + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '服务所在的分组', + 'description' => 'The name of the contact group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '服务所在的 namespace', + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12233****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '查询服务下某个集群的实例列表是所需要的参数', + 'description' => '查询服务下某个集群的实例列表是所需要的参数', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'HasIpCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the number of instances that are used for the service.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'false' => '', + 'true' => '', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '不推荐使用，请使用 InstanceId', + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'mse-09k1q11****', + 'deprecated' => true, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群实例Id', + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-st21v5****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '查询第几页', + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页展示条数', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'TotalCount' => [ + 'description' => 'The total number of instances returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HealthyInstanceCount' => [ + 'description' => 'The total number of instances with healthy heartbeats.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupName' => [ + 'description' => 'The name of the contact group.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'IpCount' => [ + 'description' => 'The total number of instances that are used for the current service.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'ClusterCount' => [ + 'description' => 'The total number of clusters.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Source' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + 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' => '[{"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":"<ListAnsServicesResponse>\\n<HttpCode>202</HttpCode>\\n<TotalCount>7</TotalCount>\\n<PageSize>10</PageSize>\\n<Message>请求处理成功</Message>\\n<RequestId>52BA6DA6-A702-4362-A32F-DFF79655****</RequestId>\\n<PageNumber>1</PageNumber>\\n<Data>\\n <GroupName>name</GroupName>\\n <IpCount>1</IpCount>\\n <HealthyInstanceCount>1</HealthyInstanceCount>\\n <ClusterCount>1</ClusterCount>\\n <Name>name</Name>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</ListAnsServicesResponse>","errorExample":""}]', + 'title' => 'ListAnsServices', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteNacosService' => [ + 'summary' => 'Deletes a Nacos service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '18547', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-123456', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hello_service', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9e78a671-4b9b-4dd4-99c1-0****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The string object.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', + ], + 'Message' => [ + 'title' => '响应信息', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'title' => '响应码', + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'title' => '删除服务的结果', + 'description' => 'The deletion result.'."\n", + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<DeleteNacosServiceResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>9e78a671-4b9b-4dd4-99c1-0b9da87d3dec</RequestId>\\n <Message>请求成功</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>ok</Data>\\n</DeleteNacosServiceResponse>","errorExample":""}]', + 'title' => 'DeleteNacosService', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'UpdateNacosService' => [ + 'summary' => 'Updates the information about a Nacos service.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '105086', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'com.dingtalk.doc.thumbnails.pdf.ThumbnailService', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', + ], + ], + [ + 'name' => 'ProtectThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protection threshold.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"6\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'UpdateNacosService', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'UpdateNacosCluster' => [ + 'summary' => 'Updates the information about a Nacos cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '105189', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例id', + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-123456', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => '服务名', + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hello_service', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '分组名', + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间id', + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Nacos集群名', + 'description' => 'The name of the Nacos cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DEFAULT', + ], + ], + [ + 'name' => 'CheckPort', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查端口', + 'description' => 'The port used for health checks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'UseInstancePortForCheck', + 'in' => 'query', + 'schema' => [ + 'title' => '是否使用实例端口进行健康检查', + 'description' => 'Specifies whether to use the port of the instance for a health check.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'HealthChecker', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查类型', + 'description' => 'The type of the health check.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"type":"none"}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', + ], + 'Message' => [ + 'title' => '响应信息', + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'title' => '响应码', + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'title' => '修改结果', + 'description' => 'The result returned.'."\n", + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => 'UpdateNacosCluster', + ], + 'ListAnsServiceClusters' => [ + 'summary' => 'Queries the clusters of a Nacos service.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17057', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the MSE cluster.'."\n" + ."\n" + .'> The MSE cluster is different from the cluster of the Nacos service.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'mse-09k1q110q01', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nacos.test.3', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12233****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alias of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-7413****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-tl32a6****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProtectThreshold' => [ + 'description' => 'The protection threshold.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'GroupName' => [ + 'description' => 'The service group to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_GROUP', + ], + 'Clusters' => [ + 'description' => 'The cluster information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'DefaultCheckPort' => [ + 'description' => 'The default port used for a health check.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'HealthCheckerType' => [ + 'description' => 'The type of the health check.'."\n", + 'type' => 'string', + 'example' => 'Heartbeat Reporting'."\n", + ], + 'UseIPPort4Check' => [ + 'description' => 'Indicates whether an end-to-end health check was initiated by the server. This parameter is valid only if the service is not a temporary service.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceName' => [ + 'description' => 'The full name of the service.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_GROUP@@nacos.test.3', + ], + 'Name' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DefaultPort' => [ + 'description' => 'The default port.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Metadata' => [ + 'description' => 'The metadata of the cluster.'."\n", + 'type' => 'object', + 'example' => '111', + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'nacos.test.3', + ], + 'SelectorType' => [ + 'description' => 'The election mode.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'Metadata' => [ + 'description' => 'The metadata of the service.'."\n", + 'type' => 'object', + 'example' => '111', + ], + 'Ephemeral' => [ + 'description' => 'Indicates whether the service is a temporary service. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Source' => [ + 'description' => 'The source type of the service. Valid values:'."\n" + ."\n" + .'* console: The service was registered in the console.'."\n" + .'* sdk: The service was registered by using the SDK.'."\n" + .'* governance: The service was registered on Microservices Governance.'."\n", + 'type' => 'string', + 'example' => 'console', + ], + 'AppDetail' => [ + 'description' => 'The information about the associated application for which Microservices Governance is enabled when the Source parameter is set to governance.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => 'The ID of the application for which Microservices Governance is enabled.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@904cba2c0xxxxxx', + ], + 'AppName' => [ + 'description' => 'The name of the application for which Microservices Governance is enabled.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-b', + ], + 'Port' => [ + 'description' => 'The port number of the application for which Microservices Governance is enabled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6001', + ], + 'CheckType' => [ + 'description' => 'The type of the health check. Valid values:'."\n" + ."\n" + .'* connection: connection status check'."\n" + .'* tcp: TCP connection check'."\n" + .'* http: HTTP connection check'."\n", + 'type' => 'string', + 'example' => 'connection', + ], + 'CheckPath' => [ + 'description' => 'The path of the health check. This parameter is required only when the CheckType parameter is set to http.'."\n", + 'type' => 'string', + 'example' => '/health', + ], + 'CheckTimeout' => [ + 'description' => 'The timeout period of the health check response. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CheckInternal' => [ + 'description' => 'The health check interval. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HealthyCheckTimes' => [ + 'description' => 'The maximum number of health check retries when the instance state changes from unhealthy to healthy.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UnhealthyCheckTimes' => [ + 'description' => 'The maximum number of health check retries when the instance state changes from healthy to unhealthy.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '[{"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":"<ListAnsServiceClustersResponse>\\n<Message>请求处理成功</Message>\\n<RequestId>52BA6DA6-A702-4362-A32F-DFF79655****</RequestId>\\n<Data>\\n <GroupName>DEFAULT_GROUP</GroupName>\\n <SelectorType>none</SelectorType>\\n <Metadata>111</Metadata>\\n <ProtectThreshold>0</ProtectThreshold>\\n <Name>DEFAULT</Name>\\n <Clusters>\\n <UseIPPort4Check>true</UseIPPort4Check>\\n <DefaultCheckPort>80</DefaultCheckPort>\\n <ServiceName>DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::</ServiceName>\\n <Metadata>111</Metadata>\\n <HealthCheckerType>心跳上报</HealthCheckerType>\\n <DefaultPort>80</DefaultPort>\\n <Name>test</Name>\\n </Clusters>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</ListAnsServiceClustersResponse>","errorExample":""}]', + 'title' => 'ListAnsServiceClusters', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateNacosInstance' => [ + 'summary' => 'Creates a Nacos instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '105182', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例id', + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-123456', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => '服务名', + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hello_service', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '分组名', + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间id', + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Nacos集群名', + 'description' => 'The name of the Nacos instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'title' => 'Nacos实例ip', + 'description' => 'The IP address of the Nacos instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.2.xx.xx', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'title' => 'Nacos实例端口', + 'description' => 'The port number of the Nacos instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '65535', + 'exclusiveMaximum' => true, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '12281', + ], + ], + [ + 'name' => 'Ephemeral', + 'in' => 'query', + 'schema' => [ + 'title' => '临时节点标志', + 'description' => 'Specifies whether to mark the instance as a temporary node.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'Weight', + 'in' => 'query', + 'schema' => [ + 'title' => '权重', + 'description' => 'The weight. Valid values: 0 to 10000. The value must be an integer. A larger value indicates a higher frequency at which the instance is accessed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'title' => '服务禁用标志', + 'description' => 'Specifies whether to enable the service for the instance.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'Metadata', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点元数据', + 'description' => 'The node metadata of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"grayversion\\":\\"1.0\\",\\"preserved.register.source\\":\\"SPRING_CLOUD\\",\\"management.context-path\\":\\"\\"}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', + ], + 'Message' => [ + 'title' => '响应信息', + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'title' => '响应码', + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'title' => '修改结果', + 'description' => 'The result returned.'."\n", + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => 'CreateNacosInstance', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'DeleteNacosInstance' => [ + 'summary' => 'Deletes a persistent application instance from a Microservices Engine (MSE) Nacos instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '121118', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Nacos instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mse-cn-st21v5****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'hello_service', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alias of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + 'default' => 'DEFAULT', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the Nacos instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10.237.1.32', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port of the Nacos instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '8080', + ], + ], + [ + 'name' => 'Ephemeral', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the node is an ephemeral node. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<String>', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. The value 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicMessage' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + '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\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'DeleteNacosInstance', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'UpdateNacosInstance' => [ + 'summary' => 'Updates the information about application instances that are registered with a Nacos instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '18554', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例id', + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-123456', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => '服务名', + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hello_service', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '分组名', + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间id', + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9e78a671-4b9b-4dd4-99c1-0****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Nacos集群名', + 'description' => 'The name of the Nacos instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'title' => 'Nacos实例ip', + 'description' => 'The IP address of the Nacos instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.2.X.X', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'title' => 'Nacos实例端口', + 'description' => 'The port number of the Nacos instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12281', + ], + ], + [ + 'name' => 'Ephemeral', + 'in' => 'query', + 'schema' => [ + 'title' => '临时节点标志', + 'description' => 'Specifies whether the node is a non-persistent node. Valid values:'."\n" + ."\n" + .'* `true`: yes.'."\n" + .'* `false`: no.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'Weight', + 'in' => 'query', + 'schema' => [ + 'title' => '权重', + 'description' => 'The weight. Valid values: 0 to 10000. The value must be an integer. A larger value indicates a higher frequency at which the instance is accessed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'title' => '服务禁用标志', + 'description' => 'Specifies whether to disable this service. Valid values:'."\n" + ."\n" + .'* `true`: yes.'."\n" + .'* `false`: no.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'Metadata', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点元数据', + 'description' => 'The metadata of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[int]', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The string object.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', + ], + 'Message' => [ + 'title' => '响应信息', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'title' => '响应码', + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'title' => '修改结果', + 'description' => 'The result of the modification.'."\n", + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<UpdateNacosInstanceResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>9e78a671-4b9b-4dd4-99c1-0b9da87d3dec</RequestId>\\n <Message>请求成功</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>ok</Data>\\n</UpdateNacosInstanceResponse>","errorExample":""}]', + 'title' => 'UpdateNacosInstance', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + ], + 'ListAnsInstances' => [ + 'summary' => 'Queries application instances that are registered with a Microservices Engine (MSE) Nacos instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '17056', + 'abilityTreeNodes' => [ + 'FEATUREmseAPH368', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Nacos instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-09k1q11****', + 'deprecated' => true, + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'name', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the contact group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12233****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alias of the Nacos instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-7413****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n" + ."\n" + .'> This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-tl327w****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DefaultKey' => [ + 'description' => 'The default key.'."\n", + 'type' => 'string', + 'example' => '30.5.XX.XX:unknown', + ], + 'Ephemeral' => [ + 'description' => 'Indicates whether the information about the ephemeral node is obtained. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Marked' => [ + 'description' => 'Indicates whether the instance was marked. Valid values:'."\n" + ."\n" + .'* `true`: The instance marking was successful.'."\n" + .'* `false`: The instance marking failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Ip' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '30.5.XX.XX', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => '30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService', + ], + 'Port' => [ + 'description' => 'The port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8080', + ], + 'LastBeat' => [ + 'description' => 'The last heartbeat time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20201010', + ], + 'OkCount' => [ + 'description' => 'The number of counted successes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Weight' => [ + 'description' => 'The weight.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceHeartBeatInterval' => [ + 'description' => 'The heartbeat interval of the instance. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'IpDeleteTimeout' => [ + 'description' => 'The timeout period for removing an IP address.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30000', + ], + 'App' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'app', + ], + 'FailCount' => [ + 'description' => 'The number of counted failures.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Healthy' => [ + 'description' => 'The health status of the instance. Valid values:'."\n" + ."\n" + .'* `true`: The instance is healthy.'."\n" + .'* `false`: The instance is unhealthy.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Enabled' => [ + 'description' => 'The effective status of the instance. Valid values:'."\n" + ."\n" + .'* `true`: The instance takes effect.'."\n" + .'* `false`: The instance does not take effect.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DatumKey' => [ + 'description' => 'The reference key.'."\n", + 'type' => 'string', + 'example' => '30.5.XX.XX:unknown:DEFAULT', + ], + 'ClusterName' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'InstanceHeartBeatTimeOut' => [ + 'description' => 'The timeout period of the instance heartbeat.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15000', + ], + 'ServiceName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::', + ], + 'Metadata' => [ + 'description' => 'The metadata.'."\n", + 'type' => 'object', + 'example' => '[int]', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"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":"<ListAnsInstancesResponse>\\n<HttpCode>202</HttpCode>\\n<TotalCount>7</TotalCount>\\n<PageSize>10</PageSize>\\n<Message>请求处理成功</Message>\\n<RequestId>52BA6DA6-A702-4362-A32F-DFF79655****</RequestId>\\n<PageNumber>1</PageNumber>\\n<Data>\\n <App>app</App>\\n <InstanceId>30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService</InstanceId>\\n <Ip>30.5.XX.XX</Ip>\\n <Port>8080</Port>\\n <Metadata>[int]</Metadata>\\n <Enabled>true</Enabled>\\n <Weight>1</Weight>\\n <DatumKey>30.5.XX.XX:unknown:DEFAULT</DatumKey>\\n <OkCount>0</OkCount>\\n <ServiceName>DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::</ServiceName>\\n <FailCount>0</FailCount>\\n <ClusterName>DEFAULT</ClusterName>\\n <LastBeat>20201010</LastBeat>\\n <DefaultKey>30.5.XX.XX:unknown</DefaultKey>\\n <InstanceHeartBeatTimeOut>15000</InstanceHeartBeatTimeOut>\\n <Ephemeral>true</Ephemeral>\\n <IpDeleteTimeout>30000</IpDeleteTimeout>\\n <Marked>true</Marked>\\n <Healthy>true</Healthy>\\n <InstanceHeartBeatInterval>5000</InstanceHeartBeatInterval>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</ListAnsInstancesResponse>","errorExample":""}]', + 'title' => 'ListAnsInstances', + 'description' => '> The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the [official documentation](https://nacos.io/zh-cn/docs/sdk.html).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetServiceListeners' => [ + 'summary' => 'Queries the list of listeners for the destination service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '137871', + 'abilityTreeNodes' => [ + 'FEATUREmseXDLQRG', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => '查询指定的服务名信息', + 'description' => 'The name of the service whose listeners you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zeekr-orderboss', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '服务所在的分组', + 'description' => 'The group to which the service belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'WEB_GROUP', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '服务所在的 namespace', + 'description' => 'The namespace to which the service belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ddaf8f12-****-b1c1-86e7c72e266b', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '查询服务下某个集群的实例列表是所需要的参数', + 'description' => 'The name of the cluster to which the service belongs.'."\n" + ."\n" + .'> The cluster is a concept for Nacos services and is not equivalent to a Microservices Engine (MSE) instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + ], + [ + 'name' => 'HasIpCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '当前查询服务的集群标识', + 'description' => 'The ID of the MSE instance to which the service belongs.'."\n" + ."\n" + .'> You must specify InstanceId or ClusterId.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '当前查询服务的集群标识', + 'description' => 'The ID of the instance to which the service belongs.'."\n" + ."\n" + .'> You must specify InstanceId or ClusterId.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-tl32odtt20j', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '查询第几页', + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页展示条数', + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RegCenterOperatorResult', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Addr' => [ + 'title' => '地址', + 'description' => 'The IP address of the listener.'."\n", + 'type' => 'string', + 'example' => '119.23.84.102', + ], + 'Agent' => [ + 'title' => '客户端版本', + 'description' => 'The listener client version.'."\n", + 'type' => 'string', + 'example' => 'Nacos-Java-Client:v2.1.1', + ], + 'App' => [ + 'title' => '应用', + 'description' => 'The application name of the listener.'."\n", + 'type' => 'string', + 'example' => 'app', + ], + 'IP' => [ + 'title' => 'ip地址', + 'description' => 'The IP address of the monitored service.'."\n", + 'type' => 'string', + 'example' => '172.16.1.5', + ], + 'Port' => [ + 'title' => '端口号', + 'description' => 'The port number of the monitored service.'."\n", + 'type' => 'string', + 'example' => '8080', + ], + 'NamespaceId' => [ + 'title' => '命名空间id', + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'example' => '0ba53825-b183-414f-a6a0-288e4f1c467e', + ], + 'ServiceName' => [ + 'title' => '服务名称', + 'description' => 'The name of the monitored service.'."\n", + 'type' => 'string', + 'example' => 'zeekr-orderboss', + ], + 'Cluster' => [ + 'title' => '集群名称', + 'description' => 'The name of the cluster to which the monitored service belongs.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '实例列表的页码', + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'title' => '查询到的实例总数', + 'description' => 'The number of listeners that are queried.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'title' => '输入时设置的每页行数', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '54973C90-F379-4372-9AA5-053A3F7****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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 \\"Data\\": [\\n {\\n \\"Addr\\": \\"119.23.84.102\\",\\n \\"Agent\\": \\"Nacos-Java-Client:v2.1.1\\",\\n \\"App\\": \\"app\\",\\n \\"IP\\": \\"172.16.1.5\\",\\n \\"Port\\": \\"8080\\",\\n \\"NamespaceId\\": \\"0ba53825-b183-414f-a6a0-288e4f1c467e\\",\\n \\"ServiceName\\": \\"zeekr-orderboss\\",\\n \\"Cluster\\": \\"DEFAULT\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\"\\n}","type":"json"}]', + 'title' => 'GetServiceListeners', + ], + 'ListEurekaServices' => [ + 'summary' => 'Queries Eureka services.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17068', + 'abilityTreeNodes' => [ + 'FEATUREmseKQ13CA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstancesId' => [ + 'description' => 'The details of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + ], + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'CONTACTINFO', + ], + 'UpStatus' => [ + 'description' => 'The number of service providers. The value is in the following format: Number of healthy instances/Total number of instances.'."\n", + 'type' => 'string', + 'example' => '1/1', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"InstancesId\\": [\\n \\"mse-cn-st21ri2****\\"\\n ],\\n \\"Name\\": \\"CONTACTINFO\\",\\n \\"UpStatus\\": \\"1/1\\"\\n }\\n ],\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListEurekaServicesResponse>\\n<HttpCode>202</HttpCode>\\n<TotalCount>7</TotalCount>\\n<PageSize>10</PageSize>\\n<Message>请求处理成功</Message>\\n<RequestId>316F5F64-F73D-42DC-8632-01E308B6****</RequestId>\\n<PageNumber>1</PageNumber>\\n<Data>\\n <UpStatus>1/1</UpStatus>\\n <Name>CONTACTINFO</Name>\\n <InstancesId>mse-cn-st21ri2****</InstancesId>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</ListEurekaServicesResponse>","errorExample":""}]', + 'title' => 'ListEurekaServices', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListEurekaInstances' => [ + 'summary' => 'Queries Eureka instances.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17067', + 'abilityTreeNodes' => [ + 'FEATUREmseKQ13CA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'name', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The number of service providers. The value is in the following format: Number of healthy instances/Total number of instances.'."\n", + 'type' => 'string', + 'example' => '1/1', + ], + 'LastDirtyTimestamp' => [ + 'description' => 'The time when the instance was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20201009115543', + ], + 'IpAddr' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '30.5.XX.XX', + ], + 'HomePageUrl' => [ + 'description' => 'The URL of the homepage.'."\n", + 'type' => 'string', + 'example' => 'http://30.5.XX.XX:8091/', + ], + 'HostName' => [ + 'description' => 'The hostname.'."\n", + 'type' => 'string', + 'example' => '30.5.XX.XX', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'L-PC1A6A28-****.hz.ali.com:contactinfo:8091', + ], + 'Port' => [ + 'description' => 'The service port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8091', + ], + 'SecurePort' => [ + 'description' => 'The security port.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + 'App' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'CONTACTINFO', + ], + 'DurationInSecs' => [ + 'description' => 'The timeout period of the instance.\\'."\n" + .'After the specified timeout period expires, the service is unavailable by default and is deleted.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'LastUpdatedTimestamp' => [ + 'description' => 'The time when the instance heartbeat was last checked.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20201010071203', + ], + 'RenewalIntervalInSecs' => [ + 'description' => 'The maximum interval between two heartbeat checks after a heartbeat check times out.\\'."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'VipAddress' => [ + 'description' => 'The virtual IP address (VIP).'."\n", + 'type' => 'string', + 'example' => 'contactinfo', + ], + 'Metadata' => [ + 'description' => 'The metadata.'."\n", + 'type' => 'object', + 'example' => '[string]', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"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":"<ListEurekaInstancesResponse>\\n<HttpCode>202</HttpCode>\\n<TotalCount>7</TotalCount>\\n<PageSize>10</PageSize>\\n<Message>请求处理成功</Message>\\n<RequestId>316F5F64-F73D-42DC-8632-01E308B6****</RequestId>\\n<PageNumber>1</PageNumber>\\n<Data>\\n <Status>1/1</Status>\\n <App>CONTACTINFO</App>\\n <RenewalIntervalInSecs>10</RenewalIntervalInSecs>\\n <SecurePort>443</SecurePort>\\n <IpAddr>30.5.XX.XX</IpAddr>\\n <InstanceId>L-PC1A6A28-****.hz.ali.com:contactinfo:8091</InstanceId>\\n <DurationInSecs>90</DurationInSecs>\\n <VipAddress>contactinfo</VipAddress>\\n <LastUpdatedTimestamp>20201010071203</LastUpdatedTimestamp>\\n <Port>8091</Port>\\n <Metadata>[string]</Metadata>\\n <LastDirtyTimestamp>20201009115543</LastDirtyTimestamp>\\n <HomePageUrl>http://30.5.XX.XX:8091/</HomePageUrl>\\n <HostName>30.5.XX.XX</HostName>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</ListEurekaInstancesResponse>","errorExample":""}]', + 'title' => 'ListEurekaInstances', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryMonitor' => [ + 'summary' => 'Queries monitoring information.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17082', + 'abilityTreeNodes' => [ + 'FEATUREmseZAXYAZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'MonitorType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The metric type. The following metric types are supported:'."\n" + ."\n" + .'\\[Basic system metrics]'."\n" + ."\n" + .'* cpuUsage'."\n" + .'* memoryUsage'."\n" + .'* diskUsage'."\n" + .'* gcCount'."\n" + .'* gcTime'."\n" + ."\n" + .'\\[Nacos registry]'."\n" + ."\n" + .'* serviceCount'."\n" + .'* writeCostTime'."\n" + .'* readCostTime'."\n" + .'* TPS regCenterTps'."\n" + .'* QPS regCenterQps'."\n" + ."\n" + .'\\[Nacos configuration center]'."\n" + ."\n" + .'* publish'."\n" + .'* getConfig'."\n" + ."\n" + .'\\[zookeeper]'."\n" + ."\n" + .'* TPS zk_TpsCount'."\n" + .'* QPS zk_QpsCount'."\n" + .'* zookeeper_AvgRequestLatency'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'regCenterQps', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp when the monitoring starts.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1666678376', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timestamp when the monitoring ends.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1666678376', + ], + ], + [ + 'name' => 'Step', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval between data points. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'podName' => [ + 'description' => 'The name of the pod.'."\n", + 'type' => 'string', + 'example' => 'mse-xxxxxx-xxxxxx-reg-center-0-0', + ], + 'clusterNamePrefix' => [ + 'description' => 'The prefix of the name.'."\n", + 'type' => 'string', + 'example' => 'mse-xxxx-xxxxxx', + ], + 'values' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The content of the data.'."\n", + 'type' => 'object', + ], + ], + ], + ], + 'example' => '6', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<QueryMonitorResponse>\\n<RequestId>ADDD8AB7-8D1C-4697-A83E-410D2607****</RequestId>\\n<Message>请求处理成功</Message>\\n<Data>6</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</QueryMonitorResponse>","errorExample":""}]', + 'title' => 'QueryMonitor', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateAcl' => [ + 'summary' => 'Modifies an IP address whitelist.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17096', + 'abilityTreeNodes' => [ + 'FEATUREmse3FEC0V', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AclEntryList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses or CIDR blocks in the IP address whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '192.168.0.0/XX,192.168.0.0/XX', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-78v1l83****', + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'Public', + 'enum' => [ + 'Private', + 'Public', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-100', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateAclResponse>\\n<Message>请求处理成功</Message>\\n<RequestId>7466566F-F30F-4A29-965D-3E0AF21D****</RequestId>\\n<ErrorCode>mse-100-100</ErrorCode>\\n<Success>true</Success>\\n</UpdateAclResponse>","errorExample":""}]', + 'title' => 'UpdateAcl', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryInstancesInfo' => [ + 'summary' => 'Queries the runtime data of a specified cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '129092', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-tl32g1u9k01', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20574710974****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The message that is returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '54973C90-F379-4372-9AA5-053A3F7****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'HealthStatus' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'Role' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'PodName' => [ + 'description' => 'The pod name.'."\n", + 'type' => 'string', + 'example' => 'mse-xxxxx-xxxxx-reg-center-0-1', + ], + 'Ip' => [ + 'description' => 'The IP address of the pod.'."\n", + 'type' => 'string', + 'example' => '25.24.91.x', + ], + 'InternetIp' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '120.55.71.x', + ], + 'SingleTunnelVip' => [ + 'description' => 'The internal IP address.'."\n", + 'type' => 'string', + 'example' => '172.16.66.x', + ], + 'CreationTimestamp' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-12-15T02:02:15Z', + ], + 'ClientPort' => [ + 'description' => 'The enabled port.'."\n", + 'type' => 'string', + 'example' => '8848', + ], + 'Zone' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'ZoneDistributed' => [ + 'description' => 'Indicates whether all pods in the cluster are distributed in the specified zones.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"Data\\": [\\n {\\n \\"HealthStatus\\": \\"null\\",\\n \\"Role\\": \\"null\\",\\n \\"PodName\\": \\"mse-xxxxx-xxxxx-reg-center-0-1\\",\\n \\"Ip\\": \\"25.24.91.x\\",\\n \\"InternetIp\\": \\"120.55.71.x\\",\\n \\"SingleTunnelVip\\": \\"172.16.66.x\\",\\n \\"CreationTimestamp\\": \\"2022-12-15T02:02:15Z\\",\\n \\"ClientPort\\": \\"8848\\",\\n \\"Zone\\": \\"cn-hangzhou-k\\",\\n \\"ZoneDistributed\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryInstancesInfo', + ], + 'QueryClusterInfo' => [ + 'summary' => 'Queries the static information of an instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '129315', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-7mz2t63ci03', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20574710974****', + ], + ], + [ + 'name' => 'AclSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the configuration of a public IP address whitelist.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '415088B3-A7BE-56F6-9CD9-C42DE895CD41', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC where the instance resides.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1v5nbauzh8xxxxxxx', + ], + 'CreateTime' => [ + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'string', + 'example' => '2022-12-15 10:02:07', + ], + 'IntranetAddress' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'DiskType' => [ + 'description' => 'A deprecated parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'PubNetworkFlow' => [ + 'description' => 'The public bandwidth. Unit: Mbit/s.\\'."\n" + .'Valid values: 0 to 5000. The value 0 indicates no access to the Internet.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'DiskCapacity' => [ + 'description' => 'A deprecated parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'MemoryCapacity' => [ + 'description' => 'A deprecated parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'null', + ], + 'ClusterAliasName' => [ + 'description' => 'The alias of the instance.'."\n", + 'type' => 'string', + 'example' => 'Development environment'."\n", + ], + 'InstanceCount' => [ + 'description' => 'The number of instance nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'IntranetPort' => [ + 'description' => 'The instance ports that are accessible over an internal network.'."\n", + 'type' => 'string', + 'example' => '8848,6443,9848,8761', + ], + 'InstanceModels' => [ + 'description' => 'The reserved structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The reserved structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'PodName' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'SingleTunnelVip' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'InternetIp' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'Ip' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'Role' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HealthStatus' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'CreationTimestamp' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'Zone' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + 'IntranetDomain' => [ + 'description' => 'The internal endpoint.'."\n", + 'type' => 'string', + 'example' => 'mse-xxxxx-nacos-ans.mse.aliyuncs.com', + ], + 'InternetDomain' => [ + 'description' => 'The public endpoint.'."\n", + 'type' => 'string', + 'example' => 'mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com', + ], + 'PayInfo' => [ + 'description' => 'The billing method.'."\n", + 'type' => 'string', + 'example' => 'Pay-as-you-go'."\n", + ], + 'InternetAddress' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + 'AclEntryList' => [ + 'description' => 'The public IP address whitelist.'."\n", + 'type' => 'string', + 'example' => '["127.0.0.0/32"]', + ], + 'HealthStatus' => [ + 'description' => 'The status of the instance.'."\n", + 'type' => 'string', + 'example' => 'INIT_SUCCESS', + ], + 'InitCostTime' => [ + 'description' => 'The time that is required to initialize the instance. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '53353', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AclId' => [ + 'description' => 'The ID of the instance in the public IP address whitelist.'."\n", + 'type' => 'string', + 'example' => 'acl-bp144q24cgqvzckmxxxx', + ], + 'Cpu' => [ + 'description' => 'A deprecated parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'ClusterType' => [ + 'description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", + 'type' => 'string', + 'example' => 'Nacos-Ans', + ], + 'ClusterName' => [ + 'description' => 'The full name of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-74355150-xxxxxxx', + ], + 'InitStatus' => [ + 'description' => 'The initial status of the instance.'."\n", + 'type' => 'string', + 'example' => 'INIT_SUCCESS', + ], + 'InternetPort' => [ + 'description' => 'The instance ports that are accessible over the Internet.'."\n", + 'type' => 'string', + 'example' => '8848,6443,9848,8761', + ], + 'AppVersion' => [ + 'description' => 'The version of the instance.'."\n", + 'type' => 'string', + 'example' => '2.1.0', + ], + 'NetType' => [ + 'description' => 'The network connection type of the instance.'."\n", + 'type' => 'string', + 'example' => 'privatenet', + ], + 'ClusterVersion' => [ + 'description' => 'The version of the order.'."\n", + 'type' => 'string', + 'example' => 'NACOS_2_0_0', + ], + 'ClusterSpecification' => [ + 'description' => 'The engine specifications.'."\n", + 'type' => 'string', + 'example' => 'MSE_SC_2_4_60_c', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1egfakxxxxx', + ], + 'ConnectionType' => [ + 'description' => 'A deprecated parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'MseVersion' => [ + 'description' => 'The version of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse_pro', + ], + 'ChargeType' => [ + 'title' => '', + 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'Tags' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + ], + 'ExpectZones' => [ + 'description' => 'The zones to which the current cluster can be distributed.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + ], + 'MaintenancePeriod' => [ + 'description' => 'The O\\&M time window.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The start time of the O\\&M time window.'."\n", + 'type' => 'string', + 'example' => '02:00', + ], + 'StartTime' => [ + 'description' => 'The end time of the O\\&M time window.'."\n", + 'type' => 'string', + 'example' => '06:00', + ], + ], + ], + 'EndDate' => [ + 'title' => '到期时间（包年包月）', + 'description' => 'The time when the subscription instance expires.'."\n", + 'type' => 'string', + 'example' => '2021-08-01 00:00:00', + ], + 'SecurityGroupId' => [ + 'title' => 'ENI网络接入的安全组ID', + 'description' => 'The ID of the security group to which the elastic network interface (ENI) is connected.'."\n", + 'type' => 'string', + 'example' => 'sg-uf6hgwe067prhg68agfa', + ], + 'SecurityGroupType' => [ + 'title' => 'ENI网络接入的安全组类型', + 'description' => 'The type of the security group to which the ENI is connected.'."\n", + 'type' => 'string', + 'example' => 'enterprise', + 'enum' => [ + 'enterprise', + 'normal', + ], + ], + 'EipInstanceId' => [ + 'title' => '弹性公网IP（EIP）的实例ID', + 'description' => 'The ID of the instance that is associated with the Elastic IP Address (EIP).'."\n", + 'type' => 'string', + 'example' => 'eip-bp1uujshd5funmyy8rcl9', + ], + 'CanUpdate' => [ + 'type' => 'boolean', + ], + 'VersionCode' => [ + 'type' => 'string', + ], + 'VersionLifecycle' => [ + 'type' => 'string', + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"415088B3-A7BE-56F6-9CD9-C42DE895CD41\\",\\n \\"Data\\": {\\n \\"VpcId\\": \\"vpc-bp1v5nbauzh8xxxxxxx\\",\\n \\"CreateTime\\": \\"2022-12-15 10:02:07\\",\\n \\"IntranetAddress\\": \\"null\\",\\n \\"DiskType\\": \\"null\\",\\n \\"PubNetworkFlow\\": \\"1\\",\\n \\"DiskCapacity\\": 0,\\n \\"MemoryCapacity\\": 0,\\n \\"ClusterAliasName\\": \\"开发环境\\",\\n \\"InstanceCount\\": 3,\\n \\"IntranetPort\\": \\"8848,6443,9848,8761\\",\\n \\"InstanceModels\\": [\\n {\\n \\"PodName\\": \\"null\\",\\n \\"SingleTunnelVip\\": \\"null\\",\\n \\"InternetIp\\": \\"null\\",\\n \\"Ip\\": \\"null\\",\\n \\"Role\\": \\"null\\",\\n \\"HealthStatus\\": \\"null\\",\\n \\"CreationTimestamp\\": \\"null\\",\\n \\"Zone\\": \\"null\\"\\n }\\n ],\\n \\"IntranetDomain\\": \\"mse-xxxxx-nacos-ans.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com\\",\\n \\"PayInfo\\": \\"按量付费\\",\\n \\"InternetAddress\\": \\"null\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"AclEntryList\\": \\"[\\\\\\"127.0.0.0/32\\\\\\"]\\",\\n \\"HealthStatus\\": \\"INIT_SUCCESS\\",\\n \\"InitCostTime\\": 53353,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AclId\\": \\"acl-bp144q24cgqvzckmxxxx\\",\\n \\"Cpu\\": 0,\\n \\"ClusterType\\": \\"Nacos-Ans\\",\\n \\"ClusterName\\": \\"mse-74355150-xxxxxxx\\",\\n \\"InitStatus\\": \\"INIT_SUCCESS\\",\\n \\"InternetPort\\": \\"8848,6443,9848,8761\\",\\n \\"AppVersion\\": \\"2.1.0\\",\\n \\"NetType\\": \\"privatenet\\",\\n \\"ClusterVersion\\": \\"NACOS_2_0_0\\",\\n \\"ClusterSpecification\\": \\"MSE_SC_2_4_60_c\\",\\n \\"VSwitchId\\": \\"vsw-bp1egfakxxxxx\\",\\n \\"ConnectionType\\": \\"null\\",\\n \\"MseVersion\\": \\"mse_pro\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExpectZones\\": [\\n \\"cn-hangzhou-k\\"\\n ],\\n \\"MaintenancePeriod\\": {\\n \\"EndTime\\": \\"02:00\\",\\n \\"StartTime\\": \\"06:00\\"\\n },\\n \\"EndDate\\": \\"2021-08-01 00:00:00\\",\\n \\"SecurityGroupId\\": \\"sg-uf6hgwe067prhg68agfa\\",\\n \\"SecurityGroupType\\": \\"enterprise\\",\\n \\"EipInstanceId\\": \\"eip-bp1uujshd5funmyy8rcl9\\",\\n \\"CanUpdate\\": true,\\n \\"VersionCode\\": \\"NACOS_2_1_0_1\\",\\n \\"VersionLifecycle\\": \\"\\"\\n },\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryClusterInfo', + ], + 'QueryClusterDetail' => [ + 'summary' => 'Queries the details of an instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17078', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '20576750143****', + ], + ], + [ + 'name' => 'AclSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query access control lists (ACLs).'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The string object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9515ACA4-E94D-440D-989E-C379FCED****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1hcg467ekqsv0zr****', + ], + 'CreateTime' => [ + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'string', + 'example' => '2020-07-31 11:36:08', + ], + 'IntranetAddress' => [ + 'description' => 'The internal IP address.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'DiskType' => [ + 'description' => 'The type of the disk.'."\n", + 'type' => 'string', + 'example' => 'alicloud-disk-ssd-multi-zone', + ], + 'PubNetworkFlow' => [ + 'description' => 'The public bandwidth. Unit: Mbit/s.\\'."\n" + .'Valid values: 0 to 5000. The value 0 indicates no access to the Internet.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'DiskCapacity' => [ + 'description' => 'The capacity of the disk. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'MemoryCapacity' => [ + 'description' => 'The size of the memory. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ClusterAliasName' => [ + 'description' => 'The alias of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-7413****', + ], + 'InstanceCount' => [ + 'description' => 'The number of instance nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'IntranetPort' => [ + 'description' => 'The private port number.'."\n", + 'type' => 'string', + 'example' => '8761', + ], + 'InstanceModels' => [ + 'description' => 'The list of instance nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The string object.'."\n", + 'type' => 'object', + 'properties' => [ + 'PodName' => [ + 'description' => 'The name of the pod.'."\n", + 'type' => 'string', + 'example' => 'mse-7413****-159616656****-reg-center-0-0', + ], + 'SingleTunnelVip' => [ + 'description' => 'The single-thread IP address.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'InternetIp' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '47.98.XX.XX', + ], + 'Ip' => [ + 'description' => 'The IP address of the instance.'."\n", + 'type' => 'string', + 'example' => '10.12.XX.XX', + ], + 'Role' => [ + 'description' => 'The role.'."\n", + 'type' => 'string', + 'example' => 'Peer', + ], + 'HealthStatus' => [ + 'description' => 'The health status of the instance.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'CreationTimestamp' => [ + 'description' => 'The timestamp when the instance was created.'."\n", + 'type' => 'string', + 'example' => '1578575377732', + ], + 'Zone' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai-f', + ], + ], + ], + ], + 'IntranetDomain' => [ + 'description' => 'The internal endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-7413****-eureka.mse.aliyuncs.com', + ], + 'InternetDomain' => [ + 'description' => 'The public endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com', + ], + 'PayInfo' => [ + 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", + 'type' => 'string', + 'example' => 'Pay-as-you-go'."\n", + ], + 'InternetAddress' => [ + 'description' => 'The public IP address of the instance.'."\n", + 'type' => 'string', + 'example' => '47.98.XX.XX', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + 'AclEntryList' => [ + 'description' => 'The whitelist.'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'HealthStatus' => [ + 'description' => 'The health status of the instance.'."\n", + 'type' => 'string', + 'example' => 'RESTART_SUCCESS', + ], + 'InitCostTime' => [ + 'description' => 'The amount of time taken to create the instance. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '98408', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AclId' => [ + 'description' => 'The ID of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'acl-bp17020kiqvzutwwj****', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterType' => [ + 'description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", + 'type' => 'string', + 'example' => 'Nacos-Ans', + ], + 'ClusterName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-bc1a29b0-160230875****', + ], + 'InitStatus' => [ + 'description' => 'The creation status of the instance.'."\n", + 'type' => 'string', + 'example' => 'RESTART_SUCCESS', + ], + 'InternetPort' => [ + 'description' => 'The private port number.'."\n", + 'type' => 'string', + 'example' => '8761', + ], + 'AppVersion' => [ + 'description' => 'The application version.'."\n", + 'type' => 'string', + 'example' => '1.2.1', + ], + 'NetType' => [ + 'description' => 'The network type of the instance. Valid values:'."\n" + ."\n" + .'* `privatenet`: VPC'."\n" + .'* `pubnet`: Internet'."\n", + 'type' => 'string', + 'example' => 'privatenet', + ], + 'ClusterVersion' => [ + 'description' => 'The version of the instance.'."\n", + 'type' => 'string', + 'example' => '1.2.1', + ], + 'ClusterSpecification' => [ + 'description' => 'The engine specifications.'."\n", + 'type' => 'string', + 'example' => 'MSE_SC_1_2_200_c', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-xxx-xxxx', + ], + 'ConnectionType' => [ + 'description' => 'The network connection type. Valid values:'."\n" + ."\n" + .'* slb'."\n" + .'* eni'."\n", + 'type' => 'string', + 'example' => 'slb', + ], + 'MseVersion' => [ + 'description' => 'The edition of Microservices Engine (MSE).'."\n", + 'type' => 'string', + 'example' => 'mse_basic', + ], + 'ChargeType' => [ + 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", + 'type' => 'string', + 'example' => 'Pay-as-you-go'."\n", + ], + 'OrderClusterVersion' => [ + 'description' => 'The version number of the original order.'."\n", + 'type' => 'string', + 'example' => '1.2.0', + ], + 'Tags' => [ + 'description' => 'The tags that are attached to the instance.'."\n", + 'type' => 'object', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-aek2dhgysj*****', + ], + 'VersionLifecycle' => [ + 'type' => 'string', + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<QueryClusterDetailResponse>\\n<RequestId>E7744898-AF7E-4FBC-9123-EAF01CFA****</RequestId>\\n<Message>请求处理成功</Message>\\n<Data>\\n <InternetAddress>47.98.XX.XX</InternetAddress>\\n <AclEntryList>[]</AclEntryList>\\n <Cpu>1</Cpu>\\n <InternetPort>8761</InternetPort>\\n <IntranetPort>8761</IntranetPort>\\n <AppVersion>1.9.3</AppVersion>\\n <DiskType>alicloud-disk-ssd-multi-zone</DiskType>\\n <PayInfo>按量付费</PayInfo>\\n <InitCostTime>98408</InitCostTime>\\n <ClusterName>mse-74131be0-159616656****</ClusterName>\\n <IntranetDomain>mse-7413****-eureka.mse.aliyuncs.com</IntranetDomain>\\n <ClusterId>mse-7413****</ClusterId>\\n <InstanceId>mse-cn-st21ri2****</InstanceId>\\n <InternetDomain>mse-7413****-p.eureka.mse.aliyuncs.com</InternetDomain>\\n <CreateTime>2020-07-31 11:36:08</CreateTime>\\n <AclId>acl-bp17020kiqvzutwwj****</AclId>\\n <HealthStatus>RESTART_SUCCESS</HealthStatus>\\n <ClusterType>Eureka</ClusterType>\\n <MemoryCapacity>2</MemoryCapacity>\\n <ClusterAliasName>mse-7413****</ClusterAliasName>\\n <InstanceModels>\\n <Role>Peer</Role>\\n <PodName>mse-7413****-159616656****-reg-center-0-0</PodName>\\n <InternetIp>47.98.XX.XX</InternetIp>\\n <InstanceId>mse-cn-st21ri2****</InstanceId>\\n <ClusterId>mse-7413****</ClusterId>\\n <SingleTunnelVip>192.168.XX.XX</SingleTunnelVip>\\n <Ip>10.12.XX.XX</Ip>\\n <HealthStatus>Running</HealthStatus>\\n <InstanceType>xxx</InstanceType>\\n <Vip>XXX</Vip>\\n <ZkClientPort>2181</ZkClientPort>\\n </InstanceModels>\\n <InstanceCount>3</InstanceCount>\\n <IntranetAddress>192.168.XX.XX</IntranetAddress>\\n <DiskCapacity>60</DiskCapacity>\\n <VpcId>vpc-bp1hcg467ekqsv0zr****</VpcId>\\n <PubNetworkFlow>3</PubNetworkFlow>\\n <RegionId>cn-hangzhou</RegionId>\\n <InitStatus>RESTART_SUCCESS</InitStatus>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</QueryClusterDetailResponse>","errorExample":""}]', + 'title' => 'QueryClusterDetail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCluster' => [ + 'summary' => 'Create an MSE registration and configuration center instance', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '17002', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'PubNetworkFlow', + 'in' => 'query', + 'schema' => [ + 'title' => 'ConnectionType为`slb`时有效，0表示不创建公网接入SLB，1以上值表示公网接入SLB的带宽固定值；单位Mbps', + 'description' => 'Valid when `ConnectionType` is `slb`. 0 indicates no public network access SLB creation, and values above 1 indicate a fixed bandwidth for public network access SLB; unit: Mbps.'."\n" + ."\n" + .'Value range: 0~5000.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PubSlbSpecification', + 'in' => 'query', + 'schema' => [ + 'title' => '不再使用', + 'description' => 'No longer in use', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => false, + 'example' => 'slb.s1.small', + ], + ], + [ + 'name' => 'DiskType', + 'in' => 'query', + 'schema' => [ + 'title' => '不再使用', + 'description' => 'No longer in use', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => false, + 'example' => 'alicloud-disk-ssd', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-bp1t50e045b5g7i3p****', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Network type, with the following values:'."\n" + .'- `privatenet`: indicates a private network.'."\n" + .'- `pubnet`: indicates a public network.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'privatenet', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Switch ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vsw-bp17opt4v18sto39k****', + ], + ], + [ + 'name' => 'InstanceCount', + 'in' => 'query', + 'schema' => [ + 'title' => '实例节点数，开发版仅支持1节点，其它版本支持3-9单数节点', + 'description' => 'Number of instance nodes, with a range limit of 1 to 9.'."\n" + ."\n" + .'[Professional Edition] '."\n" + .'- The number of instances must be 3 or more and must be an odd number.'."\n" + ."\n" + .'[Developer Edition] '."\n" + .'- The number of instances can only be 1.'."\n" + ."\n" + .'[Serverless Edition]'."\n" + ."\n" + .'Ignore this parameter.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'ClusterSpecification', + 'in' => 'query', + 'schema' => [ + 'description' => 'Engine specifications, with the following values:'."\n" + ."\n" + .'[Professional Edition] '."\n" + ."\n" + .'- `MSE_SC_2_4_60_c`: 2 cores, 4GB'."\n" + .'- `MSE_SC_1_2_60_c`: 1 core, 2GB'."\n" + .'- `MSE_SC_4_8_60_c`: 4 cores, 8GB'."\n" + .'- `MSE_SC_8_16_60_c`: 8 cores, 16GB'."\n" + .'- `MSE_SC_16_32_60_c`: 16 cores, 32GB'."\n" + ."\n" + .'[Developer Edition] '."\n" + ."\n" + .'- `MSE_SC_1_2_60_c`: 1 core, 2GB'."\n" + .'- `MSE_SC_2_4_60_c`: 2 cores, 4GB'."\n" + ."\n" + .'[Serverless Edition]'."\n" + ."\n" + .'Ignore this parameter, or you can fill in `MSE_SC_SERVERLESS`.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MSE_SC_2_4_60_c', + ], + ], + [ + 'name' => 'ClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster version, with the following values:'."\n" + ."\n" + .'[Professional Edition] '."\n" + ."\n" + .'- `NACOS_2_0_0`: indicates Nacos 2.x.x version.'."\n" + .'- `ZooKeeper_3_8_0`: indicates ZooKeeper 3.8.x version.'."\n" + ."\n" + .'[Developer Edition] '."\n" + ."\n" + .'- `NACOS_2_0_0`: indicates Nacos 2.x version.'."\n" + .'- `ZooKeeper_3_8_0`: indicates ZooKeeper 3.8.x version.'."\n" + ."\n" + .'[Serverless Edition]'."\n" + ."\n" + .'- `NACOS_2_0_0`: indicates Nacos 2.x version.'."\n" + .'- `ZooKeeper_3_8_0`: indicates ZooKeeper 3.8.x version.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NACOS_2_0_0', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster type, including ZooKeeper, Nacos-Ans.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Nacos-Ans', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the cluster is located, including but not limited to the following regions:'."\n" + .'- `cn-hangzhou`: Hangzhou'."\n" + .'- `cn-beijing`: Beijing'."\n" + .'- `cn-shanghai`: Shanghai'."\n" + .'- `cn-zhangjiakou`: Zhangjiakou'."\n" + .'- `cn-shenzhen`: Shenzhen', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PrivateSlbSpecification', + 'in' => 'query', + 'schema' => [ + 'title' => '不再使用', + 'description' => 'No longer in use', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => false, + 'example' => 'slb.s1.small', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => [ + 'title' => '网络接入类型，`slb`或`single_eni`；部分Region开发版只支持`single_eni`类型', + 'description' => 'Network access type, `slb` or `single_eni`; some regions\' Developer Edition only support the `single_eni` type.', + 'type' => 'string', + 'required' => false, + 'example' => 'slb', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'Extended request parameters, in JSON format.', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '实例版本：开发版mse_dev、基础版mse_basic、专业版mse_pro', + 'description' => 'Required unless under special circumstances, with the following values:'."\n" + ."\n" + .'- `mse_pro`: indicates Professional Edition.'."\n" + .'- `mse_dev`: indicates Developer Edition.'."\n" + .'- `mse_serverless`: indicates Serverless Edition.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'mse_dev' => '开发版', + 'mse_serverless' => 'Serverless版', + 'mse_pro' => '专业版', + ], + 'example' => 'mse_pro', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '实例别名', + 'description' => 'Custom instance name', + 'type' => 'string', + 'required' => false, + 'example' => 'tanshuyingtest001', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource group ID. For more details about the resource group, see [Basic Information of Resource Group](~~457230~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzcqmoay3dlyq', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => 'List of tags to be added. Contains up to 20 items.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => 'Tag key.', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => 'Tag value.', + 'type' => 'string', + 'required' => false, + 'example' => 'prd', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'title' => '付费类型', + 'description' => 'Billing method, including PREPAY (Subscription) and POSTPAY (Pay-As-You-Go).'."\n" + ."\n" + .'This parameter is ignored for the Serverless edition.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PREPAY' => '包年包月', + 'POSTPAY' => '按量付费', + ], + 'example' => 'POSTPAY', + ], + ], + [ + 'name' => 'SecurityGroupType', + 'in' => 'query', + 'schema' => [ + 'title' => 'ConnectionType为`single_eni`时有效，表示实例所在的安全组类型', + 'description' => 'Valid when `ConnectionType` is `single_eni`, indicating the security group type of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'enterprise', + 'default' => 'enterprise', + 'enum' => [ + 'enterprise', + 'normal', + ], + ], + ], + [ + 'name' => 'EipEnabled', + 'in' => 'query', + 'schema' => [ + 'title' => 'ConnectionType为`single_eni`时有效，表示是否开启公网访问（弹性公网IP）', + 'description' => 'Valid when `ConnectionType` is `single_eni`, indicating whether to enable public network access (Elastic IP).', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'default' => 'false', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language type of the returned information:'."\n" + ."\n" + .'- zh: Chinese'."\n" + .'- en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'String object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => 'dc63-465d-8ef5-20dc18af****', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'InstanceId' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + 'ErrorCode' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'OrderId' => [ + 'description' => 'Order ID.', + 'type' => 'string', + 'example' => '20574710974****', + ], + 'Success' => [ + 'description' => 'Request result, with the following values:'."\n" + .'- `true`: Request succeeded.'."\n" + .'- `false`: Request failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<CreateClusterResponse>\\n <RequestId>dc63-465d-8ef5-20dc18af****</RequestId>\\n <Message>请求处理成功</Message>\\n <InstanceId>mse-cn-st21ri2****</InstanceId>\\n <ErrorCode>mse-100-000</ErrorCode>\\n <OrderId>20574710974****</OrderId>\\n <Success>true</Success>\\n</CreateClusterResponse>","errorExample":""}]', + 'title' => 'Create Registration and Configuration Center Cluster', + 'description' => 'Please ensure that you fully understand the billing method and pricing of the MSE (Microservice Engine) product before using this interface.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DeleteCluster' => [ + 'summary' => 'Deletes a Microservices Engine (MSE) instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17009', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-6ja1rgl****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteClusterResponse>\\n<HttpCode>202</HttpCode>\\n<RequestId>3369AD10-F1A6-4E6F-B99E-20F51826****</RequestId>\\n<Message>请求处理成功</Message>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</DeleteClusterResponse>","errorExample":""}]', + 'title' => 'DeleteCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateCluster' => [ + 'summary' => 'Modifies the information about an instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17098', + 'abilityTreeNodes' => [ + 'FEATUREmseY3D6DK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'ClusterAliasName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alias of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cluster-1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-78v1l83****', + ], + ], + [ + 'name' => 'MaintenanceStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the O\\&M window.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '02:00', + ], + ], + [ + 'name' => 'MaintenanceEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the O\\&M window.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '06:00', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-100', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateClusterResponse>\\n<Message>请求处理成功</Message>\\n<RequestId>5B170A0D-2C5D-4CF8-B808-03966B86****</RequestId>\\n<ErrorCode>mse-100-100</ErrorCode>\\n<Success>true</Success>\\n</UpdateClusterResponse>","errorExample":""}]', + 'title' => 'UpdateCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateConfig' => [ + 'summary' => 'Updates the configurations of an instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17099', + 'abilityTreeNodes' => [ + 'FEATUREmseY3D6DK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The format of the configuration. Supported formats include TEXT, JSON, XML, and HTML.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'TEXT', + ], + ], + [ + 'name' => 'TickTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time unit. This parameter is valid for ZooKeeper instances. Default value: 2000. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2000', + ], + ], + [ + 'name' => 'InitLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum connection duration of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'SyncLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The connection timeout period of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxClientCnxns', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of connections between a client and a server. This parameter is valid for ZooKeeper instances.\\'."\n" + .'If this parameter is set to 0, no limits are imposed on the number of connections.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'OpenSuperAcl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to enable super permissions. This parameter is valid for ZooKeeper instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the user.'."\n" + ."\n" + .'> You must specify this parameter if OpenSuperAcl is set to true.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'PassWord', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that corresponds to the username.'."\n" + ."\n" + .'> You must specify this parameter if OpenSuperAcl is set to true.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'password', + ], + ], + [ + 'name' => 'JuteMaxbuffer', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum amount of data on each node. This parameter is valid for ZooKeeper instances. The default maximum data amount on each node is 1 megabyte. Unit: bytes.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1048575', + ], + ], + [ + 'name' => 'AutopurgePurgeInterval', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'none', + ], + ], + [ + 'name' => 'AutopurgeSnapRetainCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'none', + ], + ], + [ + 'name' => 'ConfigAuthEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable Resource Access Management (RAM) authentication for a configuration center. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n" + ."\n" + .'> Before you configure this parameter, you must call the QueryConfig operation to obtain the ConfigAuthSupported parameter value to check whether the instance supports the RAM authentication feature.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NamingAuthEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable RAM authentication for a registry. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n" + ."\n" + .'> Before you configure this parameter, you must call the QueryConfig operation to obtain the NamingAuthSupporte parameter value to check whether the instance supports the RAM authentication feature.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MCPEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable Mesh Configuration Protocol (MCP). This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n" + ."\n" + .'> Before you configure this parameter, you must call the QueryConfig operation to obtain the MCPSupported parameter value to check whether the instance supports MCP.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-st2212****', + ], + ], + [ + 'name' => 'ConfigSecretEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable configuration encryption for a configuration center. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n" + ."\n" + .'> Before you configure this parameter, you must call the QueryConfig operation to obtain the ConfigSecretSupported parameter value to check whether the instance supports configuration encryption.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MinSessionTimeout', + 'in' => 'query', + 'schema' => [ + 'title' => '最小超时时间', + 'description' => 'The minimum timeout period. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxSessionTimeout', + 'in' => 'query', + 'schema' => [ + 'title' => '最大超时时间', + 'description' => 'The maximum timeout period. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SnapshotCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The frequency for generating snapshots. This parameter is valid for ZooKeeper instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100000', + ], + ], + [ + 'name' => 'ExtendedTypesEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the time to live (TTL) configuration. This parameter is valid for ZooKeeper instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EurekaSupported', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TLSEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConsoleUIEnabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'Enable4lw', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'AuthEnabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"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":"<UpdateConfigResponse>\\n<RequestId>CB889254-0C8B-49B2-8465-4CDAB08A****</RequestId>\\n<Message>请求处理成功</Message>\\n<ErrorCode>mse-100-100</ErrorCode>\\n<Success>true</Success>\\n</UpdateConfigResponse>","errorExample":""}]', + 'title' => 'UpdateConfig', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListClusters' => [ + 'summary' => 'Queries Microservices Engine (MSE) instances.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17063', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterAliasName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alias of the instance. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group. For more information about resource groups, see the topic "View basic information of a resource group."'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxbzafebvvfa', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of tags. A maximum number of 20 tags are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'prd', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'KeyId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The string object.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndDate' => [ + 'description' => 'The time when the cluster expires.'."\n", + 'type' => 'string', + 'example' => '2021-08-01 00:00:00', + ], + 'IntranetDomain' => [ + 'description' => 'The internal endpoint.'."\n", + 'type' => 'string', + 'example' => 'mse-7413****-eureka.mse.aliyuncs.com', + ], + 'InternetDomain' => [ + 'description' => 'The public endpoint.'."\n", + 'type' => 'string', + 'example' => 'mse-7413****-p.eureka.mse.aliyuncs.com', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created.'."\n", + 'type' => 'string', + 'example' => '2020-07-31 11:36:08', + ], + 'ChargeType' => [ + 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", + 'type' => 'string', + 'example' => 'Pay-as-you-go'."\n", + ], + 'IntranetAddress' => [ + 'description' => 'The internal IP address.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + 'InternetAddress' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '47.98.XX.XX', + ], + 'ClusterAliasName' => [ + 'description' => 'The alias of the cluster.'."\n", + 'type' => 'string', + 'example' => 'mse-7413****', + ], + 'ClusterType' => [ + 'description' => 'The type of the cluster. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", + 'type' => 'string', + 'example' => 'Eureka', + ], + 'InitStatus' => [ + 'description' => 'The initialization status of the instance.'."\n", + 'type' => 'string', + 'example' => 'RESTART_SUCCESS', + ], + 'AppVersion' => [ + 'description' => 'The application version.'."\n", + 'type' => 'string', + 'example' => '1.9.3', + ], + 'CanUpdate' => [ + 'description' => 'Indicates whether the instance can be upgraded.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'VersionCode' => [ + 'description' => 'The version information.'."\n", + 'type' => 'string', + 'example' => 'EUREKA_1_9_3', + ], + 'InstanceCount' => [ + 'description' => 'The number of clusters.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ClusterName' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + 'MseVersion' => [ + 'description' => 'The edition of the cluster.'."\n", + 'type' => 'string', + 'example' => 'mse_pro', + ], + 'Tags' => [ + 'description' => 'The tags that are attached to the instance.'."\n", + 'type' => 'object', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the instance belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmv7jiavm4uxa', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-bp1hcg467ekqsv0zr****', + ], + 'MaintenancePeriod' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'type' => 'string', + ], + 'EndTime' => [ + 'type' => 'string', + ], + ], + ], + 'VersionLifecycle' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"202\\",\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"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":"<ListClustersResponse>\\n <HttpCode>202</HttpCode>\\n <TotalCount>7</TotalCount>\\n <RequestId>69AD2AA7-DB47-449B-941B-B14409DF****</RequestId>\\n <Message>请求处理成功</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Data>\\n <EndDate>2021-08-01 00:00:00</EndDate>\\n <IntranetDomain>mse-7413****-eureka.mse.aliyuncs.com</IntranetDomain>\\n <InternetDomain>mse-7413****-p.eureka.mse.aliyuncs.com</InternetDomain>\\n <CreateTime>2020-07-31 11:36:08</CreateTime>\\n <ChargeType>按量付费</ChargeType>\\n <IntranetAddress>192.168.XX.XX</IntranetAddress>\\n <InstanceId>mse-cn-st21ri2****</InstanceId>\\n <InternetAddress>47.98.XX.XX</InternetAddress>\\n <ClusterAliasName>mse-7413****</ClusterAliasName>\\n <ClusterType>Eureka</ClusterType>\\n <InitStatus>RESTART_SUCCESS</InitStatus>\\n <AppVersion>1.9.3</AppVersion>\\n </Data>\\n <ErrorCode>mse-100-000</ErrorCode>\\n <Success>true</Success>\\n</ListClustersResponse>","errorExample":""}]', + 'title' => 'ListClusters', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListClusterTypes' => [ + 'summary' => 'Queries the engine types that can be activated.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ConnectType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '网络连接类型', + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'* slb'."\n" + .'* eni'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slb', + 'enum' => [ + 'eni', + 'slb', + ], + ], + ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of the MSE instance that you want to purchase.'."\n" + ."\n" + .'* mse_pro: Professional Edition'."\n" + .'* mse_dev: Developer Edition'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_pro', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '821B5B05-8919-5FBB-BA75-417BFC093EB8', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ShowName' => [ + 'description' => 'The type of the MSE engine that can be activated.'."\n", + 'type' => 'string', + 'example' => 'Zookeeper', + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"821B5B05-8919-5FBB-BA75-417BFC093EB8\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"ZooKeeper\\",\\n \\"ShowName\\": \\"Zookeeper\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListClusterTypes', + ], + 'ListClusterVersions' => [ + 'summary' => 'Queries the information about supported instance versions.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Nacos-Ans', + ], + ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'* `mse_dev`: Developer Edition.'."\n" + .'* `mse_pro`: Professional Edition. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_pro', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7717BE5B-C958-5F87-BF49-464AA276EDD1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The code of the instance type.'."\n", + 'type' => 'string', + 'example' => 'NACOS_2_0_0', + ], + 'ShowName' => [ + 'description' => 'The version of the instance.'."\n", + 'type' => 'string', + 'example' => '2.1.0', + ], + 'ClusterType' => [ + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'example' => 'Nacos-Ans', + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7717BE5B-C958-5F87-BF49-464AA276EDD1\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"NACOS_2_0_0\\",\\n \\"ShowName\\": \\"2.1.0\\",\\n \\"ClusterType\\": \\"Nacos-Ans\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListClusterVersions', + ], + 'QueryClusterSpecification' => [ + 'summary' => 'Queries the information of supported instance specifications.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ConnectType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '网络连接类型', + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'* slb'."\n" + .'* eni'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slb', + 'pattern' => '', + 'enum' => [ + 'eni', + 'slb', + ], + ], + ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of the MSE instance that you want to purchase.'."\n" + ."\n" + .'* mse_pro: Professional Edition'."\n" + .'* mse_dev: Developer Edition'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'mse_pro', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The results that are returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterSpecificationName' => [ + 'description' => 'The engine specifications that can be used.'."\n", + 'type' => 'string', + 'example' => 'MSE_SC_1_2_200_c', + ], + 'MemoryCapacity' => [ + 'description' => 'The memory size in the specifications. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'CpuCapacity' => [ + 'description' => 'The number of vCPUs in the specifications.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<QueryClusterSpecificationResponse>\\n<Message>请求处理成功</Message>\\n<RequestId>EE5C32A1-BC0E-4B79-817C-103E4EDF****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <MaxTps>5000</MaxTps>\\n <CpuCapacity>1</CpuCapacity>\\n <InstanceCount>1</InstanceCount>\\n <DiskCapacity>60</DiskCapacity>\\n <ClusterSpecificationName>MSE_SC_1_2_200_c</ClusterSpecificationName>\\n <MemoryCapacity>2</MemoryCapacity>\\n <MaxCon>3000</MaxCon>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryClusterSpecificationResponse>","errorExample":""}]', + 'title' => 'QueryClusterSpecification', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryClusterDiskSpecification' => [ + 'summary' => 'Queries disk specifications that are supported by an instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76161', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ZooKeeper', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E13A3A34-7201-50C4-B2D0-0D7DB891811E', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => 'The step size of the disk capacity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Max' => [ + 'description' => 'The maximum disk capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Min' => [ + 'description' => 'The minimum disk capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E13A3A34-7201-50C4-B2D0-0D7DB891811E\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"Step\\": 2,\\n \\"Max\\": 500,\\n \\"Min\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'QueryClusterDiskSpecification', + ], + 'ListInstanceCount' => [ + 'summary' => 'Displays the number of nodes that can be deployed for an instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instance. Valid values: ZooKeeper and Nacos-Ans.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Nacos-Ans', + ], + ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition type of the instance. Valid values:'."\n" + ."\n" + .'* `mse_dev`: Developer Edition'."\n" + .'* `mse_pro`: Professional Edition'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_pro', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides. Examples:'."\n" + ."\n" + .'* cn-hangzhou: China (Hangzhou)'."\n" + .'* cn-beijing: China (Beijing)'."\n" + .'* cn-shanghai: China (Shanghai)'."\n" + .'* cn-zhangjiakou: China (Zhangjiakou)'."\n" + .'* cn-shenzhen: China (Shenzhen)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<Integer>>', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed. If the request failed, the ErrorCode parameter is returned. For more information, see the [Error codes](~~456441~~) section of this topic.'."\n", + 'type' => 'string', + 'example' => 'mse-100-100', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message. If the request is successful, a success message is returned. If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => '%s', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace `%s` in the `ErrMessage` parameter.'."\n" + ."\n" + .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The number of nodes that can be deployed for the instance of the current edition.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + '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 \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-100\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"%s\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n 3\\n ]\\n}","type":"json"}]', + 'title' => 'ListInstanceCount', + ], + 'QueryConfig' => [ + 'summary' => 'Queries configuration information of an instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17081', + 'abilityTreeNodes' => [ + 'FEATUREmseY3D6DK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse_prepaid_public_cn-st2212****', + ], + ], + [ + 'name' => 'NeedRunningConf', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether runtime configurations are required.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8BD1E58D-0755-42AC-A599-E6B55112EC53', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxClientCnxns' => [ + 'description' => 'The number of connections between a client and a server. This parameter is valid for ZooKeeper instances.\\'."\n" + .'If this parameter is set to 0, no limits are imposed on the number of connections.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ConfigAuthSupported' => [ + 'description' => 'Indicates whether RAM authentication is supported by a configuration center of the instance. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: supported.'."\n" + .'* `false`: not supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'InitLimit' => [ + 'description' => 'The maximum connection duration of the instance. Unit: seconds. This parameter is valid for ZooKeeper instances.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'MCPEnabled' => [ + 'description' => 'Indicates whether Mesh Configuration Protocol (MCP) is enabled. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'OpenSuperAcl' => [ + 'description' => 'Indicates whether super permissions are enabled. This parameter is valid for ZooKeeper instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RestartFlag' => [ + 'description' => 'Indicates whether the instance was restarted and new configurations have taken effect. Valid values:'."\n" + ."\n" + .'* `true`: The restart was successful.'."\n" + .'* `false`: The restart failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'JvmFlagsCustom' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'AutopurgePurgeInterval' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'AutopurgeSnapRetainCount' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'SyncLimit' => [ + 'description' => 'The connection timeout period of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'ConfigAuthEnabled' => [ + 'description' => 'Indicates whether RAM authentication of a configuration center is enabled. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ClusterName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'MCPSupported' => [ + 'description' => 'Indicates whether MCP is supported. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: supported.'."\n" + .'* `false`: not supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'JuteMaxbuffer' => [ + 'description' => 'The maximum amount of data on each node. This parameter is valid for ZooKeeper instances. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'TickTime' => [ + 'description' => 'The time unit of the engine. This parameter is valid for ZooKeeper instances. Default value: 2000. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '2000', + ], + 'PassWord' => [ + 'description' => 'The password that corresponds to the username. This parameter is valid only if OpenSuperAcl is set to true.'."\n", + 'type' => 'string', + 'example' => 'password', + ], + 'UserName' => [ + 'description' => 'The username of the user. This parameter is valid only if OpenSuperAcl is set to true.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'ConfigSecretSupported' => [ + 'description' => 'Indicates whether configuration encryption of a configuration center is supported by the instance. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: supported.'."\n" + .'* `false`: not supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConfigSecretEnabled' => [ + 'description' => 'Indicates whether configuration encryption of a configuration center is enabled by the instance. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'NamingAuthEnabled' => [ + 'description' => 'Indicates whether RAM authentication of a registry is enabled. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: enabled.'."\n" + .'* `false`: disabled.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'NamingAuthSupported' => [ + 'description' => 'Indicates whether RAM authentication of services is supported by the instance. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: supported.'."\n" + .'* `false`: not supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'NamingCreateServiceSupported' => [ + 'description' => 'Indicates whether service creation is supported for the instance. This parameter is valid for Nacos instances. Valid values:'."\n" + ."\n" + .'* `true`: supported.'."\n" + .'* `false`: not supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MinSessionTimeout' => [ + 'title' => '最小超时时间', + 'description' => 'The minimum timeout period. This parameter is valid for ZooKeeper instances.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'MaxSessionTimeout' => [ + 'title' => '最大超时时间', + 'description' => 'The maximum timeout period. This parameter is valid for ZooKeeper instances.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'SnapshotCount' => [ + 'description' => 'The frequency for generating snapshots. This parameter is valid for ZooKeeper instances.'."\n", + 'type' => 'string', + 'example' => '100000', + ], + 'ConfigContentLimit' => [ + 'description' => 'The maximum size of contents in a configuration. Unit: KB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'NacosRunningEnv' => [ + 'description' => 'The runtime configuration of the Nacos instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'emptyProtect' => [ + 'description' => 'Indicates whether empty list protection is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'grayAuth' => [ + 'type' => 'string', + ], + 'fenceEnabled' => [ + 'type' => 'boolean', + ], + 'fencePolicy' => [ + 'type' => 'object', + 'properties' => [ + 'interceptPolicy' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'enabledModules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'serviceName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'ExtendedTypesEnable' => [ + 'description' => 'Indicates whether the time to live (TTL) configuration is enabled. This parameter is valid for ZooKeeper instances.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EurekaSupported' => [ + 'description' => 'Indicates whether access port 8761 was enabled for Eureka. If this port is disabled, applications cannot use the Eureka protocol for service registration and discovery.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TLSEnabled' => [ + 'description' => 'MSE Nacos supports TLS transmission link encryption since version 2.1.2.1. Nacos clients must be upgraded to version 2.2.1 or later. After TLS is enabled, the system performance will decrease by about 10%. You must evaluate the system capacity. For more information about the relevant operations, see Nacos TLS transmission encryption.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConsoleUIEnabled' => [ + 'description' => 'Indicates whether the Nacos open source console is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Enable4lw' => [ + 'type' => 'boolean', + ], + 'AuthEnabled' => [ + 'title' => 'ZooKeeper sasl 强制身份认证开关', + 'description' => 'Indicates whether Simple Authentication and Security Layer (SASL) forced identity authentication is enabled for the ZooKeeper instance.'."\n", + 'type' => 'boolean', + ], + 'PrometheusSdProtocolEnabled' => [ + 'type' => 'string', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<QueryConfigResponse>\\n<Message>请求处理成功</Message>\\n<RequestId>8BD1E58D-0755-42AC-A599-E6B55112EC53</RequestId>\\n<Data>\\n <MCPEnabled>true</MCPEnabled>\\n <MaxClientCnxns>0</MaxClientCnxns>\\n <UserName>name</UserName>\\n <OpenSuperAcl>true</OpenSuperAcl>\\n <TickTime>2000</TickTime>\\n <AutopurgeSnapRetainCount>none</AutopurgeSnapRetainCount>\\n <PassWord>password</PassWord>\\n <InitLimit>100</InitLimit>\\n <ConfigAuthEnabled>true</ConfigAuthEnabled>\\n <JvmFlagsCustom>none</JvmFlagsCustom>\\n <RestartFlag>true</RestartFlag>\\n <AutopurgePurgeInterval>none</AutopurgePurgeInterval>\\n <JuteMaxbuffer>1</JuteMaxbuffer>\\n <MCPSupported>true</MCPSupported>\\n <ClusterName>name</ClusterName>\\n <ConfigAuthSupported>true</ConfigAuthSupported>\\n <SyncLimit>10</SyncLimit>\\n</Data>\\n<ErrorCode>mse-100-100</ErrorCode>\\n<Success>true</Success>\\n</QueryConfigResponse>","errorExample":""}]', + 'title' => 'QueryConfig', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetImage' => [ + 'summary' => 'Queries the maximum version number to which the current version can be upgraded.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '43433', + 'abilityTreeNodes' => [ + 'FEATUREmseLINUSD', + ], + ], + 'parameters' => [ + [ + 'name' => 'VersionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '集群版本', + 'description' => 'The version number of the current instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ZooKeeper_3_5_5', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25EA0A83-9007-4E87-808C-637BE1A****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CurrentVersionFullShowName' => [ + 'title' => '当前集群镜像版本的4位全名', + 'description' => 'The full version number of the current instance image. The parameter is in the X.X.X.X format.'."\n", + 'type' => 'string', + 'example' => '3.5.5.0', + ], + 'MaxVersionCode' => [ + 'title' => '可升级的增量版本Code', + 'description' => 'The code of the maximum version to which the current version can be upgraded.'."\n", + 'type' => 'string', + 'example' => 'ZooKeeper_3_6_3', + ], + 'MaxVersionFullShowName' => [ + 'title' => '可升级的增量版本全名', + 'description' => 'The full number of the maximum version to which the current version can be upgraded.'."\n", + 'type' => 'string', + 'example' => '3.6.3.0', + ], + 'MaxVersionChangelogUrl' => [ + 'title' => '可升级的最大版本变更日志url', + 'description' => 'The URL of the changelog for the maximum version to which the current version can be upgraded.'."\n", + 'type' => 'string', + 'example' => 'https://xxxxx', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"25EA0A83-9007-4E87-808C-637BE1A****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"HttpCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"CurrentVersionFullShowName\\": \\"3.5.5.0\\",\\n \\"MaxVersionCode\\": \\"ZooKeeper_3_6_3\\",\\n \\"MaxVersionFullShowName\\": \\"3.6.3.0\\",\\n \\"MaxVersionChangelogUrl\\": \\"https://xxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetImage', + ], + 'UpdateImage' => [ + 'summary' => 'Updates the version number of the destination cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '43431', + 'abilityTreeNodes' => [ + 'FEATUREmseLINUSD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标集群的id', + 'description' => 'The ID of the destination cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mse-8e8e9060', + ], + ], + [ + 'name' => 'VersionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '想修改的镜像版本code', + 'description' => 'The destination version number.'."\n" + ."\n" + .'> You must call the GetImage operation to obtain the maximum destination version number that corresponds to MaxVersionCode.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ZooKeeper_3_5_5', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3855D475-2B66-5CFF-9A51-3D698E52C472', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + '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\\": \\"3855D475-2B66-5CFF-9A51-3D698E52C472\\",\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateImage', + ], + 'GetMseFeatureSwitch' => [ + 'summary' => 'Queries the information about the MSE feature switch.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6B4653A3-8D9C-5FDC-BB0C-936D40E9794B', + ], + 'Result' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'example' => '{\'nacos_config_encrypt\': False}', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"6B4653A3-8D9C-5FDC-BB0C-936D40E9794B\\",\\n \\"Result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetMseFeatureSwitch', + ], + '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' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The parameter is invalid.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Ordering' => [ + 'description' => 'The ordering information.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'region', + ], + 'DistrictEnName' => [ + 'description' => 'The English name of the district.'."\n", + 'type' => 'string', + 'example' => 'Asia Pacific', + ], + 'ShowName' => [ + 'description' => 'The display name.'."\n", + 'type' => 'string', + 'example' => 'China (Shanghai)'."\n", + ], + 'DistrictCnName' => [ + 'description' => 'The Chinese name of the district.'."\n", + 'type' => 'string', + 'example' => 'Asia Pacific'."\n", + ], + 'EnName' => [ + 'description' => 'The English name of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Shanghai)', + ], + 'DistrictId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'asia-pacific', + ], + 'DistrictShowName' => [ + 'description' => 'The display name of the district.'."\n", + 'type' => 'string', + 'example' => 'Asia Pacific'."\n", + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'China (Shanghai)'."\n", + ], + 'EnDescription' => [ + 'description' => 'The complete description of the region.'."\n", + 'type' => 'string', + 'example' => 'China East 2 (Shanghai)', + ], + 'CnName' => [ + 'description' => 'The Chinese name of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Shanghai)'."\n", + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'DistrictOrdering' => [ + 'description' => 'The ordering information of the district.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '101', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<QueryBusinessLocationsResponse>\\n<RequestId>3369AD10-F1A6-4E6F-B99E-20F51826****</RequestId>\\n<Message>参数不合法</Message>\\n<Data>\\n <Description>111</Description>\\n <DistrictShowName>111</DistrictShowName>\\n <EnName>111</EnName>\\n <DistrictId>111</DistrictId>\\n <ShowName>111</ShowName>\\n <DistrictCnName>111</DistrictCnName>\\n <Name>111</Name>\\n <CnName>111</CnName>\\n <Type>111</Type>\\n <DistrictEnName>111</DistrictEnName>\\n <EnDescription>111</EnDescription>\\n <Ordering>111</Ordering>\\n <DistrictOrdering>111</DistrictOrdering>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</QueryBusinessLocationsResponse>","errorExample":""}]', + 'title' => 'QueryBusinessLocations', + 'summary' => 'Queries information about regions.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListClusterConnectionTypes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '76158', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8625467C-27DD-5711-878E-6857E3074937', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'ShowName' => [ + 'description' => 'The connection type.'."\n", + 'type' => 'string', + 'example' => 'slb', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"8625467C-27DD-5711-878E-6857E3074937\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"ShowName\\": \\"slb\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListClusterConnectionTypes', + 'summary' => 'Queries available cluster connection types.', + ], + 'QuerySlbSpec' => [ + 'summary' => 'Queries the type of a Server Load Balancer (SLB) instance.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the SLB instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the returned data.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Spec' => [ + 'description' => 'The specification of the instance.'."\n", + 'type' => 'string', + 'example' => 'slb.s2.small', + ], + 'Name' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'Standard I'."\n", + ], + 'MaxConnection' => [ + 'description' => 'The maximum number of connections.'."\n", + 'type' => 'string', + 'example' => '50,000', + ], + 'NewConnectionPerSecond' => [ + 'description' => 'The number of connections per second.'."\n", + 'type' => 'string', + 'example' => '50,000', + ], + 'Qps' => [ + 'description' => 'The number of queries per second (QPS).'."\n", + 'type' => 'string', + 'example' => '50,000', + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 2,\\n \\"Spec\\": \\"slb.s2.small\\",\\n \\"Name\\": \\"标准型I\\",\\n \\"MaxConnection\\": \\"50,000\\",\\n \\"NewConnectionPerSecond\\": \\"50,000\\",\\n \\"Qps\\": \\"50,000\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QuerySlbSpec', + ], + 'UpdateClusterSpec' => [ + 'summary' => 'Updates the number or specifications of nodes in a pay-as-you-go Microservices Engine (MSE) instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关名称', + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '节点规格', + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'InstanceCount', + 'in' => 'query', + 'schema' => [ + 'title' => '节点数量', + 'description' => 'The number of destination nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ClusterSpecification', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination engine specifications.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MSE_SC_4_8_200_c' => 'MSE_SC_4_8_200_c', + 'MSE_SC_16_32_200_c' => 'MSE_SC_16_32_200_c', + 'MSE_SC_2_4_200_c' => 'MSE_SC_2_4_200_c', + 'MSE_SC_8_16_200_c' => 'MSE_SC_8_16_200_c', + ], + 'example' => 'MSE_SC_2_4_200_c', + ], + ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The MSE version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_pro'."\n", + ], + ], + [ + 'name' => 'PubNetworkFlow', + 'in' => 'query', + 'schema' => [ + 'title' => '公网带宽', + 'type' => 'integer', + 'format' => 'int32', + 'minimum' => '0', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'title' => '是否下单之后自动支付，如果此值为false，此接口将会返回订单支付url，可手动确认支付', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'string', + 'example' => 'null', + 'title' => '如果AutoPay设置为false，则此值为订单支付的URL', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed. Take note of the following rules:'."\n" + ."\n" + .'* The **ErrorCode** parameter is not returned if the request succeeds.'."\n" + .'* The **ErrorCode** parameter is returned if the request fails. For more information, see the **Error codes** section in this topic.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + ], + ], + ], + ], + '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\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"null\\",\\n \\"ErrorCode\\": \\"mse-100-000\\"\\n}","type":"json"}]', + 'title' => 'UpdateClusterSpec', + 'description' => 'You can call this operation to update the number or specifications of nodes in a pay-as-you-go MSE instance. You are charged when you add nodes or upgrade node specifications. For more information, see \\[Pricing] (`~~1806469~~`).'."\n", + ], + 'RestartCluster' => [ + 'summary' => 'Restarts a registry.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17093', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-78v1l83****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'PodNameList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of pods. You can specify the names of multiple pods at a time. Separate multiple pod names with commas (,). Example: mse-a8aba010-1629719288255-reg-center-0-1,mse-a8aba010-1629719288255-reg-center-0-2.'."\n" + ."\n" + .'The specified pods must belong to the current cluster and be associated with the specified instance. Otherwise, a restart exception occurs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-a8aba010-1629719288255-reg-center-0-1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RestartClusterResponse>\\n<Message>请求成功</Message>\\n<RequestId>5B170A0D-2C5D-4CF8-B808-03966B86****</RequestId>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</RestartClusterResponse>","errorExample":""}]', + 'title' => 'RestartCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RetryCluster' => [ + 'summary' => 'Retries a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17094', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'RetryCluster', + ], + 'UpgradeCluster' => [ + 'summary' => 'Upgrades the version of a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-nif1w51wi0c', + ], + ], + [ + 'name' => 'UpgradeVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination version.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1.2.1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'HttpCode' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8D855418-177B-5FF8-A021-75B930AD890A', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"RequestId\\": \\"8D855418-177B-5FF8-A021-75B930AD890A\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpgradeCluster', + ], + 'CreateEngineNamespace' => [ + 'summary' => 'Creates a namespace in a Nacos instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '17003', + 'abilityTreeNodes' => [ + 'FEATUREmseL2AGED', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'mse-98s****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dev', + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Development environment'."\n", + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'ServiceCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of services that can run in the namespace.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom ID of the namespace. If you do not specify this parameter, the automatically generated Universally Unique Identifier (UUID) is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F6092602-C357-4750-89D9-E572FBEA****', + ], + 'ClusterId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-892k****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the namespace. Valid values:'."\n" + ."\n" + .'* `0`: global configuration'."\n" + .'* `1`: default namespace'."\n" + .'* `2`: custom namespace'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NamespaceShowName' => [ + 'description' => 'The display name of the namespace.'."\n", + 'type' => 'string', + 'example' => 'dev', + ], + 'Quota' => [ + 'description' => 'The quota of configurations.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Namespace' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'example' => 'f4fa5b81-2f26-4900-833a-7516b315ebb2', + ], + 'NamespaceDesc' => [ + 'description' => 'The description of the namespace.'."\n", + 'type' => 'string', + 'example' => 'mytest', + ], + 'ConfigCount' => [ + 'description' => 'The number of configurations.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ServiceCount' => [ + 'description' => 'The number of active services.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<CreateEngineNamespaceResponse>\\n<RequestId>F6092602-C357-4750-89D9-E572FBEA****</RequestId>\\n<Message>请求处理成功</Message>\\n<ClusterId>mse-892k****</ClusterId>\\n<Data>\\n <Type>1</Type>\\n <Quota>1</Quota>\\n <ConfigCount>1</ConfigCount>\\n <NamespaceShowName>public</NamespaceShowName>\\n <ServiceCount>3</ServiceCount>\\n <NamespaceDesc>mytest</NamespaceDesc>\\n <Namespace>DEFAULT</Namespace>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</CreateEngineNamespaceResponse>","errorExample":""}]', + 'title' => 'CreateEngineNamespace', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteEngineNamespace' => [ + 'summary' => 'Deletes a namespace from a Nacos instance.', + 'methods' => [ + 'post', + 'get', + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17010', + 'abilityTreeNodes' => [ + 'FEATUREmseL2AGED', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '678ca857-****-b1bf-d0a98c5ca84b', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-7pp2d1****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'mse-0c738****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"202\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"A73AC37C-C617-4E3A-8049-372CF49C****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteEngineNamespace', + ], + 'UpdateEngineNamespace' => [ + 'summary' => 'Updates a namespace for the Nacos engine.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17100', + 'abilityTreeNodes' => [ + 'FEATUREmseL2AGED', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'name', + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'public', + ], + ], + [ + 'name' => 'ServiceCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of active services.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the namespace. Valid values:'."\n" + ."\n" + .'* `0`: global configuration'."\n" + .'* `1`: default namespace'."\n" + .'* `2`: custom namespace'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NamespaceShowName' => [ + 'description' => 'The display name of the namespace.'."\n", + 'type' => 'string', + 'example' => 'mytestshowname', + ], + 'Quota' => [ + 'description' => 'The quota of configurations.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + 'NamespaceDesc' => [ + 'description' => 'The description of the namespace.'."\n", + 'type' => 'string', + 'example' => 'mytest', + ], + 'ConfigCount' => [ + 'description' => 'The quota value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<UpdateEngineNamespaceResponse>\\n<RequestId>4E9FDCFE-0738-493B-B801-82BDFBCB****</RequestId>\\n<Message>请求处理成功</Message>\\n<Data>\\n <Type>1</Type>\\n <Quota>1</Quota>\\n <ConfigCount>1</ConfigCount>\\n <NamespaceShowName>mytestshowname</NamespaceShowName>\\n <NamespaceDesc>mytest</NamespaceDesc>\\n <Namespace>public</Namespace>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</UpdateEngineNamespaceResponse>","errorExample":""}]', + 'title' => 'UpdateEngineNamespace', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetEngineNamepace' => [ + 'summary' => 'Queries the namespaces of a Nacos instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17029', + 'abilityTreeNodes' => [ + 'FEATUREmseL2AGED', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0e958d79-****-b282-b702d66362b5', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse.cn-hangzhou.aliyuncs.com', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-98s****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'Type' => [ + 'description' => 'The type of the namespace. Valid values:'."\n" + ."\n" + .'* 0: global configuration'."\n" + .'* 1: default namespace'."\n" + .'* 2: custom namespace'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Quota' => [ + 'description' => 'The quota of configurations.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FA8F966F-420C-52F5-B49E-6ED7CCE02697', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'ConfigCount' => [ + 'description' => 'The number of configurations.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'NamespaceShowName' => [ + 'description' => 'The display name of the namespace.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'NamespaceDesc' => [ + 'description' => 'The description of the namespace.'."\n", + 'type' => 'string', + 'example' => 'mytest', + ], + 'Namespace' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + ], + ], + ], + ], + '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 \\"HttpCode\\": \\"202\\",\\n \\"Type\\": \\"1\\",\\n \\"Quota\\": \\"200\\",\\n \\"RequestId\\": \\"FA8F966F-420C-52F5-B49E-6ED7CCE02697\\",\\n \\"Message\\": \\"success\\",\\n \\"ConfigCount\\": \\"1\\",\\n \\"NamespaceShowName\\": \\"public\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"NamespaceDesc\\": \\"mytest\\",\\n \\"Namespace\\": \\"public\\"\\n}","type":"json"}]', + 'title' => 'GetEngineNamepace', + ], + 'ListEngineNamespaces' => [ + 'summary' => 'Queries the namespaces of a Nacos instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '17066', + 'abilityTreeNodes' => [ + 'FEATUREmseL2AGED', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '062D13C5-DEA3-4921-8918-C49A0F1B****', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the namespace. Valid values:'."\n" + ."\n" + .'* `0`: global configuration'."\n" + .'* `1`: default namespace'."\n" + .'* `2`: custom namespace'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NamespaceShowName' => [ + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + 'Quota' => [ + 'description' => 'The quota.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'NamespaceDesc' => [ + 'description' => 'The description of the namespace.'."\n", + 'type' => 'string', + 'example' => 'mytest', + ], + 'ConfigCount' => [ + 'description' => 'The quota value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ServiceCount' => [ + 'description' => 'The number of active services.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'SourceType' => [ + 'description' => 'The source from which the namespace was created.'."\n", + 'type' => 'string', + 'example' => 'mse', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + 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' => '[{"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":"<ListEngineNamespacesResponse>\\n<HttpCode>202</HttpCode>\\n<TotalCount>7</TotalCount>\\n<PageSize>10</PageSize>\\n<Message>请求处理成功</Message>\\n<RequestId>062D13C5-DEA3-4921-8918-C49A0F1B****</RequestId>\\n<PageNumber>1</PageNumber>\\n<Data>\\n <Type>0</Type>\\n <Quota>200</Quota>\\n <ConfigCount>1</ConfigCount>\\n <NamespaceShowName>public</NamespaceShowName>\\n <ServiceCount>3</ServiceCount>\\n <NamespaceDesc>mytest</NamespaceDesc>\\n <Namespace>DEFAULT</Namespace>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</ListEngineNamespacesResponse>","errorExample":""}]', + 'title' => 'ListEngineNamespaces', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ImportZookeeperData' => [ + 'summary' => 'Initiates a task to import data from a destination URL to a Microservices Engine (MSE) ZooKeeper instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '146919', + 'abilityTreeNodes' => [ + 'FEATUREmseBQYNCQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-u0t2xzvxa06', + ], + ], + [ + 'name' => 'FileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the source data.'."\n" + ."\n" + .'> You must set this parameter to the URL that is generated by calling the GetZookeeperDataImportUrl operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxxxxxxxxx', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the file that you want to import.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'snapshot.5', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '202', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + '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 \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpCode\\": \\"202\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'ImportZookeeperData', + 'description' => '**Danger** This operation clears existing data. Exercise caution when you call this API operation.', + ], + 'GetZookeeperDataImportUrl' => [ + 'summary' => 'mse-200-105', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + 'wss', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '146920', + 'abilityTreeNodes' => [ + 'FEATUREmseBQYNCQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-zvp2xzzkk06', + ], + ], + [ + 'name' => 'ContentType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zip', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'RestResult'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<FileModel>', + 'description' => 'The ID of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'string', + 'example' => 'E4E2058F-C524-5C29-9BC7-5874EA8D7CE2', + ], + 'Success' => [ + 'description' => 'The status code. A value of 200 is returned if the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The request was successfully processed.'."\n", + 'type' => 'string', + 'example' => 'The dynamic part in the error message.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Data' => [ + 'description' => 'The URL that is used to upload the configuration file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => 'The maximum size of a file that can be uploaded each time. Unit: MB.'."\n", + 'type' => 'string', + 'example' => 'http://xxxxxxxxx', + ], + 'MaxSize' => [ + 'description' => 'code', + 'type' => 'string', + 'example' => '250000', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"E4E2058F-C524-5C29-9BC7-5874EA8D7CE2\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"You are not authorized to perform this operation.\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://xxxxxxxxx\\",\\n \\"MaxSize\\": \\"250000\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetZookeeperDataImportUrl', + ], + 'ExportZookeeperData' => [ + 'summary' => 'Initiates a task to export ZooKeeper data.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '161337', + 'abilityTreeNodes' => [ + 'FEATUREmseBQYNCQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-cn-78v1l83****', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the object that is exported. Valid values:'."\n" + ."\n" + .'* transactionLog: transaction logs'."\n" + .'* snapshot: snapshots'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'snapshot', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult<ExportTaskDO>', + 'description' => 'BaseResult'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25EA0A83-9007-4E87-808C-637BE1A****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + 'ExportType' => [ + 'description' => 'The type of the object that is exported. Valid values:'."\n" + ."\n" + .'* transactionLog: transaction logs'."\n" + .'* snapshot: snapshots'."\n", + 'type' => 'string', + 'example' => 'snapshot', + ], + 'ContentMap' => [ + 'description' => 'The content of a task.'."\n", + 'type' => 'object', + ], + 'Extend' => [ + 'description' => 'The extended information.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* CREATE: The object is being created.'."\n" + .'* RUNNING: The task is running.'."\n" + .'* FINISH: The task is completed.'."\n" + .'* FAILED: The task fails.'."\n" + .'* EXPIRE: The task has expired.'."\n", + 'type' => 'string', + 'example' => 'FINISH', + ], + 'KubeoneTaskIds' => [ + 'description' => 'The ID of the associated task at the underlying layer. This parameter is used only to troubleshoot failures.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Id' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631001140913', + ], + 'UpdateTime' => [ + 'description' => 'The last update time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1632979237663', + ], + ], + ], + ], + ], + ], + ], + '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 \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"RequestId\\": \\"25EA0A83-9007-4E87-808C-637BE1A****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ExportType\\": \\"snapshot\\",\\n \\"ContentMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Extend\\": \\"{}\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"KubeoneTaskIds\\": \\"10\\",\\n \\"Id\\": 1,\\n \\"CreateTime\\": 1631001140913,\\n \\"UpdateTime\\": 1632979237663\\n }\\n}","type":"json"}]', + 'title' => 'ExportZookeeperData', + 'description' => 'Only one task can run at a time.'."\n", + ], + 'ListExportZookeeperData' => [ + 'summary' => 'Lists historical data export tasks of a Microservices Engine (MSE) Zookeeper instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-7pp2d1****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '5', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult<List<ExportTaskDO>>', + 'description' => 'BaseResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8BD1E58D-0755-42AC-A599-E6B55112****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + 'ExportType' => [ + 'description' => 'The type of the object that is exported. Valid values:'."\n" + ."\n" + .'* transactionLog: transaction logs'."\n" + .'* snapshot: snapshots'."\n", + 'type' => 'string', + 'example' => 'snapshot', + ], + 'ContentMap' => [ + 'description' => 'The details of the task.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Extend' => [ + 'description' => 'The extension information that is in the JSON format. The extension information facilitates addition of parameters.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* CREATE: The task is being created.'."\n" + .'* RUNNING: The task is being executed.'."\n" + .'* FINISH: The task is completed.'."\n" + .'* FAILED: The task failed.'."\n" + .'* EXPIRE: The task has expired.'."\n", + 'type' => 'string', + 'example' => 'FINISH', + ], + 'KubeoneTaskIds' => [ + 'description' => 'The ID of the associated task at the underlying layer. This parameter is used only to troubleshoot failures.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Id' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreateTime' => [ + 'description' => 'The time when the task was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631001140913', + ], + 'UpdateTime' => [ + 'description' => 'The time when the task was updated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1632979237663', + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"RequestId\\": \\"8BD1E58D-0755-42AC-A599-E6B55112****\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ExportType\\": \\"snapshot\\",\\n \\"ContentMap\\": \\"{}\\",\\n \\"Extend\\": \\"{}\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"KubeoneTaskIds\\": \\"10\\",\\n \\"Id\\": 1,\\n \\"CreateTime\\": 1631001140913,\\n \\"UpdateTime\\": 1632979237663\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListExportZookeeperData', + ], + 'CreateZnode' => [ + 'summary' => 'Creates a znode.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '17007', + 'abilityTreeNodes' => [ + 'FEATUREmseINOH9I', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '/zookeeper', + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'data', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'Path' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'example' => '/', + ], + 'Dir' => [ + 'description' => 'Indicates whether the node information was returned. Valid values:'."\n" + ."\n" + .'* `true`: The node information was returned.'."\n" + .'* `false`: The node information failed to be returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Name' => [ + 'description' => 'The name of the node.'."\n", + 'type' => 'string', + 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ZooKeeper.IllegalRequest', + 'errorMessage' => 'ZooKeeper operation is illegal.', + ], + [ + 'errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', + 'errorMessage' => 'No permission to operate current Znode.', + ], + [ + 'errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', + 'errorMessage' => 'The current instance already has this Znode.', + ], + [ + 'errorCode' => 'ZooKeeper.IllegalRequest.NoNode', + 'errorMessage' => 'The current instance does not have this Znode.', + ], + [ + 'errorCode' => 'ZooKeeper.Timeout', + 'errorMessage' => 'ZooKeeper operation timeout.', + ], + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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' => '[{"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":"<CreateZnodeResponse>\\n<HttpCode>200</HttpCode>\\n<RequestId>DC34E4A3-5F1C-4E40-86EA-02EDF967****</RequestId>\\n<Message>请求处理成功</Message>\\n<Data>\\n <Path>/</Path>\\n <Data>cluster</Data>\\n <Dir>true</Dir>\\n <Name>mse-bc1a29b0-160230875****-reg-center-0-1</Name>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</CreateZnodeResponse>","errorExample":""}]', + 'title' => 'CreateZnode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteZnode' => [ + 'summary' => 'Deletes a ZooKeeper node.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17014', + 'abilityTreeNodes' => [ + 'FEATUREmseINOH9I', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/zookeeper', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'Path' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'example' => '/', + ], + 'Dir' => [ + 'description' => 'Indicates whether the node information was returned. Valid values:'."\n" + ."\n" + .'* `true`: The node information was returned.'."\n" + .'* `false`: The node information failed to be returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Name' => [ + 'description' => 'The name of the node.'."\n", + 'type' => 'string', + 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ZooKeeper.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', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpCode\\": \\"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":"<DeleteZnodeResponse>\\n<HttpCode>200</HttpCode>\\n<RequestId>DC34E4A3-5F1C-4E40-86EA-02EDF967****</RequestId>\\n<Message>请求处理成功</Message>\\n<Data>\\n <Path>/</Path>\\n <Data>cluster</Data>\\n <Dir>true</Dir>\\n <Name>mse-bc1a29b0-160230875****-reg-center-0-1</Name>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</DeleteZnodeResponse>","errorExample":""}]', + 'title' => 'DeleteZnode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateZnode' => [ + 'summary' => 'Updates the information about a ZooKeeper node.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '17105', + 'abilityTreeNodes' => [ + 'FEATUREmseINOH9I', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/zookeeper', + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'data', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + 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' => '[{"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":"<UpdateZnodeResponse>\\n<RequestId>316F5F64-F73D-42DC-8632-01E308B6****</RequestId>\\n<Message>请求处理成功</Message>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</UpdateZnodeResponse>","errorExample":""}]', + 'title' => 'UpdateZnode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListZnodeChildren' => [ + 'summary' => 'Queries the child nodes of a ZooKeeper node.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '17075', + 'abilityTreeNodes' => [ + 'FEATUREmseINOH9I', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/zookeeper', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'Path' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'example' => '/zookeeper', + ], + 'Dir' => [ + 'description' => 'Indicates whether the node information was returned. Valid values:'."\n" + ."\n" + .'* `true`: The node information was returned.'."\n" + .'* `false`: The node information failed to be returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Name' => [ + 'description' => 'The name of the node.'."\n", + 'type' => 'string', + 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ZooKeeper.IllegalRequest', + 'errorMessage' => 'ZooKeeper operation is illegal.', + ], + [ + 'errorCode' => 'ZooKeeper.IllegalRequest.NoAuth', + 'errorMessage' => 'No permission to operate current Znode.', + ], + [ + 'errorCode' => 'ZooKeeper.IllegalRequest.NodeExist', + 'errorMessage' => 'The current instance already has this Znode.', + ], + [ + 'errorCode' => 'ZooKeeper.IllegalRequest.NoNode', + 'errorMessage' => 'The current instance does not have this Znode.', + ], + [ + 'errorCode' => 'ZooKeeper.Timeout', + 'errorMessage' => 'ZooKeeper operation timeout.', + ], + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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' => '[{"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":"<ListZnodeChildrenResponse>\\n<Message>请求处理成功</Message>\\n<RequestId>BDB6CE0B-9CAF-41B5-9FEA-E08BE8E2****</RequestId>\\n<Data>\\n <Path>/zookeeper</Path>\\n <Data>cluster</Data>\\n <Dir>true</Dir>\\n <Name>mse-bc1a29b0-160230875****-reg-center-0-1</Name>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</ListZnodeChildrenResponse>","errorExample":""}]', + 'title' => 'ListZnodeChildren', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryZnodeDetail' => [ + 'summary' => 'Queries the information about a ZooKeeper node.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17085', + 'abilityTreeNodes' => [ + 'FEATUREmseINOH9I', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended request parameters in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mse-09k1q11****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/zookeeper', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-5bffa4e8630', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'Path' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'example' => '/zookeeper', + ], + 'Dir' => [ + 'description' => 'Indicates whether the node information was returned. Valid values:'."\n" + ."\n" + .'* `true`: The node information was returned.'."\n" + .'* `false`: The node information failed to be returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Name' => [ + 'description' => 'The name of the node.'."\n", + 'type' => 'string', + 'example' => 'zookeeper', + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"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":"<QueryZnodeDetailResponse>\\n<Message>请求处理成功</Message>\\n<RequestId>58E06A0A-BD2C-47A0-99C2-B100F353****</RequestId>\\n<Data>\\n <Path>/zookeeper</Path>\\n <Data>cluster</Data>\\n <Dir>true</Dir>\\n <Name>zookeeper</Name>\\n</Data>\\n<ErrorCode>mse-100-000</ErrorCode>\\n<Success>true</Success>\\n</QueryZnodeDetailResponse>","errorExample":""}]', + 'title' => 'QueryZnodeDetail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListZkTrack' => [ + 'summary' => 'Obtains the track data of a ZooKeeper instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150858', + 'abilityTreeNodes' => [ + 'FEATUREmseN84UZV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mse-cn-0ju2yq****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/path', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0x301fdfbdbf00***', + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1669618483', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1669619383', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable reverse ordering.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Traces' => [ + 'description' => 'The track data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogDate' => [ + 'description' => 'The logging time.'."\n", + 'type' => 'string', + 'example' => '2022-11-28 15:09:15,606', + ], + 'Timestamp' => [ + 'description' => 'The timestamp. It is not available.'."\n", + 'type' => 'string', + 'example' => '1669619383000', + ], + 'SessionId' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'example' => '0x301fdfbdbf00***', + ], + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/path', + ], + 'TraceType' => [ + 'title' => '轨迹类型：push、pull、notify', + 'description' => 'The type of the trajectory. Valid values:'."\n" + ."\n" + .'* Push'."\n" + .'* Pull'."\n" + .'* Notify'."\n", + 'type' => 'string', + 'example' => 'Push', + ], + 'OpType' => [ + 'title' => '操作类型'."\n" + .'对于Push'."\n" + .' ○ Create'."\n" + .' ○ Update'."\n" + .' ○ Delete'."\n" + .' ○ SetAcl'."\n" + .' ○ Multi'."\n" + .'对于Pull'."\n" + .' ○ GetData'."\n" + .' ○ GetChild'."\n" + .' ○ GetStat', + 'description' => 'The type of the operation. For trajectory of the Push type:'."\n" + ."\n" + .'* Create'."\n" + .'* Update'."\n" + .'* Delete'."\n" + .'* SetAcl'."\n" + .'* Multi'."\n" + ."\n" + .'For trajectory of the Pull type:'."\n" + ."\n" + .'* GetData'."\n" + .'* GetChild'."\n" + .'* GetStat'."\n", + 'type' => 'string', + 'example' => 'Create', + ], + 'EventType' => [ + 'title' => '事件类型'."\n" + .'对于notify：'."\n" + .' ○ NodeCreated'."\n" + .' ○ NodeDeleted'."\n" + .' ○ NodeDataChanged'."\n" + .' ○ NodeChildrenChanged', + 'description' => 'The type of the event. For trajectory of the Notify type:'."\n" + ."\n" + .'* NodeCreated'."\n" + .'* NodeDeleted'."\n" + .'* NodeDataChanged'."\n" + .'* NodeChildrenChanged'."\n", + 'type' => 'string', + 'example' => 'NodeCreated', + ], + 'DataType' => [ + 'title' => '数据类型：persist、ephemeral', + 'description' => 'The data type. Valid values:'."\n" + ."\n" + .'* persist'."\n" + .'* ephemeral'."\n", + 'type' => 'string', + 'example' => 'persist', + ], + 'Watch' => [ + 'title' => '监听', + 'description' => 'Indicates whether the monitoring feature is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Acl' => [ + 'description' => 'The access control list (ACL).'."\n", + 'type' => 'string', + 'example' => 'world:anyone:cdrwa', + ], + 'MultiSize' => [ + 'description' => 'The transaction size.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Result' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Ttl' => [ + 'description' => 'The time to live (TTL).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Finished' => [ + 'description' => 'Indicates whether the transaction ended.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****'."\n", + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'ok', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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 \\"HttpCode\\": \\"200\\",\\n \\"Traces\\": [\\n {\\n \\"LogDate\\": \\"2022-11-28 15:09:15,606\\",\\n \\"Timestamp\\": \\"1669619383000\\",\\n \\"SessionId\\": \\"0x301fdfbdbf00***\\",\\n \\"Path\\": \\"/path\\",\\n \\"TraceType\\": \\"Push\\",\\n \\"OpType\\": \\"Create\\",\\n \\"EventType\\": \\"NodeCreated\\",\\n \\"DataType\\": \\"persist\\",\\n \\"Watch\\": true,\\n \\"Acl\\": \\"world:anyone:cdrwa\\",\\n \\"MultiSize\\": 3,\\n \\"Result\\": \\"success\\",\\n \\"Ttl\\": 0,\\n \\"Finished\\": true\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\\\n\\",\\n \\"Message\\": \\"ok\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListZkTrack', + ], + 'ListSentinelBlockFallbackDefinitions' => [ + 'summary' => 'Obtains the custom behavior of traffic protection.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '163990', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClassificationSet', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '行为类型列表。', + 'description' => 'Behavior Classification Set.', + 'type' => 'array', + 'items' => [ + 'title' => '行为类型。', + 'description' => 'Behavior classification.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => 'web', + 'rpc', + ], + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => 'The name of the Microservices namespace.', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.', + 'type' => 'string', + 'required' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'title' => '状态码。', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应信息。', + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Data' => [ + 'title' => '行为信息。', + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '行为ID。', + 'description' => 'Behavior Id', + 'type' => 'string', + 'example' => '12', + ], + 'Namespace' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => 'The name of the Microservices namespace.', + 'type' => 'string', + 'example' => 'default', + ], + 'AppName' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Name' => [ + 'title' => '行为名称。', + 'description' => 'The name of the behavior.', + 'type' => 'string', + 'example' => 'defaultFallback', + ], + 'ResourceClassification' => [ + 'title' => '行为类型。', + 'description' => 'Behavior classification.', + 'type' => 'string', + 'example' => '1', + ], + 'FallbackBehavior' => [ + 'title' => '行为详情。', + 'description' => 'Behavior detail.', + 'type' => 'object', + 'example' => '{"webRespStatusCode":429,"webRespMessage":"test","webFallbackMode":0,"webRespContentType":0}', + ], + 'TargetMap' => [ + 'title' => '与该行为绑定的资源信息。', + 'description' => 'Resource information bound to the behavior.', + 'type' => 'object', + 'example' => '{"/params/{hot}":[1]}', + ], + ], + ], + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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 \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"12\\",\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Name\\": \\"defaultFallback\\",\\n \\"ResourceClassification\\": \\"1\\",\\n \\"FallbackBehavior\\": {\\n \\"webRespStatusCode\\": 429,\\n \\"webRespMessage\\": \\"test\\",\\n \\"webFallbackMode\\": 0,\\n \\"webRespContentType\\": 0\\n },\\n \\"TargetMap\\": {\\n \\"/params/{hot}\\": [\\n 1\\n ]\\n }\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListSentinelBlockFallbackDefinitions', + ], + 'BindSentinelBlockFallbackDefinition' => [ + 'summary' => 'Binds traffic protection behavior.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '164017', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => 'The microservice namespace.', + 'type' => 'string', + 'required' => true, + 'example' => 'prod', + ], + ], + [ + 'name' => 'FallbackId', + 'in' => 'query', + 'schema' => [ + 'title' => '行为ID。', + 'description' => 'Behavior ID. 0:the default behavior.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'title' => '目标规则类型。', + 'description' => 'Target rule type.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 1 => '', + '', + 4 => '', + 6 => '', + 11 => '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => 'Interface Name: The resource to which the rule applies. It must match the interface name in the console\'s interface details.', + 'type' => 'string', + 'required' => true, + 'example' => '/a', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '响应信息。', + 'description' => 'The response message.', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Data' => [ + 'title' => '返回详情。', + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => '状态码。', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'title' => '状态码。', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Data\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'BindSentinelBlockFallbackDefinition', + ], + 'ListIsolationRules' => [ + 'summary' => 'Queries isolation rules.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163572', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + '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' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => [ + 'title' => '查找包含接口关键字的防护规则。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'a', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'title' => '查找指定接口的防护规则。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '/a', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '起始页。默认值为1。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小。默认值为6。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '响应码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应信息。', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppName' => [ + 'title' => '应用名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => '', + 'type' => 'string', + 'example' => '/a', + ], + 'Threshold' => [ + 'title' => '隔离规则并发数阈值。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Enable' => [ + 'title' => '规则的启用状态。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AppId' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + 'RegionId' => [ + 'title' => '集群所在地域。', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FallbackObject' => [ + 'title' => '规则绑定的行为。', + 'description' => '', + 'type' => 'string', + 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"', + ], + 'LimitApp' => [ + 'type' => 'string', + ], + ], + ], + ], + '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', + ], + ], + 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 \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 3\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListIsolationRules', + ], + 'CreateIsolationRule' => [ + 'summary' => 'Creates an isolation rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '163570', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '隔离规则并发数阈值。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'docRequired' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'title' => '规则的启用状态。', + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/a', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所在地域。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'LimitApp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '响应信息。', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Code' => [ + 'title' => '响应码。', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '规则信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'Id' => [ + 'title' => '规则ID。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppName' => [ + 'title' => '应用名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => '', + 'type' => 'string', + 'example' => '/a', + ], + 'Threshold' => [ + 'title' => '隔离规则并发数阈值。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '3', + ], + 'Enable' => [ + 'title' => '规则的启用状态。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AppId' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'hpn9ac29kz@e31a4b871******', + ], + 'RegionId' => [ + 'title' => '集群所在地域。', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'LimitApp' => [ + 'type' => 'string', + ], + ], + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hpn9ac29kz@e31a4b871******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateIsolationRule', + ], + 'DeleteIsolationRules' => [ + 'summary' => 'Deletes isolation rules.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '163574', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '待删除的规则ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '规则ID。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '返回码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应信息。', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'title' => 'HTTP状态码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '完成删除的规则ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '规则ID。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + '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 \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteIsolationRules', + ], + 'UpdateIsolationRule' => [ + 'summary' => 'Updates an isolation rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '163571', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + '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' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'title' => '规则ID。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'title' => '隔离规则并发数阈值。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'docRequired' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'title' => '规则的启用状态。', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522******', + ], + ], + [ + 'name' => 'LimitApp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '响应信息。', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Code' => [ + 'title' => '响应码。', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '规则信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'Id' => [ + 'title' => '规则ID。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppName' => [ + 'title' => '应用名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => '', + 'type' => 'string', + 'example' => '/a', + ], + 'Threshold' => [ + 'title' => '隔离规则并发数阈值。', + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '3', + ], + 'Enable' => [ + 'title' => '规则的启用状态。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AppId' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + 'LimitApp' => [ + 'type' => 'string', + ], + ], + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Threshold\\": 3,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"LimitApp\\": \\"\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateIsolationRule', + ], + 'DeleteCircuitBreakerRules' => [ + 'summary' => 'Deletes circuit breaking rules.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '167824', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '待删除的规则ID列表。', + 'description' => 'The IDs of the rules that you want to delete.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '规则ID。', + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '完成删除的规则ID列表。', + 'description' => 'The IDs of the rules that were deleted.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '规则ID。', + 'description' => 'The ID of the rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"FAF577DD-8E8E-5BE6-80CC-380E19******\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteCircuitBreakerRules', + ], + 'DeleteFlowRules' => [ + 'summary' => 'Deletes throttling rules.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '159871', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '待删除的规则ID列表。', + 'description' => 'The IDs of the rules to be deleted.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '规则ID。', + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => true, + 'docRequired' => true, + 'example' => '[1,2]', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FAF577DD-8E8E-5BE6-80CC-380E19******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '完成删除的规则ID列表。', + 'description' => 'The IDs of the rules that were deleted.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '规则ID。', + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"FAF577DD-8E8E-5BE6-80CC-380E19******\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 1\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteFlowRules', + ], + 'UpdateFlowRule' => [ + 'summary' => 'Updates a throttling rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '159855', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '13', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The throttling threshold.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'ControlBehavior', + 'in' => 'query', + 'schema' => [ + 'description' => 'The throttling effect.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' fast failure'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 2'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' in queue'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + '', + 2 => '', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'MaxQueueingTimeMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period. Unit: milliseconds. This parameter is required when the value of ControlBehavior is set to 2.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522******', + ], + ], + [ + 'name' => 'LimitApp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Id' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'AppName' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'description' => 'The name of the API resource.'."\n", + 'type' => 'string', + 'example' => '/c', + ], + 'ControlBehavior' => [ + 'description' => 'The throttling effect.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' fast failure'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 2'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' in queue'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + 2 => '', + ], + 'example' => '0', + ], + 'MaxQueueingTimeMs' => [ + 'description' => 'The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Threshold' => [ + 'description' => 'The throttling threshold.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '5', + ], + 'Enable' => [ + 'description' => 'Indicates whether the rule was enabled.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'fasle' => '', + ], + 'example' => 'true', + ], + 'AppId' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => 'hpn9ac29kz@e31a4b871******', + ], + 'LimitApp' => [ + 'type' => 'string', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The request was successful.'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The request failed.'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 12,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/c\\",\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 5,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hpn9ac29kz@e31a4b871******\\",\\n \\"LimitApp\\": \\"Spring-cloud-a\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateFlowRule', + ], + 'ListFlowRules' => [ + 'summary' => 'Obtains a list of throttling rules.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '159811', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xx-demo', + ], + ], + [ + 'name' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword that is used for the search.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/a', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522******', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/a', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The request was successful.'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The request failed.'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'RuleId' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'AppName' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => 'finance', + ], + 'Resource' => [ + 'description' => 'The name of the interface resource.'."\n", + 'type' => 'string', + 'example' => '/a', + ], + 'ResourceType' => [ + 'description' => 'Interface resource type.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ControlBehavior' => [ + 'description' => 'The throttling effect.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' fast failure'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 2'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' in queue'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + 2 => '', + ], + 'example' => '0', + ], + 'MaxQueueingTimeMs' => [ + 'description' => 'The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Threshold' => [ + 'description' => 'The throttling threshold.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'Enable' => [ + 'description' => 'Indicates whether the throttling rule was enabled.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'AppId' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@5f1b08becb*****', + ], + 'RegionId' => [ + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FallbackObject' => [ + 'description' => 'The throttling behavior.'."\n", + 'type' => 'string', + 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"', + ], + 'MetricType' => [ + 'description' => 'The statistical dimension. The value 1 indicates that the number of accepted requests is used for statistics.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TrafficTags' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'object', + 'example' => '{\\"origin\\":\\"default\\"}', + ], + 'LimitApp' => [ + 'description' => 'Requests source application.', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalSize' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + ], + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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 \\"Code\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 2,\\n \\"AppName\\": \\"finance\\",\\n \\"Resource\\": \\"/a\\",\\n \\"ResourceType\\": 1,\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 10,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"MetricType\\": 1,\\n \\"TrafficTags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 11\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListFlowRules', + ], + 'CreateFlowRule' => [ + 'summary' => 'Creates a throttling rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '163217', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The throttling threshold.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the API resource.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/b', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ib09eblv6p@c3df23522******', + ], + ], + [ + 'name' => 'ControlBehavior', + 'in' => 'query', + 'schema' => [ + 'description' => 'The throttling effect.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0: fast failure'."\n" + .'* 2: in queue'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + '', + 2 => '', + ], + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'MaxQueueingTimeMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period. Unit: milliseconds. This value is required if the ControlBehavior parameter is set to 2.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enum' => [ + '0', + '1', + '2', + '4', + '3', + ], + ], + ], + [ + 'name' => 'LimitApp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'AppName' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'description' => 'The name of the API resource.'."\n", + 'type' => 'string', + 'example' => 'app', + ], + 'ControlBehavior' => [ + 'description' => 'The throttling effect.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' fast failure'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 2'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' in queue'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + 2 => '', + ], + 'example' => '0', + ], + 'MaxQueueingTimeMs' => [ + 'description' => 'The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Threshold' => [ + 'description' => 'The throttling threshold.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'Enable' => [ + 'description' => 'Indicates whether the rule is enabled.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'AppId' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@54e1f42f3******', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'LimitApp' => [ + 'type' => 'string', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 12,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"app\\",\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 500,\\n \\"Threshold\\": 200,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1po62@54e1f42f3******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LimitApp\\": \\"spring-cloud-a\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateFlowRule', + ], + 'CreateCircuitBreakerRule' => [ + 'summary' => 'Creates a circuit breaking rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '167810', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', + 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'docRequired' => true, + 'example' => '0.8', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'title' => '规则的启用状态。', + 'description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => 'The name of the interface to which the rule applies. The interface name must be the same as the name on the interface details page in the console.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/a', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群所在地域。', + 'description' => 'The region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Strategy', + 'in' => 'query', + 'schema' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => 'The threshold type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' slow call proportion'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' abnormal proportion'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'RetryTimeoutMs', + 'in' => 'query', + 'schema' => [ + 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', + 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period. The value must be an integral multiple of 1,000. Default value: 10000. This value indicates 10 seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => [ + 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', + 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes. The default value is 20000. This value indicates 20 seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20000', + ], + ], + [ + 'name' => 'MaxAllowedRtMs', + 'in' => 'query', + 'schema' => [ + 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', + 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => [ + 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', + 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'HalfOpenBaseAmountPerStep', + 'in' => 'query', + 'schema' => [ + 'title' => '熔断恢复每步最小通过数目，默认值为1。', + 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'HalfOpenRecoveryStepNum', + 'in' => 'query', + 'schema' => [ + 'title' => '熔断恢复阶段数，默认值为1。', + 'description' => 'The number of circuit breaking recovery steps. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0: custom interface'."\n" + .'* 1: web'."\n" + .'* 2: RPC'."\n" + .'* 3: route'."\n" + .'* 4: SQL'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '', + 'WEB', + 'RPC', + 'ROUTE', + 'SQL', + ], + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '4', + '3', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '响应信息。', + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Code' => [ + 'title' => '响应码。', + 'description' => 'The response code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '规则信息。', + 'description' => 'The details of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'title' => '应用所属的微服务命空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Id' => [ + 'title' => '规则ID。', + 'description' => 'The ID of the rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppName' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => 'The name of the interface to which the rule is applicable. The interface name must be the same as the name on the interface details page in the console.'."\n", + 'type' => 'string', + 'example' => '/a', + ], + 'StatIntervalMs' => [ + 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', + 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + 'Threshold' => [ + 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', + 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'Enable' => [ + 'title' => '规则的启用状态。', + 'description' => 'Indicates whether the rule is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Strategy' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => 'The threshold type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' Slow call ratio'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' Abnormal proportion'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '0', + ], + 'RetryTimeoutMs' => [ + 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', + 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'AppId' => [ + 'title' => '应用ID。', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + 'RegionId' => [ + 'title' => '集群所在地域。', + 'description' => 'The region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MaxAllowedRtMs' => [ + 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', + 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'MinRequestAmount' => [ + 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', + 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HalfOpenBaseAmountPerStep' => [ + 'title' => '熔断恢复每步最小通过数目。', + 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'HalfOpenRecoveryStepNum' => [ + 'title' => '熔断恢复阶段数。', + 'description' => 'The number of circuit breaking recovery steps.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"StatIntervalMs\\": 20000,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"Strategy\\": 0,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateCircuitBreakerRule', + ], + 'ListCircuitBreakerRules' => [ + 'summary' => 'Queries a list of circuit breaking rules.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '167823', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => [ + 'title' => '查找包含接口关键字的防护规则。', + 'description' => 'This parameter is used for fuzzy match of circuit breaking rules.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'title' => '查找指定接口的防护规则。', + 'description' => 'This parameter is used for exact match of circuit breaking rules.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/a', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '起始页。', + 'description' => 'The start page of the returned pages. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小。', + 'description' => 'The number of entries per page. Default value: 6.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese, and the value en-US indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '响应码。', + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应信息。', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4E9FDCFE-0738-493B-B801-82BDFBCB****', + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'title' => '规则信息。', + 'description' => 'The details of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '返回结果。', + 'description' => 'The returned result.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'title' => '应用所属的微服务命空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'RuleId' => [ + 'title' => '规则ID。', + 'description' => 'The ID of the rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppName' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => 'The name of the interface to which the rule is applicable. The interface name must be the same as the name on the interface details page in the console.'."\n", + 'type' => 'string', + 'example' => '/a', + ], + 'ResourceType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Strategy' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => 'The threshold type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' slow call proportion'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' abnormal proportion'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '0', + ], + 'Threshold' => [ + 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', + 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'Enable' => [ + 'title' => '规则的启用状态。', + 'description' => 'Indicates whether the rule was enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RetryTimeoutMs' => [ + 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', + 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'StatIntervalMs' => [ + 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', + 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + 'AppId' => [ + 'title' => '应用ID。', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + 'RegionId' => [ + 'title' => '集群所在地域。', + 'description' => 'The region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FallbackObject' => [ + 'title' => '规则绑定的行为。', + 'description' => 'The behavior that was bound to the rule.'."\n", + 'type' => 'string', + 'example' => '"{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}"', + ], + 'MaxAllowedRtMs' => [ + 'title' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', + 'description' => 'The maximum RT. Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'MinRequestAmount' => [ + 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', + 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HalfOpenBaseAmountPerStep' => [ + 'title' => '熔断恢复每步最小通过数目。', + 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'HalfOpenRecoveryStepNum' => [ + 'title' => '熔断恢复阶段数。', + 'description' => 'The number of circuit breaking recovery steps.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '起始页。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页大小。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalSize' => [ + 'title' => '总页数。', + 'description' => 'The total number of pages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'HttpStatusCode' => [ + 'title' => '状态码。', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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 \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4E9FDCFE-0738-493B-B801-82BDFBCB****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"RuleId\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"ResourceType\\": 1,\\n \\"Strategy\\": 0,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"StatIntervalMs\\": 20000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\\\\\"\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 3\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListCircuitBreakerRules', + ], + 'UpdateCircuitBreakerRule' => [ + 'summary' => 'Updates a circuit breaking rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '167822', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的微服务命空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', + 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => '0.8', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'title' => '规则的启用状态。', + 'description' => 'Specifies whether to enable the rule.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + ], + [ + 'name' => 'Strategy', + 'in' => 'query', + 'schema' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => 'The threshold type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' slow call proportion'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' abnormal proportion'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'RetryTimeoutMs', + 'in' => 'query', + 'schema' => [ + 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为1000的整数倍，默认值为10000，即10秒。', + 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period. The value must be an integral multiple of 1,000. Default value: 10000. This value indicates 10 seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => [ + 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。默认值为20000，即20秒。', + 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes. The default value is 20000. This value indicates 20 seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20000', + ], + ], + [ + 'name' => 'MaxAllowedRtMs', + 'in' => 'query', + 'schema' => [ + 'title' => '慢调用RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。', + 'description' => 'The maximum response time (RT). Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => [ + 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为10。', + 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'HalfOpenBaseAmountPerStep', + 'in' => 'query', + 'schema' => [ + 'title' => '熔断恢复每步最小通过数目，默认值为1。', + 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'HalfOpenRecoveryStepNum', + 'in' => 'query', + 'schema' => [ + 'title' => '熔断恢复阶段数，默认值为1。', + 'description' => 'The number of circuit breaking recovery steps. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'title' => '规则ID。', + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese, and the value en-US indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'The details of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'title' => '应用所属的微服务命名空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Id' => [ + 'title' => '规则ID。', + 'description' => 'The ID of the rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppName' => [ + 'title' => '应用名称。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'title' => '接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。', + 'description' => 'The name of the interface to which the rule is applicable. The interface name must be the same as the name on the interface details page in the console.'."\n", + 'type' => 'string', + 'example' => '/a', + ], + 'Strategy' => [ + 'title' => '阈值类型：选择以慢调用比例或异常比例作为阈值。', + 'description' => 'The threshold type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' slow call proportion'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' abnormal proportion'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '0', + ], + 'Threshold' => [ + 'title' => '熔断比例阈值：触发熔断的比例阈值，取值范围为0 - 1，代表0% - 100%。', + 'description' => 'A percentage threshold for triggering circuit breaking. Valid values: 0-1. These values represent 0% to 100%.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'Enable' => [ + 'title' => '规则的启用状态。', + 'description' => 'Indicates whether the rule is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RetryTimeoutMs' => [ + 'title' => '熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。', + 'description' => 'The period in which circuit breaking is implemented. Unit: milliseconds. If circuit breaking is implemented on the requests for the route, the calls to all the requests for the route fail in the configured circuit breaking period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'StatIntervalMs' => [ + 'title' => '统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为1秒~120分钟。', + 'description' => 'The length of the time window. Unit: milliseconds. The valid range is from 1 second to 120 minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + 'AppId' => [ + 'title' => '应用ID。', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@c3df23522bXXXXX', + ], + 'MaxAllowedRtMs' => [ + 'title' => '慢调用RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。', + 'description' => 'The maximum RT. Unit: milliseconds. If the RT of a request is greater than the value of this parameter, a slow call is counted. If you set Strategy to 0, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'MinRequestAmount' => [ + 'title' => '触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。', + 'description' => 'The minimum number of requests to trigger circuit breaking. If the number of requests in the current time window is less than the value of this parameter, circuit breaking is not triggered even if the circuit breaking rule is met.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HalfOpenBaseAmountPerStep' => [ + 'title' => '熔断恢复每步最小通过数目。', + 'description' => 'The minimum number of requests that can be passed in each step after circuit breaking recovers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'HalfOpenRecoveryStepNum' => [ + 'title' => '熔断恢复阶段数。', + 'description' => 'The number of circuit breaking recovery steps.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'title' => '请求结果。', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The request was successful.'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The request failed.'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/a\\",\\n \\"Strategy\\": 0,\\n \\"Threshold\\": 0.8,\\n \\"Enable\\": true,\\n \\"RetryTimeoutMs\\": 10000,\\n \\"StatIntervalMs\\": 20000,\\n \\"AppId\\": \\"hkhon1po62@c3df23522bXXXXX\\",\\n \\"MaxAllowedRtMs\\": 200,\\n \\"MinRequestAmount\\": 10,\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"HalfOpenRecoveryStepNum\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateCircuitBreakerRule', + ], + 'ListWebFlowRules' => [ + 'summary' => 'Queries hot parameter protection rules for HTTP requests.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '164286', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'ResourceSearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'flow', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'b22qb1****@2f0586be4b1****', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '/flow', + ], + ], + [ + 'name' => 'PageIndex', + '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' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4AE73569-304C-5AA9-AE11-C1D99C7D1689', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'StatIntervalMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'AppName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/flow', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ControlBehavior' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Burst' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxQueueingTimeMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ResourceMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Threshold' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParamItem' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', + ], + 'AppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hkhon1XXXX@c3df23522bXXXXX', + ], + 'MetricType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FallbackObject' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{\\"appName\\":\\"spring-cloud-a\\",\\"fallbackBehavior\\":{\\"webFallbackMode\\":0,\\"webRespContentType\\":0,\\"webRespMessage\\":\\"Blocked\\",\\"webRespStatusCode\\":429},\\"id\\":977,\\"name\\":\\"Fallback\\",\\"namespace\\":\\"default\\",\\"resourceClassification\\":1}', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + ], + ], + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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 \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"4AE73569-304C-5AA9-AE11-C1D99C7D1689\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"RuleId\\": \\"1\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ResourceType\\": 1,\\n \\"ControlBehavior\\": 0,\\n \\"Burst\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"ResourceMode\\": 0,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\",\\n \\"AppId\\": \\"hkhon1XXXX@c3df23522bXXXXX\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FallbackObject\\": \\"{\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"spring-cloud-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fallbackBehavior\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"webFallbackMode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespContentType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"webRespMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Blocked\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"webRespStatusCode\\\\\\\\\\\\\\":429},\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":977,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Fallback\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceClassification\\\\\\\\\\\\\\":1}\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 36\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListWebFlowRules', + ], + 'CreateWebFlowRule' => [ + 'summary' => 'Creates a hot parameter protection rule for HTTP requests.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '164156', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + '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' => [ + 'title' => '规则状态', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'title' => '资源名（接口名）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/flow', + ], + ], + [ + 'name' => 'Burst', + 'in' => 'query', + 'schema' => [ + 'title' => '针对突发请求额外允许的请求数目', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1****@c3df23522******', + ], + ], + [ + 'name' => 'ControlBehavior', + 'in' => 'query', + 'schema' => [ + 'title' => '流控方式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + '', + 2 => '', + ], + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '2', + ], + ], + ], + [ + 'name' => 'MaxQueueingTimeMs', + 'in' => 'query', + 'schema' => [ + 'title' => '超时时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'ResourceMode', + 'in' => 'query', + 'schema' => [ + 'title' => '资源模式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [ + '', + ], + 'example' => '0', + 'enum' => [ + '0', + ], + ], + ], + [ + 'name' => 'ParamItem', + 'in' => 'query', + 'schema' => [ + 'title' => '参数描述项', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'title' => '指标类型', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + ], + 'example' => '1', + 'enum' => [ + '1', + ], + ], + ], + [ + 'name' => 'StatIntervalMs', + 'in' => 'query', + 'schema' => [ + 'title' => '统计间隔', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '', + 'WEB', + 'RPC', + ], + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + '4', + '3', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'StatIntervalMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/flow', + ], + 'ControlBehavior' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ReourceMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxQueueingTimeMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Threshold' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hkhon1****@c3df23522******', + ], + 'MetricType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Burst' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParamItem' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A73AC37C-C617-4E3A-8049-372CF49C****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ControlBehavior\\": 0,\\n \\"ReourceMode\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1****@c3df23522******\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Burst\\": 0,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateWebFlowRule', + ], + 'DeleteWebFlowRules' => [ + 'summary' => 'Deletes a hot parameter protection rule for HTTP requests.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '164288', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '[1, 2, 3]', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '354FF159-E9FB-5FBA-BDD5-E99EE440A88D', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[1, 2, 3]', + ], + ], + ], + ], + ], + ], + '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 \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"354FF159-E9FB-5FBA-BDD5-E99EE440A88D\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n 0\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteWebFlowRules', + ], + 'UpdateWebFlowRule' => [ + 'summary' => 'Updates a hot parameter protection rule for HTTP requests.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '164287', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + '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', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Burst', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1****@c3df23522******', + ], + ], + [ + 'name' => 'ControlBehavior', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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', + ], + ], + [ + 'name' => 'ResourceMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ParamItem', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"fieldName":"key","matchStrategy":2,"parseStrategy":2,"pattern":"value"}', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StatIntervalMs', + 'in' => 'query', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '54973C90-F379-4372-9AA5-053A3F7****', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'StatIntervalMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Resource' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/flow', + ], + 'ControlBehavior' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ReourceMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxQueueingTimeMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Threshold' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hkhon1XXXX@54e1f42f37cXXXX', + ], + 'MetricType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Burst' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParamItem' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}', + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Namespace\\": \\"default\\",\\n \\"StatIntervalMs\\": 1000,\\n \\"Id\\": 1,\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Resource\\": \\"/flow\\",\\n \\"ControlBehavior\\": 0,\\n \\"ReourceMode\\": 0,\\n \\"MaxQueueingTimeMs\\": 200,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true,\\n \\"AppId\\": \\"hkhon1XXXX@54e1f42f37cXXXX\\",\\n \\"MetricType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Burst\\": 0,\\n \\"ParamItem\\": \\"{\\\\\\"fieldName\\\\\\":\\\\\\"testKey\\\\\\",\\\\\\"matchStrategy\\\\\\":2,\\\\\\"parseStrategy\\\\\\":2,\\\\\\"pattern\\\\\\":\\\\\\"testValue\\\\\\"}\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateWebFlowRule', + ], + 'ListAuthPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17061', + 'abilityTreeNodes' => [ + 'FEATUREmseDB5C9P', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service source.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* **SPRING_CLOUD**'."\n" + .'* **DUBBO**'."\n" + .'* **istio**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SPRING_CLOUD', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the authentication rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'auto-rule-**', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'jgy4cadmqo@***', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese and the value en-US indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05A5A150-4A5F-5A8C-97D6-710776CC8408', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AuthRule' => [ + 'description' => 'The content of the service authentication rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Black' => [ + 'description' => 'Indicates whether the rule is a blacklist rule.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Path' => [ + 'description' => 'The service path.'."\n", + 'type' => 'string', + 'example' => '/a', + ], + 'Method' => [ + 'description' => 'The request method.'."\n", + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'The method version.'."\n", + 'type' => 'string', + 'example' => '0.0.1', + ], + 'ParameterTypes' => [ + 'description' => 'The types of request parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the request parameter.'."\n", + 'type' => 'string', + 'example' => '[\\"java.lang.String\\",\\"java.lang.Object\\",\\"java.lang.String\\"]', + ], + ], + 'ServiceName' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Name' => [ + 'description' => 'The method name.'."\n", + 'type' => 'string', + 'example' => 'hello', + ], + 'Group' => [ + 'description' => 'The group.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'ReturnType' => [ + 'description' => 'The type of the return value.'."\n", + 'type' => 'string', + 'example' => 'Boolean', + ], + ], + ], + 'AppIds' => [ + 'description' => 'The IDs of applications.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => '["dez4qt7weh@***"]', + ], + ], + 'AuthType' => [ + 'description' => 'The rule type. Valid values:'."\n" + ."\n" + .'* 0: by application'."\n" + .'* 1: by namespace'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'K8sNamespaces' => [ + 'description' => 'The queried namespaces.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'acced****', + ], + ], + ], + ], + ], + 'NamespaceId' => [ + 'description' => 'The namespace ID.'."\n", + 'type' => 'string', + 'example' => 'ced54a95-4e33-4bda-be7e-37e95868***', + ], + 'Protocol' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* **SPRING_CLOUD**'."\n" + .'* **DUBBO**'."\n" + .'* **istio**'."\n", + 'type' => 'string', + 'example' => 'SPRING_CLOUD', + ], + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the resource belongs.'."\n", + 'type' => 'string', + 'example' => '19039813784***', + ], + 'Source' => [ + 'description' => 'The source of the application.'."\n", + 'type' => 'string', + 'example' => 'edasmsc', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AppName' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'AppId' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@5f1b08becb*****', + ], + 'Name' => [ + 'description' => 'The name of the authentication rule.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Id' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '204', + ], + 'Enable' => [ + 'description' => 'Indicates whether the rule was enabled or disabled. Valid values:'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'AuthType' => [ + 'description' => 'The rule type. Valid values:'."\n" + ."\n" + .'* 0: by application'."\n" + .'* 1: by namespace'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'K8sNamespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***', + ], + ], + ], + ], + 'TotalSize' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"05A5A150-4A5F-5A8C-97D6-710776CC8408\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Status\\": 1,\\n \\"AuthRule\\": [\\n {\\n \\"Black\\": false,\\n \\"Path\\": \\"/a\\",\\n \\"Method\\": {\\n \\"Version\\": \\"0.0.1\\",\\n \\"ParameterTypes\\": [\\n \\"[\\\\\\\\\\\\\\"java.lang.String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"java.lang.Object\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"java.lang.String\\\\\\\\\\\\\\"]\\"\\n ],\\n \\"ServiceName\\": \\"spring-cloud-a\\",\\n \\"Name\\": \\"hello\\",\\n \\"Group\\": \\"default\\",\\n \\"ReturnType\\": \\"Boolean\\"\\n },\\n \\"AppIds\\": [\\n \\"[\\\\\\"dez4qt7weh@***\\\\\\"]\\"\\n ],\\n \\"AuthType\\": 0,\\n \\"K8sNamespaces\\": [\\n \\"acced****\\"\\n ]\\n }\\n ],\\n \\"NamespaceId\\": \\"ced54a95-4e33-4bda-be7e-37e95868***\\",\\n \\"Protocol\\": \\"SPRING_CLOUD\\",\\n \\"AccountId\\": \\"19039813784***\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"Name\\": \\"test\\",\\n \\"Id\\": 204,\\n \\"Enable\\": false,\\n \\"AuthType\\": 0,\\n \\"K8sNamespace\\": \\"c19c6c500e1ff4d7abc7bed9b8236***\\"\\n }\\n ],\\n \\"TotalSize\\": 11,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ListAuthPolicy', + 'summary' => 'Queries a list of service authentication rules.', + ], + 'UpdateAuthPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17097', + 'abilityTreeNodes' => [ + 'FEATUREmseDB5C9P', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demo-test', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source for application access.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '432', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcde@12345', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* **SPRING_CLOUD**'."\n" + .'* **DUBBO**'."\n" + .'* **istio**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SPRING_CLOUD', + ], + ], + [ + 'name' => 'AuthRule', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the service authentication rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"all\\":true,\\"appIds\\":[\\"f6xqzbao96@4adfaf3c92c947a\\"],\\"black\\":false}]', + ], + ], + [ + 'name' => 'K8sNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ACK cluster namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c19c6c500e1ff4d7abc7bed9b8236***', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese, and the value en-US indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '83E3909D-D26F-5D97-B73B-407A26***', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"83E3909D-D26F-5D97-B73B-407A26***\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": \\"{}\\",\\n \\"Code\\": 500,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateAuthPolicy', + 'summary' => 'Updates a service authentication rule.', + ], + 'AddAuthPolicy' => [ + 'summary' => 'Creates a service authentication rule.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '16988', + 'abilityTreeNodes' => [ + 'FEATUREmseDB5C9P', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'e9clba2xlc@***', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'K8sNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'c19c6c500e1ff4d7abc7***', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dc63-465d-8ef5-20dc18af****', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"dc63-465d-8ef5-20dc18af****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"请求处理成功。\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AddAuthPolicy', + ], + 'RemoveAuthPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17087', + 'abilityTreeNodes' => [ + 'FEATUREmseDB5C9P', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '259', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9515ACA4-E94D-440D-989E-C379FCED****', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9515ACA4-E94D-440D-989E-C379FCED****\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": 500,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'RemoveAuthPolicy', + 'summary' => 'Deletes a service authentication rule.', + ], + 'GetServiceMethodPage' => [ + 'summary' => 'Queries a list of service interfaces.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + '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' => '应用所属的MSE命名空间。', + 'type' => 'string', + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用id。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hkhonxxxxx@f3f75ed8ffxxxxx', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => '服务名。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'sc-A', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '服务版本。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'ServiceGroup', + 'in' => 'query', + 'schema' => [ + 'title' => '服务分组。', + 'description' => '', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'title' => '服务提供者ip。', + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'title' => '请求信息。', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求id。', + 'description' => '', + 'type' => 'string', + 'example' => '2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1', + ], + 'Data' => [ + 'title' => '请求响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '方法描述列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '每个方法描述。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NameDetail' => [ + 'title' => '接口描述信息。', + 'description' => '', + 'type' => 'string', + 'example' => '示例接口描述信息。', + ], + 'ParameterDetails' => [ + 'title' => '接口参数类型。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '每个参数的类型。', + 'description' => '', + 'type' => 'string', + 'example' => 'java.lang.String', + ], + ], + 'ParameterDefinitions' => [ + 'title' => '参数的详细定义。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '参数的详细定义。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '参数类型。', + 'description' => '', + 'type' => 'string', + 'example' => 'java.lang.String', + ], + 'Description' => [ + 'title' => '参数描述。', + 'description' => '', + 'type' => 'string', + 'example' => '参数描述示例', + ], + 'Name' => [ + 'title' => '参数名字。', + 'description' => '', + 'type' => 'string', + 'example' => 'aParam', + ], + ], + ], + ], + 'Paths' => [ + 'title' => '接口对应的请求路径列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '接口对应的请求路径。', + 'description' => '', + 'type' => 'string', + 'example' => '/a', + ], + ], + 'ParameterTypes' => [ + 'title' => '参数类型。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '参数类型。', + 'description' => '', + 'type' => 'string', + 'example' => 'java.lang.String', + ], + ], + 'RequestMethods' => [ + 'title' => 'HTTP请求方法。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => 'HTTP请求参数。', + 'description' => '', + 'type' => 'string', + 'example' => 'GET', + ], + ], + 'ReturnDetails' => [ + 'title' => '返回值类型。', + 'description' => '', + 'type' => 'string', + 'example' => 'java.lang.String', + ], + 'Name' => [ + 'title' => '方法名。', + 'description' => '', + 'type' => 'string', + 'example' => 'aMethod', + ], + 'MethodController' => [ + 'title' => '接口所在的Controller类全称。', + 'description' => '', + 'type' => 'string', + 'example' => 'com.alibabacloud.mse.demo.a.AController', + ], + 'ReturnType' => [ + 'title' => '返回值类型。', + 'description' => '', + 'type' => 'string', + 'example' => 'java.lang.String', + ], + ], + ], + ], + 'TotalSize' => [ + 'title' => '方法总数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'title' => '第几页。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + '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 \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"NameDetail\\": \\"示例接口描述信息。\\",\\n \\"ParameterDetails\\": [\\n \\"java.lang.String\\"\\n ],\\n \\"ParameterDefinitions\\": [\\n {\\n \\"Type\\": \\"java.lang.String\\",\\n \\"Description\\": \\"参数描述示例\\",\\n \\"Name\\": \\"aParam\\"\\n }\\n ],\\n \\"Paths\\": [\\n \\"/a\\"\\n ],\\n \\"ParameterTypes\\": [\\n \\"java.lang.String\\"\\n ],\\n \\"RequestMethods\\": [\\n \\"GET\\"\\n ],\\n \\"ReturnDetails\\": \\"java.lang.String\\",\\n \\"Name\\": \\"aMethod\\",\\n \\"MethodController\\": \\"com.alibabacloud.mse.demo.a.AController\\",\\n \\"ReturnType\\": \\"java.lang.String\\"\\n }\\n ],\\n \\"TotalSize\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'GetServiceMethodPage', + ], + 'GetServiceListPage' => [ + 'summary' => 'Queries the version of a microservices application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17044', + 'abilityTreeNodes' => [ + 'FEATUREmseXPQ6HT', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '地域。', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => 'The name of the MSE namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名字。', + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + 'maxLength' => 100, + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => [ + 'title' => '服务类型。', + 'description' => 'The service type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'springCloud', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用id。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => '服务名字。', + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sc-A', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页数。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'title' => '要查询的ip地址。', + 'description' => 'The IP address from which the query is initiated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '223.5.5.5', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'title' => '请求信息。', + 'description' => 'The request information.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求id。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx', + ], + 'Data' => [ + 'title' => '请求响应数据。', + 'description' => 'The response to the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '当前页面数据。', + 'description' => 'The data on the current page.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '每个服务的信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'title' => '应用名。', + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => 'example-app', + ], + 'Version' => [ + 'title' => '服务版本。', + 'description' => 'The service version.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'InstanceNum' => [ + 'title' => '服务对应的节点数。', + 'description' => 'The number of service nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtModifyTime' => [ + 'title' => '服务最后的更新时间。', + 'description' => 'The time when the service was last updated.'."\n", + 'type' => 'string', + 'example' => '123456', + ], + 'AppId' => [ + 'title' => '应用id。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => 'dez4xxxxx@f3f75ed8ffxxxxx', + ], + 'ServiceName' => [ + 'title' => '服务名。', + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'example' => 'sc-A', + ], + 'Group' => [ + 'title' => '服务分组。', + 'description' => 'The group to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_GROUP', + ], + 'ServiceType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TotalSize' => [ + 'title' => '数据总数。', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'PageNumber' => [ + 'title' => '当前页码。', + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"AppName\\": \\"example-app\\",\\n \\"Version\\": \\"1\\",\\n \\"InstanceNum\\": 1,\\n \\"GmtModifyTime\\": \\"123456\\",\\n \\"AppId\\": \\"dez4xxxxx@f3f75ed8ffxxxxx\\",\\n \\"ServiceName\\": \\"sc-A\\",\\n \\"Group\\": \\"DEFAULT_GROUP\\",\\n \\"ServiceType\\": \\"\\"\\n }\\n ],\\n \\"TotalSize\\": \\"100\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetServiceListPage', + ], + 'GetServiceList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17043', + 'abilityTreeNodes' => [ + 'FEATUREmseW9QIF2', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjiakou', + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the framework.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dubbo', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xxx@xxx', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'com.alibaba.xxx', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'EdasAppName' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DubboApplicationName' => [ + 'description' => 'The name of the Dubbo application.'."\n", + 'type' => 'string', + 'example' => 'dubbo-application', + ], + 'Version' => [ + 'description' => 'The version information.'."\n", + 'type' => 'string', + 'example' => '1.0.0', + ], + 'SpringApplicationName' => [ + 'description' => 'The name of the Spring application.'."\n", + 'type' => 'string', + 'example' => 'spring-application', + ], + 'RegistryType' => [ + 'description' => 'The type of the service registry.'."\n", + 'type' => 'string', + 'example' => 'nacos', + ], + 'ServiceType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'dubbo', + ], + 'ServiceName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'com.alibaba.xxx', + ], + 'Methods' => [ + 'description' => 'The methods.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The methods.'."\n", + 'type' => 'object', + 'properties' => [ + 'Paths' => [ + 'description' => 'The paths.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The path of the service.'."\n", + 'type' => 'string', + 'example' => '/path', + ], + ], + 'ParameterTypes' => [ + 'description' => 'The data types of the parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data type of the parameter.'."\n", + 'type' => 'string', + 'example' => 'int', + ], + ], + 'RequestMethods' => [ + 'description' => 'The methods.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method.'."\n", + 'type' => 'string', + 'example' => 'sayHello', + ], + ], + 'Name' => [ + 'description' => 'The name of the method.'."\n", + 'type' => 'string', + 'example' => 'sayHello', + ], + 'MethodController' => [ + 'description' => 'The controller of the method.'."\n", + 'type' => 'string', + 'example' => 'com.alibaba.SayHelloController', + ], + 'ReturnType' => [ + 'description' => 'The type of the return value.'."\n", + 'type' => 'string', + 'example' => 'int', + ], + ], + ], + ], + 'Metadata' => [ + 'description' => 'The metadata.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'Group' => [ + 'description' => 'The group.'."\n", + 'type' => 'string', + 'example' => 'dubbo', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + '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 \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": [\\n {\\n \\"EdasAppName\\": \\"test\\",\\n \\"DubboApplicationName\\": \\"dubbo-application\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"SpringApplicationName\\": \\"spring-application\\",\\n \\"RegistryType\\": \\"nacos\\",\\n \\"ServiceType\\": \\"dubbo\\",\\n \\"ServiceName\\": \\"com.alibaba.xxx\\",\\n \\"Methods\\": [\\n {\\n \\"Paths\\": [\\n \\"/path\\"\\n ],\\n \\"ParameterTypes\\": [\\n \\"int\\"\\n ],\\n \\"RequestMethods\\": [\\n \\"sayHello\\"\\n ],\\n \\"Name\\": \\"sayHello\\",\\n \\"MethodController\\": \\"com.alibaba.SayHelloController\\",\\n \\"ReturnType\\": \\"int\\"\\n }\\n ],\\n \\"Metadata\\": {},\\n \\"Group\\": \\"dubbo\\"\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetServiceList', + 'summary' => 'Queries the services of an application.', + ], + 'CreateOrUpdateSwimmingLaneGroup' => [ + 'summary' => 'Creates or updates a lane group for end-to-end canary release.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '116107', + 'abilityTreeNodes' => [ + 'FEATUREmseCR8P7I', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => 'region', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '泳道组ID。-1时为创建泳道组，大于0时为修改指定泳道组。', + 'description' => 'The ID of the lane group. A value of -1 is used to create a lane group. A value greater than 0 is used to modify the specified lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '120', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '名称', + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'group1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '0 未生效', + 'description' => 'The status of the lane group. The value 0 specifies that the lane group is disabled. The value 1 specifies that the lane group is enabled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'EntryApp', + 'in' => 'query', + 'schema' => [ + 'title' => '入口应用。格式 "来源系统:id"。比如：'."\n" + .'- mse:${mse应用id}'."\n" + .'- mse-gw:${mse云原生网关id}', + 'description' => 'The ingress application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Ingress', + ], + ], + [ + 'name' => 'AppIds', + 'in' => 'query', + 'schema' => [ + 'title' => '应用集合。以 "," 分割应用 id', + 'description' => 'The IDs of applications. Separate application IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522baa898,hkhon1po62@66e5235415730a5,hkhon1po62@958bba95910341f', + ], + ], + [ + 'name' => 'MessageQueueGrayEnable', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启消息灰度', + 'description' => 'Specifies whether to enable canary release for messaging.'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'MessageQueueFilterSide', + 'in' => 'query', + 'schema' => [ + 'title' => '消息灰度过滤侧', + 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Server', + 'default' => 'Server', + 'enum' => [ + 'Server', + 'Client', + ], + ], + ], + [ + 'name' => 'DbGrayEnable', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启数据库灰度', + 'description' => 'Specifies whether to enable database canary release.'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'RecordCanaryDetail', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启记录请求详情', + 'description' => 'Specifies whether to record request details.'."\n", + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Paths', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + [ + 'name' => 'RouteIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '路由ID列表（以云原生网关为入口时，在创建泳道组的泳道前，需调用本接口传入选择的云原生网关路由ID列表）', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + [ + 'name' => 'CanaryModel', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'SwimVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true: The request was successful. false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码。', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000'."\n", + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'example' => 'example-app', + ], + 'DbGrayEnable' => [ + 'title' => '是否开启数据库灰度', + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'UserId' => [ + 'title' => '应用所属的用户id。', + 'description' => 'The ID of the user to which the application belongs.'."\n", + 'type' => 'string', + 'example' => '12345', + ], + 'MessageQueueFilterSide' => [ + 'title' => '消息灰度过滤侧', + 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", + 'type' => 'string', + 'example' => 'Client', + ], + 'AppIds' => [ + 'title' => '应用id列表，逗号分隔。', + 'description' => 'The list of application IDs that are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => 'abcd1@abcde123,abcd1@abcde124', + ], + 'Namespace' => [ + 'title' => 'MSE命名空间名字', + 'description' => 'The name of the MSE namespace.'."\n", + 'type' => 'string', + 'example' => 'prod', + ], + 'RecordCanaryDetail' => [ + 'title' => '是否开启记录请求详情。', + 'description' => 'Specifies whether to record request details.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'title' => '泳道组id。', + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2047', + 'default' => '123', + ], + 'EntryApp' => [ + 'title' => '入口应用。格式 "来源系统:id"。比如：'."\n" + .'mse:${mse应用id}'."\n" + .'mse-gw:${mse云原生网关id}', + 'description' => 'The ingress application.'."\n", + 'type' => 'string', + 'example' => 'mse:abcd1@a2345', + ], + 'Region' => [ + 'title' => '应用所属地域。', + 'description' => 'The region where the application resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MessageQueueGrayEnable' => [ + 'title' => '是否开启消息灰度。', + 'description' => 'Specifies whether to enable canary release for messaging.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'paths' => [ + 'type' => 'string', + ], + 'Paths' => [ + 'type' => 'string', + ], + 'canaryModel' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CanaryModel' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"请求处理成功\\\\n\\",\\n \\"Data\\": {\\n \\"Name\\": \\"example-app\\",\\n \\"DbGrayEnable\\": \\"true\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"AppIds\\": \\"abcd1@abcde123,abcd1@abcde124\\",\\n \\"Namespace\\": \\"prod\\",\\n \\"RecordCanaryDetail\\": true,\\n \\"Id\\": 2047,\\n \\"EntryApp\\": \\"mse:abcd1@a2345\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": true,\\n \\"paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"Paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"canaryModel\\": 0,\\n \\"CanaryModel\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'CreateOrUpdateSwimmingLaneGroup', + ], + 'DeleteSwimmingLaneGroup' => [ + 'summary' => 'Deletes a lane group.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '145', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'any', + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": \\"{}\\"\\n}","type":"json"}]', + 'title' => 'DeleteSwimmingLaneGroup', + ], + 'CreateOrUpdateSwimmingLane' => [ + 'summary' => 'Creates or updates a lane for end-to-end canary release.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '116127', + 'abilityTreeNodes' => [ + 'FEATUREmseCR8P7I', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'region', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '泳道ID。-1时为创建泳道，大于0时为修改指定泳道。', + 'description' => 'The ID of the primary key. The value -1 indicates a request that is used to create a lane. A value greater than 0 indicates a request that is used to modify a lane.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '名称', + 'description' => 'The name of the lane.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Test lane'."\n", + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'title' => '匹配到后的目标机器标签', + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gray', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启。', + 'description' => 'Specifies whether to enable the lane.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '所属泳道组', + 'description' => 'The language of the response. Valid values:****'."\n" + ."\n" + .'* **zh-CN**: Chinese'."\n" + .'* **en-US**: English'."\n" + ."\n" + .'> Default value: **zh-CN**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '115', + ], + ], + [ + 'name' => 'EnableRules', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启规则', + 'description' => 'Specifies whether to configure a routing rule for the lane. If an Ingress gateway is used, this parameter is not required.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'true', + ], + ], + [ + 'name' => 'PathIndependentPercentageEnable', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'EntryRules', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => 'SwimmingLane', + 'description' => 'The lane.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Paths' => [ + 'title' => '路径列表', + 'description' => 'The paths.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + 'required' => false, + 'maxItems' => 50, + ], + 'Condition' => [ + 'title' => '指示RestItems如何组合成最终的条件', + 'description' => 'Specifies how RESTful items are combined into the final condition.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '""', + 'default' => 'AND', + 'enum' => [ + 'AND', + 'OR', + ], + ], + 'RestItems' => [ + 'title' => '匹配列表', + 'description' => 'The matching list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The object of the rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '匹配类型', + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'header', + ], + 'Name' => [ + 'title' => '名称', + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + 'Operator' => [ + 'title' => '操作符', + 'description' => 'The operator.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mod', + ], + 'NameList' => [ + 'title' => '匹配列表', + 'description' => 'The matching list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'A081', + ], + 'required' => false, + 'maxItems' => 10, + ], + 'Datum' => [ + 'title' => '数值', + 'description' => 'The value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '.params[0]', + ], + 'Cond' => [ + 'title' => '匹配符', + 'description' => 'The matching character.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '=', + ], + 'Divisor' => [ + 'title' => '除数', + 'description' => 'The divisor.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Remainder' => [ + 'title' => '余数', + 'description' => 'The remainder.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Rate' => [ + 'title' => '百分比', + 'description' => 'The percentage.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Value' => [ + 'title' => '值', + 'description' => 'The value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + 'Priority' => [ + 'title' => '优先级', + 'description' => 'The priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + 'required' => false, + 'description' => 'The information about the routing rule for the ingress application.'."\n", + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'EntryRule', + 'in' => 'query', + 'schema' => [ + 'title' => 'json string', + 'description' => 'The JSON string.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'GatewaySwimmingLaneRouteJson', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '网关路由信息（使用云原生网关为入口时使用）', + 'description' => 'The information about the routing rule for the gateway. This parameter is required when a cloud-native gateway is used as the ingress.'."\n", + 'type' => 'object', + 'properties' => [ + 'GatewayId' => [ + 'title' => '网关ID', + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'GatewayUniqueId' => [ + 'title' => '网关唯一ID', + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gw-84efde2ee1464260bdb17a5b****', + ], + 'RouteIdList' => [ + 'title' => '路由ID列表', + 'description' => 'The route IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The route ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + 'CanaryModel' => [ + 'title' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Conditions' => [ + 'title' => '匹配条件列表（按内容路由使用）', + 'description' => 'The matching conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '参数名称', + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'Value' => [ + 'title' => '参数值', + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xiaoming', + ], + 'Type' => [ + 'title' => '参数类型：'."\n" + .'- header：Header'."\n" + .'- param：Parameter', + 'description' => 'The type of the parameter. Valid values:'."\n" + ."\n" + .'* header'."\n" + .'* param'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'header', + ], + 'Cond' => [ + 'title' => '条件：'."\n" + .'- PRE：前缀匹配'."\n" + .'- EQUAL：精确匹配'."\n" + .'- ERGULAR：正则匹配', + 'description' => 'The matching condition. Valid values:'."\n" + ."\n" + .'* PRE: prefix matching'."\n" + .'* EQUAL: exact matching'."\n" + .'* ERGULAR: regular expression matching'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRE', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Percentage' => [ + 'title' => '流量比例（按比例路由使用，取值0-100）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RouteIndependentPercentageEnable' => [ + 'type' => 'boolean', + ], + 'RouteIndependentPercentageList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Percentage' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'Condition' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. The value 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => 'The name of the lane.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'id' => [ + 'description' => 'The ID of the lane.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '94765', + ], + 'tag' => [ + 'description' => 'The tag of the lane.'."\n", + 'type' => 'string', + 'example' => 'release', + ], + 'status' => [ + 'description' => 'The status of the lane.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'enable' => [ + 'description' => 'Indicates whether the lane was enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'regionId' => [ + 'description' => 'The ID of the region where the application is deployed.'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'groupId' => [ + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72586', + ], + 'entryRule' => [ + 'description' => 'The rule for the ingress application.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'entryRules' => [ + 'description' => 'The name.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'paths' => [ + 'description' => 'The paths.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The paths.'."\n", + 'type' => 'string', + 'example' => '/', + ], + ], + 'path' => [ + 'title' => '', + 'description' => 'The path of the code group.'."\n", + 'type' => 'string', + 'example' => '/adump/wxb/prod', + ], + 'condition' => [ + 'description' => 'The condition.'."\n", + 'type' => 'string', + 'example' => 'AND', + ], + 'restItems' => [ + 'description' => 'The conditions to be met.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '匹配类型', + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'cookie', + ], + 'name' => [ + 'title' => '名称', + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'operator' => [ + 'title' => '操作符', + 'description' => 'The operator.'."\n", + 'type' => 'string', + 'example' => 'rawvalue', + ], + 'nameList' => [ + 'title' => '匹配列表', + 'description' => 'The names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'maxItems' => 10, + ], + 'datum' => [ + 'title' => '数值', + 'description' => 'The value.'."\n", + 'type' => 'string', + 'example' => 'x', + ], + 'cond' => [ + 'title' => '匹配符', + 'description' => 'The matching character.'."\n", + 'type' => 'string', + 'example' => '==', + ], + 'divisor' => [ + 'title' => '除数', + 'description' => 'The divisor.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'remainder' => [ + 'title' => '余数', + 'description' => 'The remainder.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'rate' => [ + 'title' => '百分比', + 'description' => 'The percentage.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'value' => [ + 'title' => '值', + 'description' => 'The value.'."\n", + 'type' => 'string', + 'example' => '9', + ], + ], + ], + ], + ], + ], + ], + 'enableRules' => [ + 'description' => 'Indicates whether the rule is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'gmtCreate' => [ + 'description' => 'The time when the lane was created.'."\n", + 'type' => 'string', + 'example' => '1545726028000', + ], + 'gmtModified' => [ + 'description' => 'The time when the lane was updated.'."\n", + 'type' => 'string', + 'example' => '1565701886000', + ], + 'gatewaySwimmingLaneRouteJson' => [ + 'description' => 'The routing rule for the MSE gateway.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'pathIndependentPercentageEnable' => [ + 'type' => 'boolean', + ], + ], + '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', + ], + ], + ], + '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 \\"Data\\": {\\n \\"name\\": \\"test\\",\\n \\"id\\": 94765,\\n \\"tag\\": \\"release\\",\\n \\"status\\": 0,\\n \\"enable\\": true,\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"groupId\\": 72586,\\n \\"entryRule\\": \\"{}\\",\\n \\"entryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/adump/wxb/prod\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"test\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"9\\"\\n }\\n ]\\n }\\n ],\\n \\"enableRules\\": true,\\n \\"gmtCreate\\": \\"1545726028000\\",\\n \\"gmtModified\\": \\"1565701886000\\",\\n \\"gatewaySwimmingLaneRouteJson\\": \\"{}\\",\\n \\"pathIndependentPercentageEnable\\": false\\n }\\n}","type":"json"}]', + 'title' => 'CreateOrUpdateSwimmingLane', + ], + 'DeleteSwimmingLane' => [ + 'summary' => 'Deletes a lane.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'LaneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the lane.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '229', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + ], + ], + ], + ], + '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 \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"请求处理成功\\"\\n}","type":"json"}]', + 'title' => 'DeleteSwimmingLane', + ], + 'QueryAllSwimmingLaneGroup' => [ + 'summary' => 'Queries all lane groups.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '116120', + 'abilityTreeNodes' => [ + 'FEATUREmseCR8P7I', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '需要查询的MSE命名空间名字', + 'description' => 'The name of the Microservices Engine (MSE) namespace that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '54973C90-F379-4372-9AA5-053A3F7****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'DynamicMessage' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '泳道组名称', + 'description' => 'The name of the lane group.'."\n", + 'type' => 'string', + 'example' => 'swimmingGroup', + ], + 'UserId' => [ + 'title' => '泳道所属的用户id', + 'description' => 'The ID of the user to which the lane belongs.'."\n", + 'type' => 'string', + 'example' => '12345', + ], + 'MessageQueueFilterSide' => [ + 'title' => '在哪一侧实现消息灰度', + 'description' => 'The side at which canary release for messaging was enabled.'."\n", + 'type' => 'string', + 'example' => 'Client', + ], + 'AppIds' => [ + 'title' => '应用Id列表', + 'description' => 'The application IDs.'."\n", + 'type' => 'string', + 'example' => 'abcde@abcde,abcde@abcde', + ], + 'Namespace' => [ + 'title' => '泳道所属的MSE命名空间', + 'description' => 'The MSE namespace to which the lane belongs.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'RecordCanaryDetail' => [ + 'title' => '是否记录请求详情（全链路灰度可观测）', + 'description' => 'Indicates whether the request details (metrics of end-to-end canary release) were recorded.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Id' => [ + 'title' => '泳道组Id', + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'EntryApp' => [ + 'title' => '入口应用类型+入口应用Id', + 'description' => 'The type and ID of the ingress application.'."\n", + 'type' => 'string', + 'example' => 'mse:abcde@abcde', + ], + 'Region' => [ + 'title' => '所属地域', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MessageQueueGrayEnable' => [ + 'title' => '是否开启消息灰度', + 'description' => 'Indicates whether canary release for messaging is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Paths' => [ + 'type' => 'string', + ], + 'paths' => [ + 'type' => 'string', + ], + 'CanaryModel' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'canaryModel' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SwimVersion' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'swimVersion' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'example' => '[{id:100,name:"test"}]'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + '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 \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"swimmingGroup\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"AppIds\\": \\"abcde@abcde,abcde@abcde\\",\\n \\"Namespace\\": \\"default\\",\\n \\"RecordCanaryDetail\\": false,\\n \\"Id\\": 123,\\n \\"EntryApp\\": \\"mse:abcde@abcde\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": true,\\n \\"Paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"paths\\": \\"[\\\\\\"/a\\\\\\"]\\",\\n \\"CanaryModel\\": 0,\\n \\"canaryModel\\": 0,\\n \\"SwimVersion\\": 2,\\n \\"swimVersion\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryAllSwimmingLaneGroup', + ], + 'QueryAllSwimmingLane' => [ + 'summary' => 'Queries all the lanes in a lane group.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '116125', + 'abilityTreeNodes' => [ + 'FEATUREmseCR8P7I', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => 'The name of the MSE namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '泳道组id。', + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '186', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码。', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Message' => [ + 'title' => '请求信息。', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '泳道组名称。', + 'description' => 'The name of the lane group.'."\n", + 'type' => 'string', + 'example' => 'swimmingGroup', + ], + 'UserId' => [ + 'title' => '泳道所属的用户id。', + 'description' => 'The user ID of the lane group.'."\n", + 'type' => 'string', + 'example' => '12345', + ], + 'MessageQueueFilterSide' => [ + 'title' => '在哪一侧实现消息灰度。', + 'description' => 'The side on which canary release for messaging is implemented.'."\n", + 'type' => 'string', + 'example' => 'Client', + ], + 'Enable' => [ + 'title' => '是否开启。', + 'description' => '是否开启。', + 'type' => 'string', + 'example' => 'true', + ], + 'Namespace' => [ + 'title' => '泳道所属的MSE命名空间。', + 'description' => 'The Microservices Engine (MSE) namespace to which the lane belongs.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'RecordCanaryDetail' => [ + 'title' => '是否记录请求详情（全链路灰度可观测）。', + 'description' => 'Indicates whether request details were recorded (metrics of end-to-end canary release).'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Id' => [ + 'title' => '泳道组Id。', + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RegionId' => [ + 'title' => '所属地域。', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MessageQueueGrayEnable' => [ + 'title' => '是否开启消息灰度。', + 'description' => 'Indicates whether canary release for messaging is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'enableRules' => [ + 'title' => '是否开启规则。', + 'description' => 'Indicates whether the rule is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EntryRules' => [ + 'description' => 'The ingress application rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'paths' => [ + 'description' => 'The paths.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/', + ], + ], + 'path' => [ + 'title' => '', + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/adump/wxb/prod', + ], + 'condition' => [ + 'description' => 'The condition.'."\n", + 'type' => 'string', + 'example' => 'AND', + ], + 'restItems' => [ + 'description' => 'The RESTful matching rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '匹配类型', + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'cookie', + ], + 'name' => [ + 'title' => '名称', + 'description' => 'The name of the matching rule.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'operator' => [ + 'title' => '操作符', + 'description' => 'The operator.'."\n", + 'type' => 'string', + 'example' => 'rawvalue', + ], + 'nameList' => [ + 'title' => '匹配列表', + 'description' => 'The matching list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the matching rule.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'maxItems' => 10, + ], + 'datum' => [ + 'title' => '数值', + 'description' => 'The value.'."\n", + 'type' => 'string', + 'example' => 'x', + ], + 'cond' => [ + 'title' => '匹配符', + 'description' => 'The matching character.'."\n", + 'type' => 'string', + 'example' => '==', + ], + 'divisor' => [ + 'title' => '除数', + 'description' => 'The divisor.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'remainder' => [ + 'title' => '余数', + 'description' => 'The remainder.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'rate' => [ + 'title' => '百分比', + 'description' => 'The percentage.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'value' => [ + 'title' => '值', + 'description' => 'The value.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'gmtCreate' => [ + 'title' => '泳道创建时间。', + 'description' => 'The time when the lane was created.'."\n", + 'type' => 'string', + 'example' => '1683598484000', + ], + 'gmtModified' => [ + 'title' => '泳道更新时间。', + 'description' => 'The time when the lane was updated.'."\n", + 'type' => 'string', + 'example' => '1683598484000', + ], + 'groupId' => [ + 'title' => '泳道组Id。', + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'string', + 'example' => '72709', + ], + 'GroupId' => [ + 'title' => '泳道组Id。', + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'string', + 'example' => '6859', + ], + 'tag' => [ + 'title' => '泳道对应的标签。', + 'description' => 'The tag of the lane.'."\n", + 'type' => 'string', + 'example' => 'gray', + ], + 'Tag' => [ + 'title' => '泳道对应的标签。', + 'description' => 'The tag of the lane.'."\n", + 'type' => 'string', + 'example' => 'gray', + ], + 'GatewaySwimmingLaneRoute' => [ + 'title' => '网关路由信息（使用云原生网关为入口时使用）', + 'description' => '网关路由信息（使用云原生网关为入口时使用）', + 'type' => 'object', + 'properties' => [ + 'GatewayId' => [ + 'title' => '网关ID', + 'description' => '网关ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GatewayUniqueId' => [ + 'title' => '网关唯一ID', + 'description' => '网关唯一ID', + 'type' => 'string', + 'example' => 'gw-84efde2ee1464260bdb17a5b****', + ], + 'RouteIdList' => [ + 'title' => '路由ID列表', + 'description' => '路由ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'CanaryModel' => [ + 'title' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', + 'description' => '全链路灰度模式：'."\n" + ."\n" + .'- 0: 按请求内容路由'."\n" + ."\n" + .'- 1: 按比例路由', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Conditions' => [ + 'title' => '匹配条件列表（按内容路由使用）', + 'description' => '匹配条件列表（按内容路由使用）', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '参数名称', + 'description' => '参数名称', + 'type' => 'string', + 'example' => 'name', + ], + 'Value' => [ + 'title' => '参数值', + 'description' => '参数值', + 'type' => 'string', + 'example' => 'xiaoming', + ], + 'Type' => [ + 'title' => '参数类型：'."\n" + .'- header：Header'."\n" + .'- param：Parameter', + 'description' => '参数类型：'."\n" + .'- header：Header'."\n" + .'- param：Parameter', + 'type' => 'string', + 'example' => 'header', + ], + 'Cond' => [ + 'title' => '条件：'."\n" + .'- PRE：前缀匹配'."\n" + .'- EQUAL：精确匹配'."\n" + .'- ERGULAR：正则匹配', + 'description' => '条件：'."\n" + .'- PRE：前缀匹配'."\n" + .'- EQUAL：精确匹配'."\n" + .'- ERGULAR：正则匹配', + 'type' => 'string', + 'example' => 'PRE', + ], + 'NameList' => [ + 'description' => 'NameList', + 'type' => 'array', + 'items' => [ + 'description' => 'Name', + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + ], + 'Percentage' => [ + 'title' => '流量比例（按比例路由使用，取值0-100）', + 'description' => '流量比例（按比例路由使用，取值0-100）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RouteIndependentPercentageEnable' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'RouteIndependentPercentageList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12345', + ], + 'Percentage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + 'Condition' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AND、OR', + ], + ], + ], + 'PathIndependentPercentageEnable' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'GatewaySwimmingLaneRouteJson' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{\\"GatewayUniqueId\\":\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\",\\"Percentage\\":0,\\"RouteIdList\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\"CanaryModel\\":1,\\"Conditions\\":[]}', + ], + ], + ], + 'example' => '[{id:100,name:"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\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"swimmingGroup\\",\\n \\"UserId\\": \\"12345\\",\\n \\"MessageQueueFilterSide\\": \\"Client\\",\\n \\"Enable\\": \\"true\\",\\n \\"Namespace\\": \\"default\\",\\n \\"RecordCanaryDetail\\": false,\\n \\"Id\\": 123,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MessageQueueGrayEnable\\": false,\\n \\"enableRules\\": true,\\n \\"EntryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/adump/wxb/prod\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"test\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"test\\"\\n }\\n ]\\n }\\n ],\\n \\"gmtCreate\\": \\"1683598484000\\",\\n \\"gmtModified\\": \\"1683598484000\\",\\n \\"groupId\\": \\"72709\\",\\n \\"GroupId\\": \\"6859\\",\\n \\"tag\\": \\"gray\\",\\n \\"Tag\\": \\"gray\\",\\n \\"GatewaySwimmingLaneRoute\\": {\\n \\"GatewayId\\": 1,\\n \\"GatewayUniqueId\\": \\"gw-84efde2ee1464260bdb17a5b****\\",\\n \\"RouteIdList\\": [\\n 1\\n ],\\n \\"CanaryModel\\": 0,\\n \\"Conditions\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Value\\": \\"xiaoming\\",\\n \\"Type\\": \\"header\\",\\n \\"Cond\\": \\"PRE\\",\\n \\"NameList\\": [\\n \\"name\\"\\n ]\\n }\\n ],\\n \\"Percentage\\": 20,\\n \\"RouteIndependentPercentageEnable\\": \\"true\\",\\n \\"RouteIndependentPercentageList\\": [\\n {\\n \\"RouteId\\": \\"12345\\",\\n \\"Percentage\\": \\"60\\"\\n }\\n ],\\n \\"Condition\\": \\"AND、OR\\"\\n },\\n \\"PathIndependentPercentageEnable\\": true,\\n \\"GatewaySwimmingLaneRouteJson\\": \\"{\\\\\\\\\\\\\\"GatewayUniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"RouteIdList\\\\\\\\\\\\\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\\\\\\\\\\\\\"CanaryModel\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"Conditions\\\\\\\\\\\\\\":[]}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryAllSwimmingLane', + ], + 'GetTagsBySwimmingLaneGroupId' => [ + 'summary' => 'Obtains all tags in the current lane group.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '154', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '需要查询的MSE命名空间名字', + 'description' => 'The name of the Microservices Engine (MSE) namespace that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'Data' => [ + 'description' => 'The data of the tag.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data of the tag.'."\n", + 'type' => 'string', + 'example' => '[{"desc":"k8s-pod-label","priority":100,"tag":"gray","type":"tag"}]', + ], + 'example' => '["gray"]', + ], + ], + ], + ], + ], + '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 \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": [\\n \\"[{\\\\\\"desc\\\\\\":\\\\\\"k8s-pod-label\\\\\\",\\\\\\"priority\\\\\\":100,\\\\\\"tag\\\\\\":\\\\\\"gray\\\\\\",\\\\\\"type\\\\\\":\\\\\\"tag\\\\\\"}]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'GetTagsBySwimmingLaneGroupId', + ], + 'QuerySwimmingLaneById' => [ + 'summary' => 'Queries the information about a lane based on the lane ID.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '116123', + 'abilityTreeNodes' => [ + 'FEATUREmseCR8P7I', + ], + ], + 'parameters' => [ + [ + 'name' => 'LaneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the lane.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '250', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => 'The name of the Microservices Engine (MSE) namespace.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码。', + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Message' => [ + 'title' => '请求信息。', + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '泳道名称', + 'type' => 'string', + 'example' => 'test', + ], + 'id' => [ + 'description' => '泳道ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'tag' => [ + 'description' => '泳道对应的标签。', + 'type' => 'string', + 'example' => 'gray', + ], + 'status' => [ + 'description' => '泳道状态', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'enable' => [ + 'description' => '泳道开关', + 'type' => 'boolean', + 'example' => 'true', + ], + 'regionId' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'groupId' => [ + 'description' => '泳道组Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'entryRule' => [ + 'description' => '入口应用规则', + 'type' => 'string', + 'example' => '{}', + ], + 'entryRules' => [ + 'description' => '入口应用规则详情', + 'type' => 'array', + 'items' => [ + 'description' => '入口应用规则', + 'type' => 'object', + 'properties' => [ + 'paths' => [ + 'description' => '路径列表', + 'type' => 'array', + 'items' => [ + 'description' => '路径', + 'type' => 'string', + 'example' => '/', + ], + ], + 'path' => [ + 'title' => '', + 'description' => '路径', + 'type' => 'string', + 'example' => '/', + ], + 'condition' => [ + 'description' => '条件', + 'type' => 'string', + 'example' => 'AND', + ], + 'restItems' => [ + 'description' => 'Rest匹配规则列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Rest匹配规则', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '匹配类型', + 'description' => '匹配类型', + 'type' => 'string', + 'example' => 'cookie', + ], + 'name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => '11111', + ], + 'operator' => [ + 'title' => '操作符', + 'description' => '操作符', + 'type' => 'string', + 'example' => 'rawvalue', + ], + 'nameList' => [ + 'title' => '匹配列表', + 'description' => '名称列表', + 'type' => 'array', + 'items' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => 'test', + ], + 'maxItems' => 10, + ], + 'datum' => [ + 'title' => '数值', + 'description' => '数值', + 'type' => 'string', + 'example' => 'x', + ], + 'cond' => [ + 'title' => '匹配符', + 'description' => '匹配符', + 'type' => 'string', + 'example' => '==', + ], + 'divisor' => [ + 'title' => '除数', + 'description' => '除数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'remainder' => [ + 'title' => '余数', + 'description' => '余数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'rate' => [ + 'title' => '百分比', + 'description' => '百分比', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'value' => [ + 'title' => '值', + 'description' => '值', + 'type' => 'string', + 'example' => 'hello', + ], + ], + ], + ], + ], + ], + ], + 'enableRules' => [ + 'description' => '是否开启规则。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'gmtCreate' => [ + 'description' => '规则创建时间', + 'type' => 'string', + 'example' => '1683598484000', + ], + 'gmtModified' => [ + 'description' => '规则修改时间', + 'type' => 'string', + 'example' => '1683598484000', + ], + 'gatewaySwimmingLaneRouteJson' => [ + 'description' => 'MSE网关路由规则', + 'type' => 'string', + 'example' => '{}', + ], + 'PathIndependentPercentageEnable' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'example' => '{id:102,name:"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\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Data\\": {\\n \\"name\\": \\"test\\",\\n \\"id\\": 1,\\n \\"tag\\": \\"gray\\",\\n \\"status\\": 1,\\n \\"enable\\": true,\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"groupId\\": 8,\\n \\"entryRule\\": \\"{}\\",\\n \\"entryRules\\": [\\n {\\n \\"paths\\": [\\n \\"/\\"\\n ],\\n \\"path\\": \\"/\\",\\n \\"condition\\": \\"AND\\",\\n \\"restItems\\": [\\n {\\n \\"type\\": \\"cookie\\",\\n \\"name\\": \\"11111\\",\\n \\"operator\\": \\"rawvalue\\",\\n \\"nameList\\": [\\n \\"test\\"\\n ],\\n \\"datum\\": \\"x\\",\\n \\"cond\\": \\"==\\",\\n \\"divisor\\": 10,\\n \\"remainder\\": 10,\\n \\"rate\\": 30,\\n \\"value\\": \\"hello\\"\\n }\\n ]\\n }\\n ],\\n \\"enableRules\\": true,\\n \\"gmtCreate\\": \\"1683598484000\\",\\n \\"gmtModified\\": \\"1683598484000\\",\\n \\"gatewaySwimmingLaneRouteJson\\": \\"{}\\",\\n \\"PathIndependentPercentageEnable\\": false\\n }\\n}","type":"json"}]', + 'title' => 'QuerySwimmingLaneById', + ], + 'ListAppBySwimmingLaneGroupTags' => [ + 'summary' => 'Lists applications by tag in a specified lane group.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '要查询的标签。', + 'description' => 'The tag based on which you want to list applications.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '要查询的标签。', + 'description' => 'The tag based on which you want to list applications.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gray', + ], + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '泳道组id。', + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '需要查询的MSE命名空间名字。', + 'description' => 'The name of the MSE namespace that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6832e76b-bb5f-4dea-****-************', + ], + 'Success' => [ + 'title' => '请求是否成功。', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrorCode' => [ + 'title' => '请求错误码。', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'title' => '请求附加信息。', + 'description' => 'The additional request information.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '请求返回数据。', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '每个tag对应的应用信息列表。', + 'description' => 'The returned information.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '应用列表。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '应用所属的用户id。', + 'type' => 'string', + 'example' => '12345', + 'description' => 'The ID of the user to which the application belongs.'."\n", + ], + 'RegionId' => [ + 'title' => '应用所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'description' => 'The region where the application resides.'."\n", + ], + 'Namespace' => [ + 'title' => '应用所在的微服务命名空间。', + 'type' => 'string', + 'example' => 'default', + 'description' => 'The microservice namespace where the application resides.'."\n", + ], + 'AppName' => [ + 'title' => '应用名字。', + 'type' => 'string', + 'example' => 'example-app-name', + 'description' => 'The application name.'."\n", + ], + 'AppId' => [ + 'title' => '应用id。', + 'type' => 'string', + 'example' => '123456abcde@12345abcde', + 'description' => 'The application ID.'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"6832e76b-bb5f-4dea-****-************\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"key\\": [\\n {\\n \\"UserId\\": \\"12345\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"example-app-name\\",\\n \\"AppId\\": \\"123456abcde@12345abcde\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListAppBySwimmingLaneGroupTags', + ], + 'ListAppBySwimmingLaneGroupTag' => [ + 'summary' => 'Queries the applications in a lane group by tag.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'title' => '标签名字。', + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gray', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '泳道组id。', + 'description' => 'The ID of the lane group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '119', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '需要查询的MSE命名空间名字', + 'description' => 'The name of the Microservices Engine (MSE) namespace that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'any', + 'example' => '[{appName:"test",appId:"hkhon1po62@958bba95910341f'."\n" + .'"}]', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + '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\\": \\"请求处理成功\\",\\n \\"Data\\": \\"[{appName:\\\\\\"test\\\\\\",appId:\\\\\\"hkhon1po62@958bba95910341f\\\\n\\\\\\"}]\\"\\n}","type":"json"}]', + 'title' => 'ListAppBySwimmingLaneGroupTag', + ], + 'GetLosslessRuleByApp' => [ + 'summary' => 'Queries the rules for graceful start and shutdown of an application.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '173262', + 'abilityTreeNodes' => [ + 'FEATUREmse9OTHB7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'region id, such as cn-hangzhou', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Key word of search lossless list', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the MSE namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'appId', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522baa***', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<MseLosslessResponse>', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'title' => 'appName', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'AppId' => [ + 'title' => 'appId', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@24810bf4364a***', + ], + 'Count' => [ + 'title' => 'instance\'s count of app', + 'description' => 'The number of instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Enable' => [ + 'title' => 'rule is open or close', + 'description' => 'Indicates whether graceful start is enabled. Valid values:'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'WarmupTime' => [ + 'description' => 'The prefetching duration. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'DelayTime' => [ + 'description' => 'The registration latency. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'FuncType' => [ + 'title' => 'warmup function type, 2 means f(x)=x^2', + 'description' => 'The slope of the prefetching curve.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Aligned' => [ + 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', + 'description' => 'Indicates whether service registration is complete before readiness probe.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Related' => [ + 'title' => 'K8s\'s HPA is related to warmup or NOT', + 'description' => 'Indicates whether service prefetching is complete before readiness probe.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'LossLessDetail' => [ + 'title' => 'show lossLess offline&online detail', + 'description' => 'Indicates whether online and offline processing details are displayed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Notice' => [ + 'title' => 'enable lossLess offline active notification', + 'description' => 'Indicates whether notification is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + '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 \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"AppId\\": \\"hkhon1po62@24810bf4364a***\\",\\n \\"Count\\": 1,\\n \\"Enable\\": true,\\n \\"WarmupTime\\": 120,\\n \\"DelayTime\\": 60,\\n \\"FuncType\\": 2,\\n \\"Aligned\\": true,\\n \\"Related\\": false,\\n \\"LossLessDetail\\": true,\\n \\"Notice\\": false\\n }\\n}","type":"json"}]', + 'title' => 'GetLosslessRuleByApp', + 'description' => 'You can call this operation to query the rules for graceful start and shutdown of an application.'."\n" + ."\n" + .'You can query the rules for graceful start and shutdown of an application preferentially by using the AppId parameter.'."\n" + ."\n" + .'If the AppId parameter is left empty, you can use the RegionId, Namespace, and AppName parameters to query the rules for graceful start and shutdown of an application.'."\n", + ], + 'ModifyLosslessRule' => [ + 'summary' => 'Modifies configurations of the lossless online and offline feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '115999', + 'abilityTreeNodes' => [ + 'FEATUREmse9OTHB7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => 'appName', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'wx-work-api', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'namespace', + 'description' => 'The microservice namespace to which the rule applies.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'default', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'appName', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'c644n5frmc@3e75f25fd4*****', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'title' => 'the switch of rule, TRUE means open, FALSE means close', + 'description' => 'Specifies whether to enable the alert rule. Valid values:'."\n" + ."\n" + .'* `true`: enables the rule.'."\n" + .'* `false`: disables the rule.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'WarmupTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'warmup time of App', + 'description' => 'The prefetching duration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '60', + ], + ], + [ + 'name' => 'DelayTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'delay time of register to registry', + 'description' => 'The registration latency.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'FuncType', + 'in' => 'query', + 'schema' => [ + 'title' => 'warmup function type, 2 means f(x)=x^2', + 'description' => 'The slope of the prefetching curve.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Aligned', + 'in' => 'query', + 'schema' => [ + 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', + 'description' => 'Specifies whether to align the lifecycle of the application in the Kubernetes cluster with that of the microservice.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'Related', + 'in' => 'query', + 'schema' => [ + 'title' => 'K8s\'s HPA is related to warmup or NOT', + 'description' => 'Specifies whether to associate with service prefetching.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'LossLessDetail', + 'in' => 'query', + 'schema' => [ + 'title' => 'show lossLess offline&online detail', + 'description' => 'Specifies whether to display online and offline processing details.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Notice', + 'in' => 'query', + 'schema' => [ + 'title' => 'enable lossLess offline active notification', + 'description' => 'Specifies whether to enable notification.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', + 'title' => 'Id of the request', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => '响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'modifyLosslessRule success', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'any', + 'example' => 'null', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"modifyLosslessRule success\\",\\n \\"Data\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'ModifyLosslessRule', + ], + 'FetchLosslessRuleList' => [ + 'summary' => 'Obtains the rules for graceful start and shutdown.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'region id, such as cn-hangzhou', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Key word of search lossless list', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'spring-boot-sample', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'appId', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hyaziyb6sc@86827c61f5ed8fc', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'current', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'limit', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<FetchListResponse<MseLosslessResponse>>', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '56D9E600-6348-4260-B35F-583413F****', + 'title' => 'Id of the request', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalSize' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + ], + 'Results' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'title' => 'appName', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'echo-demo', + ], + 'AppId' => [ + 'title' => 'appId', + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@24810bf4364aea1', + ], + 'Count' => [ + 'title' => 'instance\'s count of app', + 'description' => 'The number of instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Enable' => [ + 'title' => 'rule is open or close', + 'description' => 'Indicates whether graceful start is enabled. Valid values:'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'WarmupTime' => [ + 'description' => 'The prefetching duration. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + 'title' => '', + ], + 'DelayTime' => [ + 'description' => 'The registration latency. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + 'title' => '', + ], + 'FuncType' => [ + 'title' => 'warmup function type, 2 means f(x)=x^2', + 'description' => 'The slope of the prefetching curve.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Aligned' => [ + 'title' => 'microservices lifecycle aligns to k8s\'s or NOT', + 'description' => 'Indicates whether service registration is complete before readiness probe.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Related' => [ + 'title' => 'K8s\'s HPA is related to warmup or NOT', + 'description' => 'Indicates whether service prefetching is complete before readiness probe.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'LossLessDetail' => [ + 'title' => 'show lossLess offline&online detail', + 'description' => 'Indicates whether online and offline processing details are displayed.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Notice' => [ + 'title' => 'enable lossLess offline active notification', + 'description' => 'Indicates whether notification is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"56D9E600-6348-4260-B35F-583413F****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 36,\\n \\"Results\\": [\\n {\\n \\"AppName\\": \\"echo-demo\\",\\n \\"AppId\\": \\"hkhon1po62@24810bf4364a***\\",\\n \\"Count\\": 3,\\n \\"Enable\\": true,\\n \\"WarmupTime\\": 60,\\n \\"DelayTime\\": 60,\\n \\"FuncType\\": 2,\\n \\"Aligned\\": true,\\n \\"Related\\": false,\\n \\"LossLessDetail\\": false,\\n \\"Notice\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'FetchLosslessRuleList', + 'description' => 'You can call this operation to query the rules for graceful start and shutdown.'."\n", + ], + 'GetLocalityRule' => [ + 'summary' => 'Obtains the Intra-zone Provider First rules.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '45915', + 'abilityTreeNodes' => [ + 'FEATUREmseZ3XXPX', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => '', + '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' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hgxznfcvbe@be2c0228f******', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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 \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"D3971C60-3F07-58B0-8EA0-A194********\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"pageNumber\\\\\\":0,\\\\n \\\\\\"namespaceId\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"enable\\\\\\":false,\\\\n \\\\\\"appId\\\\\\":\\\\\\"hkhon1po62@3aa3582********\\\\\\",\\\\n \\\\\\"pageSize\\\\\\":0,\\\\n \\\\\\"region\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"routeRules\\\\\\":[\\\\n {\\\\n \\\\\\"threshold\\\\\\":0.2,\\\\n \\\\\\"tags\\\\\\":[]\\\\n }\\\\n ]\\\\n}\\",\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'GetLocalityRule', + ], + 'UpdateLocalityRule' => [ + 'summary' => 'Updates the Intra-zone Provider First rules.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'myNamespace', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'hkhon1po62@c3df23522******', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.2', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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 \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"78F05E89-D387-50CE-8186-2E27A8AB****\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"Message\\\\\\":\\\\\\"updateLocalityPolicy success\\\\\\",\\\\n \\\\\\"RequestId\\\\\\":\\\\\\"3B519913-7348-16AB-AD71-******\\\\\\",\\\\n \\\\\\"HttpStatusCode\\\\\\":200,\\\\n \\\\\\"Code\\\\\\":200,\\\\n \\\\\\"Success\\\\\\":true\\\\n}\\",\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'UpdateLocalityRule', + ], + 'GetApplicationList' => [ + 'summary' => 'Obtains the list of applications.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17022', + 'abilityTreeNodes' => [ + 'FEATUREmseHJJ9Z1', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of an application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'rest-container', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of an application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'hkhon1po62@c3df23522b*****', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the application. The value is fixed as edasmsc.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The programming language of the application, such as Java and Go.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Java', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'SwitchEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Specifies whether to enable switching.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'SentinelEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Specifies whether to enable the Sentinel-compatible mode.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + 'default' => 'default', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F55E608F-7C15-****-9CFD-DF832EBC4A0F', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExtraInfo' => [ + 'description' => 'The additional information.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'AppName' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'finance', + ], + 'AppId' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@5f1b08becb*****', + ], + 'UserId' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1234567890', + ], + 'InstancesNumber' => [ + 'description' => 'The number of instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Source' => [ + 'description' => 'The source of the application.'."\n", + 'type' => 'string', + 'example' => 'edasmsc', + ], + 'Language' => [ + 'description' => 'The programming language of the application.'."\n", + 'type' => 'string', + 'example' => 'JAVA', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Namespace' => [ + 'title' => '应用所属的MSE命名空间。', + 'description' => 'The microservice namespace to which the application belongs.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Tags' => [ + 'type' => 'object', + ], + ], + ], + ], + 'TotalSize' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + '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 \\"Success\\": true,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"F55E608F-7C15-****-9CFD-DF832EBC4A0F\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Status\\": 0,\\n \\"ExtraInfo\\": \\"{}\\",\\n \\"AppName\\": \\"finance\\",\\n \\"AppId\\": \\"hkhon1po62@5f1b08becb*****\\",\\n \\"UserId\\": \\"1234567890\\",\\n \\"InstancesNumber\\": 1,\\n \\"Source\\": \\"edasmsc\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\",\\n \\"Tags\\": {\\n \\"tagKey1\\": \\"tagValue1\\",\\n \\"tagKey2\\": \\"tagValue2\\"\\n }\\n }\\n ],\\n \\"TotalSize\\": 11,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'GetApplicationList', + ], + 'CreateMseServiceApplication' => [ + 'summary' => 'Creates an application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bsd-xxyp-open-goods-server', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the instance resides. Examples:'."\n" + ."\n" + .'* cn-hangzhou: China (Hangzhou)'."\n" + .'* cn-beijing: China (Beijing)'."\n" + .'* cn-shanghai: China (Shanghai)'."\n" + .'* cn-zhangjiakou: China (Zhangjiakou)'."\n" + .'* cn-shenzhen: China (Shenzhen)'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service source.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'edasmsc', + 'default' => 'edasmsc', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The programming language of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'JAVA', + ], + ], + [ + 'name' => 'ExtraInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The additional information.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{}', + ], + ], + [ + 'name' => 'SentinelEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Specifies whether to enable the Sentinel-compatible mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'SwitchEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Specifies whether to enable switching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'MseVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of the MSE instance that you want to purchase.'."\n" + ."\n" + .'* mse_pro: Professional Edition.'."\n" + .'* mse_dev: Developer Edition.', + 'type' => 'string', + 'required' => false, + 'example' => 'mse_pro', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '904F6C04-1284-****-8ED2-FFC57E507A72', + ], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status. Valid values: 1: available; 2: deleted.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExtraInfo' => [ + 'description' => 'The additional information.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'AppName' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'UpdateTime' => [ + 'description' => 'The last modification time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1632979237663', + ], + 'LicenseKey' => [ + 'description' => 'The license key in use.'."\n", + 'type' => 'string', + 'example' => 'xxxxxxxx@xxxxxxxxxx', + ], + 'CreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631001140913', + ], + 'AppId' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'example' => 'xxxxxxxx@xxxxxxxxxx', + ], + 'UserId' => [ + 'description' => 'The ID of the user.'."\n", + 'type' => 'string', + 'example' => '1234567890', + ], + 'Source' => [ + 'description' => 'The source type.'."\n", + 'type' => 'string', + 'example' => 'edasmsc', + ], + 'Language' => [ + 'description' => 'The programming language of the application.'."\n", + 'type' => 'string', + 'example' => 'JAVA', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Version' => [ + 'description' => 'The version information.'."\n", + 'type' => 'string', + 'example' => '1.0.0', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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::CreateApplication', + ], + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"904F6C04-1284-****-8ED2-FFC57E507A72\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"ExtraInfo\\": \\"{}\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"UpdateTime\\": 1632979237663,\\n \\"LicenseKey\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"CreateTime\\": 1631001140913,\\n \\"AppId\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"UserId\\": \\"1234567890\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Version\\": \\"1.0.0\\"\\n },\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'CreateMseServiceApplication', + ], + 'CreateApplication' => [ + 'summary' => 'Creates an application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '17001', + 'abilityTreeNodes' => [ + 'FEATUREmse3O985H', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '地域。', + 'description' => 'The region to which the application belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的MSE命名空间。', + 'description' => 'MSE命名空间名字。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'prod', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名。', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service where the application is deployed. A value of ACK indicates Container Service for Kubernetes.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ACK', + 'default' => 'edasmsc', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The programming language of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'JAVA', + 'default' => 'JAVA', + ], + ], + [ + 'name' => 'SentinelEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Specifies whether to start the switch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'SwitchEnable', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + 'minItems' => 0, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '68D91223-CCE9-5F9C-B538-20F617DA48B1', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the application. A value of 1 indicates that the application is in a normal state.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExtraInfo' => [ + 'description' => 'The additional information.'."\n", + 'type' => 'string', + 'example' => '{\\"rpcTypes\\":[\\"dubbo\\",\\"springCloud\\"]}', + ], + 'AppName' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'UpdateTime' => [ + 'description' => 'The update time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1632979237663', + ], + 'LicenseKey' => [ + 'description' => 'The license key in use.'."\n", + 'type' => 'string', + 'example' => 'xxxxxxxx@xxxxxxxxxx', + ], + 'CreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631001140913', + ], + 'AppId' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'xxxxxxxx@xxxxxxxxxx', + ], + 'UserId' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '1888888888', + ], + 'Source' => [ + 'description' => 'The service where the application is deployed. Valid values:'."\n" + ."\n" + .'* \\- ACK: Container Service for Kubernetes'."\n" + .'* \\- Normal: another service'."\n", + 'type' => 'string', + 'example' => 'ACK', + ], + 'Language' => [ + 'description' => 'The programming language of the application.'."\n", + 'type' => 'string', + 'example' => 'JAVA', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Namespace' => [ + 'description' => 'MSE命名空间名字。', + 'type' => 'string', + 'example' => 'prod', + ], + 'Version' => [ + 'description' => '版本号。', + 'type' => 'string', + 'example' => '1.0.0', + ], + ], + 'example' => 'data', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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 \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"68D91223-CCE9-5F9C-B538-20F617DA48B1\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"ExtraInfo\\": \\"{\\\\\\\\\\\\\\"rpcTypes\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"dubbo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"springCloud\\\\\\\\\\\\\\"]}\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"UpdateTime\\": 1632979237663,\\n \\"LicenseKey\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"CreateTime\\": 1631001140913,\\n \\"AppId\\": \\"xxxxxxxx@xxxxxxxxxx\\",\\n \\"UserId\\": \\"1888888888\\",\\n \\"Source\\": \\"ACK\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"prod\\",\\n \\"Version\\": \\"1.0.0\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'CreateApplication', + ], + 'GetOverview' => [ + 'summary' => 'Queries overview information about Microservices Governance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query time. Unit: days. For example, if you set this parameter to 30, the governance rules within the last 30 days are queried.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'string', + 'example' => 'data', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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 \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": \\"data\\",\\n \\"Code\\": 1,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'GetOverview', + 'description' => 'You can call this operation to query overview information about service governance.'."\n", + ], + 'RemoveApplication' => [ + 'summary' => 'Deletes a single application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '17086', + 'abilityTreeNodes' => [ + 'FEATUREmseHJJ9Z1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '地域。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '微服务命名空间。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'prod', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '要删除的应用名字。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'example-app', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '要删除的应用id。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'abcde@12345', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id。', + 'description' => '', + 'type' => 'string', + 'example' => 'abcde-12345', + ], + 'Success' => [ + 'title' => '是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码。', + 'description' => '', + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'Message' => [ + 'title' => '错误信息。', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'title' => '删除执行结果。', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abcde-12345\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'RemoveApplication', + ], + 'GetApplicationInstanceList' => [ + 'summary' => 'Queries the list of microservice application instances.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17021', + 'abilityTreeNodes' => [ + 'FEATUREmseZB84VG', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的MSE命名空间。', + 'description' => 'The Microservices Engine (MSE) namespace to which the application belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名字。', + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + 'maxLength' => 100, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用Id。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => true, + 'example' => 'abcde@12345', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'title' => '节点标签。', + 'description' => 'The tags that you want to add to nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'gray', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页。从1开始。', + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '所在地域。', + 'description' => 'The region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '返回数据', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => '节点列表。', + 'description' => 'The queried nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '微服务治理节点列表。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'title' => '节点ip。', + 'description' => 'The node IP address.'."\n", + 'type' => 'string', + 'example' => '10.1.2.3', + ], + 'Tags' => [ + 'title' => '节点标签。', + 'description' => 'The node tags.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '节点标签结构。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'title' => '标签值。', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'gray', + ], + ], + ], + ], + 'Port' => [ + 'title' => '应用端口。', + 'description' => 'The application port.'."\n", + 'type' => 'string', + 'example' => '8080', + ], + ], + ], + ], + 'TotalSize' => [ + 'title' => '总共有多少个节点。', + 'description' => 'The total number of nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'title' => '第几页，从1开始。', + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页多少个。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Ip\\": \\"10.1.2.3\\",\\n \\"Tags\\": [\\n {\\n \\"Tag\\": \\"gray\\"\\n }\\n ],\\n \\"Port\\": \\"8080\\"\\n }\\n ],\\n \\"TotalSize\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'GetApplicationInstanceList', + ], + 'QueryGovernanceKubernetesCluster' => [ + 'summary' => 'Queries the Kubernetes clusters for which Microservices Governance is activated.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '116299', + 'abilityTreeNodes' => [ + 'FEATUREmse3O985H', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => 'Kubernetes集群名', + 'description' => 'The name of the Kubernetes cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'example-cluster', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => 'Kubernetes集群Id', + 'description' => 'The ID of the Kubernetes cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'c24c9354acxxxxxxx', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '当前页码', + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页元素数量', + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '5', + 'example' => '10', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DE34D413-2B79-5E77-9696-36D875E822AD', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'title' => 'Kubernetes集群名', + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'example-cluster', + ], + 'ClusterId' => [ + 'title' => 'Kubernetes集群Id', + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'abcdef123456789', + ], + 'Region' => [ + 'title' => 'Kubernetes集群所在的地域', + 'description' => 'The region where the cluster resides.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'K8sVersion' => [ + 'title' => 'Kubernetes集群版本', + 'description' => 'The version of the cluster.'."\n", + 'type' => 'string', + 'example' => '1.22', + ], + 'NamespaceInfos' => [ + 'title' => 'Kubernetes集群命名空间信息（json格式）', + 'description' => 'The information about the namespace.'."\n", + 'type' => 'string', + 'example' => '[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]', + ], + 'PilotStartTime' => [ + 'title' => 'pilot启动时间', + 'description' => 'The time when the pilot component was started.'."\n", + 'type' => 'string', + 'example' => '2022-05-17T05:39:43.000+0000', + ], + 'VersionLifeCycle' => [ + 'type' => 'string', + ], + 'PilotVersion' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TotalSize' => [ + 'title' => '页码总数', + 'description' => 'The total number of clusters.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页大小', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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 \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DE34D413-2B79-5E77-9696-36D875E822AD\\",\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"ClusterName\\": \\"example-cluster\\",\\n \\"ClusterId\\": \\"abcdef123456789\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"K8sVersion\\": \\"1.22\\",\\n \\"NamespaceInfos\\": \\"[{\\\\\\"Name\\\\\\":\\\\\\"ack-onepilot\\\\\\",\\\\\\"Tags\\\\\\":{\\\\\\"name\\\\\\":\\\\\\"ack-onepilot\\\\\\"}}]\\",\\n \\"PilotStartTime\\": \\"2022-05-17T05:39:43.000+0000\\",\\n \\"VersionLifeCycle\\": \\"\\",\\n \\"PilotVersion\\": \\"\\"\\n }\\n ],\\n \\"TotalSize\\": 3,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QueryGovernanceKubernetesCluster', + ], + 'ModifyGovernanceKubernetesCluster' => [ + 'summary' => 'Modifies the information about a cluster for which Microservice Governance is enabled.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '25610', + 'abilityTreeNodes' => [ + 'FEATUREmseSXV85E', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cd23228b3c80c4d4f9ad87cc3****', + ], + ], + [ + 'name' => 'NamespaceInfos', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '命名空间接入MSE服务治理的对应信息。', + 'description' => 'The information about the namespace for which Microservices Engine(MSE) Microservices Governance is enabled.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'kubernetes命名空间名字。', + 'description' => 'The name of the Kubernetes namespace.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'MseNamespace' => [ + 'title' => '对应的微服务命名空间，为空代表没有接入。', + 'description' => 'The microservice namespace. If you do not specify this parameter, Microservice Governance is not enabled for the namespace.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F9849E97-2455-54B0-A3B4-3F6E4E9FFEB1', + ], + 'Data' => [ + 'description' => 'The deletion result.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"F9849E97-2455-54B0-A3B4-3F6E4E9FFEB1\\",\\n \\"Data\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ModifyGovernanceKubernetesCluster', + ], + 'GetGovernanceKubernetesCluster' => [ + 'summary' => 'Queries the information about a Container Service for Kubernetes (ACK) cluster for which Microservices Governance is enabled.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '24691', + 'abilityTreeNodes' => [ + 'FEATUREmse3O985H', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5B170A0D-2C5D-4CF8-B808-03966B86****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'cd23228b3c80c4d4f9ad7af1d87cc30d5', + ], + 'ClusterName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'myCluster', + ], + 'Region' => [ + 'description' => 'The ID of the region in which the instance resides. The region is supported by MSE.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'K8sVersion' => [ + 'description' => 'The version of Kubernetes.'."\n", + 'type' => 'string', + 'example' => '1.20.11-aliyun.1', + ], + 'NamespaceInfos' => [ + 'description' => 'The information of the namespace.'."\n", + 'type' => 'string', + 'example' => '[{\\"Name\\":\\"ack-onepilot\\",\\"Tags\\":null},{\\"Name\\":\\"default\\",\\"Tags\\":{\\"mse-enable\\":\\"enabled\\"}},{\\"Name\\":\\"kube-node-lease\\",\\"Tags\\":null},{\\"Name\\":\\"kube-public\\",\\"Tags\\":null},{\\"Name\\":\\"kube-system\\",\\"Tags\\":null}]', + ], + 'PilotStartTime' => [ + 'description' => 'The time when the pilot component was started.'."\n", + 'type' => 'string', + 'example' => '2022-01-11T11:50:38.000+0000', + ], + 'UpdateTime' => [ + 'description' => 'The time of the last modification.'."\n", + 'type' => 'string', + 'example' => '2022-01-12T05:24:31.000+0000', + ], + 'Namespaces' => [ + 'description' => 'The queried namespaces.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'Kubernetes命名空间名字', + 'description' => 'The name of the namespace in the ACK cluster.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'MseNamespace' => [ + 'title' => '对应接入的mse命名空间名字', + 'description' => 'The name of the MSE namespace that you want to access.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + 'PilotVersion' => [ + 'type' => 'string', + ], + 'VersionLifeCycle' => [ + 'type' => 'string', + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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 \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5B170A0D-2C5D-4CF8-B808-03966B86****\\",\\n \\"Data\\": {\\n \\"ClusterId\\": \\"cd23228b3c80c4d4f9ad7af1d87cc30d5\\",\\n \\"ClusterName\\": \\"myCluster\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"K8sVersion\\": \\"1.20.11-aliyun.1\\",\\n \\"NamespaceInfos\\": \\"[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ack-onepilot\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"mse-enable\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"enabled\\\\\\\\\\\\\\"}},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-node-lease\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-public\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null},{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kube-system\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Tags\\\\\\\\\\\\\\":null}]\\",\\n \\"PilotStartTime\\": \\"2022-01-11T11:50:38.000+0000\\",\\n \\"UpdateTime\\": \\"2022-01-12T05:24:31.000+0000\\",\\n \\"Namespaces\\": [\\n {\\n \\"Name\\": \\"default\\",\\n \\"MseNamespace\\": \\"default\\"\\n }\\n ],\\n \\"PilotVersion\\": \\"4.1.1\\",\\n \\"VersionLifeCycle\\": \\"STABLE\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetGovernanceKubernetesCluster', + ], + 'ListNamespaces' => [ + 'summary' => 'Displays the list of namespaces, the number of online nodes in each namespace, and the total number of applications in each namespace. You can also call this operation to perform fuzzy queries based on the namespace name.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '192223', + 'abilityTreeNodes' => [ + 'FEATUREmseSXV85E', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '5', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'myNamespace', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + 'minItems' => 0, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<PageResult<NamespaceVO>>', + 'description' => 'RestResult<PageResult<NamespaceVO>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'title' => '实例列表的页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalSize' => [ + 'title' => '查询到的实例总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'PageSize' => [ + 'title' => '输入时设置的每页行数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '178*******', + ], + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Namespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'myNamespace', + ], + 'Version' => [ + 'title' => '--- 基础版', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Describe' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'InstanceCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'AppCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2024-09-02T09:49:48.000+0000', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2024-09-02T09:49:48.000+0000', + ], + 'Tags' => [ + 'type' => 'object', + ], + ], + ], + ], + 'Results' => [ + 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '178*******', + ], + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Namespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'myNamespace', + ], + 'Version' => [ + 'title' => '--- 基础版', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Describe' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'InstanceCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'AppCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2024-09-02T09:49:48.000+0000', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2024-09-02T09:49:48.000+0000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"D1F1A6F3-7E03-5EAD-B3F1-123456789ABC\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 7,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"UserId\\": \\"178*******\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\",\\n \\"Version\\": 1,\\n \\"Describe\\": \\"测试命名空间1。\\",\\n \\"InstanceCount\\": 6,\\n \\"AppCount\\": 3,\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0,\\n \\"Tags\\": {\\n \\"1\\": \\"1\\",\\n \\"2\\": \\"2\\"\\n }\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"UserId\\": \\"178*******\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\",\\n \\"Version\\": 1,\\n \\"Describe\\": \\"测试命名空间1。\\",\\n \\"InstanceCount\\": 6,\\n \\"AppCount\\": 3,\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListNamespaces', + ], + 'CreateNamespace' => [ + 'summary' => 'Creates a namespace for Microservices Governance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '187065', + 'abilityTreeNodes' => [ + 'FEATUREmseSXV85E', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '要搜索的命名空间名字', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'myNamespace', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'Describe', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + 'minItems' => 0, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误时的提示信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => 'D1F1A6F3-7E03-5EAD-B3F1-123456789ABC', + ], + 'ErrorCode' => [ + 'title' => '错误码。', + 'description' => '', + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '命名空间所属的地域', + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Namespace' => [ + 'title' => '命名空间名字', + 'description' => '', + 'type' => 'string', + 'example' => 'myNamespace', + ], + ], + ], + ], + ], + ], + ], + '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 \\"Message\\": \\"请求处理成功。\\",\\n \\"RequestId\\": \\"D1F1A6F3-7E03-5EAD-B3F1-123456789ABC\\",\\n \\"ErrorCode\\": \\"mse-100-000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"myNamespace\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateNamespace', + ], + 'DeleteNamespace' => [ + 'summary' => '删除MSE命名空间', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '操作的地域', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '要删除的MSE命名空间名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'prod', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'title' => 'HTTP状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '请求信息，错误排查用', + 'description' => '', + 'type' => 'string', + 'example' => '', + 'default' => '请求处理成功', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'abcde-efg', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码。', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'NO_PERMISSION', + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"abcde-efg\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NO_PERMISSION\\"\\n}","type":"json"}]', + 'title' => 'DeleteNamespace', + ], + 'QueryNamespace' => [ + 'summary' => '查询MSE命名空间', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '操作的地域', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '要搜索的命名空间名字', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values: zh and en. Default value: zh. The value zh which indicates Chinese, and the value en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误时的提示信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => 'abcde-fg', + ], + 'ErrorCode' => [ + 'title' => '错误码。', + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'title' => '返回的数据', + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '命名空间所属的地域', + 'description' => 'The region to which the namespace belongs.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Namespace' => [ + 'title' => '命名空间名字', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"abcde-fg\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryNamespace', + ], + 'ApplyTagPolicies' => [ + 'summary' => 'Modifies a tag-based routing rule.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '16993', + 'abilityTreeNodes' => [ + 'FEATUREmseW9QIF2', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的MSE命名空间', + 'description' => 'The Microservices Engine (MSE) namespace to which the application belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名字', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => true, + 'docRequired' => true, + 'example' => 'h5pohqu3gd@xxx', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'key为标签名。', + 'description' => 'The details of the routing rule.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'The status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The routing rule does not take effect'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* 1'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The routing rule takes effect'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* 2'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The routing rule is invalid'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n", + 'enumValueTitles' => [ + '', + '', + '', + ], + 'example' => '0', + ], + 'Rate' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'description' => 'The percentage.'."\n", + ], + 'Enable' => [ + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'description' => 'Specifies whether to enable the routing rule.'."\n", + ], + 'Tag' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The environment of the routing rule.'."\n", + 'example' => 'gray', + ], + 'Name' => [ + 'title' => '路由规则名称。', + 'description' => 'The name of the routing rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gray', + ], + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'description' => 'The ID of the routing rule.'."\n", + ], + 'InstanceNum' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'The number of instances.'."\n", + 'example' => '10', + ], + 'Rules' => [ + 'title' => '规则信息。', + 'description' => 'The details of the routing rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'springcloud' => [ + 'title' => 'springcloud规则。', + 'description' => 'The rule of the Spring Cloud application.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'condition' => [ + 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', + 'description' => 'The logical operation relationships. Valid values: AND and OR.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AND', + ], + 'restItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'datum' => [ + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'description' => 'The value on which operators such as rawvalue are performed.'."\n", + ], + 'operator' => [ + 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', + 'description' => 'The operator. A value of rawvalue indicates direct comparison. A value of mode indicates the modulo operation. A value of list indicates using a whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rawvalue', + ], + 'nameList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The name.'."\n", + 'example' => 'test1', + ], + 'required' => false, + 'description' => 'Information about the fields that are required by the list operator.'."\n", + ], + 'cond' => [ + 'title' => '比较符号，可取 >=, <=, >, <, == 。', + 'description' => 'The comparison operator. Valid values: >=, <=, >, <, and ==.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '==', + ], + 'divisor' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'description' => 'The divisor that is required by the mod operator.'."\n", + ], + 'remainder' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'The remainder.'."\n", + 'example' => '30', + ], + 'rate' => [ + 'title' => '比例规则，20% 的流量路由到该标签对应的节点。', + 'description' => 'The rate. A value of 20 indicates that 20% of the traffic is routed to the tagged node.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'type' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'description' => 'The type.'."\n", + ], + 'name' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'key', + 'description' => 'The name.'."\n", + ], + 'value' => [ + 'type' => 'any', + 'required' => false, + 'example' => 'test', + 'description' => 'The value.'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + 'description' => '', + ], + 'triggerPolicy' => [ + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PERCENT' => '', + 'CONTENT' => '', + ], + 'example' => 'CONTENT', + 'description' => 'The policy type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PERCENT'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* CONTENT'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + ], + 'enable' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => 'Specifies whether to enable the routing rule.'."\n", + 'example' => 'true', + ], + 'appId' => [ + 'type' => 'string', + 'required' => false, + 'example' => '***@***', + 'description' => 'The ID of the application.'."\n", + ], + 'priority' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'The priority.'."\n", + 'example' => '1', + ], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'gray', + 'description' => 'The tag.'."\n", + ], + 'required' => false, + 'description' => 'The tags.'."\n", + ], + 'paths' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => '/hello', + 'description' => 'The path.'."\n", + ], + 'required' => false, + 'description' => 'The list of paths.'."\n", + ], + 'path' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The path.'."\n", + 'example' => '/hello', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'dubbo' => [ + 'title' => 'dubbo 规则。', + 'description' => 'The rules of the Dubbo application.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appId' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The ID of the application.'."\n", + 'example' => '***@***'."\n", + ], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'gray', + 'description' => 'The tag.'."\n", + ], + 'required' => false, + 'description' => 'The tags.'."\n", + ], + 'triggerPolicy' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The policy type.'."\n", + 'example' => 'CONTENT', + ], + 'serviceName' => [ + 'title' => '服务名（接口）。', + 'description' => 'The service name (interface).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HelloService', + ], + 'group' => [ + 'title' => 'dubbo服务分组。', + 'description' => 'The group of the Dubbo application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'version' => [ + 'title' => 'dubbo服务版本。', + 'description' => 'The version of the Dubbo application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + 'methodName' => [ + 'title' => 'dubbo服务的方法名。', + 'description' => 'The method name of the Dubbo application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + 'paramTypes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'int', + 'description' => 'The data type of the parameter.'."\n", + ], + 'required' => false, + 'description' => 'The list of parameter data types.'."\n", + ], + 'condition' => [ + 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', + 'description' => 'The logical operation relationships. Valid values: AND and OR.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AND', + ], + 'argumentItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'operator' => [ + 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', + 'description' => 'The operator. A value of rawvalue indicates direct comparison. A value of mode indicates the modulo operation. A value of list indicates using a whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rawvalue', + ], + 'nameList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The name.'."\n", + 'example' => 'demo', + ], + 'required' => false, + 'description' => 'The list of names.'."\n", + ], + 'datum' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The value on which operators such as rawvalue are performed.'."\n", + 'example' => '30'."\n", + ], + 'cond' => [ + 'title' => '比较符号，可取 >=, <=, >, <, == 。', + 'description' => 'The comparison operator. Valid values: >=, <=, >, <, and ==.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '==', + ], + 'divisor' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'The divisor that is required by the mod operator.'."\n", + 'example' => '30'."\n", + ], + 'remainder' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30'."\n", + 'description' => 'The remainder.'."\n", + ], + 'rate' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'The rate. A value of 20 indicates that 20% of the traffic is routed to the tagged node.'."\n", + 'example' => '10', + ], + 'index' => [ + 'title' => '参数位置，从0开始。', + 'description' => 'The position of the parameter, which starts from 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'expr' => [ + 'title' => '表达式，见其他字段解释。', + 'description' => 'The expression.'."\n", + 'type' => 'string', + 'required' => false, + ], + 'value' => [ + 'title' => '比较的值。表达式得到的值会跟这个值比较。如果 operator 是 list 白名单，value 的值用 \\",\\" 分隔，比如 1,2,3。', + 'description' => 'The value that is used for comparison. The value obtained by the expression is compared with this value. If the list operator is used, data of the value parameter is separated by commas (,). For example, 1,2,3.'."\n", + 'type' => 'any', + 'required' => false, + 'example' => '1,2,3', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'description' => 'The list of parameter contents.'."\n", + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'description' => '', + ], + 'example' => '{ "blue": { # Tag key. "rate": 20, # Rate. A value of 20 indicates that 20% of the traffic is routed to the node identified by the tag. "name": "luoye-route-test", # Routing rule name. "carryData": false, # Specifies whether to enable pass-through. This parameter is applicable to end-to-end canary release. "rules": { # Rule information. "dubbo": \\[{ # Dubbo rule. The system also supports Spring Cloud and Istio rule. "serviceName": "com.taobao.hsf.common.DemoService", # Service name (operation name). "group": "", # Group name. "version": "", # Service version. "methodName": "sayHello", # Method name. "condition": "AND", # Logical operator used by the following items. Valid values: AND and OR. "argumentItems": \\[{ # Array of rule details. "index": 0, # Index field. "expr": "", # Expression. Its details is described below. "operator": "rawvalue", # The comparison mode. A value of rawvalue indicates direct comparison. A value of mode indicates the modulo operation. A value of list indicates using a whitelist. "value": "jim", # Base value. The value obtained by the expression will be compared with this value. If operator is set to list, separate the items specified for this parameter with commas (,). Example: 1,2,3. "cond": "==" # Comparison operator. Valid values: >=, <=, >, <, and ==. }] }] } }, "\\_base": { # Another tag key. "rate": 80 # Rate. A value of 20 indicates that 20% of the traffic is routed to the node identified by the tag. } }'."\n", + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Optional. The ID of the namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12233****', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the routing rule.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceNum' => [ + 'description' => 'The number of instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Remove' => [ + 'description' => 'Indicates whether the routing rule was deleted.'."\n", + 'type' => 'boolean', + ], + 'CarryData' => [ + 'description' => 'Indicates whether the field is the primary key.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tag' => [ + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'example' => 'gray', + ], + 'Name' => [ + 'description' => 'The policy name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Rules' => [ + 'description' => 'The details of the routing rule.'."\n", + 'type' => 'string', + 'example' => '{\\"_base\\": {\\"rate\\": 100, \\"remove\\": true}, \\"blue\\": {\\"rate\\": 0}}', + ], + 'Id' => [ + 'description' => 'The ID of the primary key.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Rate' => [ + 'description' => 'The rate.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Enable' => [ + 'description' => 'Indicates whether the rule is enabled. Valid values:'."\n" + ."\n" + .'* `true`: The rule is enabled.'."\n" + .'* `false`: The rule is disabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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 \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"InstanceNum\\": 1,\\n \\"Remove\\": true,\\n \\"CarryData\\": true,\\n \\"Tag\\": \\"gray\\",\\n \\"Name\\": \\"test\\",\\n \\"Rules\\": \\"{\\\\\\\\\\\\\\"_base\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"rate\\\\\\\\\\\\\\": 100, \\\\\\\\\\\\\\"remove\\\\\\\\\\\\\\": true}, \\\\\\\\\\\\\\"blue\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"rate\\\\\\\\\\\\\\": 0}}\\",\\n \\"Id\\": 12,\\n \\"Rate\\": 10,\\n \\"Enable\\": true\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ApplyTagPolicies', + ], + 'ListApplicationsWithTagRules' => [ + 'summary' => 'Queries the routing rules of an application.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '50', + 'example' => '10', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the routing rule. Default value: edasmsc.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the application.', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'xjpc0h9h4d@xxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属的MSE命名空间', + 'description' => 'The MSE namespace to which the application belongs.', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + 'default' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名字', + 'description' => 'The name of the application.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'title' => '应用所属的MSE命名空间', + 'description' => 'The MSE namespace to which the application belongs.', + 'type' => 'string', + 'example' => 'default', + ], + 'AppName' => [ + 'title' => '应用名', + 'description' => 'The application name.', + 'type' => 'string', + 'example' => 'service-lottery-core', + ], + 'AppId' => [ + 'description' => 'The application ID.', + 'type' => 'string', + 'example' => 'daqijp6c31@xxx', + ], + 'RouteRules' => [ + 'description' => 'The queried rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the rule.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Rate' => [ + 'title' => '比例规则，20% 的流量路由到该标签对应的节点。', + 'description' => 'The rate.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Enable' => [ + 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tag' => [ + 'title' => '标签名。', + 'description' => 'The tag.', + 'type' => 'string', + 'example' => 'gray', + ], + 'Name' => [ + 'title' => '路由规则名称。', + 'description' => 'The rule name.', + 'type' => 'string', + 'example' => 'dubbo', + ], + 'Id' => [ + 'description' => 'The rule ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '653', + ], + 'InstanceNum' => [ + 'description' => 'The number of instances.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Rules' => [ + 'description' => 'The details of the routing rule.', + 'type' => 'object', + 'properties' => [ + 'springcloud' => [ + 'title' => 'springcloud规则。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'condition' => [ + 'type' => 'string', + ], + 'restItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'datum' => [ + 'type' => 'string', + ], + 'operator' => [ + 'type' => 'string', + ], + 'nameList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'cond' => [ + 'type' => 'string', + ], + 'divisor' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'remainder' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'rate' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'type' => [ + 'type' => 'string', + ], + 'name' => [ + 'type' => 'string', + ], + 'value' => [ + 'type' => 'string', + ], + ], + ], + ], + 'triggerPolicy' => [ + 'type' => 'string', + ], + 'enable' => [ + 'type' => 'boolean', + ], + 'appId' => [ + 'type' => 'string', + ], + 'priority' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'paths' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'path' => [ + 'type' => 'string', + ], + ], + ], + ], + 'dubbo' => [ + 'title' => 'dubbo 规则。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'appId' => [ + 'type' => 'string', + ], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'triggerPolicy' => [ + 'type' => 'string', + ], + 'serviceName' => [ + 'title' => '服务名（接口）。', + 'description' => '', + 'type' => 'string', + ], + 'group' => [ + 'title' => 'dubbo服务分组。', + 'description' => '', + 'type' => 'string', + ], + 'version' => [ + 'title' => 'dubbo服务版本。', + 'description' => '', + 'type' => 'string', + ], + 'methodName' => [ + 'title' => 'dubbo服务方法名。', + 'description' => '', + 'type' => 'string', + ], + 'paramTypes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'condition' => [ + 'title' => '下面 items 各项中的逻辑运算关系。可选 AND 或者 OR。', + 'description' => '', + 'type' => 'string', + ], + 'argumentItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'operator' => [ + 'title' => '操作符。rawvalue 表示直接比较，mode 表示取模，list 表示白名单。', + 'description' => '', + 'type' => 'string', + ], + 'nameList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'datum' => [ + 'type' => 'string', + ], + 'cond' => [ + 'title' => '比较符号，可取 >=, <=, >, <, == 。', + 'description' => '', + 'type' => 'string', + ], + 'divisor' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'remainder' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'rate' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'index' => [ + 'title' => '参数位置，从0开始。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + ], + 'expr' => [ + 'type' => 'string', + ], + 'value' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'example' => '{'."\n" + .' "dubbo": [{'."\n" + .' "serviceName": "com.taobao.hsf.common.DemoService",'."\n" + .' "group": "",'."\n" + .' "version": "",'."\n" + .' "methodName": "sayHello",'."\n" + .' "condition": "AND",'."\n" + .' "argumentItems": [{'."\n" + .' "index": 0,'."\n" + .' "expr": "",'."\n" + .' "operator": "rawvalue",'."\n" + .' "value": "jim",'."\n" + .' "cond": "=="'."\n" + .' }]'."\n" + .' }]'."\n" + .' }', + ], + ], + ], + ], + 'RouteStatus' => [ + 'description' => 'The route state. Valid values:'."\n" + ."\n" + .'* 0: disabled'."\n" + .'* 1: enabled', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'TotalSize' => [ + 'description' => 'The total number of entries returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Result\\": [\\n {\\n \\"Namespace\\": \\"default\\",\\n \\"AppName\\": \\"service-lottery-core\\",\\n \\"AppId\\": \\"daqijp6c31@xxx\\",\\n \\"RouteRules\\": [\\n {\\n \\"Status\\": 1,\\n \\"Rate\\": 10,\\n \\"Enable\\": true,\\n \\"Tag\\": \\"gray\\",\\n \\"Name\\": \\"dubbo\\",\\n \\"Id\\": 653,\\n \\"InstanceNum\\": 1,\\n \\"Rules\\": {\\n \\"springcloud\\": [\\n {\\n \\"condition\\": \\"\\",\\n \\"restItems\\": [\\n {\\n \\"datum\\": \\"\\",\\n \\"operator\\": \\"\\",\\n \\"nameList\\": [\\n \\"\\"\\n ],\\n \\"cond\\": \\"\\",\\n \\"divisor\\": 0,\\n \\"remainder\\": 0,\\n \\"rate\\": 0,\\n \\"type\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"triggerPolicy\\": \\"\\",\\n \\"enable\\": true,\\n \\"appId\\": \\"\\",\\n \\"priority\\": 0,\\n \\"tags\\": [\\n \\"\\"\\n ],\\n \\"paths\\": [\\n \\"\\"\\n ],\\n \\"path\\": \\"\\"\\n }\\n ],\\n \\"dubbo\\": [\\n {\\n \\"appId\\": \\"\\",\\n \\"tags\\": [\\n \\"\\"\\n ],\\n \\"triggerPolicy\\": \\"\\",\\n \\"serviceName\\": \\"\\",\\n \\"group\\": \\"\\",\\n \\"version\\": \\"\\",\\n \\"methodName\\": \\"\\",\\n \\"paramTypes\\": [\\n \\"\\"\\n ],\\n \\"condition\\": \\"\\",\\n \\"argumentItems\\": [\\n {\\n \\"operator\\": \\"\\",\\n \\"nameList\\": [\\n \\"\\"\\n ],\\n \\"datum\\": \\"\\",\\n \\"cond\\": \\"\\",\\n \\"divisor\\": 0,\\n \\"remainder\\": 0,\\n \\"rate\\": 0,\\n \\"index\\": 0,\\n \\"expr\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RouteStatus\\": 1\\n }\\n ],\\n \\"TotalSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'ListApplicationsWithTagRules', + ], + 'GetAppMessageQueueRoute' => [ + 'summary' => 'Queries information about canary release for messaging of an application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '116141', + 'abilityTreeNodes' => [ + 'FEATUREmse4ZR99T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the instance resides. Examples:'."\n" + ."\n" + .'* `cn-hangzhou`: China (Hangzhou)'."\n" + .'* `cn-beijing`: China (Beijing)'."\n" + .'* `cn-shanghai`: China (Shanghai)'."\n" + .'* `cn-zhangjiakou`: China (Zhangjiakou)'."\n" + .'* `cn-shenzhen`: China (Shenzhen)'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'hkhon1po62@c3df23522baa898', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => 'The name of the Microservices Engine (MSE) namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称', + 'description' => 'The name of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4B00BCB0-105F-5A2A-B75B-641C8E9B18FC', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@54e1f42f37cd65a', + ], + 'Region' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Enable' => [ + 'description' => 'Indicates whether the canary release for messaging feature is enabled.'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tags' => [ + 'description' => 'The tags used to ignore message consumption for nodes in untagged environments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag used to ignore message consumption for nodes in untagged environments.'."\n", + 'type' => 'string', + 'example' => 'gray', + ], + ], + 'FilterSide' => [ + 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", + 'type' => 'string', + 'example' => 'Server', + 'default' => 'Server', + 'enum' => [ + 'Server', + 'Client', + ], + ], + 'GrayBaseTags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values: true and false. The value true indicates that the request was successful. The value false indicates that the request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"4B00BCB0-105F-5A2A-B75B-641C8E9B18FC\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AppId\\": \\"hkhon1po62@54e1f42f37cd65a\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Enable\\": true,\\n \\"Tags\\": [\\n \\"gray\\"\\n ],\\n \\"FilterSide\\": \\"Server\\",\\n \\"GrayBaseTags\\": [\\n \\"\\"\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetAppMessageQueueRoute', + ], + 'UpdateMessageQueueRoute' => [ + 'summary' => 'Updates the configuration of a canary release for messaging of an application.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '116139', + 'abilityTreeNodes' => [ + 'FEATUREmse4ZR99T', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tag that is negligible for the untagged environment of the application.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag that is negligible for the untagged environment of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gray', + ], + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the canary release for messaging feature is enabled for the application. Valid values:'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'hkhon1po62@c3df23522baa898', + ], + ], + [ + 'name' => 'FilterSide', + 'in' => 'query', + 'schema' => [ + 'description' => 'The side for message filtering when the canary release for messaging feature is enabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Server', + 'default' => 'Server', + 'enum' => [ + 'Server', + 'Client', + ], + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'MSE命名空间名字', + 'description' => '', + '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' => 'GrayBaseTags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E3919C62-876A-5926-A0BC-18351A24FA35', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'string', + 'example' => 'True', + ], + 'Code' => [ + 'description' => 'The status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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 \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E3919C62-876A-5926-A0BC-18351A24FA35\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"True\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateMessageQueueRoute', + ], + 'AddMockRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent-auto-test-sc', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The rule source.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'ProviderAppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service provider application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'dcqtkuhnc4@66e5235415****', + ], + ], + [ + 'name' => 'ProviderAppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service provider application.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'demo-cartservice', + ], + ], + [ + 'name' => 'ExtraJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{}', + ], + ], + [ + 'name' => 'ScMockItems', + 'in' => 'query', + 'schema' => [ + 'description' => 'The input parameters. The JSON format is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[]', + ], + ], + [ + 'name' => 'DubboMockItems', + 'in' => 'query', + 'schema' => [ + 'description' => 'The items in the recycle bin.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[]', + ], + ], + [ + 'name' => 'ConsumerAppIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom application.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{\\"appName\\":\\"provide\\",\\"appId\\":\\"bst8l6o735@f6d8aaf6e56e67d\\"}]', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the alert rule. Valid values:'."\n" + ."\n" + .'* `true`: enables the alert rule.'."\n" + .'* `false`: disables the alert rule.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MockType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The response time (RT) threshold of slow calls. Valid values:'."\n" + ."\n" + .'* \\- 15: 15 ms'."\n" + .'* \\- 30: 30 ms'."\n" + .'* \\- 60: 60 ms'."\n" + .'* \\- 120: 120 ms'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'NamespaceId' => [ + 'description' => 'The ID of the namespace.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ScMockItemJson' => [ + 'description' => 'The HTTP mock rule.'."\n", + 'type' => 'string', + 'example' => '[{"oper":"return+json","Path":"/mock","Value":"{\\n \\"date\\": \\"2021-09-10T07:45:12.357+0000\\",\\n \\"name\\": \\"name\\",\\n \\"id\\": \\"1\\"\\n}","Method":"GET","Condition":"AND","Timeout":1,"ArgumentMockItems":[{"type":"param","name":"id","value":"1","cond":"==","operator":"rawvalue"},{"type":"param","name":"name","value":"aliyun","cond":"==","operator":"rawvalue"}]}]', + ], + 'ConsumerAppName' => [ + 'description' => 'The name of the consumer application.'."\n", + 'type' => 'string', + 'example' => 'demo-xxxx', + ], + 'ConsumerAppId' => [ + 'description' => 'The ID of the consumer application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@a000601b265xxxx', + ], + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '178432728867xxxx', + ], + 'ExtraJson' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'desc', + ], + 'Source' => [ + 'description' => 'The service source.'."\n", + 'type' => 'string', + 'example' => 'edasmsc', + ], + 'Region' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ProviderAppId' => [ + 'description' => 'The ID of the service provider application.'."\n", + 'type' => 'string', + 'example' => 'hkhon1po62@a000601b265xxxx', + ], + 'ProviderAppName' => [ + 'description' => 'The name of the service provider application.'."\n", + 'type' => 'string', + 'example' => 'demo-xxxx', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'mse-bc1a29b0-160230875****-reg-center-0-1', + ], + 'Id' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '275', + ], + 'Enable' => [ + 'description' => 'Indicates whether the mock rule is enabled.'."\n" + ."\n" + .'* `true`: enabled'."\n" + .'* `false`: disabled'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MockType' => [ + 'description' => 'The mock type. Valid values:'."\n" + ."\n" + .'* \\- `[unk]0[unk]`: desktop client'."\n" + .'* \\- `[unk]1[unk]`: mobile client'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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 \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Data\\": {\\n \\"NamespaceId\\": \\"cn-shanghai\\",\\n \\"ScMockItemJson\\": \\"[{\\\\\\"oper\\\\\\":\\\\\\"return+json\\\\\\",\\\\\\"Path\\\\\\":\\\\\\"/mock\\\\\\",\\\\\\"Value\\\\\\":\\\\\\"{\\\\\\\\n \\\\\\\\\\\\\\"date\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"2021-09-10T07:45:12.357+0000\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"id\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"\\\\\\\\n}\\\\\\",\\\\\\"Method\\\\\\":\\\\\\"GET\\\\\\",\\\\\\"Condition\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"Timeout\\\\\\":1,\\\\\\"ArgumentMockItems\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"param\\\\\\",\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\",\\\\\\"cond\\\\\\":\\\\\\"==\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"rawvalue\\\\\\"},{\\\\\\"type\\\\\\":\\\\\\"param\\\\\\",\\\\\\"name\\\\\\":\\\\\\"name\\\\\\",\\\\\\"value\\\\\\":\\\\\\"aliyun\\\\\\",\\\\\\"cond\\\\\\":\\\\\\"==\\\\\\",\\\\\\"operator\\\\\\":\\\\\\"rawvalue\\\\\\"}]}]\\",\\n \\"ConsumerAppName\\": \\"demo-xxxx\\",\\n \\"ConsumerAppId\\": \\"hkhon1po62@a000601b265xxxx\\",\\n \\"AccountId\\": \\"178432728867xxxx\\",\\n \\"ExtraJson\\": \\"desc\\",\\n \\"Source\\": \\"edasmsc\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"ProviderAppId\\": \\"hkhon1po62@a000601b265xxxx\\",\\n \\"ProviderAppName\\": \\"demo-xxxx\\",\\n \\"Name\\": \\"mse-bc1a29b0-160230875****-reg-center-0-1\\",\\n \\"Id\\": 275,\\n \\"Enable\\": true,\\n \\"MockType\\": 0\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AddMockRule', + 'summary' => 'Creates a service mocking rule.', + ], + 'GetPlugins' => [ + 'summary' => 'Obtains plug-ins.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '128636', + 'abilityTreeNodes' => [ + 'FEATUREmse7RUWJD', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the plug-in. Valid values:'."\n" + ."\n" + .'* 0: custom'."\n" + .'* 1: permission authorization'."\n" + .'* 2: security protection'."\n" + .'* 3: transmission protocol'."\n" + .'* 4: traffic control'."\n" + .'* 5: traffic observation'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EnableOnly', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the plug-in.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the plug-in.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key-auth', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'zh: Chinese en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****'."\n", + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The returned code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'message', + ], + 'Data' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the plug-in.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the plug-in.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PrimaryUser' => [ + 'description' => 'The ID of the creator.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'Category' => [ + 'description' => 'The type of the plug-in. Valid values:'."\n" + ."\n" + .'0: custom'."\n" + ."\n" + .'1: permission authorization'."\n" + ."\n" + .'2: security protection'."\n" + ."\n" + .'3: transmission protocol'."\n" + ."\n" + .'4: traffic control'."\n" + ."\n" + .'5: traffic observation'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Name' => [ + 'description' => 'The name of the plug-in.'."\n", + 'type' => 'string', + 'example' => 'key-auth', + ], + 'Version' => [ + 'description' => 'The version of the plug-in.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Summary' => [ + 'description' => 'The summary of the plug-in.'."\n", + 'type' => 'string', + 'example' => 'This is a plug-in.'."\n", + ], + 'SummaryEn' => [ + 'type' => 'string', + ], + 'Phase' => [ + 'description' => 'The execution stage of the plug-in.'."\n" + ."\n" + .'* 0: default stage'."\n" + .'* 1: authorization stage'."\n" + .'* 2: authentication stage'."\n" + .'* 3: statistics stage'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Priority' => [ + 'description' => 'The execution priority of the plug-in. A larger value indicates a higher priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ConfigCheck' => [ + 'description' => 'The information about the plug-in configuration used for checking.'."\n", + 'type' => 'string', + 'example' => '\\# The configuration includes the fields required for checking, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne'."\n", + ], + 'WasmLang' => [ + 'description' => 'The WebAssembly language. Valid values:'."\n" + ."\n" + .'* 0: C++'."\n" + .'* 1: TinyGo'."\n" + .'* 2: Rust'."\n" + .'* 3: AssemblyScript'."\n" + .'* 4: Zig'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PublishState' => [ + 'description' => 'The publish status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WasmFile' => [ + 'description' => 'The URL of the Object Storage Service (OSS) bucket that stores the WebAssembly plug-in.'."\n", + 'type' => 'string', + 'example' => 'https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm', + ], + 'Status' => [ + 'description' => 'Indicates whether the plug-in is enabled.'."\n" + ."\n" + .'* 0: disabled'."\n" + .'* 1: enabled'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Mode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'NewVersionPublishingFlag' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => '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', + ], + ], + [ + [ + '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\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"message\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"Category\\": 0,\\n \\"Name\\": \\"key-auth\\",\\n \\"Version\\": \\"v1\\",\\n \\"Summary\\": \\"这是一个插件\\",\\n \\"SummaryEn\\": \\"\\",\\n \\"Phase\\": 1,\\n \\"Priority\\": 1,\\n \\"ConfigCheck\\": \\"# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \\\\\\"name\\\\\\"、\\\\\\"age\\\\\\"、“friends” 字段\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\\\n\\",\\n \\"WasmLang\\": 0,\\n \\"PublishState\\": 1,\\n \\"WasmFile\\": \\"https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm\\",\\n \\"Status\\": \\"1\\",\\n \\"Mode\\": 0,\\n \\"MaxVersion\\": \\"1.0.0\\",\\n \\"NewVersionPublishingFlag\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetPlugins', + ], + 'GetPluginConfig' => [ + 'summary' => 'Obtains plug-in configurations.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '128638', + 'abilityTreeNodes' => [ + 'FEATUREmseKZMVG1', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n", + ], + ], + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway plug-in.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'zh: Chinese en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<GatewayPluginConfigDetail>', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic error code.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic error message.'."\n", + 'type' => 'string', + 'example' => 'message', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the plug-in.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PrimaryUser' => [ + 'description' => 'The ID of the creator.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Category' => [ + 'description' => 'The category of the plug-in. Valid values:'."\n" + ."\n" + .'0: user-defined'."\n" + ."\n" + .'1: permission authentication'."\n" + ."\n" + .'2: security protection'."\n" + ."\n" + .'3: transmission protocol'."\n" + ."\n" + .'4: traffic control'."\n" + ."\n" + .'5: traffic observation'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Name' => [ + 'description' => 'The name of the plug-in.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'Version' => [ + 'description' => 'The version of the plug-in.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Summary' => [ + 'description' => 'The summary of the plug-in.'."\n", + 'type' => 'string', + 'example' => 'This is a plug-in.'."\n", + ], + 'SummaryEn' => [ + 'type' => 'string', + ], + 'Readme' => [ + 'description' => 'The description of the README file.'."\n", + 'type' => 'string', + 'example' => 'read me', + ], + 'ReadmeEn' => [ + 'description' => 'The description of the README file that is edited in English.'."\n", + 'type' => 'string', + 'example' => 'read me', + ], + 'ConfigExample' => [ + 'title' => '插件配置样例', + 'type' => 'string', + ], + 'Phase' => [ + 'description' => 'The execution stage of the plug-in. Valid values:'."\n" + ."\n" + .'0: default stage'."\n" + ."\n" + .'1: authorization stage'."\n" + ."\n" + .'2: authentication stage'."\n" + ."\n" + .'3: statistics stage'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Priority' => [ + 'description' => 'The execution priority of the plug-in. A larger value indicates a higher priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ConfigCheck' => [ + 'description' => 'The information about the plug-in configuration used for checking.'."\n", + 'type' => 'string', + 'example' => '\\# The configuration includes the fields required for checking, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne'."\n", + ], + 'Mode' => [ + 'description' => 'The mode.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WasmLang' => [ + 'description' => 'The WebAssembly language. Valid values:'."\n" + ."\n" + .'0: C++'."\n" + ."\n" + .'1: TinyGo'."\n" + ."\n" + .'2: Rust'."\n" + ."\n" + .'3: AssemblyScript'."\n" + ."\n" + .'4: Zig'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageName' => [ + 'description' => 'The name of the image.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'PublishState' => [ + 'description' => 'The publish status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => 'Indicates whether the plug-in is enabled. Valid values:'."\n" + ."\n" + .'0: disabled'."\n" + ."\n" + .'1: enabled'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'GatewayConfigList' => [ + 'description' => 'The list of gateway plug-in configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the plug-in configuration.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', + ], + 'PluginId' => [ + 'description' => 'The ID of the gateway plug-in.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Enable' => [ + 'description' => 'Indicates whether the plug-in is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Config' => [ + 'description' => 'The plug-in configuration.'."\n", + 'type' => 'string', + 'example' => '\\# Configure a check for the required fields of the plug-in, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne'."\n", + ], + 'ConfigLevel' => [ + 'description' => 'The application scope of the plug-in. Valid values:'."\n" + ."\n" + .'0: global'."\n" + ."\n" + .'1: domain names'."\n" + ."\n" + .'2: routes'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceList' => [ + 'title' => '域名/路由资源列表（根据ConfigLevel区分）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Name' => [ + 'title' => '资源名称（域名/路由名）', + 'type' => 'string', + 'example' => 'test-route', + ], + ], + ], + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '1667309705000', + ], + 'GmtModified' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '1667309705000', + ], + ], + ], + 'title' => '网关插件配置规则列表。规则排列顺序为路由级规则、域名级规则、实例级规则', + ], + 'RouteConfigStartIndex' => [ + 'title' => '路由级规则在GatewayConfigList中的起始下标。若不存在路由级规则，值为-1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DomainConfigStartIndex' => [ + 'title' => '域名级规则在GatewayConfigList中的起始下标。若不存在域名级规则，值为-1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'GatewayConfigStartIndex' => [ + 'title' => '实例规则在GatewayConfigList中的下标。若不存在实例级规则，值为-1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'VersionJson' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"message\\",\\n \\"Data\\": {\\n \\"Id\\": 1,\\n \\"PrimaryUser\\": \\"123\\",\\n \\"Type\\": 0,\\n \\"Category\\": 0,\\n \\"Name\\": \\"name\\",\\n \\"Version\\": \\"v1\\",\\n \\"Summary\\": \\"这是一个插件。\\",\\n \\"SummaryEn\\": \\"\\",\\n \\"Readme\\": \\"read me\\",\\n \\"ReadmeEn\\": \\"read me\\",\\n \\"ConfigExample\\": \\"\\",\\n \\"Phase\\": 0,\\n \\"Priority\\": 1,\\n \\"ConfigCheck\\": \\"# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \\\\\\"name\\\\\\"、\\\\\\"age\\\\\\"、“friends” 字段\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\",\\n \\"Mode\\": 0,\\n \\"WasmLang\\": 0,\\n \\"ImageName\\": \\"name\\",\\n \\"PublishState\\": 1,\\n \\"Status\\": \\"1\\",\\n \\"GatewayConfigList\\": [\\n {\\n \\"Id\\": 1,\\n \\"GatewayId\\": 1,\\n \\"GatewayUniqueId\\": \\"gw-ubuwqygbq4783gqb2y3f87q****\\",\\n \\"PluginId\\": 1,\\n \\"Enable\\": true,\\n \\"Config\\": \\"# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \\\\\\"name\\\\\\"、\\\\\\"age\\\\\\"、“friends” 字段\\\\nname: John\\\\nage: 18\\\\nfriends:\\\\n- David\\\\n- Anne\\",\\n \\"ConfigLevel\\": 0,\\n \\"ResourceList\\": [\\n {\\n \\"Id\\": 0,\\n \\"Name\\": \\"test-route\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"1667309705000\\",\\n \\"GmtModified\\": \\"1667309705000\\"\\n }\\n ],\\n \\"RouteConfigStartIndex\\": 0,\\n \\"DomainConfigStartIndex\\": 5,\\n \\"GatewayConfigStartIndex\\": 7,\\n \\"VersionJson\\": \\"[{\\\\\\"id\\\\\\":1, \\\\\\"version\\\\\\": \\\\\\"1.0.0\\\\\\"}]\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetPluginConfig', + ], + 'CreatePluginConfig' => [ + 'summary' => 'Creates a plug-in configuration.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '219339', + 'abilityTreeNodes' => [ + 'FEATUREmseKZMVG1', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关唯一ID', + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', + ], + ], + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关插件ID', + 'description' => 'The gateway plug-in ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'ConfigLevel', + 'in' => 'query', + 'schema' => [ + 'title' => '插件应用范围。'."\n" + ."\n" + .'- 全局：0'."\n" + .'- 路由：1'."\n" + .'- 域名：2', + 'description' => 'The application scope of the plug-in. Valid values:'."\n" + ."\n" + .'* 0: global'."\n" + .'* 1: route'."\n" + .'* 2: domain name'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => [ + 'title' => '插件配置。Wasm 插件配置内容是 YAML 格式，Lua 插件配置内容是 Lua 代码。', + 'description' => 'The plug-in configuration. The configuration content of the WebAssembly (Wasm) plug-in is in the YAML format. The configuration content of the Lua plug-in is Lua code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'status_code: 200'."\n" + .'headers:'."\n" + .'- Content-Type=application/json'."\n" + .'body: "{\\"rule\\": \\"global\\"}"', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启。', + 'description' => 'Indicates whether the plug-in is enabled.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '域名ID/路由ID列表（根据ConfigLevel区分）', + 'description' => 'The domain IDs or route IDs. They are distinguished based on ConfigLevel.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'ID值', + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Long>', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', + ], + 'PluginConfigID' => [ + 'title' => '插件配置ID', + 'description' => 'The plug-in configuration ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + '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\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"PluginConfigID\\": 10\\n}","type":"json"}]', + 'title' => 'CreatePluginConfig', + ], + 'UpdatePluginConfig' => [ + 'summary' => 'Updates plug-in configurations.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '128635', + 'abilityTreeNodes' => [ + 'FEATUREmseKZMVG1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the plug-in configuration.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'deprecated' => true, + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****', + ], + ], + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway plug-in.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the plug-in.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The plug-in configuration. Configurations of WebAssembly plug-ins are in the YAML format, and configurations of Lua plug-ins are in the Lua code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '\\# Configure a check for the required fields of the plug-in, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne'."\n", + ], + ], + [ + 'name' => 'ConfigLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application scope of the plug-in.'."\n" + ."\n" + .'* 0: global'."\n" + .'* 1: route'."\n" + .'* 2: domain name'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '域名ID/路由ID列表（根据ConfigLevel区分）', + 'type' => 'array', + 'items' => [ + 'title' => 'ID值', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + [ + 'name' => 'GmtCreate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1667309705000', + 'deprecated' => true, + ], + ], + [ + 'name' => 'GmtModified', + 'in' => 'query', + 'schema' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1667309705000', + 'deprecated' => true, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'zh: Chinese en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Long>', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned.'."\n", + 'type' => 'string', + 'example' => '500', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'DynamicMessage' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'Data' => [ + 'description' => 'The ID of the plug-in configuration.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + '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\\": \\"03A3E2F4-6804-5663-9D5D-2EC47A1*****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"500\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"code\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'UpdatePluginConfig', + ], + 'DeletePluginConfig' => [ + 'summary' => 'Deletes a plug-in configuration.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '217729', + 'abilityTreeNodes' => [ + 'FEATUREmseKZMVG1', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关唯一ID', + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + ], + [ + 'name' => 'PluginConfigId', + 'in' => 'query', + 'schema' => [ + 'title' => '插件配置ID', + 'description' => 'The plug-in configuration ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '200', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Void>', + 'description' => 'RestResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\"\\n}","type":"json"}]', + 'title' => 'DeletePluginConfig', + ], + 'AddSSLCert' => [ + 'summary' => 'Associates a certificate with a domain name of a gateway. You can specify a certificate that is hosted in Alibaba Cloud Security.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '35701', + 'abilityTreeNodes' => [ + 'FEATUREmseM77BTJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the certificate.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '5213641-cn-hangzhou', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E1CC74F0-5BDE-5220-A031-5CA622D80723', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Indicates whether the association is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1CC74F0-5BDE-5220-A031-5CA622D80723\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'AddSSLCert', + ], + 'AddGatewayDomain' => [ + 'summary' => 'Associates a domain name with a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '35639', + 'abilityTreeNodes' => [ + 'FEATUREmseM77BTJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'MustHttps', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable HTTPS.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the certificate.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6828169-cn-hangzhou', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test.com', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the protocol. Valid values:'."\n" + ."\n" + .'* `HTTP`'."\n" + .'* `HTTPS`'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', + ], + ], + [ + 'name' => 'Http2', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable `HTTP/2`.'."\n" + ."\n" + .'* `open`: enables `HTTP/2`'."\n" + .'* `close`: disables `HTTP/2`'."\n" + .'* `globalConfig`: uses global configurations'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'close', + ], + ], + [ + 'name' => 'TlsMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum version of Transport Layer Security (TLS).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TLS 1.3', + ], + ], + [ + 'name' => 'TlsMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum version of TLS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TLS 1.0', + ], + ], + [ + 'name' => 'TlsCipherSuitesConfigJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'TLS加密套件配置', + 'type' => 'object', + 'properties' => [ + 'ConfigType' => [ + 'title' => '加密套件配置类型', + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'DEFAULT', + 'CUSTOM', + ], + ], + 'TlsCipherSuites' => [ + 'title' => '加密套件名称列表', + 'type' => 'array', + 'items' => [ + 'title' => '加密套件名称', + 'type' => 'string', + 'example' => 'AES256-SHA', + ], + ], + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '16BA802F-B848-55DF-9F57-CD71B7272D1F', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + '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\\": \\"16BA802F-B848-55DF-9F57-CD71B7272D1F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 100\\n}","type":"json"}]', + 'title' => 'AddGatewayDomain', + ], + 'DeleteGatewayDomain' => [ + 'summary' => 'Deletes a domain name that is associated with a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '35642', + 'abilityTreeNodes' => [ + 'FEATUREmseM77BTJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '109', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-90392d768a3847a7b804c505254d****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '39016EAC-6EDB-52FE-AE20-4B013DF236FF', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'CONTACTINFO', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597c****', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '253', + ], + 'Protocol' => [ + 'description' => 'The protocol.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'MustHttps' => [ + 'description' => 'Indicates whether HTTP probing is allowed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CertIdentifier' => [ + 'description' => 'The ID of the certificate.'."\n", + 'type' => 'string', + 'example' => '243', + ], + 'GmtCreate' => [ + 'description' => 'The time when the domain name was added.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The last modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"39016EAC-6EDB-52FE-AE20-4B013DF236FF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 2,\\n \\"Name\\": \\"CONTACTINFO\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 253,\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"243\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteGatewayDomain', + ], + 'UpdateSSLCert' => [ + 'summary' => 'Updates a certificate.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '35702', + 'abilityTreeNodes' => [ + 'FEATUREmseM77BTJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the domain name.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '210', + ], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the certificate.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5951436-cn-hangzhou', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-2a99625886d54722be94d92e9a69****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CA689BED-08F3-54C2-A206-A0924E2ACA0A', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Indicates whether the update is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA689BED-08F3-54C2-A206-A0924E2ACA0A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'UpdateSSLCert', + ], + 'UpdateGatewayDomain' => [ + 'summary' => 'Modifies the information about the domain name associated with a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '35640', + 'abilityTreeNodes' => [ + 'FEATUREmseM77BTJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the protocol. Valid values:'."\n" + ."\n" + .'* HTTPS'."\n" + .'* HTTP'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTPS', + ], + ], + [ + 'name' => 'MustHttps', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to forcibly use HTTPS.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the certificate.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6209108-cn-hangzhou', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the domain name that you want to update.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '94', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', + ], + ], + [ + 'name' => 'Http2', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable `HTTP/2`.'."\n" + ."\n" + .'* `open`: `HTTP/2` is enabled.'."\n" + .'* `close`: `HTTP/2` is disabled.'."\n" + .'* `globalConfig`: Global configurations are used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'close', + ], + ], + [ + 'name' => 'TlsMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum version of Transport Layer Security (TLS).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TLS 1.3', + ], + ], + [ + 'name' => 'TlsMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum version of TLS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TLS 1.0', + ], + ], + [ + 'name' => 'TlsCipherSuitesConfigJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigType' => [ + 'type' => 'string', + ], + 'TlsCipherSuites' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '403', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '94', + ], + ], + ], + ], + ], + '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\\": \\"6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 403,\\n \\"Success\\": true,\\n \\"Data\\": 94\\n}","type":"json"}]', + 'title' => 'UpdateGatewayDomain', + ], + 'ListSSLCert' => [ + 'summary' => 'Obtains a list of gateway certificates.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'title' => '按证书名称模糊搜索', + 'type' => 'string', + 'example' => 'certabc', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CAA9A229-141D-5FBA-AC5C-516C02026A11', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'CertIdentifier' => [ + 'description' => 'The ID of the certificate.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + 'CertName' => [ + 'description' => 'The name of the certificate.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + 'CommonName' => [ + 'description' => 'The domain name with which the certificate is associated.'."\n", + 'type' => 'string', + 'example' => '*.test.com', + ], + 'Sans' => [ + 'description' => 'The SSL certificate.'."\n", + 'type' => 'string', + 'example' => 'SSL', + ], + 'BeforeDate' => [ + 'description' => 'The time when the certificate took effect. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'string', + 'example' => '2031-03-30 02:35:12', + ], + 'AfterDate' => [ + 'description' => 'The time when the certificate expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'string', + 'example' => ' 2021-04-01 02:35:12', + ], + 'Algorithm' => [ + 'description' => 'The algorithm.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Issuer' => [ + 'description' => 'The issuer of the certificate.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GmtBefore' => [ + 'description' => 'The time when the certificate took effect. This value is a GMT timestamp.'."\n", + 'type' => 'string', + 'example' => '2031-03-30 02:35:12', + ], + 'GmtAfter' => [ + 'description' => 'The time when the certificate expires. This value is a GMT timestamp.'."\n", + 'type' => 'string', + 'example' => '2021-04-01 02:35:12', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"CAA9A229-141D-5FBA-AC5C-516C02026A11\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"CertIdentifier\\": \\"1234\\",\\n \\"CertName\\": \\"test.com\\",\\n \\"CommonName\\": \\"*.test.com\\",\\n \\"Sans\\": \\"SSL\\",\\n \\"BeforeDate\\": \\"1694503184803\\",\\n \\"AfterDate\\": \\"1726039184803\\",\\n \\"Algorithm\\": \\"test\\",\\n \\"Issuer\\": \\"test\\",\\n \\"GmtBefore\\": \\"2023-09-12T07:19:44.803+0000\\",\\n \\"GmtAfter\\": \\"2024-09-11T07:19:44.803+0000\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListSSLCert', + ], + 'ListGatewayDomain' => [ + 'summary' => 'Queries the domain names that are associated with a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '35641', + 'abilityTreeNodes' => [ + 'FEATUREmseM77BTJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-c9bc5afd61014165bd58f621b491****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the domain name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'title' => '按域名模糊搜索', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3F5D8E93-CA66-57F1-8BCF-A223E11B6B91', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the domain name.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '243', + ], + 'Name' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + 'Protocol' => [ + 'description' => 'The protocol.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'MustHttps' => [ + 'description' => 'Indicates whether HTTPS is forcefully used.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CertIdentifier' => [ + 'description' => 'The certificate ID.'."\n", + 'type' => 'string', + 'example' => '3452-cn-hangzhou', + ], + 'CertBeforeDate' => [ + 'description' => 'The time when the certificate expires.'."\n", + 'type' => 'string', + 'example' => ' 2031-03-30 02:35:12', + ], + 'GatewayId' => [ + 'description' => 'The gateway ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'GmtCreate' => [ + 'description' => 'The time when the domain name was created.'."\n", + 'type' => 'string', + 'example' => ' 2031-03-30 02:35:12', + ], + 'GmtModified' => [ + 'description' => 'The time when the domain name was updated.'."\n", + 'type' => 'string', + 'example' => ' 2031-03-30 02:35:12', + ], + 'Status' => [ + 'description' => 'The state of the domain name. Valid values:'."\n" + ."\n" + .'* 0: unpublished'."\n" + .'* 2: publishing'."\n" + .'* 3: published'."\n" + .'* 4: editing'."\n" + .'* 5: unpublishing'."\n" + .'* 6: unavailable'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Type' => [ + 'description' => 'The type of the domain name source. Valid values:'."\n" + ."\n" + .'* Op: console'."\n" + .'* Ingress: MSE Ingress'."\n", + 'type' => 'string', + 'example' => 'Op', + ], + 'Comment' => [ + 'description' => 'The route comment. This parameter is returned only in ingress scenarios.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The route status.'."\n", + 'type' => 'string', + 'example' => 'Error', + ], + ], + ], + 'Http2' => [ + 'description' => 'Indicates whether `HTTP/2` is enabled.'."\n" + ."\n" + .'* `open`: `HTTP/2` is enabled.'."\n" + .'* `close`: `HTTP/2` is disabled.'."\n" + .'* `globalConfig`: Global configurations are used.'."\n", + 'type' => 'string', + 'example' => 'close', + ], + 'TlsMax' => [ + 'description' => 'The maximum version of Transport Layer Security (TLS).'."\n", + 'type' => 'string', + 'example' => 'TLS 1.3', + ], + 'TlsMin' => [ + 'description' => 'The minimum version of TLS.'."\n", + 'type' => 'string', + 'example' => 'TLS 1.0', + ], + 'IsManaged' => [ + 'title' => '是否为托管域名', + 'type' => 'boolean', + ], + 'TlsCipherSuitesConfig' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigType' => [ + 'type' => 'string', + ], + 'TlsCipherSuites' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"3F5D8E93-CA66-57F1-8BCF-A223E11B6B91\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 243,\\n \\"Name\\": \\"test.com\\",\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"3452-cn-hangzhou\\",\\n \\"CertBeforeDate\\": \\" 2031-03-30 02:35:12\\",\\n \\"GatewayId\\": 12,\\n \\"GmtCreate\\": \\" 2031-03-30 02:35:12\\",\\n \\"GmtModified\\": \\" 2031-03-30 02:35:12\\",\\n \\"Status\\": 3,\\n \\"Type\\": \\"Op\\",\\n \\"Comment\\": {\\n \\"Status\\": \\"Error\\"\\n },\\n \\"Http2\\": \\"close\\",\\n \\"TlsMax\\": \\"TLS 1.3\\",\\n \\"TlsMin\\": \\"TLS 1.0\\",\\n \\"IsManaged\\": true,\\n \\"TlsCipherSuitesConfig\\": {\\n \\"ConfigType\\": \\"\\",\\n \\"TlsCipherSuites\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListGatewayDomain', + ], + 'GetGatewayDomainDetail' => [ + 'summary' => 'Queries the details of a domain name associated with a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '35699', + 'abilityTreeNodes' => [ + 'FEATUREmseM77BTJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '29', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-6d0b23e1d39e41658a968d79a635****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '88B83302-CD88-54D3-8DF2-208BFDC73F0D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '403', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Name' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Protocol' => [ + 'description' => 'The protocol of the gateway.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'MustHttps' => [ + 'description' => 'Indicates whether HTTPS is forcibly used.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CertIdentifier' => [ + 'description' => 'The ID of the certificate.'."\n", + 'type' => 'string', + 'example' => '234-cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'CertName' => [ + 'description' => 'The name of the certificate.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'CommonName' => [ + 'description' => 'The public domain name.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'Sans' => [ + 'description' => 'The name of the extended field.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + 'BeforeDate' => [ + 'description' => 'The expiration time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-04-01 02:35:12', + ], + 'AfterDate' => [ + 'description' => 'The start time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-04-01 02:35:12', + ], + 'Algorithm' => [ + 'description' => 'The algorithm.'."\n", + 'type' => 'string', + 'example' => 'RSA', + ], + 'Issuer' => [ + 'description' => 'The issuer.'."\n", + 'type' => 'string', + 'example' => 'Istio', + ], + 'GmtBefore' => [ + 'description' => 'The expiration time.'."\n", + 'type' => 'string', + 'example' => '2021-04-01 02:35:12', + ], + 'GmtAfter' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '2021-04-01 02:35:12', + ], + 'Http2' => [ + 'description' => 'Indicates whether `HTTP/2` is enabled.'."\n" + ."\n" + .'* `open`: `HTTP/2` is enabled.'."\n" + .'* `close`: `HTTP/2` is disabled.'."\n" + .'* `globalConfig`: Global configurations are used.'."\n", + 'type' => 'string', + 'example' => 'close', + ], + 'TlsMax' => [ + 'description' => 'The maximum version of Transport Layer Security (TLS).'."\n", + 'type' => 'string', + 'example' => 'TLS 1.3', + ], + 'TlsMin' => [ + 'description' => 'The minimum version of TLS.'."\n", + 'type' => 'string', + 'example' => 'TLS 1.0', + ], + 'IsManaged' => [ + 'title' => '是否为托管域名', + 'type' => 'boolean', + ], + 'TlsCipherSuitesConfig' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigType' => [ + 'type' => 'string', + ], + 'TlsCipherSuites' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"88B83302-CD88-54D3-8DF2-208BFDC73F0D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 403,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test.com\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"GatewayId\\": 1,\\n \\"Protocol\\": \\"HTTP\\",\\n \\"MustHttps\\": true,\\n \\"CertIdentifier\\": \\"234-cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"CertName\\": \\"test\\",\\n \\"CommonName\\": \\"name\\",\\n \\"Sans\\": \\"test.com\\",\\n \\"BeforeDate\\": 0,\\n \\"AfterDate\\": 0,\\n \\"Algorithm\\": \\"RSA\\",\\n \\"Issuer\\": \\"Istio\\",\\n \\"GmtBefore\\": \\"2021-04-01 02:35:12\\",\\n \\"GmtAfter\\": \\"2021-04-01 02:35:12\\",\\n \\"Http2\\": \\"close\\",\\n \\"TlsMax\\": \\"TLS 1.3\\",\\n \\"TlsMin\\": \\"TLS 1.0\\",\\n \\"IsManaged\\": true,\\n \\"TlsCipherSuitesConfig\\": {\\n \\"ConfigType\\": \\"\\",\\n \\"TlsCipherSuites\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayDomainDetail', + ], + 'AddGateway' => [ + 'summary' => 'Adds a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '24670', + 'abilityTreeNodes' => [ + 'FEATUREmseYEACIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '网关名称', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-ceshi', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => 'The specifications of the internal-facing Server Load Balancer (SLB) instance. Valid values:'."\n" + ."\n" + .'* slb.s1.small'."\n" + .'* slb.s2.small'."\n" + .'* slb.s2.medium'."\n" + .'* slb.s3.small'."\n" + .'* slb.s3.medium'."\n" + .'* slb.s3.large'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Vpc', + 'in' => 'query', + 'schema' => [ + 'title' => '专有网络ID', + 'description' => 'The ID of the primary vSwitch.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp15mncnrtm83uauxd1xb', + ], + ], + [ + 'name' => 'ZoneInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The details of the zone.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen-e', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp*****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'title' => '主交换机ID', + 'description' => 'The ID of the primary vSwitch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1q8th57frl5khj2li43', + ], + ], + [ + 'name' => 'VSwitchId2', + 'in' => 'query', + 'schema' => [ + 'title' => '备交换机ID', + 'description' => 'Specifies whether to use an advanced security group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-wz9bu6o5vsvitt5mrxo6s', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method you specify when you purchase an ordinary instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PREPAY: subscription'."\n" + .'* POSTPAY: pay-as-you-go'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PREPAY' => '', + 'POSTPAY' => '', + ], + 'example' => 'POSTPAY', + 'enum' => [ + 'PREPAY', + 'POSTPAY', + ], + ], + ], + [ + 'name' => 'MserVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '网关产品类型：'."\n" + .'- mse_pro：传统实例'."\n" + .'- mse_serverless：Serverless', + 'description' => 'The MSE instance type. Valid values:'."\n" + ."\n" + .'* mse_pro: ordinary instance'."\n" + .'* mse_serverless: serverless instance'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_pro', + 'default' => 'mse_pro', + 'enum' => [ + 'mse_premium', + 'mse_pro', + 'mse_serverless', + ], + ], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => [ + 'title' => '节点规格', + 'description' => 'The node specifications you specify when you purchase an ordinary instance. Valid values:'."\n" + ."\n" + .'* MSE_GTW\\_16\\_32\\_200\\_c(16C32G)'."\n" + .'* MSE_GTW\\_2\\_4\\_200\\_c(2C4G)'."\n" + .'* MSE_GTW\\_4\\_8\\_200\\_c(4C8G)'."\n" + .'* MSE_GTW\\_8\\_16\\_200\\_c(8C16G)'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MSE_GTW_16_32_200_c' => '16C32G', + 'MSE_GTW_2_4_200_c' => '2C4G', + 'MSE_GTW_4_8_200_c' => '4C8G', + 'MSE_GTW_8_16_200_c' => '8C16G', + ], + 'example' => 'MSE_GTW_2_4_200_c', + 'enum' => [ + 'MSE_GTW_2_4_200_c', + 'MSE_GTW_4_8_200_c', + 'MSE_GTW_8_16_200_c', + 'MSE_GTW_16_32_200_c', + ], + ], + ], + [ + 'name' => 'Replica', + 'in' => 'query', + 'schema' => [ + 'title' => '节点数量', + 'description' => 'The number of nodes you specify when you purchase an ordinary instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ManagedEntryNetworkType', + 'in' => 'query', + 'schema' => [ + 'title' => '网关入口类型（普通实例专业版适用）', + 'type' => 'string', + 'example' => 'pubnet', + 'enum' => [ + 'pubnet', + 'privatenet', + 'privatepubnet', + ], + ], + ], + [ + 'name' => 'NlbNetworkType', + 'in' => 'query', + 'schema' => [ + 'title' => '代购NLB的网络类型：'."\n" + .'- pubnet：公网'."\n" + .'- privatenet：私网'."\n" + .'- privatepubnet：公网+私网', + 'description' => 'The network type of the Network Load Balancer (NLB) instance you specify when you purchase a serverless instance.'."\n" + ."\n" + .'* pubnet: Internet'."\n" + .'* privatenet: private network'."\n" + .'* privatepubnet: Internet and private network'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pubnet', + 'enum' => [ + 'pubnet', + 'privatenet', + 'privatepubnet', + ], + ], + ], + [ + 'name' => 'ClbNetworkType', + 'in' => 'query', + 'schema' => [ + 'title' => '代购按LCU计费的CLB的网络类型：'."\n" + .'- pubnet：公网'."\n" + .'- privatenet：私网'."\n" + .'- privatepubnet：公网+私网', + 'description' => 'The network type of the purchased Classic Load Balancer (CLB) instance that is billed based on LCUs.'."\n" + ."\n" + .'* pubnet: Internet'."\n" + .'* privatenet: private network'."\n" + .'* privatepubnet: Internet and private network'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pubnet', + 'enum' => [ + 'pubnet', + 'privatenet', + 'privatepubnet', + ], + ], + ], + [ + 'name' => 'SlbSpec', + 'in' => 'query', + 'schema' => [ + 'title' => '内网SLB规格', + 'description' => 'The specifications of the internal-facing Server Load Balancer (SLB) instance. Valid values:'."\n" + ."\n" + .'* slb.s1.small'."\n" + .'* slb.s2.small'."\n" + .'* slb.s2.medium'."\n" + .'* slb.s3.small'."\n" + .'* slb.s3.medium'."\n" + .'* slb.s3.large'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slb.s2.small', + 'deprecated' => true, + ], + ], + [ + 'name' => 'InternetSlbSpec', + 'in' => 'query', + 'schema' => [ + 'title' => '外网SLB规格', + 'description' => 'The specifications of the Internet-facing Server Load Balancer (SLB) instance. Valid values:'."\n" + ."\n" + .'* slb.s1.small'."\n" + .'* slb.s2.smal'."\n" + .'* slb.s2.medium'."\n" + .'* slb.s3.small'."\n" + .'* slb.s3.medium'."\n" + .'* slb.s3.large'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slb.s2.small', + 'deprecated' => true, + ], + ], + [ + 'name' => 'EnterpriseSecurityGroup', + 'in' => 'query', + 'schema' => [ + 'title' => '是否企业安全组类型', + 'description' => 'Specifies whether to enable hardware acceleration.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'EnableHardwareAcceleration', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启硬件加速', + 'description' => 'Specifies whether to activate Tracing Analysis.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'EnableXtrace', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启xtrace', + 'description' => 'The sampling rate of Tracing Analysis. Valid values: \\[1,100].'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'XtraceRatio', + 'in' => 'query', + 'schema' => [ + 'title' => 'xtrace采样率，取值[0,100]', + 'description' => 'Specifies whether to activate Log Service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'EnableSls', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否开启SLS日志投递', + 'description' => 'The tag of the gateway.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => 'The tag object.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm34x43l*****', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The ID of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C', + ], + 'HttpStatusCode' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The request is successfully processed.'."\n", + 'type' => 'string', + 'example' => 'The return value.'."\n", + ], + 'Code' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'object', + 'properties' => [ + 'GatewayUniqueId' => [ + 'description' => 'code', + 'type' => 'string', + 'example' => 'gw-5017305290e14cebbrvec4a5****', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14cebbrvec4a5****\\"\\n }\\n}","type":"json"}]', + 'title' => 'AddGateway', + ], + 'ListGatewayZone' => [ + 'summary' => 'Obtains a list of zones where a gateway is available.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + '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' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'NO_PERMISSION', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'DynamicCode' => [ + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace %s in **ErrMessage**.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The queried zones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'LocalName' => [ + 'description' => 'The local name of the zone.'."\n", + 'type' => 'string', + 'example' => 'I', + ], + 'SupportQat' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"NO_PERMISSION\\",\\n \\"HttpStatusCode\\": 200,\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"LocalName\\": \\"I\\",\\n \\"SupportQat\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListGatewayZone', + ], + 'AddGatewaySlb' => [ + 'summary' => 'Associates a Server Load Balancer (SLB) instance with a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '71795', + 'abilityTreeNodes' => [ + 'FEATUREmseMNDRFM', + ], + ], + 'parameters' => [ + [ + 'name' => 'SlbId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the SLB instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'lb-bp18t6jjskwxh6wy1****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service source. Valid values:'."\n" + ."\n" + .'* PUB_NET: Internet'."\n" + .'* PRIVATE_NET: VPC'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PUB_NET', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', + ], + ], + [ + 'name' => 'VServerGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the HTTP virtual service group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '353', + ], + ], + [ + 'name' => 'ServiceWeight', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service weight.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'HttpPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTP port number (virtual service group).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'HttpsPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTPS port number (virtual service group).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '443', + ], + ], + [ + 'name' => 'HttpsVServerGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the HTTPS virtual service group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '353', + ], + ], + [ + 'name' => 'VServiceList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The SLB monitoring information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VServerGroupId' => [ + 'description' => 'The ID of the virtual server group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rsp-bp1j**t0fyl**', + ], + 'VServerGroupName' => [ + 'description' => 'The name of the virtual server group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'k8s/31**0/***/istio-system/clusterid', + ], + 'Port' => [ + 'description' => 'The port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '443', + ], + 'Protocol' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTPS', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'string', + 'example' => 'lb-uf6dqr4ondqi5w3df7hdf', + ], + ], + ], + ], + ], + '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\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"lb-uf6dqr4ondqi5w3df7hdf\\"\\n}","type":"json"}]', + 'title' => 'AddGatewaySlb', + ], + 'AddSecurityGroupRule' => [ + 'summary' => 'Creates a security group rule for a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '安全组ID', + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sg-wz929kxhcdpw9z8idqd8', + ], + ], + [ + 'name' => 'PortRange', + 'in' => 'query', + 'schema' => [ + 'title' => '端口范围', + 'description' => 'The range of port numbers.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1/65535', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关ID', + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-c9bc5afd61014165bd58f621b491****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'string', + 'example' => '12', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '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\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"12\\"\\n}","type":"json"}]', + 'title' => 'AddSecurityGroupRule', + ], + 'DeleteGateway' => [ + 'summary' => 'Deletes a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '24808', + 'abilityTreeNodes' => [ + 'FEATUREmseYEACIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeleteSlb', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to delete the SLB instance purchased for the gateway when you delete the gateway.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0fe488252dc44d55a9dd57875193a1d7', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The HTTP status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the primary key.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Name' => [ + 'description' => 'The name of the gateway.'."\n", + 'type' => 'string', + 'example' => 'mse-bc1a29b0-reg-center-0-1', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway. The ID is automatically generated by the system.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597c****', + ], + 'Region' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PrimaryUser' => [ + 'description' => 'The information about the user.'."\n", + 'type' => 'string', + 'example' => '1231254', + ], + 'Status' => [ + 'description' => 'The status of the gateway. Valid values: 0: The gateway is being created. 1: The gateway fails to be created. 2: The gateway is running. 3: The gateway is changing. 4: The gateway is scaling down. 6: The gateway is scaling up. 8: The gateway is being deleted. 10: The gateway is restarting. 11: The gateway is being rebuilt. 12: The gateway is updating. 13: The gateway fails to be updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Vpc' => [ + 'description' => 'The ID of the virtual private cloud (VPC) where the gateway resides.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1328cm01m6uel42b5zb', + ], + 'Vswitch' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp18zeqxx6mpuq843z4n5', + ], + 'SecurityGroup' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-bp11ufzqn6mmb8dtzz82', + ], + 'Spec' => [ + 'description' => 'The specifications of the gateway.'."\n", + 'type' => 'string', + 'example' => 'MSE_GTW_16_32_200_c', + ], + 'Replica' => [ + 'description' => 'The number of gateway replicas.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The time when the gateway was last updated.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"mse-bc1a29b0-reg-center-0-1\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"1231254\\",\\n \\"Status\\": 1,\\n \\"Vpc\\": \\"vpc-bp1328cm01m6uel42b5zb\\",\\n \\"Vswitch\\": \\"vsw-bp18zeqxx6mpuq843z4n5\\",\\n \\"SecurityGroup\\": \\"sg-bp11ufzqn6mmb8dtzz82\\",\\n \\"Spec\\": \\"MSE_GTW_16_32_200_c\\",\\n \\"Replica\\": 2,\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteGateway', + ], + 'DeleteGatewaySlb' => [ + 'summary' => 'Deletes the Server Load Balancer (SLB) instance that is associated with a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '71802', + 'abilityTreeNodes' => [ + 'FEATUREmseMNDRFM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the association record.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '395', + ], + ], + [ + 'name' => 'DeleteSlb', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to delete the SLB instance purchased for the gateway when you delete the gateway.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-c9bc5afd61014165bd58f621b491****', + ], + ], + [ + 'name' => 'SlbId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the SLB instance that needs to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lb-uf6duug6s13x4abc8****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The deletion result.'."\n", + 'type' => 'string', + 'example' => '28', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9297B27D-D932-5E9F-93B9-99D6C5F3A879\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": \\"28\\"\\n}","type":"json"}]', + 'title' => 'DeleteGatewaySlb', + ], + 'DeleteSecurityGroupRule' => [ + 'summary' => 'Deletes a security group rule from a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '93', + ], + ], + [ + 'name' => 'CascadingDelete', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '43E50CB7-258E-5AFF-9B93-ECC19928C699', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-uf6hgwe067prhg68agfa', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597c****', + ], + 'PortRange' => [ + 'description' => 'The range of ports for the transport layer protocol in the destination security group. Valid values:'."\n" + ."\n" + .'* When the IpProtocol parameter is set to tcp or udp, the port number range is 1 to 65535. The start port number and the end port number are separated by a forward slash (/). Example: 1/200.'."\n" + .'* If the IpProtocol parameter is set to icmp, the port number range is -1/-1, which indicates all ports.'."\n" + .'* If the IpProtocol parameter is set to gre, the port number range is -1/-1, which indicates all ports.'."\n" + .'* If the IpProtocol parameter is set to all, the port number range is -1/-1, which indicates all ports.'."\n", + 'type' => 'string', + 'example' => '8443/8443', + ], + 'IpProtocol' => [ + 'description' => 'The transport layer protocol. The value of this parameter is case-insensitive. Valid values:'."\n" + ."\n" + .'* icmp'."\n" + .'* gre'."\n" + .'* tcp'."\n" + .'* udp'."\n" + .'* all: All protocols are supported.'."\n", + 'type' => 'string', + 'example' => 'tcp', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '103', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-11T14:12:55.000+0000', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'auto-description1', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"43E50CB7-258E-5AFF-9B93-ECC19928C699\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 2,\\n \\"SecurityGroupId\\": \\"sg-uf6hgwe067prhg68agfa\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"PortRange\\": \\"8443/8443\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"GatewayId\\": 103,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-11T14:12:55.000+0000\\",\\n \\"Description\\": \\"auto-description1\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteSecurityGroupRule', + ], + 'UpdateGatewayOption' => [ + 'summary' => 'Updates the configurations of a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '421', + ], + ], + [ + 'name' => 'GatewayOption', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The detailed configurations of the gateway.'."\n" + ."\n" + .'* **TraceDetails**: the sampling description of Managed Service for OpenTelemetry. Content: TraceEnabled indicates whether Managed Service for OpenTelemetry is activated. Sample indicates the sampling rate of Managed Service for OpenTelemetry.'."\n" + .'* **LogConfigDetails**: the description of Simple Log Service. Content: LogEnabled indicates whether Simple Log Service is activated. ProjectName indicates the Simple Log Service project to which logs are delivered. LogStoreName indicates the name of the Logstore.'."\n" + .'* **EnableHardwareAcceleration**: indicates whether hardware acceleration is enabled.'."\n" + .'* **DisableHttp2Alpn**: indicates whether the HTTP/2 protocol is disabled.'."\n" + .'* **EnableWaf**: indicates whether Web Application Firewall (WAF) is enabled.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/GatewayOption', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c4****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '124D02EB-DBDD-534D-A701-B4A95D3D****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + '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', + ], + ], + 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', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"124D02EB-DBDD-534D-A701-B4A95D3D****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TraceDetails\\": {\\n \\"TraceEnabled\\": true,\\n \\"Sample\\": 0,\\n \\"TraceType\\": \\"XTRACE\\",\\n \\"ServiceId\\": 0,\\n \\"ServicePort\\": \\"\\"\\n },\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"\\",\\n \\"LogStoreName\\": \\"\\"\\n },\\n \\"EnableHardwareAcceleration\\": true,\\n \\"DisableHttp2Alpn\\": true,\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayOption', + ], + 'UpdateGatewayName' => [ + 'summary' => 'Updates the name of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '66628', + 'abilityTreeNodes' => [ + 'FEATUREmseYEACIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demo-test', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'gw-1cef54brvecdb419fb264d4f9b8c', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8C95711F-E702-5395-BFAA-21BA946CDE47', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'string', + '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\\": \\"8C95711F-E702-5395-BFAA-21BA946CDE47\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'UpdateGatewayName', + ], + 'QueryGatewayRegion' => [ + 'summary' => 'Queries the regions supported by a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9e78a671-4b9b-4dd4-99c1-0b9da87d3dec', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about regions.'."\n", + 'type' => 'string', + 'example' => '{"cn-hanghzou"}', + ], + ], + ], + ], + ], + ], + '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\\": \\"9e78a671-4b9b-4dd4-99c1-0b9da87d3dec\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"{\\\\\\"cn-hanghzou\\\\\\"}\\"\\n ]\\n}","type":"json"}]', + 'title' => 'QueryGatewayRegion', + ], + 'QueryGatewayType' => [ + 'summary' => 'Queries available gateway types.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The information about the gateway type. The data type of this parameter is List.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the gateway.'."\n", + 'type' => 'string', + 'example' => 'Ingress', + ], + ], + ], + ], + ], + ], + '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\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"Ingress\\"\\n ]\\n}","type":"json"}]', + 'title' => 'QueryGatewayType', + ], + 'GetGateway' => [ + 'summary' => 'Obtains the basic information about a gateway, such as the virtual private cloud (VPC) and vSwitch to which the gateway belongs.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92862', + 'abilityTreeNodes' => [ + 'FEATUREmseYEACIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'gw-685f661467b54f48b7b7a76605ce****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The information about the gateway.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Name' => [ + 'description' => 'The name of the gateway.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', + ], + 'Region' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PrimaryUser' => [ + 'description' => 'The Alibaba Cloud account ID of the user who created the gateway.'."\n", + 'type' => 'string', + 'example' => '1231254', + ], + 'Status' => [ + 'description' => 'The status of the gateway. Valid values:'."\n" + ."\n" + .'* 0: The gateway is being created.'."\n" + .'* 1: The gateway fails to be created.'."\n" + .'* 2: The gateway is running.'."\n" + .'* 3: The gateway is changing.'."\n" + .'* 4: The gateway is scaling in.'."\n" + .'* 6: The gateway is scaling out.'."\n" + .'* 8: The gateway is being deleted.'."\n" + .'* 10: The gateway is restarting.'."\n" + .'* 11: The gateway is being rebuilt.'."\n" + .'* 12: The gateway is updating.'."\n" + .'* 13: The gateway fails to be updated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Vpc' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1328cm01m6uel42b5zb', + ], + 'Vswitch' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp18zeqxx6mpuq843z4n5', + ], + 'SecurityGroup' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-bp11ufzqn6mmb8dtzz82', + ], + 'Spec' => [ + 'description' => 'The specifications of the gateway.'."\n", + 'type' => 'string', + 'example' => 'MSE_GTW_16_32_200_c', + ], + 'Replica' => [ + 'description' => 'The number of gateway replicas.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GmtCreate' => [ + 'description' => 'The time when the gateway was created. The time is displayed in GMT. The time is the local time of the region in which the gateway resides.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The time when the gateway was last modified.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'XtraceDetails' => [ + 'description' => 'The details of Tracing Analysis.'."\n", + 'type' => 'object', + 'properties' => [ + 'Sample' => [ + 'description' => 'The sampling rate of Tracing Analysis.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TraceOn' => [ + 'description' => 'Indicates whether sampling by using Tracing Analysis is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Vswitch2' => [ + 'description' => 'The ID of the secondary vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1j6ivhav15ve7q54kq2', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-st21ri2****', + ], + 'ChargeType' => [ + 'description' => 'The billing method, such as subscription or pay-as-you-go.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'EndDate' => [ + 'description' => 'The time when the gateway expires.'."\n", + 'type' => 'string', + 'example' => '2021-08-01 00:00:00', + ], + 'StatusDesc' => [ + 'description' => 'The description of the status.'."\n", + 'type' => 'string', + 'example' => 'Restarting'."\n", + ], + 'LogConfigDetails' => [ + 'description' => 'The log configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogEnabled' => [ + 'description' => 'Indicates whether Log Service is activated.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProjectName' => [ + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'example' => 'k8s-log-c173117256e934a96b7fefdf2ef8a8057', + ], + 'LogStoreName' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'string', + 'example' => 'mse_access_log', + ], + ], + ], + 'MseTag' => [ + 'description' => 'The tag of the resource.'."\n", + 'type' => 'string', + 'example' => '{"TagKey":"TagValue"}', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-acfm34x43l*****', + ], + 'TotalReplica' => [ + 'description' => 'The total number of replicas, including the number of replicas that are automatically scaled out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Elastic' => [ + 'description' => 'Indicates whether auto scale-out is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ElasticReplica' => [ + 'description' => 'The number of replicas that are automatically scaled out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ElasticType' => [ + 'description' => 'The type of auto scale-out. Valid value:'."\n" + ."\n" + .'* CronHPA: scale-out by time'."\n", + 'type' => 'string', + 'example' => 'CronHPA', + ], + 'ElasticPolicy' => [ + 'description' => 'The auto scale-out policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxReplica' => [ + 'description' => 'The maximum number of instances that are automatically scaled out. This parameter is used for horizontal scale-out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ElasticType' => [ + 'description' => 'The type of auto scale-out. Valid value:'."\n" + ."\n" + .'* CronHPA: scale-out by time'."\n", + 'type' => 'string', + 'example' => 'CronHPA', + ], + 'TimePolicyList' => [ + 'description' => 'The policy of scale-out by time.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DesiredReplica' => [ + 'description' => 'The number of expected replicas.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'StartTime' => [ + 'description' => 'The start time of auto scale-out.'."\n", + 'type' => 'string', + 'example' => '16:00', + ], + 'EndTime' => [ + 'description' => 'The end time of auto scale-out.'."\n", + 'type' => 'string', + 'example' => '18:00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"DEFAULT\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"1231254\\",\\n \\"Status\\": 0,\\n \\"Vpc\\": \\"vpc-bp1328cm01m6uel42b5zb\\",\\n \\"Vswitch\\": \\"vsw-bp18zeqxx6mpuq843z4n5\\",\\n \\"SecurityGroup\\": \\"sg-bp11ufzqn6mmb8dtzz82\\",\\n \\"Spec\\": \\"MSE_GTW_16_32_200_c\\",\\n \\"Replica\\": 1,\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"XtraceDetails\\": {\\n \\"Sample\\": 10,\\n \\"TraceOn\\": true\\n },\\n \\"Vswitch2\\": \\"vpc-bp1j6ivhav15ve7q54kq2\\",\\n \\"InstanceId\\": \\"mse-cn-st21ri2****\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"EndDate\\": \\"2021-08-01 00:00:00\\",\\n \\"StatusDesc\\": \\"正在重启中。\\",\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"k8s-log-c173117256e934a96b7fefdf2ef8a8057\\",\\n \\"LogStoreName\\": \\"mse_access_log\\"\\n },\\n \\"MseTag\\": \\"{\\\\\\"TagKey\\\\\\":\\\\\\"TagValue\\\\\\"}\\",\\n \\"ResourceGroupId\\": \\"rg-acfm34x43l*****\\",\\n \\"TotalReplica\\": 3,\\n \\"Elastic\\": true,\\n \\"ElasticReplica\\": 1,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"ElasticPolicy\\": {\\n \\"MaxReplica\\": 5,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"TimePolicyList\\": [\\n {\\n \\"DesiredReplica\\": 2,\\n \\"StartTime\\": \\"16:00\\",\\n \\"EndTime\\": \\"18:00\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetGateway', + ], + 'ListGateway' => [ + 'summary' => 'Queries a list of gateways.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '24675', + 'abilityTreeNodes' => [ + 'FEATUREmseYEACIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OrderItem', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order information.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'DescSort', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the sorting feature. This feature is not available.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FilterParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The details of parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'GatewayType' => [ + 'description' => 'The type of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Ingress', + ], + 'Name' => [ + 'description' => 'The name of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rutain-test', + ], + 'Vpc' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp13hhyjntbab7w****', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gw-5017305290e14centbrveca****', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mse_ingresspre-cn-****', + ], + 'MseTag' => [ + 'description' => 'The tag of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"key":"tagkey","value":"tagvalue"}]', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-7y2uye*****', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '34300B3-52EC-5049-8C96-914098CF****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*', + ], + 'Code' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The gateway ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '153', + ], + 'Name' => [ + 'description' => 'The gateway name.'."\n", + 'type' => 'string', + 'example' => 'tesa-test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-5017305290e14cebb8ce5cb6a4****', + ], + 'GatewayType' => [ + 'description' => 'The gateway type.'."\n", + 'type' => 'string', + 'example' => 'Ingress', + ], + 'Region' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PrimaryUser' => [ + 'description' => 'The user information.'."\n", + 'type' => 'string', + 'example' => '18278117654342', + ], + 'Status' => [ + 'description' => 'The gateway state. Valid values:'."\n" + ."\n" + .'* 0: The gateway is being created.'."\n" + .'* 1: The gateway failed to be created.'."\n" + .'* 2: The gateway is running.'."\n" + .'* 3: The gateway is being changed.'."\n" + .'* 4: The gateway is scaling in.'."\n" + .'* 6: The gateway is scaling out.'."\n" + .'* 8: The gateway is being deleted.'."\n" + .'* 9: The gateway is suspended and is to be released.'."\n" + .'* 10: The gateway is restarting.'."\n" + .'* 11: The gateway is being rebuilt.'."\n" + .'* 12: The gateway is being upgraded.'."\n" + .'* 13: The gateway failed to be upgraded.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AhasOn' => [ + 'description' => 'Indicates whether Application High Availability Service (AHAS) is activated.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ArmsOn' => [ + 'description' => 'Indicates whether Application Real-Time Monitoring Service (ARMS) is activated.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Spec' => [ + 'description' => 'The specifications of the gateway.'."\n", + 'type' => 'string', + 'example' => 'MSE_GTW_1_2_200_c', + ], + 'Replica' => [ + 'description' => 'The number of replicas.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GmtCreate' => [ + 'description' => 'The time when the gateway was created.'."\n", + 'type' => 'string', + 'example' => '2021-09-13 19:24:23', + ], + 'GmtModified' => [ + 'description' => 'The time when the gateway was modified.'."\n", + 'type' => 'string', + 'example' => '2021-09-13 19:24:23', + ], + 'StatusDesc' => [ + 'description' => 'The description of the gateway state.'."\n", + 'type' => 'string', + 'example' => 'Restarting'."\n", + ], + 'Slb' => [ + 'description' => 'The details of Server Load Balancer (SLB) instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the SLB instances.'."\n", + 'type' => 'object', + 'properties' => [ + 'SlbIp' => [ + 'description' => 'The IP address of the SLB instance.'."\n", + 'type' => 'string', + 'example' => '153.12.XX.XX', + ], + 'SlbPort' => [ + 'description' => 'The port number of the SLB instance.'."\n", + 'type' => 'string', + 'example' => '80', + ], + 'SlbSpec' => [ + 'description' => 'The specifications of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'slb.s2.small', + ], + 'Type' => [ + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'* PUB_NET'."\n" + .'* PRIVATE_NET'."\n", + 'type' => 'string', + 'example' => 'PUB_NET', + ], + 'GatewaySlbStatus' => [ + 'description' => 'The state of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'Ready', + ], + 'StatusDesc' => [ + 'description' => 'The description of the state.'."\n", + 'type' => 'string', + 'example' => 'Creating'."\n", + ], + 'GatewaySlbMode' => [ + 'description' => 'The mode of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'UserHost', + ], + 'SlbId' => [ + 'description' => 'The ID of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'lb-bp1ut8asdfgucjk****', + ], + ], + ], + ], + 'InternetSlb' => [ + 'description' => 'The details of the Internet-facing SLB instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'SlbIp' => [ + 'description' => 'The IP address of the SLB instance.'."\n", + 'type' => 'string', + 'example' => '153.12.XX.XX', + ], + 'SlbPort' => [ + 'description' => 'The port number of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'slb.s2.small', + ], + 'SlbSpec' => [ + 'description' => 'The specifications of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'slb.s2.small', + ], + 'Type' => [ + 'description' => 'The type of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'PUB_NET', + ], + 'InternetNetworkFlow' => [ + 'description' => 'The traffic of the gateway.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'GatewaySlbStatus' => [ + 'description' => 'The state of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'Ready', + ], + 'StatusDesc' => [ + 'description' => 'The description of the state.'."\n", + 'type' => 'string', + 'example' => 'Creating'."\n", + ], + 'GatewaySlbMode' => [ + 'description' => 'The mode of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'UserHost', + ], + 'SlbId' => [ + 'description' => 'The ID of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'lb-bp1ut8asdfgucjk****', + ], + ], + ], + ], + 'Upgrade' => [ + 'description' => 'Indicates whether the instance was upgraded.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'MustUpgrade' => [ + 'description' => 'Indicates whether the instance was forcefully upgraded.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SupportWasm' => [ + 'description' => 'Indicates whether WebAssembly (Wasm) is supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CurrentVersion' => [ + 'description' => 'The current version of the gateway.'."\n", + 'type' => 'string', + 'example' => '0.1.0-mse-gw', + ], + 'AppVersion' => [ + 'description' => 'The version of the application.'."\n", + 'type' => 'string', + 'example' => '1.0.1.0', + ], + 'LatestVersion' => [ + 'description' => 'The latest version of the gateway.'."\n", + 'type' => 'string', + 'example' => '0.1.0-mse-gw', + ], + 'Vswitch2' => [ + 'description' => 'The ID of the secondary vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bpbrveck45nf****', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'mse_ingresspost-cn-0jbvrcex****', + ], + 'ChargeType' => [ + 'description' => 'The billing method.'."\n", + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'EndDate' => [ + 'description' => 'The time when the instance expires.'."\n", + 'type' => 'string', + 'example' => '4792060800000', + ], + 'Tag' => [ + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'InitConfig' => [ + 'description' => 'The configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableWaf' => [ + 'description' => 'Indicates whether Web Application Firewall (WAF) is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SupportWaf' => [ + 'description' => 'Indicates whether WAF is supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'GatewayVersion' => [ + 'description' => 'The version of the gateway.'."\n", + 'type' => 'string', + 'example' => '1.2.9', + ], + 'RollBack' => [ + 'description' => 'Indicates whether rollbacks are allowed.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'MseTag' => [ + 'description' => 'The resource tag.'."\n", + 'type' => 'string', + 'example' => '{"tagKey":"tagValue"}', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-97hg87vi****', + ], + 'TotalReplica' => [ + 'description' => 'The total number of replicas, including the number of replicas that are automatically scaled out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Elastic' => [ + 'description' => 'Indicates whether auto scale-out is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ElasticReplica' => [ + 'description' => 'The number of replicas that are automatically scaled out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ElasticType' => [ + 'description' => 'The type of auto scale-out. Valid value:'."\n" + ."\n" + .'* CronHPA: scale-out by time'."\n", + 'type' => 'string', + 'example' => 'CronHPA', + ], + 'ElasticPolicy' => [ + 'description' => 'The auto scale-out policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Elastic' => [ + 'description' => 'Indicates whether auto scale-out is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MaxReplica' => [ + 'description' => 'The maximum number of instances that are automatically scaled out. This parameter is used for horizontal scale-out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ElasticType' => [ + 'description' => 'The type of auto scale-out. Valid value:'."\n" + ."\n" + .'* CronHPA: scale-out by time'."\n", + 'type' => 'string', + 'example' => 'CronHPA', + ], + 'TimePolicyList' => [ + 'description' => 'The time policy list for auto scale-out.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DesiredReplica' => [ + 'description' => 'The expected number of replicas for auto scale-out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'StartTime' => [ + 'description' => 'The start time of auto scale-out.'."\n", + 'type' => 'string', + 'example' => '07:00', + ], + 'EndTime' => [ + 'description' => 'The end time of auto scale-out.'."\n", + 'type' => 'string', + 'example' => '09:00', + ], + ], + ], + ], + 'LoadWarningThreshold' => [ + 'title' => '网关按负载弹性的水位设置，true表示开启警戒水位，false表示开启安全水位', + 'type' => 'boolean', + ], + 'EnableScaleTimePolicyList' => [ + 'title' => '允许缩容时间段', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'type' => 'string', + ], + 'EndTime' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ElasticInstanceId' => [ + 'description' => 'The ID of the elastic gateway. This parameter is returned if auto scale-out is used.'."\n", + 'type' => 'string', + 'example' => 'mse_ingresselastic_public_cn-uqm3d0*****', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the gateway belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6heojei217tv14*****', + ], + 'MseVersion' => [ + 'type' => 'string', + ], + 'MaintenancePeriod' => [ + 'type' => 'object', + 'properties' => [ + 'TimeZone' => [ + 'type' => 'string', + ], + 'StartTime' => [ + 'type' => 'string', + ], + 'EndTime' => [ + 'type' => 'string', + ], + ], + ], + 'GatewayEntry' => [ + 'title' => '网关入口地址（适用普通实例专业版）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NetType' => [ + 'title' => '入口网络类型'."\n" + ."\n" + .'- PRIVATE_NET：私网'."\n" + ."\n" + .'- PUB_NET：公网', + 'type' => 'string', + 'example' => 'PUB_NET', + ], + 'EntryDomain' => [ + 'title' => '入口域名', + 'type' => 'string', + 'example' => 'gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com', + ], + 'IpList' => [ + 'title' => '入口IP列表', + 'type' => 'array', + 'items' => [ + 'title' => '入口IP', + 'type' => 'string', + 'example' => '1.2.3.4', + ], + ], + 'HttpPorts' => [ + 'title' => 'HTTP监听端口列表', + 'type' => 'array', + 'items' => [ + 'title' => 'HTTP监听端口', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + 'HttpsPorts' => [ + 'title' => 'HTTPS监听端口列表', + 'type' => 'array', + 'items' => [ + 'title' => 'HTTPS监听端口', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + ], + 'Status' => [ + 'title' => '网关入口就绪状态', + 'type' => 'string', + 'example' => 'Ready', + 'enum' => [ + 'Ready', + 'NotReady', + ], + ], + 'Ipv6List' => [ + 'title' => 'ipv6地址', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'VersionLifecycle' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"34300B3-52EC-5049-8C96-914098CF****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 153,\\n \\"Name\\": \\"tesa-test\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14cebb8ce5cb6a4****\\",\\n \\"GatewayType\\": \\"Ingress\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PrimaryUser\\": \\"18278117654342\\",\\n \\"Status\\": 2,\\n \\"AhasOn\\": false,\\n \\"ArmsOn\\": false,\\n \\"Spec\\": \\"MSE_GTW_1_2_200_c\\",\\n \\"Replica\\": 2,\\n \\"GmtCreate\\": \\"2021-09-13 19:24:23\\",\\n \\"GmtModified\\": \\"2021-09-13 19:24:23\\",\\n \\"StatusDesc\\": \\"重启中\\",\\n \\"Slb\\": [\\n {\\n \\"SlbIp\\": \\"153.12.XX.XX\\",\\n \\"SlbPort\\": \\"80\\",\\n \\"SlbSpec\\": \\"slb.s2.small\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"创建中\\",\\n \\"GatewaySlbMode\\": \\"UserHost\\",\\n \\"SlbId\\": \\"lb-bp1ut8asdfgucjk****\\"\\n }\\n ],\\n \\"InternetSlb\\": [\\n {\\n \\"SlbIp\\": \\"153.12.XX.XX\\",\\n \\"SlbPort\\": \\"slb.s2.small\\",\\n \\"SlbSpec\\": \\"slb.s2.small\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"InternetNetworkFlow\\": \\"20\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"创建中\\",\\n \\"GatewaySlbMode\\": \\"UserHost\\",\\n \\"SlbId\\": \\"lb-bp1ut8asdfgucjk****\\"\\n }\\n ],\\n \\"Upgrade\\": false,\\n \\"MustUpgrade\\": false,\\n \\"SupportWasm\\": true,\\n \\"CurrentVersion\\": \\"0.1.0-mse-gw\\",\\n \\"AppVersion\\": \\"1.0.1.0\\",\\n \\"LatestVersion\\": \\"0.1.0-mse-gw\\",\\n \\"Vswitch2\\": \\"vsw-bpbrveck45nf****\\",\\n \\"InstanceId\\": \\"mse_ingresspost-cn-0jbvrcex****\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"EndDate\\": \\"4792060800000\\",\\n \\"Tag\\": \\"test\\",\\n \\"InitConfig\\": {\\n \\"EnableWaf\\": true,\\n \\"SupportWaf\\": true\\n },\\n \\"GatewayVersion\\": \\"1.2.9\\",\\n \\"RollBack\\": false,\\n \\"MseTag\\": \\"{\\\\\\"tagKey\\\\\\":\\\\\\"tagValue\\\\\\"}\\",\\n \\"ResourceGroupId\\": \\"rg-97hg87vi****\\",\\n \\"TotalReplica\\": 4,\\n \\"Elastic\\": true,\\n \\"ElasticReplica\\": 2,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"ElasticPolicy\\": {\\n \\"Elastic\\": true,\\n \\"MaxReplica\\": 10,\\n \\"ElasticType\\": \\"CronHPA\\",\\n \\"TimePolicyList\\": [\\n {\\n \\"DesiredReplica\\": 4,\\n \\"StartTime\\": \\"07:00\\",\\n \\"EndTime\\": \\"09:00\\"\\n }\\n ],\\n \\"LoadWarningThreshold\\": true,\\n \\"EnableScaleTimePolicyList\\": [\\n {\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\"\\n }\\n ]\\n },\\n \\"ElasticInstanceId\\": \\"mse_ingresselastic_public_cn-uqm3d0*****\\",\\n \\"VpcId\\": \\"vpc-uf6heojei217tv14*****\\",\\n \\"MseVersion\\": \\"\\",\\n \\"MaintenancePeriod\\": {\\n \\"TimeZone\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\"\\n },\\n \\"GatewayEntry\\": [\\n {\\n \\"NetType\\": \\"PUB_NET\\",\\n \\"EntryDomain\\": \\"gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com\\",\\n \\"IpList\\": [\\n \\"1.2.3.4\\"\\n ],\\n \\"HttpPorts\\": [\\n 80\\n ],\\n \\"HttpsPorts\\": [\\n 443\\n ],\\n \\"Status\\": \\"Ready\\",\\n \\"Ipv6List\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"VersionLifecycle\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGateway', + ], + 'ListGatewaySlb' => [ + 'summary' => 'Queries the Server Load Balancer (SLB) instances that are associated with a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'gw-1cef5440bf2d484db419fb264d4f****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EAB345F4-3AC3-560C-B653-65717703****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'string', + 'example' => 'ID', + ], + 'SlbId' => [ + 'description' => 'The ID of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'lb-bp1kmnli3hdpreptw2ah3', + ], + 'SlbIp' => [ + 'description' => 'The IP address of the SLB instance.'."\n", + 'type' => 'string', + 'example' => '121.199.XX.XX', + ], + 'SlbPort' => [ + 'description' => 'The port number of the SLB instance.'."\n", + 'type' => 'string', + 'example' => '80,443', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'PUB_NET', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-14 14:39:16', + ], + 'GatewaySlbMode' => [ + 'description' => 'The mode of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'UserSelect', + ], + 'GatewaySlbStatus' => [ + 'description' => 'The association status.'."\n", + 'type' => 'string', + 'example' => 'Ready', + ], + 'StatusDesc' => [ + 'description' => 'The description of the status.'."\n", + 'type' => 'string', + 'example' => 'Associating'."\n", + ], + 'VServerGroupId' => [ + 'description' => 'The ID of the HTTP virtual service group.'."\n", + 'type' => 'string', + 'example' => '353', + ], + 'HttpPort' => [ + 'description' => 'The port number of the HTTP virtual service group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'HttpsPort' => [ + 'description' => 'The port number of the HTTPS virtual service group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + 'ServiceWeight' => [ + 'description' => 'The service weight.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'EditEnable' => [ + 'description' => 'Indicates whether the edit operation is supported.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'HttpsVServerGroupId' => [ + 'description' => 'The ID of the HTTPS virtual service group.'."\n", + 'type' => 'string', + 'example' => '353', + ], + 'VsMetaInfo' => [ + 'type' => 'string', + ], + 'VServiceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'type' => 'string', + ], + 'Protocol' => [ + 'type' => 'string', + ], + 'VServerGroupId' => [ + 'type' => 'string', + ], + 'VServerGroupName' => [ + 'type' => 'string', + ], + ], + ], + ], + 'SlbType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"EAB345F4-3AC3-560C-B653-65717703****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"ID\\",\\n \\"SlbId\\": \\"lb-bp1kmnli3hdpreptw2ah3\\",\\n \\"SlbIp\\": \\"121.199.XX.XX\\",\\n \\"SlbPort\\": \\"80,443\\",\\n \\"Type\\": \\"PUB_NET\\",\\n \\"GatewayId\\": \\"1\\",\\n \\"GmtCreate\\": \\"2022-01-14 14:39:16\\",\\n \\"GatewaySlbMode\\": \\"UserSelect\\",\\n \\"GatewaySlbStatus\\": \\"Ready\\",\\n \\"StatusDesc\\": \\"关联中\\",\\n \\"VServerGroupId\\": \\"353\\",\\n \\"HttpPort\\": 80,\\n \\"HttpsPort\\": 443,\\n \\"ServiceWeight\\": 80,\\n \\"EditEnable\\": false,\\n \\"HttpsVServerGroupId\\": \\"353\\",\\n \\"VsMetaInfo\\": \\"[{\\\\\\"protocol\\\\\\":\\\\\\"HTTP\\\\\\",\\\\\\"vServerGroupName\\\\\\":\\\\\\"k8s/80/****\\\\\\",\\\\\\"port\\\\\\":80,\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-bp***\\\\\\"},{\\\\\\"protocol\\\\\\":\\\\\\"HTTPS\\\\\\",\\\\\\"vServerGroupName\\\\\\":\\\\\\"k8s/443/***\\\\\\",\\\\\\"port\\\\\\":443,\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-bp*****\\\\\\"}]\\",\\n \\"VServiceList\\": [\\n {\\n \\"Port\\": \\"443\\",\\n \\"Protocol\\": \\"HTTPS\\",\\n \\"VServerGroupId\\": \\"rsp-bp183l2x70***\\",\\n \\"VServerGroupName\\": \\"k8s/31**0/***/istio-system/clusterid\\"\\n }\\n ],\\n \\"SlbType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListGatewaySlb', + ], + 'GetGatewayOption' => [ + 'summary' => 'Obtains the global parameters of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92787', + 'abilityTreeNodes' => [ + 'FEATUREmseS26K2N', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C92F4A4D-A2FD-593E-839E-F3D4DFD2****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned. The value 200 indicates that the request is successfully processed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The detailed configurations of the gateway.'."\n" + ."\n" + .'* **TraceDetails**: the sampling description of Managed Service for OpenTelemetry. Content: TraceEnabled indicates whether Managed Service for OpenTelemetry is activated. Sample indicates the sampling rate of Managed Service for OpenTelemetry.'."\n" + .'* **LogConfigDetails**: the description of Simple Log Service. Content: LogEnabled indicates whether Simple Log Service is activated. ProjectName indicates the Simple Log Service project to which logs are delivered. LogStoreName indicates the name of the Logstore.'."\n" + .'* **EnableHardwareAcceleration**: indicates whether hardware acceleration is enabled.'."\n" + .'* **DisableHttp2Alpn**: indicates whether the HTTP/2 protocol is disabled.'."\n" + .'* **EnableWaf**: indicates whether Web Application Firewall (WAF) is enabled.'."\n", + 'example' => '{\'LogConfigDetails\': {\'LogEnabled\': False}, \'TraceDetails\': {\'TraceEnabled\': False}}', + '$ref' => '#/components/schemas/GatewayOption', + ], + ], + ], + ], + ], + '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\\": \\"C92F4A4D-A2FD-593E-839E-F3D4DFD2****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TraceDetails\\": {\\n \\"TraceEnabled\\": true,\\n \\"Sample\\": 0,\\n \\"TraceType\\": \\"XTRACE\\",\\n \\"ServiceId\\": 0,\\n \\"ServicePort\\": \\"\\"\\n },\\n \\"LogConfigDetails\\": {\\n \\"LogEnabled\\": true,\\n \\"ProjectName\\": \\"\\",\\n \\"LogStoreName\\": \\"\\"\\n },\\n \\"EnableHardwareAcceleration\\": true,\\n \\"DisableHttp2Alpn\\": true,\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayOption', + ], + 'ListSecurityGroupRule' => [ + 'summary' => 'Queries the security group rules of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关ID', + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-83b0ddb569434f82b9fe8e4c60c40f7c', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the security group authorization record.'."\n", + 'type' => 'string', + 'example' => '21', + ], + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-bp1cg6qlyjepj0y6cf2c', + ], + 'PortRange' => [ + 'description' => 'The port range.'."\n", + 'type' => 'string', + 'example' => '8000/8000', + ], + 'IpProtocol' => [ + 'description' => 'The protocol type.'."\n", + 'type' => 'string', + 'example' => 'tcp', + ], + 'AuthCidrs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'GatewayId' => [ + 'description' => 'The gateway ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '81', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-12a432a1f5da423997d8880bd32c304d', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The last modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'Description' => [ + 'description' => 'The rule description.'."\n", + 'type' => 'string', + 'example' => 'Test'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"21\\",\\n \\"SecurityGroupId\\": \\"sg-bp1cg6qlyjepj0y6cf2c\\",\\n \\"PortRange\\": \\"8000/8000\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"AuthCidrs\\": [\\n \\"\\"\\n ],\\n \\"GatewayId\\": 81,\\n \\"GatewayUniqueId\\": \\"gw-12a432a1f5da423997d8880bd32c304d\\",\\n \\"GmtCreate\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"Description\\": \\"测试\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListSecurityGroupRule', + ], + 'ListSecurityGroup' => [ + 'summary' => 'Obtains the information about security groups.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关ID', + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-e98e40675aaf49bda082137d158e1585', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-8vb8gsmrqyc35k645rk6', + ], + 'SecurityGroupName' => [ + 'description' => 'The name of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg2', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1b', + ], + 'SecurityGroupType' => [ + 'description' => 'The type of the security group. Valid values:'."\n" + ."\n" + .'* normal: basic security group'."\n" + .'* enterprise: advanced security group For more information, see [Advanced security groups](~~120621~~).'."\n", + 'type' => 'string', + 'example' => 'enterprise', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + '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\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-8vb8gsmrqyc35k645rk6\\",\\n \\"SecurityGroupName\\": \\"sg2\\",\\n \\"VpcId\\": \\"vpc-bp1b\\",\\n \\"SecurityGroupType\\": \\"enterprise\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListSecurityGroup', + ], + 'UpdateGatewaySpec' => [ + 'summary' => 'Updates the number of nodes or the specifications of nodes in a pay-as-you-go or subscription cloud-native gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关名称', + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => [ + 'title' => '节点规格', + 'description' => 'The node specifications of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'MSE_GTW_16_32_200_c' => 'MSE_GTW_16_32_200_c', + 'MSE_GTW_2_4_200_c' => 'MSE_GTW_2_4_200_c', + 'MSE_GTW_4_8_200_c' => 'MSE_GTW_4_8_200_c', + 'MSE_GTW_8_16_200_c' => 'MSE_GTW_8_16_200_c', + ], + 'example' => 'MSE_GTW_4_8_200_c', + ], + ], + [ + 'name' => 'Replica', + 'in' => 'query', + 'schema' => [ + 'title' => '节点数量', + 'description' => 'The number of nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'gw-892ehbv7gg56******', + ], + ], + ], + ], + ], + '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\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"gw-892ehbv7gg56******\\"\\n}","type":"json"}]', + 'title' => 'UpdateGatewaySpec', + 'description' => 'You can call this operation to update the number of nodes or the specifications of nodes in a pay-as-you-go or subscription cloud-native gateway. If you add nodes or increase the specifications, you will incur fees. For more information, see [Pricing](~~250950~~).'."\n", + ], + 'SelectGatewaySlb' => [ + 'summary' => 'Queries an idle Server Load Balancer (SLB) instance that is associated with a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the SLB instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-slb', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the SLB instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PUB_NET', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-492af9b04bb4474cae9d645be850****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E00C6D90-A28A-5813-8981-0459AA436F46', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'SlbId' => [ + 'description' => 'The ID of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'lb-bp14lqiw5n96hq2****', + ], + 'SlbName' => [ + 'description' => 'The name of the SLB instance.'."\n", + 'type' => 'string', + 'example' => 'MseGatewaySlb-gw', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"E00C6D90-A28A-5813-8981-0459AA436F46\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"SlbId\\": \\"lb-bp14lqiw5n96hq2****\\",\\n \\"SlbName\\": \\"MseGatewaySlb-gw\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'SelectGatewaySlb', + ], + 'AddServiceSource' => [ + 'summary' => 'Adds a Nacos service source.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service source.'."\n" + ."\n" + .'* K8s: Container Service for Kubernetes (ACK) cluster'."\n" + .'* NACOS: Nacos instance', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'The Ingress configuration.'."\n", + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service source.'."\n" + ."\n" + .'* K8s: ACK cluster'."\n" + .'* NACOS: MSE Nacos instance', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'K8s,MSE', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to monitor Ingress classes.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'c9ad2a0717032427e920754e25b49e3b5', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The namespace whose resources you want to monitor.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'istio', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to update the Ingress status.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', + ], + ], + [ + 'name' => 'IngressOptionsRequest', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of service groups.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => [ + 'description' => 'The group to which the service belongs.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'IngressClass' => [ + 'description' => 'An array of service root paths.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'com.test.xxx', + ], + 'WatchNamespace' => [ + 'description' => 'The root path of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'EnableStatus' => [ + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh-CN: Chinese. This is the default value.'."\n" + .'* en-US: English.'."\n" + .'* ja: Japanese.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ToAuthorizeSecurityGroups', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of security groups to be authorized. You can specify security groups to allow backend services to access data sources that you create.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp1acepclex0vmi1****', + ], + 'PortRange' => [ + 'description' => 'The authorized port range of the security group. You can select multiple port ranges. Separate each port range with a comma (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8080/8080,9000/10000', + ], + 'Description' => [ + 'description' => 'The description of the authorization record.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rule for xxx', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'GroupList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NACOS', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PathList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh-CN (default): Chinese'."\n" + .'* en-US: English'."\n" + .'* ja: Japanese'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The response data.'."\n", + 'type' => 'string', + 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', + ], + 'HttpStatusCode' => [ + 'description' => 'code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'mse-200-105', + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7', + ], + 'Code' => [ + 'description' => 'duplicatedClusterAliasName', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'duplicated cluster alias name', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'mse-100-007', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63', + ], + ], + ], + ], + ], + '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\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 63\\n}","type":"json"}]', + 'title' => 'AddServiceSource', + ], + 'AddGatewayServiceVersion' => [ + 'summary' => 'Adds a service version for a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '90280', + 'abilityTreeNodes' => [ + 'FEATUREmseY699NS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '33', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{\\"name\\":\\"v1\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v1\\"}]}', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'gw-913a49bab6c5461187a3305fb8da****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BA4046B6-CFC6-583C-B608-DD75011A590F', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '403', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned. The value 200 indicates that the request is successfully processed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The ID of the gateway service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '330', + ], + ], + ], + ], + ], + '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\\": \\"BA4046B6-CFC6-583C-B608-DD75011A590F\\",\\n \\"HttpStatusCode\\": 403,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 330\\n}","type":"json"}]', + 'title' => 'AddGatewayServiceVersion', + ], + 'DeleteServiceSource' => [ + 'summary' => 'Deletes a gateway service source.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '24910', + 'abilityTreeNodes' => [ + 'FEATUREmseQRG9VI', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data source.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '17', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-492af9b04bb4474cae9d645be850****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2CEF593F-D60C-5449-9E98-15CA6ECD9189', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\": \\"2CEF593F-D60C-5449-9E98-15CA6ECD9189\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 1,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteServiceSource', + ], + 'DeleteGatewayServiceVersion' => [ + 'summary' => 'Deletes a service version from a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '90283', + 'abilityTreeNodes' => [ + 'FEATUREmseY699NS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '777', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{\\"name\\":\\"app\\",\\"labels\\":[{\\"key\\":\\"app\\",\\"value\\":\\"demo-server\\"}]}', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-b6988bd16920479d9104e1729f97****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '29D52777-BE96-563E-BC6B-796ACE47A7A5', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + '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\\": \\"29D52777-BE96-563E-BC6B-796ACE47A7A5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'DeleteGatewayServiceVersion', + ], + 'DeleteGatewayService' => [ + 'summary' => 'Deletes a service from a gateway', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '25194', + 'abilityTreeNodes' => [ + 'FEATUREmse5GGXKF', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '190', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The unique ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B3545F76-6ED1-586F-8DB9-ECE07985F381', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '190', + ], + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597c****', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SourceType' => [ + 'description' => 'The source type of the service.'."\n", + 'type' => 'string', + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'GroupName' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_GROUP', + ], + 'SourceId' => [ + 'description' => 'The ID of the service source.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServiceNameInRegistry' => [ + 'description' => 'The name of the service registered with the service registry.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'MetaInfo' => [ + 'description' => 'The basic information about the service.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Ips' => [ + 'description' => 'IP'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'IP'."\n", + 'type' => 'string', + 'example' => '127.0.1.12', + ], + ], + 'GmtCreate' => [ + 'description' => 'The time when the service was created.'."\n", + 'type' => 'string', + 'example' => '2022-01-14 14:39:16', + ], + 'GmtModified' => [ + 'description' => 'The last modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"B3545F76-6ED1-586F-8DB9-ECE07985F381\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 190,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 1,\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"DEFAULT_GROUP\\",\\n \\"SourceId\\": 1,\\n \\"ServiceNameInRegistry\\": \\"test\\",\\n \\"MetaInfo\\": \\"{}\\",\\n \\"Ips\\": [\\n \\"127.0.1.12\\"\\n ],\\n \\"GmtCreate\\": \\"2022-01-14 14:39:16\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteGatewayService', + ], + 'UpdateGatewayServiceTrafficPolicy' => [ + 'summary' => 'Updates the traffic policy of a service.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '113905', + 'abilityTreeNodes' => [ + 'FEATUREmseY699NS', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '411', + ], + ], + [ + 'name' => 'GatewayTrafficPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The traffic policy of the gateway.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/TrafficPolicy', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-75c5036c083e4f89ba8ef9fafff2e902', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* **zh-CN** (default): Chinese'."\n" + .'* **en-US**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '11A61389-F896-5231-A4FB-074D9E2E0055', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request was successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'example' => '{\'GatewayUniqueId\': \'gw-2b8ebd75dc554c37a4279ba9917379f2\', \'Id\': 417, \'GatewayTrafficPolicy\': {\'LoadBalancerSettings\': {\'LoadbalancerType\': \'ROUND_ROBIN\'}, \'TlsSetting\': {\'TlsMode\': \'DISABLE\'}}}', + '$ref' => '#/components/schemas/GatewayService', + ], + ], + ], + ], + ], + '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\\": \\"11A61389-F896-5231-A4FB-074D9E2E0055\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 0,\\n \\"Name\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"GatewayTrafficPolicy\\": {\\n \\"TlsSetting\\": {\\n \\"TlsMode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"\\",\\n \\"CaCertContent\\": \\"\\",\\n \\"Sni\\": \\"\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"\\",\\n \\"Path\\": \\"\\",\\n \\"TTL\\": \\"0s\\"\\n },\\n \\"ConsistentHashLBType\\": \\"\\"\\n },\\n \\"WarmupDuration\\": 0\\n }\\n },\\n \\"GatewayUniqueId\\": \\"\\",\\n \\"MetaInfo\\": \\"\\",\\n \\"Namespace\\": \\"\\",\\n \\"GroupName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayServiceTrafficPolicy', + ], + 'UpdateGatewayServiceVersion' => [ + 'summary' => 'Updates the service version of a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '90281', + 'abilityTreeNodes' => [ + 'FEATUREmseY699NS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '575', + ], + ], + [ + 'name' => 'ServiceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{\\"name\\":\\"v3\\",\\"labels\\":[{\\"key\\":\\"version\\",\\"value\\":\\"v3\\"}]}', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-eccf313e2224438ba53d95d039e5****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D6580AA6-E285-58D2-B00B-12C051B3B7BF', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '614', + ], + ], + ], + ], + ], + '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\\": \\"D6580AA6-E285-58D2-B00B-12C051B3B7BF\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 1,\\n \\"Success\\": true,\\n \\"Data\\": 614\\n}","type":"json"}]', + 'title' => 'UpdateGatewayServiceVersion', + ], + 'ListServiceSource' => [ + 'summary' => 'Queries a list of associated sources.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '24908', + 'abilityTreeNodes' => [ + 'FEATUREmse5GGXKF', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-c51a15c7ee934a4fb945ccf35fe1****', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the type of the returned service source. If this parameter is not specified, service sources of all types are returned. Valid values:'."\n" + ."\n" + .'* K8s'."\n" + .'* MSE'."\n" + .'* MSE_ZK'."\n" + .'* SAE'."\n" + .'* EDAS', + 'type' => 'string', + 'required' => false, + 'example' => 'MSE', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B8C4B0D8-EBB9-5F20-8295-04224FBE5529', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Address' => [ + 'description' => 'The ID of the Container Service for Kubernetes (ACK) cluster or the endpoint of the Microservices Engine (MSE) instance.'."\n", + 'type' => 'string', + 'example' => '***', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'NACOS', + ], + 'Source' => [ + 'description' => 'The type of the service source.'."\n", + 'type' => 'string', + 'example' => 'MSE', + ], + 'BindingWithGateway' => [ + 'description' => 'Indicates whether the service source is associated with the gateway. The value 1 indicates that the service source is associated with the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'GmtModified' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'SourceUniqueId' => [ + 'description' => 'The unique ID of the service source.'."\n", + 'type' => 'string', + 'example' => 'mse-cn-***', + ], + 'IngressOptions' => [ + 'description' => 'The information about the support for Ingresses by applications.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => [ + 'description' => 'Indicates whether Ingresses are enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'IngressClass' => [ + 'description' => 'The Ingress class.'."\n", + 'type' => 'string', + 'example' => 'com.test.xxx', + ], + 'WatchNamespace' => [ + 'description' => 'The namespace that you want to monitor.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'EnableStatus' => [ + 'description' => 'Indicates whether the Ingress status is updated.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-2u9uhd9283hd92hgd39g239dg2*****', + ], + 'GroupList' => [ + 'description' => 'The array of service groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The group to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_GROUP', + ], + ], + 'PathList' => [ + 'description' => 'The array of root paths of service lists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The root path of the service list.'."\n", + 'type' => 'string', + 'example' => '/path', + ], + ], + 'Invalid' => [ + 'title' => '来源是否有效', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"B8C4B0D8-EBB9-5F20-8295-04224FBE5529\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Address\\": \\"***\\",\\n \\"Type\\": \\"NACOS\\",\\n \\"Source\\": \\"MSE\\",\\n \\"BindingWithGateway\\": 1,\\n \\"GatewayId\\": 1,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"SourceUniqueId\\": \\"mse-cn-***\\",\\n \\"IngressOptions\\": {\\n \\"EnableIngress\\": true,\\n \\"IngressClass\\": \\"com.test.xxx\\",\\n \\"WatchNamespace\\": \\"default\\",\\n \\"EnableStatus\\": true\\n },\\n \\"GatewayUniqueId\\": \\"gw-2u9uhd9283hd92hgd39g239dg2*****\\",\\n \\"GroupList\\": [\\n \\"DEFAULT_GROUP\\"\\n ],\\n \\"PathList\\": [\\n \\"/path\\"\\n ],\\n \\"Invalid\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListServiceSource', + ], + 'ListGatewayService' => [ + 'summary' => 'Queries a list of services that are subscribed to by a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '25193', + 'abilityTreeNodes' => [ + 'FEATUREmseY699NS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OrderItem', + 'in' => 'query', + 'schema' => [ + 'description' => 'The item based on which entries are sorted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreate', + ], + ], + [ + 'name' => 'DescSort', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable sorting.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FilterParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The parameters that are used to specify filter conditions. The values of the parameters are in the format of {"key1":"value1"}.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'SourceType' => [ + 'description' => 'The type of the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace to which the service belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'public', + ], + 'GroupName' => [ + 'description' => 'The group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-5017305290e14centbrveca****', + ], + 'ServiceProtocol' => [ + 'description' => 'The protocol of the service.'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n" + .'* HTTP2'."\n" + .'* GRPC'."\n" + .'* DUBBO'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'HTTP2' => 'HTTP2', + 'HTTPS' => 'HTTPS', + 'HTTP' => 'HTTP', + 'DUBBO' => 'DUBBO', + 'GRPC' => 'GRPC', + ], + 'example' => 'HTTP', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F46CDBA4-B1EE-5C94-8A48-51C10177****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Result' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-5017305290e14centbrveca****', + ], + 'GatewayId' => [ + 'description' => 'The gateway ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SourceType' => [ + 'description' => 'The source type.'."\n", + 'type' => 'string', + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + 'GroupName' => [ + 'description' => 'The group.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SourceId' => [ + 'description' => 'The ID of the service source.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ServiceNameInRegistry' => [ + 'description' => 'The name of the service that is registered with the service registry.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'MetaInfo' => [ + 'description' => 'The metadata or IP addresses of the service.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Ips' => [ + 'description' => 'The list of IP addresses.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '127.0.2.1', + ], + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'Versions' => [ + 'description' => 'The service version.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The version.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The version number.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + 'ServiceProtocol' => [ + 'description' => 'The protocol of the service.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'ServicePort' => [ + 'description' => 'The service port number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + 'HealehStatus' => [ + 'description' => 'The health status.'."\n" + ."\n" + .'* Health'."\n" + .'* Unhealthy'."\n" + .'* Unknown'."\n", + 'type' => 'string', + 'example' => 'Unhealthy', + ], + 'HealthStatus' => [ + 'description' => 'The health status.'."\n" + ."\n" + .'* Health'."\n" + .'* Unhealthy'."\n" + .'* Unknown'."\n", + 'type' => 'string', + 'example' => 'Unhealthy', + ], + 'HealthCheck' => [ + 'description' => 'Indicates whether health checks are performed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HealthCheckInfo' => [ + 'description' => 'The information about health checks.'."\n", + 'type' => 'object', + 'properties' => [ + 'Check' => [ + 'description' => 'Indicates whether checks are performed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Protocol' => [ + 'description' => 'The network protocol.'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + 'Timeout' => [ + 'description' => 'The timeout period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Interval' => [ + 'description' => 'The health check interval.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HealthyThreshold' => [ + 'description' => 'The threshold for healthy instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UnhealthyThreshold' => [ + 'description' => 'The threshold for unhealthy instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HttpPath' => [ + 'description' => 'The path to which the HTTP request for the health check is sent.'."\n", + 'type' => 'string', + 'example' => '/health', + ], + 'HttpHost' => [ + 'description' => 'The endpoint of the HTTP request for the health check.'."\n", + 'type' => 'string', + 'example' => 'http://172.168.0.1', + ], + 'ExpectedStatuses' => [ + 'description' => 'The expected status of the health check.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The expected HTTP status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + 'UnhealthyEndpoints' => [ + 'description' => 'The array of endpoints of unhealthy instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The endpoint of the unhealthy instance.'."\n", + 'type' => 'string', + 'example' => '172.168.0.1', + ], + ], + 'GatewayTrafficPolicy' => [ + 'description' => 'The traffic management policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Tls' => [ + 'description' => 'The Transport Layer Security (TLS).'."\n", + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => 'DISABLE, SIMPLE, MUTUAL, ISTIO_MUTUAL', + 'description' => 'The TLS mode.'."\n" + ."\n" + .'* DISABLE'."\n" + .'* SIMPLE'."\n" + .'* MUTUAL'."\n" + .'* ISTIO_MUTUAL'."\n", + 'type' => 'string', + 'example' => 'SIMPLE', + ], + 'CertId' => [ + 'description' => 'The ID of the certificate.'."\n", + 'type' => 'string', + 'example' => '5******-cn-hangzhou', + ], + 'CaCertId' => [ + 'description' => 'The ID of the certification authority (CA) certificate.'."\n", + 'type' => 'string', + 'example' => '5******-cn-hangzhou', + ], + 'CaCertContent' => [ + 'description' => 'The public key of the CA certificate .'."\n", + 'type' => 'string', + 'example' => 'content', + ], + 'SubjectAltNames' => [ + 'description' => 'The array of subject aliases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The subject alias.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + ], + 'Sni' => [ + 'description' => 'The Server Name Indication (SNI) value.'."\n", + 'type' => 'string', + 'example' => 'name-sni', + ], + ], + ], + 'LoadBalancerSettings' => [ + 'description' => 'The load balancing settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'LoadbalancerType' => [ + 'title' => 'ROUND_ROBIN, LEAST_CONN, RANDOM, CONSISTENT_HASH', + 'description' => 'The load balancing type.'."\n" + ."\n" + .'* ROUND_ROBIN'."\n" + .'* LEAST_CONN'."\n" + .'* RANDOM'."\n" + .'* CONSISTENT_HASH'."\n", + 'type' => 'string', + 'example' => 'RANDOM', + ], + 'ConsistentHashLBConfig' => [ + 'description' => 'The consistent hashing settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'param', + ], + 'HttpCookie' => [ + 'description' => 'The cookie-based load balancing parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the cookie.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'Path' => [ + 'description' => 'The path of the cookie.'."\n", + 'type' => 'string', + 'example' => '/path', + ], + 'Ttl' => [ + 'description' => 'The lifecycle of the cookie.'."\n", + 'type' => 'string', + 'example' => '360', + ], + ], + ], + 'MinimumRingSize' => [ + 'description' => 'The minimum value of the hash ring.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ConsistentHashLBType' => [ + 'title' => 'HEADER, COOKIE, SOURCE_IP, QUERY_PARAMETER', + 'description' => 'The type based on which consistent hashing load balancing is performed.'."\n" + ."\n" + .'* HEADER'."\n" + .'* COOKIE'."\n" + .'* SOURCE_IP'."\n" + .'* QUERY_PARAMETER'."\n", + 'type' => 'string', + 'example' => 'HEADER', + ], + ], + ], + 'WarmupDuration' => [ + 'description' => 'The prefetch time of the least connection load balancing.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'Ports' => [ + 'description' => 'The port array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8080', + ], + ], + 'ServiceFQDN' => [ + 'type' => 'string', + ], + 'DnsServerList' => [ + 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'type' => 'array', + 'items' => [ + 'title' => 'DNS服务器地址（IP+端口）', + 'type' => 'string', + 'example' => '1.1.1.1:80', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"F46CDBA4-B1EE-5C94-8A48-51C10177****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 9,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"GatewayId\\": 1,\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"public\\",\\n \\"GroupName\\": \\"test\\",\\n \\"SourceId\\": 2,\\n \\"ServiceNameInRegistry\\": \\"test\\",\\n \\"MetaInfo\\": \\"{}\\",\\n \\"Ips\\": [\\n \\"127.0.2.1\\"\\n ],\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"Versions\\": [\\n {\\n \\"Name\\": \\"v1\\"\\n }\\n ],\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"ServicePort\\": 80,\\n \\"HealehStatus\\": \\"Unhealthy\\",\\n \\"HealthStatus\\": \\"Unhealthy\\",\\n \\"HealthCheck\\": true,\\n \\"HealthCheckInfo\\": {\\n \\"Check\\": true,\\n \\"Protocol\\": \\"TCP\\",\\n \\"Timeout\\": 2,\\n \\"Interval\\": 2,\\n \\"HealthyThreshold\\": 2,\\n \\"UnhealthyThreshold\\": 2,\\n \\"HttpPath\\": \\"/health\\",\\n \\"HttpHost\\": \\"http://172.168.0.1\\",\\n \\"ExpectedStatuses\\": [\\n 200\\n ]\\n },\\n \\"UnhealthyEndpoints\\": [\\n \\"172.168.0.1\\"\\n ],\\n \\"GatewayTrafficPolicy\\": {\\n \\"Tls\\": {\\n \\"Mode\\": \\"SIMPLE\\",\\n \\"CertId\\": \\"5******-cn-hangzhou\\",\\n \\"CaCertId\\": \\"5******-cn-hangzhou\\",\\n \\"CaCertContent\\": \\"content\\",\\n \\"SubjectAltNames\\": [\\n \\"name\\"\\n ],\\n \\"Sni\\": \\"name-sni\\"\\n },\\n \\"LoadBalancerSettings\\": {\\n \\"LoadbalancerType\\": \\"RANDOM\\",\\n \\"ConsistentHashLBConfig\\": {\\n \\"ParameterName\\": \\"param\\",\\n \\"HttpCookie\\": {\\n \\"Name\\": \\"name\\",\\n \\"Path\\": \\"/path\\",\\n \\"Ttl\\": \\"360\\"\\n },\\n \\"MinimumRingSize\\": 10000,\\n \\"ConsistentHashLBType\\": \\"HEADER\\"\\n },\\n \\"WarmupDuration\\": 10\\n }\\n },\\n \\"Ports\\": [\\n 8080\\n ],\\n \\"ServiceFQDN\\": \\"\\",\\n \\"DnsServerList\\": [\\n \\"1.1.1.1:80\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayService', + ], + 'GetMseSource' => [ + 'summary' => 'Queries the existing Microservices Engine (MSE) Nacos instances that are service sources of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '24939', + 'abilityTreeNodes' => [ + 'FEATUREmseZM8SC5', + 'FEATUREmseRZJSHZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1t50e045b5g7i3p****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The MSE engine type. Valid values:'."\n" + ."\n" + .'* NACOS'."\n" + .'* ZOOKEEPER'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NACOS', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5EB2D865-B43F-5526-8F92-857718CF73A2', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n" + ."\n" + .'* If the request is successful, a success message is returned.'."\n" + .'* If the request fails, an error message is returned, such as the "TaskId not found" message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'example' => 'mse_prepaid_public_cn-7pp2eec****', + ], + 'Address' => [ + 'description' => 'The endpoint of the instance.'."\n", + 'type' => 'string', + 'example' => 'mse-af1****-nacos-ans.mse.aliyuncs.com:8848', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'Nacos', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ClusterId' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'example' => 'mse_', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'GetMseSource', + ], + 'GetKubernetesSource' => [ + 'summary' => 'Obtains sources of all Container Service for Kubernetes (ACK) services in a gateway.', + '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' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-c5d1aadb7df646cfb7065fbf75c1****', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1t50e045b5g7i3p****', + ], + ], + [ + 'name' => 'IsAll', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to obtain the information about all Kubernetes clusters. If you set the value to false, only the information about unassociated clusters is obtained.'."\n", + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the ACK cluster.'."\n", + 'type' => 'string', + 'example' => 'k8s-demo', + ], + 'Cluster' => [ + 'description' => 'The ID of the ACK cluster.'."\n", + 'type' => 'string', + 'example' => 'cbc1efca895a64af097ff00b26f3f****', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'GetKubernetesSource', + ], + 'GetGatewayServiceDetail' => [ + 'summary' => 'Queries the details of a service.', + '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' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '35', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-f4c960ad071a48a790b36324394c****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9802C54E-5CC5-5706-927B-993DBB6DCF2F', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597c****', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SourceType' => [ + 'description' => 'The source type of the service.'."\n", + 'type' => 'string', + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'GroupName' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SourceId' => [ + 'description' => 'The ID of the service source.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServiceNameInRegistry' => [ + 'description' => 'The name of the service registered with the service registry.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'MetaInfo' => [ + 'description' => 'The basic information about the service.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Ips' => [ + 'description' => 'The IP address of the service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '127.0.1.12', + ], + ], + 'Versions' => [ + 'description' => 'The service version. This parameter is deprecated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'example' => 'version', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'LabelDetails' => [ + 'description' => 'The details of the tag.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'example' => 'label', + ], + 'Values' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + 'VersionDetails' => [ + 'description' => 'The details of versions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceVersion' => [ + 'description' => 'The service version.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The version number.'."\n", + 'type' => 'string', + 'example' => 'v2', + ], + 'Labels' => [ + 'description' => 'The tag.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'example' => 'version', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'v2', + ], + ], + ], + ], + ], + ], + 'EndpointNum' => [ + 'description' => 'The number of instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EndpointNumPercent' => [ + 'description' => 'The percentage of instances.'."\n", + 'type' => 'string', + 'example' => '20%', + ], + ], + ], + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'GmtModified' => [ + 'description' => 'The last modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GatewayTrafficPolicy' => [ + 'description' => 'The traffic policy of the service.'."\n", + 'example' => '{}', + '$ref' => '#/components/schemas/TrafficPolicy', + ], + 'HealthStatus' => [ + 'description' => 'The status of the health check. Valid values:'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'HealthCheck' => [ + 'description' => 'Indicates whether the health check is enabled.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ServiceProtocol' => [ + 'description' => 'The protocol of the service.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'Ports' => [ + 'description' => 'The array of service ports.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The service port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + 'PortTrafficPolicyList' => [ + 'description' => 'The traffic policy of service ports.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The object of the port traffic policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The port ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServiceId' => [ + 'description' => 'The service ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServicePort' => [ + 'description' => 'The service port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8080', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-2837hfd91h34dbg87364g*****', + ], + 'TrafficPolicy' => [ + 'description' => 'The traffic policy.'."\n", + '$ref' => '#/components/schemas/TrafficPolicy', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '1667460287386', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '1667460287386', + ], + ], + ], + ], + 'ServiceFQDN' => [ + 'type' => 'string', + ], + 'ServicePort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'DnsServerList' => [ + 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'type' => 'array', + 'items' => [ + 'title' => 'DNS服务器地址（IP+端口）', + 'type' => 'string', + 'example' => '1.1.1.1:80', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'GetGatewayServiceDetail', + ], + 'UpdateServiceSource' => [ + 'summary' => 'Modifies service sources of a cloud-native gateway. You can modify only Container Service for Kubernetes (ACK) service sources that contain configurations related to Ingress resource monitoring.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '24909', + 'abilityTreeNodes' => [ + 'FEATUREmseQRG9VI', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service source. Valid values:'."\n" + ."\n" + .'* K8s: ACK cluster.'."\n" + .'* NACOS: Nacos instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'K8s', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service source. Valid values:'."\n" + ."\n" + .'* K8s: ACK cluster.'."\n" + .'* MSE: Nacos instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'K8s', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => 'The address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c9ad2a0717032427e920754e25b49e3b5', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service source.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '63', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'istio', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gw-cdd1bb9bfb8341e9805f931a3ba1f4c6', + ], + ], + [ + 'name' => 'IngressOptionsRequest', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configurations of Ingress resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableIngress' => [ + 'description' => 'Specifies whether to enable Ingress.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'IngressClass' => [ + 'description' => 'Specifies whether to monitor Ingress classes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'com.test.xxx', + ], + 'WatchNamespace' => [ + 'description' => 'The namespace whose resources you want to monitor.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'EnableStatus' => [ + 'description' => 'Specifies whether to update the Ingress status.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PathList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'An array of service root paths.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The root path of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/path', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese.'."\n" + .'* en: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6AB2B0B6-4A86-54E2-A340-FC47A22EE659', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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' => 'UpdateServiceSource', + ], + 'ImportServices' => [ + 'summary' => 'Imports services to a gateway.', + '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' => 'The information about services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'public', + ], + 'GroupName' => [ + 'description' => 'The group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Ips' => [ + 'description' => 'The IP addresses of the service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '127.0.XX.XX', + ], + 'required' => false, + ], + 'ServicePort' => [ + 'title' => '服务的端口', + 'description' => 'The port of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8080', + ], + 'ServiceProtocol' => [ + 'title' => '服务的协议版本', + 'description' => 'The protocol of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GRPC, HTTP', + ], + 'DnsServerList' => [ + 'title' => 'DNS服务器列表（仅供DNS域名服务使用）', + 'type' => 'array', + 'items' => [ + 'title' => 'DNS服务器地址（IP+端口）', + 'type' => 'string', + 'example' => '1.1.1.1:80', + ], + ], + 'SaeAppId' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'DNS', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '服务来源', + 'description' => 'The service source. Valid values:'."\n" + ."\n" + .'* MSE: MSE Nacos instance'."\n" + .'* K8s: ACK cluster'."\n" + .'* VIP: fixed address'."\n" + .'* DNS: DNS domain'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'EDAS' => 'EDAS', + 'MSE_ZK' => 'MSE_ZK', + 'SAE' => 'SAE', + 'K8S' => 'K8S', + 'DNS' => 'DNS', + 'VIP' => 'VIP', + 'MSE' => 'MSE', + ], + 'example' => 'DNS', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5', + ], + ], + [ + 'name' => 'TlsSetting', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Transport Layer Security (TLS) settings. Valid values:'."\n" + ."\n" + .'* mode: TLS mode'."\n" + .'* certId: certificate ID'."\n" + .'* caCertId: CA certificate ID'."\n" + .'* caCertContent: CA certificate public key'."\n" + .'* sni: service name identification'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "mode": "MUTUAL",'."\n" + .' "certId": "1*****-cn-hangzhou",'."\n" + .' "caCertContent": "123",'."\n" + .' "sni": "ceshi"'."\n" + .'}', + ], + ], + [ + 'name' => 'FcServiceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'FcVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'FcAlias', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '服务来源ID，指定来源添加服务时使用', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'ImportServices', + ], + 'UpdateGatewayService' => [ + 'summary' => 'Updates gateways for fixed address services or DNS services.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '25309', + 'abilityTreeNodes' => [ + 'FEATUREmseY699NS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '322', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.1:80', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ServicePort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'ServiceProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', + ], + ], + [ + 'name' => 'TlsSetting', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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域名服务使用）', + 'type' => 'array', + 'items' => [ + 'title' => 'DNS服务器地址（IP+端口）', + 'type' => 'string', + 'example' => '1.1.1.1:80', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '322', + ], + ], + ], + ], + ], + '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' => 'UpdateGatewayService', + ], + 'PullServices' => [ + 'summary' => 'Queries all the microservices of a service source.', + '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' => 'The type of the service source.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'k8s' => 'k8s', + 'MSE' => 'MSE', + ], + 'example' => 'K8s', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-eccf313e2224438ba53d95d039e5****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'public', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '服务来源ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'GroupName' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Services' => [ + 'description' => 'The information about services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + 'GroupName' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SourceId' => [ + 'description' => 'The ID of the service source.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'SourceType' => [ + 'description' => 'The type of the service source.'."\n", + 'type' => 'string', + 'example' => 'MSE', + ], + 'SourceIdList' => [ + 'title' => '归属的服务来源ID列表', + 'type' => 'array', + 'items' => [ + 'title' => '归属的服务来源ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + 'SaeAppId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'NamespaceShowName' => [ + 'description' => 'The alias of the namespace.'."\n", + 'type' => 'string', + 'example' => 'public', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'PullServices', + ], + 'UpdateGatewayServiceCheck' => [ + 'summary' => 'Updates the health check policy of a specified service in a cloud-native gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'title' => '服务ID', + 'description' => 'The ID of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关唯一ID', + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gw-8d410698bd7f4628ab76b*****72dd1d', + ], + ], + [ + 'name' => 'Check', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启健康检查', + 'description' => 'Specifies whether to enable the health check.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ExpectedStatuses', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '正常状态码（健康检查协议为HTTP时必填）', + 'description' => 'The expected status code, which is required if the health check protocol is HTTP.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '用于判断健康检查正常的HTTP状态码：'."\n" + .'- http_2xx: 200'."\n" + .'- http_3xx: 300'."\n" + .'- http_4xx: 400'."\n" + .'- http_5xx: 500', + 'description' => 'The HTTP status code that indicates the normal health check. This parameter is required if the health check protocol is HTTP. Valid values:'."\n" + ."\n" + .'* http\\_2xx: 200'."\n" + .'* http\\_3xx: 300'."\n" + .'* http\\_4xx: 400'."\n" + .'* http\\_5xx: 500'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查协议，目前支持：'."\n" + .'- HTTP'."\n" + .'- TCP', + 'description' => 'The health check protocol. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* TCP'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查响应超时时间（秒）', + 'description' => 'The timeout period of responses to the health check. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查间隔时间（秒）', + 'description' => 'The interval at which the health check is performed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'HealthyThreshold', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查健康阈值', + 'description' => 'The healthy threshold of the health check.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'UnhealthyThreshold', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查不健康阈值', + 'description' => 'The unhealthy threshold of the health check.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'HttpPath', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查路径（健康检查协议为HTTP时必填）', + 'description' => 'The health check path, which is required if the health check protocol is HTTP.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/healthz', + ], + ], + [ + 'name' => 'HttpHost', + 'in' => 'query', + 'schema' => [ + 'title' => '健康检查域名', + 'description' => 'The health check domain name, which is optional if the health check protocol is HTTP.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '62CBFCB8-DDC6-588C-BF1B-88828AF*****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The service ID of the operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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' => 'UpdateGatewayServiceCheck', + ], + 'UpdateGatewayRouteAuth' => [ + 'summary' => 'Updates the authentication configurations of a route.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The route ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '109', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The gateway ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '102', + ], + ], + [ + 'name' => 'AuthJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The authentication configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The authentication type. If an empty string is passed, no authentication type is available. Valid values:'."\n" + ."\n" + .'* JWT'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'JWT', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '54973C90-F379-4372-9AA5-053A3F7****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The route ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + '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' => 'UpdateGatewayRouteAuth', + ], + 'ListGatewayAuthConsumerResource' => [ + 'summary' => 'Queries the list of authorized resources for the consumer on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', + ], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the route.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource authorization status. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A73AC37C-C617-4E3A-8049-372CF49C****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Result' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the authorized resource for the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ConsumerId' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RouteId' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3091', + ], + 'RouteName' => [ + 'description' => 'The name of the route.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceStatus' => [ + 'description' => 'The resource authorization status. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-5017305290e14centbrveca****', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'ListGatewayAuthConsumerResource', + ], + 'UpdateGatewayAuthConsumer' => [ + 'summary' => 'Updates the consumer on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-90392d768a3847a7b804c505254d****', + ], + ], + [ + 'name' => 'EncodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'* RSA'."\n" + .'* OCT'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RSA', + ], + ], + [ + 'name' => 'Jwks', + 'in' => 'query', + 'schema' => [ + 'description' => 'The JWT public key. The JSON format is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', + ], + ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Authorization', + ], + ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable pass-through.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TokenPosition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HEADER', + ], + ], + [ + 'name' => 'TokenPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Bearer ', + ], + ], + [ + 'name' => 'KeyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the key used for JWT-based identity authentication.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'iss', + ], + ], + [ + 'name' => 'KeyValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the key used for JWT-based identity authentication.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcd', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the consumer.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Description'."\n", + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '63', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + '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' => 'UpdateGatewayAuthConsumer', + ], + 'ListGatewayRouteOnAuth' => [ + 'summary' => 'Queries a list of routes for which authentication is enabled.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-c9bc5afd61014165bd58f621b491****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authentication method. Valid values:'."\n" + ."\n" + .'* JWT'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'JWT', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The details of the data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The route ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Name' => [ + 'description' => 'The name of the route.'."\n", + 'type' => 'string', + 'example' => 'ceshi', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597c****', + ], + 'GatewayId' => [ + 'description' => 'The gateway ID.'."\n", + 'type' => 'string', + 'example' => '399', + ], + 'RoutePredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/api', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + ], + ], + ], + ], + 'DomainId' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'DomainName' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => '123.com', + ], + 'DomainIdList' => [ + 'description' => 'The domain IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'DomainNameList' => [ + 'description' => 'The domain names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'ListGatewayRouteOnAuth', + ], + 'ListGatewayAuthConsumer' => [ + 'summary' => 'Queries the list of consumers on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-0fe488252dc44d55a9dd57875193****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the consumer.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* JWT'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'JWT', + ], + ], + [ + 'name' => 'ConsumerStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the consumer. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'dc63-465d-8ef5-20dc18af****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Result' => [ + 'description' => 'The returned information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'description' => 'The name of the consumer.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ConsumerStatus' => [ + 'description' => 'The status of the consumer. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'PrimaryUser' => [ + 'description' => 'The creator.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-5017305290e14centbrveca****', + ], + 'Type' => [ + 'description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* JWT'."\n", + 'type' => 'string', + 'example' => 'JWT', + ], + 'Description' => [ + 'description' => 'The description of the consumer.'."\n", + 'type' => 'string', + 'example' => 'Description'."\n", + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2021-09-13 19:24:23', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'ListGatewayAuthConsumer', + ], + 'UpdateGatewayAuthConsumerResource' => [ + 'summary' => 'Updates a list of resources on which permissions are granted to a gateway authentication consumer.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', + ], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The gateway authentication consumer ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'ResourceList', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'description' => 'The gateway authentication consumer ID.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'RouteId' => [ + 'description' => 'The route ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7816', + ], + 'RouteName' => [ + 'description' => 'The name of the route.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'helo', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Indicates whether the list of the resources was updated. Valid values:'."\n" + ."\n" + .'* true: The list of the resources was updated.'."\n" + .'* false: The list of the resources was not updated.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => 'UpdateGatewayAuthConsumerResource', + ], + 'UpdateGatewayAuthConsumerStatus' => [ + 'summary' => 'Updates the status of the consumer on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-685f661467b54f48b7b7a76605ce****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The consumer ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ConsumerStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the consumer. Valid values:'."\n" + ."\n" + .'* true: The consumer is enabled.'."\n" + .'* false: The consumer is disabled.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '56D9E600-6348-4260-B35F-583413F****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => 'UpdateGatewayAuthConsumerStatus', + ], + 'AddGatewayAuthConsumer' => [ + 'summary' => 'Adds a consumer on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the consumer.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'name', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* JWT'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'JWT', + ], + ], + [ + 'name' => 'EncodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'* RSA'."\n" + .'* OCT'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RSA', + ], + ], + [ + 'name' => 'Jwks', + 'in' => 'query', + 'schema' => [ + 'description' => 'The JWT public key. The JSON format is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', + ], + ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Authorization', + ], + ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable pass-through.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TokenPosition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HEADER', + ], + ], + [ + 'name' => 'TokenPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Bearer ', + ], + ], + [ + 'name' => 'KeyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the key used for JWT-based identity authentication.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'iss', + ], + ], + [ + 'name' => 'KeyValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the key used for JWT-based identity authentication.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcd', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the consumer.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the `%s` variable in the `ErrMessage` parameter.'."\n" + ."\n" + .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + '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' => 'AddGatewayAuthConsumer', + ], + 'DeleteGatewayAuthConsumerResource' => [ + 'summary' => 'Deletes resource permissions from the consumer on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-ubuwqygbq4783gqb2y3f87q****'."\n", + ], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The consumer ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'IdList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the authorized resources that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1,2,3,4', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3369AD10-F1A6-4E6F-B99E-20F51826****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned.'."\n", + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3369AD10-F1A6-4E6F-B99E-20F51826****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayAuthConsumerResource', + ], + 'UpdateGatewayAuthConsumerResourceStatus' => [ + 'summary' => 'Updates the resource authorization status for the consumer on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-2a99625886d54722be94d92e9a69****', + ], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'IdList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of IDs of the authorized resources that a user wants to update.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1,2,3,4', + ], + ], + [ + 'name' => 'ResourceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource authorization status. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the `%s` variable in the `ErrMessage` parameter.'."\n" + ."\n" + .'> If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Indicates whether the execution was successful. Valid values:'."\n" + ."\n" + .'* true: The execution was successful.'."\n" + .'* false: The execution failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => 'UpdateGatewayAuthConsumerResourceStatus', + ], + 'DeleteGatewayAuthConsumer' => [ + 'summary' => 'Deletes a consumer on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer on which the gateway performs authentication operations.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '33ff74b6-d21e-4f9b-91a8-bc1ea4ef****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Indicates whether the execution was successful. Valid values:'."\n" + ."\n" + .'* true: The execution was successful.'."\n" + .'* false: The execution failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => 'DeleteGatewayAuthConsumer', + ], + 'GetGatewayAuthConsumerDetail' => [ + 'summary' => 'Queries the details of the consumer on which a gateway performs authentication operations.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-1a4ab101d5924b6f92c5ec98a84*****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '120', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned.'."\n", + 'type' => 'string', + 'example' => 'mse-100-000', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Name' => [ + 'description' => 'The name of the consumer.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ConsumerStatus' => [ + 'description' => 'The status of the consumer. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'PrimaryUser' => [ + 'description' => 'The creator.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', + ], + 'Type' => [ + 'description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'* JWT'."\n", + 'type' => 'string', + 'example' => 'JWT', + ], + 'GmtCreate' => [ + 'description' => 'The time when the consumer authentication record was created.'."\n", + 'type' => 'string', + 'example' => ' 2031-03-30 02:35:12', + ], + 'GmtModified' => [ + 'description' => 'The time when the consumer authentication record was modified.'."\n", + 'type' => 'string', + 'example' => '2023-02-01 14:17:57', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'Description'."\n", + ], + 'EncodeType' => [ + 'description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'* RSA'."\n" + .'* OCT'."\n", + 'type' => 'string', + 'example' => 'RSA', + ], + 'Jwks' => [ + 'description' => 'The JWT public key. The JSON format is supported.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "keys": ['."\n" + .' {'."\n" + .' "e": "AQAB",'."\n" + .' "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ",'."\n" + .' "kty": "RSA",'."\n" + .' "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'TokenName' => [ + 'description' => 'The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'example' => 'Authorization', + ], + 'TokenPass' => [ + 'description' => 'Specifies whether to enable pass-through.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TokenPosition' => [ + 'description' => 'The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'example' => 'HEADER', + ], + 'TokenPrefix' => [ + 'description' => 'The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as `Authorization: Bearer <Content of a token>`.'."\n", + 'type' => 'string', + 'example' => 'Bearer ', + ], + 'KeyName' => [ + 'description' => 'The name of the key used for JWT-based identity authentication.'."\n", + 'type' => 'string', + 'example' => 'iss', + ], + 'KeyValue' => [ + 'description' => 'The value of the key used for JWT-based identity authentication.'."\n", + 'type' => 'string', + 'example' => 'abcd', + ], + 'ResourceList' => [ + 'description' => 'The resource list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource list.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the authorized resource for the consumer.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'ConsumerId' => [ + 'description' => 'The consumer ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RouteId' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3458', + ], + 'RouteName' => [ + 'description' => 'The name of the route.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceStatus' => [ + 'description' => 'The resource authorization state. Valid values:'."\n" + ."\n" + .'* true: Resource authorization is enabled.'."\n" + .'* false: Resource authorization is disabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-4822033a8513496fa10f05c934f*****', + ], + 'GmtCreate' => [ + 'description' => 'The time when the resource associated with the consumer authentication record was created.'."\n", + 'type' => 'string', + 'example' => '2022-12-06 01:38:03', + ], + 'GmtModified' => [ + 'description' => 'The time when the resource associated with the consumer authentication record was modified.'."\n", + 'type' => 'string', + 'example' => '2022-12-06 01:38:03', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'GetGatewayAuthConsumerDetail', + ], + 'AddBlackWhiteList' => [ + 'summary' => 'Creates a blacklist or a whitelist.', + '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' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-0fe488252dc44d55a9dd57875193****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The effective scope of the blacklist or whitelist. Valid values:'."\n" + ."\n" + .'* GATEWAY'."\n" + .'* DOMAIN'."\n" + .'* ROUTE'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GATEWAY', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of object in the blacklist or whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IP', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the blacklist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.117.115.51', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the blacklist.'."\n" + ."\n" + .'* on: enabled'."\n" + .'* off: disabled'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'off', + ], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => [ + 'description' => 'The whitelist. Default value: No.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceIdJsonList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource IDs in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[123]', + ], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'this is a note', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '966F6CA7-16D0-50AB-AB02-E140934F90C1', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The ID of the record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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' => 'AddBlackWhiteList', + ], + 'UpdateBlackWhiteList' => [ + 'summary' => 'Modifies the blacklist or whitelist of a gateway.', + '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' => 'The ID of the blacklist.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'GATEWAY', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the blacklist or whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IP', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the blacklist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '127.0.2.11', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the blacklist or whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => '', + 'on' => '', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-c70622ff52fe49beb29bea9a6f52****', + ], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the whitelist.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceIdJsonList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource IDs in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[123]', + ], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'this is a note', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AD5DEDA0-C82A-50D9-AF54-BD3576CCFB4C', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The ID of the record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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' => 'UpdateBlackWhiteList', + ], + 'GatewayBlackWhiteList' => [ + 'summary' => 'Queries a list of blacklists and whitelists of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'FilterParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'parse from filterParams', + 'description' => 'The filter parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'GatewayId' => [ + 'description' => 'The gateway ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '81', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway. If this parameter is used together with the GatewayId parameter, the value of the GatewayId parameter is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gw-5017305290e14centbrveca****', + ], + 'ResourceType' => [ + 'description' => 'This parameter is unavailable for public use.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + 'Type' => [ + 'description' => 'This parameter is unavailable for public use.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => ' ""', + ], + 'IsWhite' => [ + 'description' => 'This parameter is unavailable for public use.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => ' ""', + ], + 'SearchType' => [ + 'description' => 'The query type. Valid values:'."\n" + ."\n" + .'* ROUTE: The list is queried by route. If the value of this parameter is ROUTE, set the SearchContent parameter to the route name.'."\n" + .'* DOMAIN: The list is queried by domain name. If the value of this parameter is DOMAIN, set the SearchContent parameter to the domain name.'."\n" + .'* IP: The list is queried by specified IP address. If the value of this parameter is IP, set the SearchContent parameter to the IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IP', + ], + 'SearchContent' => [ + 'description' => 'The content that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'OrderItem', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is unavailable for public use.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'DescSort', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is unavailable for public use.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => '""', + 'default' => 'false', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'RestResult<PageResult<BlackWhiteList>>', + 'description' => 'The response parameters.>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '58E06A0A-BD2C-47A0-99C2-B100F353****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The placeholder in the dynamic error message. This parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic message. This parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'title' => '实例列表的页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalSize' => [ + 'title' => '查询到的实例总数', + 'description' => 'The total number of instances returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '输入时设置的每页行数', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Result' => [ + 'description' => 'The returned information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the blacklist and whitelist.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '549', + ], + 'ResourceId' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '549', + ], + 'ResourceType' => [ + 'description' => 'The effective scope of the blacklist or whitelist. Valid values:'."\n" + ."\n" + .'* GATEWAY'."\n" + .'* DOMAIN'."\n" + .'* ROUTE'."\n", + 'type' => 'string', + 'example' => 'GATEWAY', + ], + 'Content' => [ + 'description' => 'The content of the blacklist.'."\n", + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'IsWhite' => [ + 'description' => 'Specifies whether to enable the whitelist feature.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Type' => [ + 'description' => 'The type of the blacklist and whitelist. The value is fixed to IP address blacklist and whitelist.'."\n", + 'type' => 'string', + 'example' => 'IP', + ], + 'Status' => [ + 'description' => 'The status of the blacklist or whitelist.'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", + 'type' => 'string', + 'example' => 'on', + ], + 'GatewayId' => [ + 'description' => 'The gateway ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '81', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-5017305290e14centbrveca****', + ], + 'GmtCreate' => [ + 'description' => 'The time when the blacklist or whitelist was created.'."\n", + 'type' => 'string', + 'example' => '2024-08-02T02:43:40.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The time when the rule was modified.'."\n", + 'type' => 'string', + 'example' => '2024-08-02T02:43:40.000+0000', + ], + 'ResourceIdJsonList' => [ + 'description' => 'The list of resource IDs in the JSON format.'."\n" + ."\n" + .'* If the value of the ResourceType parameter is ROUTE, the value of this parameter is the list of route IDs.'."\n" + .'* If the value of the ResourceType parameter is DOMAIN, the value of this parameter is the list of domain names.'."\n", + 'type' => 'string', + 'example' => '[234]', + ], + 'Note' => [ + 'description' => 'The comment.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ResourceIdNameJson' => [ + 'description' => 'The description of the resource name.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Name' => [ + 'description' => 'The name of the blacklist.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'GatewayBlackWhiteList', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '430', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '120', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'ResourceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'GATEWAY', + ], + 'Content' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'IP', + ], + 'IsWhite' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => '1', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '430', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-08-10 20:22:34', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-08-10 20:22:34', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetBlackWhiteList' => [ + 'summary' => 'Queries the blacklist or whitelist of a gateway.', + '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' => 'The type of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GATEWAY', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IP', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gw-32d5c9769c1842b1a2cc3426c59e****', + ], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the whitelist.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '89CBC928-4F57-51FA-A413-EE0F4CD87200', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation. ', + ], + 'Code' => [ + 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '275', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ResourceType' => [ + 'description' => 'The type of a resource.'."\n", + 'type' => 'string', + 'example' => 'GATEWAY', + ], + 'Content' => [ + 'description' => 'The content of the blacklist.'."\n", + 'type' => 'string', + 'example' => 'text', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'IP', + ], + 'IsWhite' => [ + 'description' => 'Indicates whether the whitelist is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => 'The status of the blacklist or whitelist.'."\n", + 'type' => 'string', + 'example' => 'on', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597c****', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + ], + ], + ], + ], + ], + ], + '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' => 'GetBlackWhiteList', + ], + 'AddGatewayAuth' => [ + 'summary' => 'Adds an authentication configuration for a gateway.', + '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' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'jwt', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authentication type. JSON Web Token (JWT) authentication, OpenID Connect (OIDC) authentication, Identity as a Service (IDaaS) authentication, or custom authentication are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'JWT', + ], + ], + [ + 'name' => 'Issuer', + 'in' => 'query', + 'schema' => [ + 'description' => 'The iss value of JWT claims, which indicates the issuer. You must make sure that the value of this parameter is the same as the iss value in the payload of JWT claims.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Jwks', + 'in' => 'query', + 'schema' => [ + 'description' => 'The JWT public key. The JSON format is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', + ], + ], + [ + 'name' => 'TokenPosition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The position of the parameter that is required to verify a token. By default, a token is prefixed with Bearer and stored in the authorization header. Example: `Authorization: Bearer token`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HEADER', + ], + ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the parameter that is required to verify a token. By default, a token is prefixed with Bearer and stored in the authorization header. Example: `Authorization: Bearer token`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Authorization', + ], + ], + [ + 'name' => 'TokenNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name prefix of the parameter that is required to verify a token. By default, a token is prefixed with Bearer and stored in the authorization header. Example: `Authorization: Bearer token`'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Bearer ', + ], + ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable pass-through.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the whitelist feature.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The redirect URL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://test-.com/oauth2/callback', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID registered with the OIDC authentication service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23460e2fdd9bf9ad106****', + ], + ], + [ + 'name' => 'ClientSecret', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application secret registered with the OIDC authentication service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + [ + 'name' => 'CookieDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name of the cookie. After the authentication is passed, the cookie is sent to the specified domain name to maintain the logon status. For example, if you set `Cookie-domain` to a.example.com, the cookie is sent to the domain name `a.example.com`. If you set `Cookie-domain` to .example.com, the cookie is sent to all subdomains of `example.com`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + ], + [ + 'name' => 'ScopesList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The OIDC scope.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The OIDC scope.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Separate multiple values with semicolons (;).'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'LoginUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL that is used to log on to the IDaaS instance.', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + [ + 'name' => 'Sub', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sub value of JWT claims, which indicates the subject. You must make sure that the value of this parameter is the same as the sub value in the payload of JWT claims. If you do not set this parameter or leave it empty, the default value, which is the value of the Issuer parameter, is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'ExternalAuthZJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the custom authentication service.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'PrefixPath' => [ + 'description' => 'The path of the authentication API provided by the authentication service. The path supports the prefix match method.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/auth', + ], + 'TokenKey' => [ + 'description' => 'The header that stores a token in an authentication request. In most cases, a token is stored in the Authorization or Cookie header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Authorization', + ], + 'AllowRequestHeaders' => [ + 'description' => 'The header that can be carried in an authentication request.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The OIDC scope.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'x-req', + ], + 'required' => false, + ], + 'AllowUpstreamHeaders' => [ + 'description' => 'The header that can be retained in an authentication response.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'x-resp', + ], + 'required' => false, + ], + 'Timeout' => [ + 'description' => 'The timeout period. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'IsRestrict' => [ + 'description' => 'Specifies whether the gateway allows a client request when the authentication server is unavailable. If a connection to the authentication server fails to be established or a 5xx error code is returned, the authentication server is unavailable.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'WithRequestBody' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'BodyMaxBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4000000', + ], + 'WithRematchRoute' => [ + 'type' => 'boolean', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gw-492af9b04bb4474cae9d645be850e3d7', + ], + ], + [ + 'name' => 'AuthResourceMode', + 'in' => 'query', + 'schema' => [ + 'title' => '授权资源模式：'."\n" + ."\n" + .'- 0：简单模式'."\n" + .'- 1：复杂模式', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + [ + 'name' => 'AuthResourceConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '复杂模式的YAML配置', + 'type' => 'string', + ], + ], + [ + 'name' => 'AuthResourceList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the resource to be authorized.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'DomainId' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Path' => [ + 'description' => 'The request path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'MatchType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'EQUAL', + ], + 'IgnoreCase' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AuthResourceHeaderList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'x-req', + ], + 'HeaderMethod' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'EQUAL', + ], + 'HeaderValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4279C00F-A5E1-53C6-A43B-751C1C524D0B', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + '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' => 'AddGatewayAuth', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ExternalAuthZ', + ], + ], + [ + 'name' => 'Issuer', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Jwks', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}', + ], + ], + [ + 'name' => 'TokenPosition', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'HEADER', + ], + ], + [ + 'name' => 'TokenName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Authorization', + ], + ], + [ + 'name' => 'TokenNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Bearer', + ], + ], + [ + 'name' => 'TokenPass', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '719', + ], + ], + [ + 'name' => 'RedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://test-.com/oauth2/callback', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'app_mnvxaavggw7hcdcnr6usi6***', + ], + ], + [ + 'name' => 'ClientSecret', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****', + ], + ], + [ + 'name' => 'CookieDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + ], + [ + 'name' => 'ScopesList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'openid', + ], + 'required' => false, + ], + ], + [ + 'name' => 'LoginUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://daxxxxcn.aliyunidaas.com/', + ], + ], + [ + 'name' => 'Sub', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example-app', + ], + ], + [ + 'name' => 'ExternalAuthZJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '37396', + ], + 'PrefixPath' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '/auth', + ], + 'TokenKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Authorization', + ], + 'AllowRequestHeaders' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'x-req', + ], + 'required' => false, + ], + 'AllowUpstreamHeaders' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'x-resp', + ], + 'required' => false, + ], + 'Timeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'IsRestrict' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'WithRequestBody' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'BodyMaxBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4000000', + ], + 'WithRematchRoute' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-9cdcf8e4f58144059e73ff4c5ef9****', + ], + ], + [ + 'name' => 'IsWhite', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AuthResourceMode', + 'in' => 'query', + 'schema' => [ + 'title' => '授权资源模式：'."\n" + ."\n" + .'- 0：简单模式'."\n" + .'- 1：复杂模式', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AuthResourceConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '复杂模式的YAML配置', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '\'\'', + ], + ], + [ + 'name' => 'AuthResourceList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'DomainId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1765', + ], + 'Path' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'MatchType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'EQUAL', + ], + 'IgnoreCase' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + ], + 'AuthResourceHeaderList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'x-req', + ], + 'HeaderMethod' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'EQUAL', + ], + 'HeaderValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DeleteResourceIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '719', + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetGatewayAuthDetail' => [ + 'summary' => 'Obtains the authentication details of a gateway.', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1100', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关ID（和网关唯一ID二选一）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2274', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关唯一ID（和网关ID二选一，网关唯一ID不为空时优先使用网关唯一ID查询）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6', + ], + 'HttpStatusCode' => [ + 'title' => 'HTTP 状态码。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '信息。', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'title' => '用于和Success同步，当Success为true时，Code为200', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'title' => '鉴权详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '鉴权ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1100', + ], + 'Name' => [ + 'title' => '鉴权名称', + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'title' => '鉴权所属网关的唯一ID', + 'description' => '', + 'type' => 'string', + 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', + ], + 'GatewayId' => [ + 'title' => '鉴权所属网关的ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2274', + ], + 'Type' => [ + 'title' => '鉴权类型：'."\n" + ."\n" + .'- JWT'."\n" + .'- OIDC'."\n" + .'- IDaaS'."\n" + .'- ExternalAuthZ（自建的鉴权服务）', + 'description' => '', + 'type' => 'string', + 'example' => 'JWT', + ], + 'Issuer' => [ + 'title' => '鉴权类型为JWT/OIDC时使用：'."\n" + ."\n" + .'- JWT：表示JWT claims 的iss(issuer)，即签发人。'."\n" + .'- OIDC：表示OIDC claims 的iss(issuer)，即签发人', + 'description' => '', + 'type' => 'string', + 'example' => 'https://example.com/auth', + ], + 'Jwks' => [ + 'title' => 'JWT公钥，JSON格式', + 'description' => '', + 'type' => 'string', + 'example' => '{\\n \\"keys\\":[\\n {\\n \\"kty\\": \\"RSA\\",\\n \\"e\\": \\"AQAB\\",\\n \\"use\\": \\"sig\\",\\n \\"kid\\": \\"1rGufmH1YN8rqM9ZOLgo7eEST3AnL89Y-m-XGFioLoA\\",\\n \\"alg\\": \\"RS256\\",\\n \\"n\\": \\"rM2GIc0YTMqwNCwXnjKbW5QndkCEZgyLu3uQUnyZF7HvMTekiTvQg_39mg3dV1eaYYkYfZBogyroJBqAQXhk6VVCxlBjFVp2xstJPVWngMOOlcafwN_BKdN-EQ06O_Uu__e7gNKI3DunkNk0cNaFETE7d4meRYyTlgEzYgsrW05_ufR0BKoddL3E5JsCpUxRjH9ICbodBx0U74W6Dcci-R2EA1DBrEcboE6n90uoJs6UJNriAK_71nAsYonihU5aQFFnyPTkJHfRwHK6JlME6rn-b-rpLSpdyc6U1nOFZP2DEpz8U5FrYoLYSZIU-MQGxDhCnGc_rxl2IyP9B2qcCQ\\"\\n }\\n ]\\n}\\n', + ], + 'IsWhite' => [ + 'title' => '授权黑白名单模式：'."\n" + ."\n" + .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" + .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'GmtCreate' => [ + 'title' => '鉴权创建的GMT时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-02-19T02:41:03.000+0000', + ], + 'GmtModified' => [ + 'title' => '鉴权修改的GMT时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-02-19T02:41:03.000+0000', + ], + 'TokenPosition' => [ + 'title' => 'JWT Token类型：'."\n" + ."\n" + .'- HEADER：通过Header传输', + 'description' => '', + 'type' => 'string', + 'example' => 'HEADER', + ], + 'TokenName' => [ + 'title' => 'JWT Token保存的位置', + 'description' => '', + 'type' => 'string', + 'example' => 'Authorization', + ], + 'TokenNamePrefix' => [ + 'title' => 'JWT Token的前缀', + 'description' => '', + 'type' => 'string', + 'example' => 'Bearer ', + ], + 'TokenPass' => [ + 'title' => '是否透传Token', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'title' => '鉴权是否开启', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RedirectUrl' => [ + 'title' => '授权成功后的重定向地址（OIDC/IDaaS使用，需要与OIDC/IDaaS中配置的重定向地址保持一致。）', + 'description' => '', + 'type' => 'string', + 'example' => 'https://yourdomain/path', + ], + 'ClientId' => [ + 'title' => '服务注册的应用ID（OIDC/IDaaS使用）。', + 'description' => '', + 'type' => 'string', + 'example' => 'example-app', + ], + 'ClientSecret' => [ + 'title' => '服务注册的应用Secret（OIDC/IDaaS使用）。', + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'CookieDomain' => [ + 'title' => 'Cookie的域名，认证通过后会将Cookie发送到指定的域名，保持登录状态（OIDC/IDaaS使用）。', + 'description' => '', + 'type' => 'string', + 'example' => 'hello.com', + ], + 'ScopesList' => [ + 'title' => 'OIDC 作用域（OIDC 使用）。', + 'description' => '', + 'type' => 'string', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'openid', + 'extendType' => 'true', + ], + 'example' => '["openid","email"]', + ], + 'LoginUrl' => [ + 'title' => 'IDaaS实例用户登录页地址（IDaaS使用）。', + 'description' => '', + 'type' => 'string', + 'example' => 'https://daxxxxcn.aliyunidaas.com/', + ], + 'Sub' => [ + 'title' => '鉴权类型为JWT时使用；JWT claims 的sub(subject)，即主体。', + 'description' => '', + 'type' => 'string', + 'example' => 'https://example.com/auth', + ], + 'ExternalAuthZ' => [ + 'title' => '自定义鉴权信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'title' => '鉴权服务ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15300', + ], + 'PrefixPath' => [ + 'title' => '鉴权API的Path', + 'description' => '', + 'type' => 'string', + 'example' => '/auth', + ], + 'TokenKey' => [ + 'title' => 'Token位置，表示Token位于请求报文中哪个Header中，常见的有Authorization和Cookie', + 'description' => '', + 'type' => 'string', + 'example' => 'Authorization', + ], + 'AllowRequestHeaders' => [ + 'title' => '允许的请求头部', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'x-req', + ], + ], + 'AllowUpstreamHeaders' => [ + 'title' => '允许的响应头部', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'x-resp', + ], + ], + 'Timeout' => [ + 'title' => '鉴权服务的超时时间，单位：秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'IsRestrict' => [ + 'title' => '自定义鉴权模式：'."\n" + ."\n" + .'- true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关拒绝客户端请求'."\n" + .'- false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回5xx请求），网关放过客户端请求', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Service' => [ + 'title' => '鉴权服务信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '鉴权服务名称', + 'description' => '', + 'type' => 'string', + 'example' => ' httpbin-auth-service', + ], + 'SourceType' => [ + 'title' => '鉴权服务来源类型', + 'description' => '', + 'type' => 'string', + 'example' => 'K8S', + ], + 'GroupName' => [ + 'title' => '鉴权服务所属的分组', + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'Namespace' => [ + 'title' => '鉴权服务命名空间', + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + 'WithRequestBody' => [ + 'title' => '是否允许携带Body', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BodyMaxBytes' => [ + 'title' => 'Body的最大字节数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4000000', + ], + 'WithRematchRoute' => [ + 'type' => 'boolean', + ], + ], + ], + 'ResourceList' => [ + 'title' => '鉴权的授权规则列表，多个规则条件之间是“或”关系，规则条件内的多个匹配项之间是“与”关系。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '授权规则ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1303', + ], + 'AuthId' => [ + 'title' => '规则所归属鉴权的ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2274', + ], + 'DomainId' => [ + 'title' => '规则内域名的ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1765', + ], + 'DomainName' => [ + 'title' => '规则内的域名', + 'description' => '', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Path' => [ + 'title' => '规则的匹配路径', + 'description' => '', + 'type' => 'string', + 'example' => '/test', + ], + 'IsWhite' => [ + 'title' => '授权黑白名单模式：'."\n" + ."\n" + .'- true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验）'."\n" + .'- false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'GatewayId' => [ + 'title' => '规则所属网关的ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2274', + ], + 'GatewayUniqueId' => [ + 'title' => '规则所属网关的唯一ID', + 'description' => '', + 'type' => 'string', + 'example' => 'gw-6f0dbd108a0249d2b675b3ef50b*****', + ], + 'GmtCreate' => [ + 'title' => '授权规则的创建GMT时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-02-19T03:32:38.000+0000', + ], + 'GmtModified' => [ + 'title' => '授权规则的修改GMT时间', + 'description' => '', + 'type' => 'string', + 'example' => '2024-02-19T03:32:38.000+0000', + ], + 'MatchType' => [ + 'title' => '请求Path的匹配类型：'."\n" + ."\n" + .'- EQUAL：精确匹配'."\n" + .'- PRE：前缀匹配'."\n" + .'- ERGULAR：正则匹配', + 'description' => '', + 'type' => 'string', + 'example' => 'EQUAL', + ], + 'IgnoreCase' => [ + 'title' => '路径是否开启大小写敏感'."\n" + ."\n" + .'- true：开启大小写敏感'."\n" + .'- false：关闭大小写敏感', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AuthResourceHeaderList' => [ + 'title' => '规则的请求头（当前仅供自定义鉴权使用）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => [ + 'title' => '请求头名称', + 'description' => '', + 'type' => 'string', + 'example' => 'x-req', + ], + 'HeaderMethod' => [ + 'title' => '匹配条件：'."\n" + ."\n" + .'- EQUAL：等于'."\n" + .'- NOT_EQUAL：不等于'."\n" + .'- EXIST：存在'."\n" + .'- NOT_EXIST：不存在'."\n" + .'- INCLUDE：包含'."\n" + .'- EXCLUDE：不包含'."\n" + .'- PREFIX：前缀'."\n" + .'- SUFFIX：后缀'."\n" + .'- REGREX：正则', + 'description' => '', + 'type' => 'string', + 'example' => 'EQUAL', + ], + 'HeaderValue' => [ + 'title' => '请求头的值', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + 'AuthResourceMode' => [ + 'title' => '授权资源模式：'."\n" + ."\n" + .'- 0：简单模式'."\n" + .'- 1：复杂模式', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AuthResourceConfig' => [ + 'title' => '复杂模式的YAML配置', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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' => 'GetGatewayAuthDetail', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-5017305290e14centbrveca****', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '549', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'JWT', + ], + 'Issuer' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://example.com/auth', + ], + 'Jwks' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{\\"keys\\":[{\\"kty\\":\\"oct\\",\\"k\\":\\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\\",\\"alg\\":\\"HS256\\"}]}', + ], + 'TokenPosition' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HEADER', + ], + 'TokenName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Authorization', + ], + 'TokenNamePrefix' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Bearer', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-09-13 19:24:23', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-09-13 19:24:23', + ], + 'TokenPass' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsWhite' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://test.com/oauth2/callback', + ], + 'ClientId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'app_mnvxaavggw7hcdcnr6usi6***', + ], + 'ClientSecret' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****', + ], + 'CookieDomain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.com', + ], + 'ScopesList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["openid"]', + ], + 'LoginUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' '."\n" + .'https://daxxxxcn.aliyunidaas.com/', + ], + 'Sub' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example-app', + ], + 'ExternalAuthZ' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45186', + ], + 'PrefixPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/auth', + ], + 'TokenKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Authorization', + ], + 'AllowRequestHeaders' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'x-req', + ], + ], + 'AllowUpstreamHeaders' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'x-resp', + ], + ], + 'Timeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'WithRequestBody' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'WithRematchRoute' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BodyMaxBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'IsRestrict' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Service' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'updatetime', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MSE', + ], + 'GroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'com.mse.console.test.3YXO', + ], + 'Namespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + 'AuthResourceMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '120', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '399', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'JWT', + ], + 'Issuer' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://example.com/auth', + ], + 'Jwks' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "keys": ['."\n" + .' {'."\n" + .' "e": "AQAB",'."\n" + .' "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ",'."\n" + .' "kty": "RSA",'."\n" + .' "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'IsWhite' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'TokenPosition' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HEADER', + ], + 'TokenName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Authorization', + ], + 'TokenNamePrefix' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Bearer ', + ], + 'TokenPass' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://yourdomain/path', + ], + 'ClientId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example-app', + ], + 'ClientSecret' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'CookieDomain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.com', + ], + 'ScopesList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'openid', + ], + ], + 'LoginUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://daxxxxcn.aliyunidaas.com/', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'AddAuthResource' => [ + 'summary' => 'Adds authorization information for a gateway.', + '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' => 'The ID of the authorization record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '13', + ], + ], + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '128', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '/abc', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', + ], + ], + [ + 'name' => 'MatchType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The matching type. Valid values:'."\n" + ."\n" + .'* EQUAL'."\n" + .'* PRE'."\n" + .'* ERGULAR'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'exact', + ], + ], + [ + 'name' => 'IgnoreCase', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the matching is not case-sensitive. Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AuthResourceHeaderList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The authentication resource headers.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => [ + 'description' => 'The parameter of the HTTP header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Access-Control-Allow-Origin', + ], + 'HeaderMethod' => [ + 'description' => 'The header matching mode.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SUFFIX'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* EXIST'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* PREFIX'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* EQUAL'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* EXCLUDE'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* NOT_EQUAL'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* NOT_EXIST'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* REGREX'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* INCLUDE'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SUFFIX' => '', + 'EXIST' => '', + 'PREFIX' => '', + 'EQUAL' => '', + 'EXCLUDE' => '', + 'NOT_EQUAL' => '', + 'NOT_EXIST' => '', + 'REGREX' => '', + 'INCLUDE' => '', + ], + 'example' => 'EQUAL', + ], + 'HeaderValue' => [ + 'description' => 'The parameter value of the HTTP header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4BBCF560-4DD7-5DBD-B849-CCB135BBBAB7', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '403', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 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' => 'AddAuthResource', + ], + 'DeleteAuthResource' => [ + 'summary' => 'Deletes an authorized resource.', + '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' => 'The destination ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '36', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '559412D1-BFCE-53CC-B88E-0192C331EF44', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the primary key.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'AuthId' => [ + 'description' => 'The authentication ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '253', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', + ], + 'DomainId' => [ + 'description' => 'The ID of the domain name.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'DomainName' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/zookeeper', + ], + 'IsWhite' => [ + 'description' => 'Indicates whether the whitelist mode is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + ], + ], + ], + ], + ], + ], + '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' => 'DeleteAuthResource', + ], + 'AddGatewayRoute' => [ + 'summary' => 'Adds a gateway route.', + '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' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '526', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the route.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RouteOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sequence number of the route. (A small value indicates a high priority.)'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Predicates', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The matching rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'Type' => [ + 'description' => 'The route matching type. Valid values:'."\n" + ."\n" + .'* PRE: prefix matching'."\n" + .'* EQUAL: exact matching'."\n" + .'* ERGULAR: regular expression matching'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'PRE', + ], + 'IgnoreCase' => [ + 'description' => 'Specifies whether to ignore case sensitivity.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'MethodPredicates' => [ + 'description' => 'The information about method matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + 'required' => false, + ], + 'HeaderPredicates' => [ + 'description' => 'The information about header matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request header.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the request header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'debug', + ], + 'Value' => [ + 'description' => 'The value of the request header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRE', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'QueryPredicates' => [ + 'description' => 'The information about URL parameter matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the URL parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'userid', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRE', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Services', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of services.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '353', + ], + 'Percent' => [ + 'description' => 'The weight in the form of a percentage value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'Version' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + 'SourceType' => [ + 'description' => 'The source type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace to which the service belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'AgreementType' => [ + 'description' => 'The type of the protocol.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DUBBO', + ], + 'HttpDubboTranscoder' => [ + 'description' => 'The transcoder of the Dubbo protocol.'."\n", + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => [ + 'description' => 'The name of the Dubbo service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', + ], + 'DubboServiceVersion' => [ + 'description' => 'The version of the Dubbo service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0', + ], + 'DubboServiceGroup' => [ + 'description' => 'The name of the service group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'None'."\n", + ], + 'MothedMapList' => [ + 'description' => 'The forwarding rules of the Dubbo service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method mapping.'."\n", + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => [ + 'description' => 'The method name of the Dubbo service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sayHello', + ], + 'HttpMothed' => [ + 'description' => 'The HTTP method.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* ALL_GET'."\n" + ."\n" + .'* ALL_POST'."\n" + ."\n" + .'* ALL_PUT'."\n" + ."\n" + .'* ALL_DELETE'."\n" + ."\n" + .'* ALL_PATCH'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALL_GET', + ], + 'Mothedpath' => [ + 'description' => 'The path used for method matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/mytestzbk/sayhello', + ], + 'PassThroughAllHeaders' => [ + 'description' => 'The pass-through type of the header.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* PASS_ALL: All headers are passed through.'."\n" + ."\n" + .'* PASS_NOT: All headers are not passed through.'."\n" + ."\n" + .'* PASS_ASSIGN: Specified headers are passed through.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PASS_NOT', + ], + 'PassThroughList' => [ + 'description' => 'The list of headers to be passed through.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the header to be passed through.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'x-forward', + ], + 'required' => false, + ], + 'ParamMapsList' => [ + 'description' => 'The information about parameter mappings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter mapping object.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => [ + 'description' => 'The position of the input parameter.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* `ALL_QUERY_PARAMETER`: request parameter'."\n" + ."\n" + .'* `ALL_HEADER`: request header'."\n" + .'* `ALL_PATH`: request path'."\n" + .'* `ALL_BODY`: request body'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALL_QUERY_PARAMETER', + ], + 'ExtractKey' => [ + 'description' => 'The key extracted from the input parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'MappingType' => [ + 'description' => 'The type of the backend service parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'java.lang.String', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ServicePort' => [ + 'description' => 'The service port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '443', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination service. Valid values:'."\n" + ."\n" + .'* Single'."\n" + .'* Multiple'."\n" + .'* VersionOriented'."\n" + .'* Mock'."\n" + .'* Redirect'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VersionOriented' => 'VersionOriented', + 'Multiple' => 'Multiple', + 'Single' => 'Single', + 'Redirect' => 'Redirect', + 'Mock' => 'Mock', + ], + 'example' => 'Multiple', + ], + ], + [ + 'name' => 'DirectResponseJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The mock response configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The mock return code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '403', + ], + 'Body' => [ + 'description' => 'The mock return value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-492af9b04bb4474cae9d645be8*****', + ], + ], + [ + 'name' => 'DomainIdListJSON', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[0,94]', + ], + ], + [ + 'name' => 'RedirectJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configuration of the redirection.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '302', + ], + 'Host' => [ + 'description' => 'The hostname to be redirected to.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + 'Path' => [ + 'description' => 'The path to be redirected to.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnableWaf', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to activate Web Application Firewall (WAF).'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Fallback', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the Fallback service.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FallbackServices', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the Fallback service.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '353', + ], + 'Percent' => [ + 'description' => 'The weight in the form of a percentage value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'Version' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + 'SourceType' => [ + 'description' => 'The source type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace to which the service belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'AgreementType' => [ + 'description' => 'The type of the protocol.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DUBBO', + ], + 'ServicePort' => [ + 'description' => 'The service port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '443', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RouteType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The route type. Valid values:'."\n" + ."\n" + .'Op: Manage routes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Op', + ], + ], + [ + 'name' => 'Policies', + 'in' => 'query', + 'schema' => [ + 'description' => 'The routing policy in a JSON string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"CORS":"{\\"allowMethods\\":\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\"allowHeaders\\":\\"*\\",\\"exposeHeaders\\":\\"*\\",\\"unitNum\\":12,\\"allowCredentials\\":true,\\"status\\":\\"off\\",\\"allowOrigins\\":\\"*\\",\\"timeUnit\\":\\"h\\"}","Timeout":"{\\"unitNum\\":10,\\"timeUnit\\":\\"s\\",\\"status\\":\\"off\\"}","Retry":"{\\"attempts\\":2,\\"retryOn\\":[\\"5xx\\"],\\"status\\":\\"off\\"}","HTTPRewrite":"{\\"pathType\\":\\"EQUAL\\",\\"path\\":\\"/o\\",\\"status\\":\\"off\\"}","Waf":"{\\"enabled\\":false}","HeaderOp":"{\\"status\\":\\"off\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Add\\",\\"key\\":\\"kkk\\",\\"value\\":\\"ll\\"}]}"}', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '路由描述', + 'type' => 'string', + 'example' => 'a route for xxx', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '03A3E2F4-6804-5663-9D5D-2EC47A1*****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The ID of the created route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '555', + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned.'."\n" + ."\n" + .'* InvalidParameter: The parameter is invalid. For example, the parameter is incomplete or the parameter format is invalid.'."\n" + .'* IllegalRequest: The request is invalid. Unauthorized access to data initiated by parameters is identified.'."\n" + .'* NoPermission: You are not authorized to perform this operation.'."\n" + .'* NotFound: The resource does not exist and error 404 is returned.'."\n" + .'* InternalError: An internal error occurred.'."\n", + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + ], + ], + ], + ], + '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' => 'AddGatewayRoute', + ], + 'DeleteGatewayRoute' => [ + 'summary' => 'Deletes a route from a gateway.', + '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' => 'The ID of the route.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '252', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'gw-492af9b04bb4474cae9d645be850e3d7', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-5017305290e14cebbrvec4a5****', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '125', + ], + 'Predicates' => [ + 'description' => 'The matching rules.'."\n", + 'type' => 'string', + 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}', + ], + 'DefaultServiceId' => [ + 'description' => 'The default service ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RouteOrder' => [ + 'description' => 'The sequence number of the route.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => 'The status of the route. Valid values:'."\n" + ."\n" + .'* 0: unpublished'."\n" + .'* 2: publishing'."\n" + .'* 3: published'."\n" + .'* 4: editing (updated but not published)'."\n" + .'* 5: unpublishing'."\n" + .'* 6: unavailable'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2021-12-30T06:41:52.000+0000', + ], + ], + ], + ], + ], + ], + ], + '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' => 'DeleteGatewayRoute', + ], + 'UpdateGatewayRouteHTTPRewrite' => [ + 'summary' => 'Updates the rewrite policy of a route for a gateway.', + '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' => 'The ID of the route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '238', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '430', + ], + ], + [ + 'name' => 'HttpRewriteJSON', + 'in' => 'query', + 'schema' => [ + 'description' => 'The information about the rewrite policy. The JSON format is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"pathType":"PRE","path":"/","status":"off"}', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-90392d768a3847a7b804c505254da96d', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AE60DA1E-B234-5105-897B-68372453A5A2', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '411', + ], + ], + ], + ], + ], + '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' => 'UpdateGatewayRouteHTTPRewrite', + ], + 'UpdateGatewayRoute' => [ + 'summary' => 'Updates a route for a gateway.', + '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' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '501', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the route.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'route-web', + 'title' => '路由名称（已废弃，不支持修改路由名称，填入和当前不同的路由名称会导致更新失败）', + 'deprecated' => true, + ], + ], + [ + 'name' => 'RouteOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sequence number of the route.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Predicates', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The route matching conditions.'."\n", + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'The information about path matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The path used for route matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRE', + ], + 'IgnoreCase' => [ + 'description' => 'Specifies whether to perform case-insensitive matching.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + 'MethodPredicates' => [ + 'description' => 'The information about method matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + 'required' => false, + ], + 'HeaderPredicates' => [ + 'description' => 'The information about header matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request header.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the request header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'debug', + ], + 'Value' => [ + 'description' => 'The value of the request header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRE', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'QueryPredicates' => [ + 'description' => 'The information about parameter matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a URL parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'userid', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRE', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Services', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about destination services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The services.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Percent' => [ + 'description' => 'The percentage.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'Version' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'web', + ], + 'SourceType' => [ + 'description' => 'The source type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace in which the service resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'AgreementType' => [ + 'description' => 'The type of the protocol. Valid values:'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DUBBO'."\n", + ], + 'HttpDubboTranscoder' => [ + 'description' => 'The transcoder of the Dubbo protocol.'."\n", + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => [ + 'description' => 'The name of the Dubbo service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', + ], + 'DubboServiceVersion' => [ + 'description' => 'The version of the Dubbo service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0', + ], + 'DubboServiceGroup' => [ + 'description' => 'The Dubbo service group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'service name', + ], + 'MothedMapList' => [ + 'description' => 'The forwarding rules of the Dubbo service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method mapping object.'."\n", + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => [ + 'description' => 'The method name of the Dubbo service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sayHello', + ], + 'HttpMothed' => [ + 'description' => 'The HTTP method.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* ALL_GET'."\n" + ."\n" + .'* ALL_POST'."\n" + ."\n" + .'* ALL_PUT'."\n" + ."\n" + .'* ALL_DELETE'."\n" + ."\n" + .'* ALL_PATCH'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALL_GET', + ], + 'Mothedpath' => [ + 'description' => 'The path that is used to match a method.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/mytestzbk/sayhello'."\n", + ], + 'PassThroughAllHeaders' => [ + 'description' => 'The pass-through type of the header.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* PASS_ALL: All headers are passed through.'."\n" + ."\n" + .'* PASS_NOT: All headers are not passed through.'."\n" + ."\n" + .'* PASS_ASSIGN: Specified headers are passed through.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PASS_NOT'."\n", + ], + 'PassThroughList' => [ + 'description' => 'The list of headers to be passed through.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the header to be passed through.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'x-forward'."\n", + ], + 'required' => false, + ], + 'ParamMapsList' => [ + 'description' => 'The information of parameter mappings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter mapping object.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => [ + 'description' => 'The position of the input parameter.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* `ALL_QUERY_PARAMETER`: request parameter'."\n" + ."\n" + .'* `ALL_HEADER`: request header'."\n" + ."\n" + .'* `ALL_PATH`: request path'."\n" + ."\n" + .'* `ALL_BODY`: request body'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALL_QUERY_PARAMETER'."\n", + ], + 'ExtractKey' => [ + 'description' => 'The key extracted from the input parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'MappingType' => [ + 'description' => 'The type of the backend service parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'java.lang.String', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ServicePort' => [ + 'description' => 'The Dubbo port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20880', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '139', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination service type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Mock', + ], + ], + [ + 'name' => 'DirectResponseJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about service mocking.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The mock return code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + 'Body' => [ + 'description' => 'The mock return value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392a2c4', + ], + ], + [ + 'name' => 'DomainIdListJSON', + 'in' => 'query', + 'schema' => [ + 'description' => 'The associated domain name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[90]', + ], + ], + [ + 'name' => 'RedirectJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about redirection.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '302', + ], + 'Host' => [ + 'description' => 'The hostname to be redirected to.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + 'Path' => [ + 'description' => 'The path to be redirected to.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnableWaf', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to activate Web Application Firewall (WAF).'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '请使用UpdateGatewayRouteWafStatus更新路由WAF状态', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Fallback', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the Fallback service.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FallbackServices', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the Fallback service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data object.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Percent' => [ + 'description' => 'The weight in the form of a percentage value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'Version' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'SourceType' => [ + 'description' => 'The source type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace in which the service resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Namespace'."\n", + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'AgreementType' => [ + 'description' => 'The type of the protocol. Valid values:'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DUBBO'."\n", + ], + 'ServicePort' => [ + 'description' => 'The service port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8848', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '路由描述', + 'type' => 'string', + 'example' => 'a route for xxx', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '73785414-2C5B-5E28-BD91-B2C742269C48', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '337', + ], + 'ErrorCode' => [ + 'description' => 'The error code returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'NoPermission', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73785414-2C5B-5E28-BD91-B2C742269C48\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 337,\\n \\"ErrorCode\\": \\"NoPermission\\"\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRoute', + ], + 'UpdateGatewayRouteCORS' => [ + 'summary' => 'Modifies the cross-origin resource sharing (CORS) policy of a route.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '101484', + 'abilityTreeNodes' => [ + 'FEATUREmseXCPJ75', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the associated record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '55', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '85', + ], + ], + [ + 'name' => 'CorsJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the CORS policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'off', + ], + 'AllowOrigins' => [ + 'description' => 'The origins from which access is allowed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://api.aliyun-inc.com/', + ], + 'AllowMethods' => [ + 'description' => 'The HTTP methods allowed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GET,POST', + ], + 'AllowHeaders' => [ + 'description' => 'The request headers allowed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'content-type', + ], + 'ExposeHeaders' => [ + 'description' => 'The response headers allowed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + 'TimeUnit' => [ + 'description' => 'The unit of time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'h', + ], + 'UnitNum' => [ + 'description' => 'The value of time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '24', + ], + 'AllowCredentials' => [ + 'description' => 'The credentials allowed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-f70a6ddf2f0941a2bb997b2d16028f37', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. In compliance with [RFC 7231](https://tools.ietf.org/html/rfc7231), the backend service must return a response based on the language used by the user.'."\n" + ."\n" + .'* No default value.'."\n" + .'* zh-CN: Chinese'."\n" + .'* en-US: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '41BE990E-44E4-5ED3-AEEB-A276941B1854', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation. ', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '618', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41BE990E-44E4-5ED3-AEEB-A276941B1854\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation. \\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 618\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteCORS', + ], + 'UpdateGatewayRouteHeaderOp' => [ + 'summary' => 'Modifies the header configuration policy of a route.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '72158', + 'abilityTreeNodes' => [ + 'FEATUREmseXCPJ75', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '411', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '324', + ], + ], + [ + 'name' => 'HeaderOpJSON', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of user header settings.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"status\\":\\"on\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Update\\",\\"key\\":\\"hosts\\",\\"value\\":\\"test.com\\"}]}', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-6bdc977deda44bf589c49d063b4c2d1d', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7C8CB294-BED8-5F32-A416-7517725E8F27', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '666', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C8CB294-BED8-5F32-A416-7517725E8F27\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 666\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteHeaderOp', + ], + 'UpdateGatewayRouteTimeout' => [ + 'summary' => 'Modifies the timeout policy of a route.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '114050', + 'abilityTreeNodes' => [ + 'FEATUREmseXCPJ75', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the associated record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '567', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '85', + ], + ], + [ + 'name' => 'TimeoutJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The timeout period.'."\n", + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'description' => 'The value of the timeout period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'TimeUnit' => [ + 'description' => 'The unit of time. A value of s indicates seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 's', + ], + 'Status' => [ + 'description' => 'The status of the policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'off', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-533290d279c1405f9628c64f7c8272ee', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5359729E-A059-5942-98AF-E981E89C99FA', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. true: The request was successful. false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5359729E-A059-5942-98AF-E981E89C99FA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 400\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteTimeout', + ], + 'UpdateGatewayRouteRetry' => [ + 'summary' => 'Modifies the retry policy of a route.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '114051', + 'abilityTreeNodes' => [ + 'FEATUREmseXCPJ75', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the associated record.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '508', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '501', + ], + ], + [ + 'name' => 'RetryJSON', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the retry policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Attempts' => [ + 'description' => 'The number of retries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'RetryOn' => [ + 'description' => 'The retry conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The retry condition.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5xx', + ], + 'required' => false, + ], + 'HttpCodes' => [ + 'description' => 'The HTTP status codes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'Status' => [ + 'description' => 'The status of the policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'off', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1d10a', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9297B27D-D932-5E9F-93B9-99D6C5F3A879', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9297B27D-D932-5E9F-93B9-99D6C5F3A879\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": 640\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteRetry', + ], + 'GetGatewayRouteDetail' => [ + 'summary' => 'Queries the details of a route for a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1050', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-5d3a78a53ec947aa928212d671d400ac', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FDF2D16C-5D28-5FAA-A56B-30BDE3559880', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1050', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597c****', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DefaultServiceId' => [ + 'description' => 'The default service ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'DefaultServiceName' => [ + 'description' => 'The default service name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => 'The status of the route. Valid values:'."\n" + ."\n" + .'* 0: unpublished'."\n" + .'* 2: publishing'."\n" + .'* 3: published'."\n" + .'* 4: editing (updated but not published)'."\n" + .'* 5: unpublishing'."\n" + .'* 6: unavailable'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'GmtModified' => [ + 'description' => 'The last modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07T10:07:57.000+0000', + ], + 'RouteOrder' => [ + 'description' => 'The sequence number of the route.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Predicates' => [ + 'description' => 'The matching conditions.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'RoutePredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/api', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + 'IgnoreCase' => [ + 'description' => 'Indicates whether case sensitivity is ignored.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'MethodPredicates' => [ + 'description' => 'The information about method matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method.'."\n", + 'type' => 'string', + 'example' => 'GET', + ], + ], + 'HeaderPredicates' => [ + 'description' => 'The information about header matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request header.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the request header.'."\n", + 'type' => 'string', + 'example' => 'id', + ], + 'Value' => [ + 'description' => 'The value of the request header.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Type' => [ + 'description' => 'The route type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + ], + ], + ], + 'QueryPredicates' => [ + 'description' => 'The information about parameter matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The parameter name.'."\n", + 'type' => 'string', + 'example' => 'userid', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'description' => 'The route type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + ], + ], + ], + ], + ], + 'DomainId' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'DomainName' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => '123.com', + ], + 'Services' => [ + 'description' => 'The configurations of services.'."\n", + 'type' => 'string', + 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]', + ], + 'RouteServices' => [ + 'description' => 'The services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The services.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The service ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '782', + ], + 'ServiceName' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'example' => 'xkc-crm', + ], + 'Percent' => [ + 'description' => 'The weight.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Version' => [ + 'description' => 'The service version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'example' => 'dubbo4', + ], + 'SourceType' => [ + 'description' => 'The source type of the service.'."\n", + 'type' => 'string', + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'api', + ], + 'AgreementType' => [ + 'description' => 'The protocol type.'."\n", + 'type' => 'string', + 'example' => 'DUBBO', + ], + 'HttpDubboTranscoder' => [ + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => [ + 'type' => 'string', + ], + 'DubboServiceVersion' => [ + 'type' => 'string', + ], + 'MothedMapList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => [ + 'type' => 'string', + ], + 'HttpMothed' => [ + 'type' => 'string', + ], + 'Mothedpath' => [ + 'type' => 'string', + ], + 'PassThroughAllHeaders' => [ + 'type' => 'string', + ], + 'PassThroughList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ParamMapsList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => [ + 'type' => 'string', + ], + 'ExtractKey' => [ + 'type' => 'string', + ], + 'MappingType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'DubboServiceGroup' => [ + 'type' => 'string', + ], + ], + ], + 'ServicePort' => [ + 'description' => 'The port number of the service.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20880', + ], + 'HealthStatus' => [ + 'title' => '健康状态'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Checking'."\n" + ."\n" + .'- Unknown', + 'type' => 'string', + 'example' => 'Health', + ], + 'UnhealthyEndpoints' => [ + 'title' => '非健康Endpoint列表', + 'type' => 'array', + 'items' => [ + 'title' => '非健康Endpoint', + 'type' => 'string', + 'example' => '192.168.1.2', + ], + ], + ], + ], + ], + 'HTTPRewrite' => [ + 'description' => 'The information about the rewrite policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the policy.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + 'Path' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'example' => '/test/client', + ], + 'Host' => [ + 'description' => 'The hostname of the gateway.'."\n", + 'type' => 'string', + 'example' => 'aliyuncs.com', + ], + 'PathType' => [ + 'description' => 'The rewrite type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + 'Pattern' => [ + 'description' => 'The matching pattern.'."\n", + 'type' => 'string', + 'example' => '/test', + ], + 'Substitution' => [ + 'description' => 'The replacement.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'HeaderOp' => [ + 'description' => 'The header settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + 'HeaderOpItems' => [ + 'description' => 'The information about headers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'DirectionType' => [ + 'description' => 'The request or response.'."\n", + 'type' => 'string', + 'example' => 'Response', + ], + 'OpType' => [ + 'description' => 'The type of the operation.'."\n", + 'type' => 'string', + 'example' => 'Add', + ], + 'Key' => [ + 'description' => 'The header key.'."\n", + 'type' => 'string', + 'example' => 'debug', + ], + 'Value' => [ + 'description' => 'The header value.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'DestinationType' => [ + 'description' => 'The destination service type.'."\n", + 'type' => 'string', + 'example' => 'Single', + ], + 'DirectResponse' => [ + 'description' => 'The information about service mocking.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Body' => [ + 'description' => 'The mock return value.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + 'Cors' => [ + 'description' => 'The configuration for cross-origin resource sharing (CORS).'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + 'AllowOrigins' => [ + 'description' => 'The origins allowed.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'AllowMethods' => [ + 'description' => 'The methods allowed.'."\n", + 'type' => 'string', + 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH', + ], + 'AllowHeaders' => [ + 'description' => 'The headers allowed.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'ExposeHeaders' => [ + 'description' => 'The response headers.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'TimeUnit' => [ + 'description' => 'The time unit.'."\n", + 'type' => 'string', + 'example' => 'h', + ], + 'UnitNum' => [ + 'description' => 'The unit number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'AllowCredentials' => [ + 'description' => 'The credentials allowed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Timeout' => [ + 'description' => 'The timeout configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'description' => 'The unit number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TimeUnit' => [ + 'description' => 'The time unit.'."\n", + 'type' => 'string', + 'example' => 's', + ], + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + ], + ], + 'Retry' => [ + 'description' => 'The retry configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Attempts' => [ + 'description' => 'The number of retries allowed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RetryOn' => [ + 'description' => 'The retry condition.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The retry condition.'."\n", + 'type' => 'string', + 'example' => '5xx', + ], + ], + 'HttpCodes' => [ + 'description' => 'The HTTP status codes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => '500', + ], + ], + 'Status' => [ + 'description' => 'The retry status.'."\n", + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + 'DomainIdList' => [ + 'description' => 'The IDs of domains.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of domains.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'DomainNameList' => [ + 'description' => 'The list of domain names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of domain names.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + ], + 'Redirect' => [ + 'description' => 'The configuration of the redirection.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Host' => [ + 'description' => 'The hostname.'."\n", + 'type' => 'string', + 'example' => '16', + ], + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '10111', + ], + ], + ], + 'FlowMirror' => [ + 'description' => '流量镜像配置。', + 'type' => 'object', + 'properties' => [ + 'TargetServiceId' => [ + 'description' => '目标服务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'TargetServiceName' => [ + 'description' => '目标服务名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Port' => [ + 'description' => '目标服务端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8790', + ], + 'Percentage' => [ + 'description' => '流量复制比例（%），取值0-100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'Status' => [ + 'description' => '开启状态，取值：'."\n" + ."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + 'EnableWaf' => [ + 'description' => 'Indicates whether Web Application Firewall (WAF) is activated.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AhasStatus' => [ + 'description' => 'The status of Application High Availability Service (AHAS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Fallback' => [ + 'description' => 'Indicates whether the Fallback service is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'FallbackServices' => [ + 'description' => 'The information of the Fallback service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data object.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The service ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ServiceName' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'Percent' => [ + 'description' => 'The weight in the form of a percentage value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Version' => [ + 'description' => 'The service version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'SourceType' => [ + 'description' => 'The source type of the service.'."\n", + 'type' => 'string', + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'namespace', + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AgreementType' => [ + 'description' => 'The protocol type.'."\n", + 'type' => 'string', + 'example' => 'DUBBO', + ], + 'ServicePort' => [ + 'description' => 'The port number of the service.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8848', + ], + ], + ], + ], + 'Policies' => [ + 'description' => 'The routing policy in a JSON string.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "CORS": "{\\"allowMethods\\":\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\"allowHeaders\\":\\"*\\",\\"exposeHeaders\\":\\"*\\",\\"unitNum\\":12,\\"allowCredentials\\":true,\\"status\\":\\"off\\",\\"allowOrigins\\":\\"*\\",\\"timeUnit\\":\\"h\\"}",'."\n" + .' "Timeout": "{\\"unitNum\\":10,\\"timeUnit\\":\\"s\\",\\"status\\":\\"off\\"}",'."\n" + .' "Retry": "{\\"attempts\\":2,\\"retryOn\\":[\\"5xx\\"],\\"status\\":\\"off\\"}",'."\n" + .' "HTTPRewrite": "{\\"pathType\\":\\"EQUAL\\",\\"path\\":\\"/o\\",\\"status\\":\\"off\\"}",'."\n" + .' "Waf": "{\\"enabled\\":false}",'."\n" + .' "HeaderOp": "{\\"status\\":\\"off\\",\\"headerOpItems\\":[{\\"directionType\\":\\"Request\\",\\"opType\\":\\"Add\\",\\"key\\":\\"kkk\\",\\"value\\":\\"ll\\"}]}"'."\n" + .'}', + ], + 'Description' => [ + 'title' => '路由描述', + 'type' => 'string', + 'example' => 'a route for xxx', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FDF2D16C-5D28-5FAA-A56B-30BDE3559880\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 1050,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597c****\\",\\n \\"GatewayId\\": 1,\\n \\"DefaultServiceId\\": 3,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"Status\\": 0,\\n \\"GmtCreate\\": \\"2022-01-07 18:07:57\\",\\n \\"GmtModified\\": \\"2022-01-07T10:07:57.000+0000\\",\\n \\"RouteOrder\\": 1,\\n \\"Predicates\\": \\"{}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/api\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"200\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"123.com\\",\\n \\"Services\\": \\"[{\\\\\\\\\\\\\\"Percent\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"ServiceId\\\\\\\\\\\\\\":126}]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 782,\\n \\"ServiceName\\": \\"xkc-crm\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"dubbo4\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"GroupName\\": \\"api\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"HttpDubboTranscoder\\": {\\n \\"DubboServiceName\\": \\"org.apache.dubbo.samples.basic.api.DemoService\\\\n\\",\\n \\"DubboServiceVersion\\": \\"0.0.0\\",\\n \\"MothedMapList\\": [\\n {\\n \\"DubboMothedName\\": \\"sayHello\\",\\n \\"HttpMothed\\": \\"ALL_GET\\",\\n \\"Mothedpath\\": \\"/mytestzbk/sayhello\\",\\n \\"PassThroughAllHeaders\\": \\"PASS_NOT\\",\\n \\"PassThroughList\\": [\\n \\"x-forward\\"\\n ],\\n \\"ParamMapsList\\": [\\n {\\n \\"ExtractKeySpec\\": \\"ALL_QUERY_PARAMETER\\",\\n \\"ExtractKey\\": \\"name\\",\\n \\"MappingType\\": \\"java.lang.String\\"\\n }\\n ]\\n }\\n ],\\n \\"DubboServiceGroup\\": \\"service group\\"\\n },\\n \\"ServicePort\\": 20880,\\n \\"HealthStatus\\": \\"Health\\",\\n \\"UnhealthyEndpoints\\": [\\n \\"192.168.1.2\\"\\n ]\\n }\\n ],\\n \\"HTTPRewrite\\": {\\n \\"Status\\": \\"off\\",\\n \\"Path\\": \\"/test/client\\",\\n \\"Host\\": \\"aliyuncs.com\\",\\n \\"PathType\\": \\"PRE\\",\\n \\"Pattern\\": \\"/test\\",\\n \\"Substitution\\": \\"test\\"\\n },\\n \\"HeaderOp\\": {\\n \\"Status\\": \\"off\\",\\n \\"HeaderOpItems\\": [\\n {\\n \\"DirectionType\\": \\"Response\\",\\n \\"OpType\\": \\"Add\\",\\n \\"Key\\": \\"debug\\",\\n \\"Value\\": \\"test\\"\\n }\\n ]\\n },\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"{}\\"\\n },\\n \\"Cors\\": {\\n \\"Status\\": \\"off\\",\\n \\"AllowOrigins\\": \\"*\\",\\n \\"AllowMethods\\": \\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\n \\"AllowHeaders\\": \\"*\\",\\n \\"ExposeHeaders\\": \\"*\\",\\n \\"TimeUnit\\": \\"h\\",\\n \\"UnitNum\\": 24,\\n \\"AllowCredentials\\": true\\n },\\n \\"Timeout\\": {\\n \\"UnitNum\\": 10,\\n \\"TimeUnit\\": \\"s\\",\\n \\"Status\\": \\"off\\"\\n },\\n \\"Retry\\": {\\n \\"Attempts\\": 1,\\n \\"RetryOn\\": [\\n \\"5xx\\"\\n ],\\n \\"HttpCodes\\": [\\n \\"500\\"\\n ],\\n \\"Status\\": \\"on\\"\\n },\\n \\"DomainIdList\\": [\\n 1\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"16\\",\\n \\"Path\\": \\"10111\\"\\n },\\n \\"FlowMirror\\": {\\n \\"TargetServiceId\\": 21,\\n \\"TargetServiceName\\": \\"test\\",\\n \\"Port\\": 8790,\\n \\"Percentage\\": 90,\\n \\"Status\\": \\"on\\"\\n },\\n \\"EnableWaf\\": true,\\n \\"AhasStatus\\": 1,\\n \\"Fallback\\": true,\\n \\"FallbackServices\\": [\\n {\\n \\"ServiceId\\": 1,\\n \\"ServiceName\\": \\"name\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"name\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"GroupName\\": \\"test\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"ServicePort\\": 8848\\n }\\n ],\\n \\"Policies\\": \\"{\\\\n \\\\\\"CORS\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"allowMethods\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"allowHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"exposeHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"unitNum\\\\\\\\\\\\\\":12,\\\\\\\\\\\\\\"allowCredentials\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"allowOrigins\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeUnit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"h\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Timeout\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"unitNum\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"timeUnit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"s\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Retry\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"attempts\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"retryOn\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"5xx\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"HTTPRewrite\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"pathType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EQUAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/o\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"Waf\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"enabled\\\\\\\\\\\\\\":false}\\\\\\",\\\\n \\\\\\"HeaderOp\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"headerOpItems\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"directionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Request\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"opType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Add\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"kkk\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ll\\\\\\\\\\\\\\"}]}\\\\\\"\\\\n}\\",\\n \\"Description\\": \\"a route for xxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayRouteDetail', + ], + 'ListGatewayRoute' => [ + 'summary' => 'Queries the routes of a gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '25969', + 'abilityTreeNodes' => [ + 'FEATUREmseVZLJSD', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OrderItem', + 'in' => 'query', + 'schema' => [ + 'description' => 'The item based on which entries are sorted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreate', + ], + ], + [ + 'name' => 'DescSort', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable sorting. This parameter is unavailable.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'FilterParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The parameters that specify filter conditions. The parameters are in the format of {"key1":"value1"}.'."\n", + 'type' => 'object', + 'properties' => [ + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '81', + ], + 'Name' => [ + 'description' => 'The name of the gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'DefaultServiceId' => [ + 'description' => 'The default service ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '默认服务ID（已废弃）', + 'deprecated' => true, + ], + 'RouteOrder' => [ + 'description' => 'The order.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'DomainId' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '284', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-30a0106924c94bca8712ec4e79fc5acc', + ], + 'DomainName' => [ + 'description' => 'The associated domain name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '*.alites.com', + ], + 'Path' => [ + 'title' => '按路由路径模糊搜索', + 'type' => 'string', + 'example' => '/test', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '83F02EAB-ECDF-55C6-B332-8649E5E7AF2C', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message returned if the request failed.'."\n", + 'type' => 'string', + 'example' => 'You are not authorized to perform this operation.', + ], + 'Code' => [ + 'description' => 'The code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Result' => [ + 'description' => 'The data structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '47', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-cf0e7f52ecc7429dbc7ba4d5e3656100', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '496', + ], + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RouteOrder' => [ + 'description' => 'The order.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DefaultServiceName' => [ + 'description' => 'The default service name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DefaultServiceId' => [ + 'description' => 'The default service ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Predicates' => [ + 'description' => 'The matching rules.'."\n", + 'type' => 'string', + 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/rpc/compute \\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":true}}', + ], + 'RoutePredicates' => [ + 'description' => 'The matching rules.'."\n", + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'The path used for route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The path of the node.'."\n", + 'type' => 'string', + 'example' => '/getIp', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + 'IgnoreCase' => [ + 'description' => 'Indicates whether case sensitivity is ignored.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'MethodPredicates' => [ + 'description' => 'The HTTP methods used for route matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method.'."\n", + 'type' => 'string', + 'example' => 'GET', + ], + ], + 'HeaderPredicates' => [ + 'description' => 'The headers used for route matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The header list.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The header key.'."\n", + 'type' => 'string', + 'example' => 'userid', + ], + 'Value' => [ + 'description' => 'The value.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + ], + ], + ], + 'QueryPredicates' => [ + 'description' => 'The parameters used for route matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key.'."\n", + 'type' => 'string', + 'example' => 'userid', + ], + 'Value' => [ + 'description' => 'The value.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + ], + ], + ], + ], + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-25T07:14:01.817+0000', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-01-07 18:07:57', + ], + 'Services' => [ + 'description' => 'The information about services.'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'RouteServices' => [ + 'description' => 'The information about services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of services.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1563', + ], + 'ServiceName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'hu', + ], + 'Percent' => [ + 'description' => 'The weight in the form of a percentage value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'Version' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SourceType' => [ + 'description' => 'The source type.'."\n", + 'type' => 'string', + 'example' => 'MSE', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'api', + ], + 'AgreementType' => [ + 'description' => 'The type of the protocol.'."\n", + 'type' => 'string', + 'example' => 'DUBBO', + ], + 'HttpDubboTranscoder' => [ + 'description' => 'The transcoder of the Dubbo protocol.'."\n", + 'type' => 'object', + 'properties' => [ + 'DubboServiceName' => [ + 'description' => 'The name of the Dubbo service.'."\n", + 'type' => 'string', + 'example' => 'org.apache.dubbo.samples.basic.api.DemoService', + ], + 'DubboServiceVersion' => [ + 'description' => 'The version of the Dubbo service.'."\n", + 'type' => 'string', + 'example' => '0.0.0', + ], + 'MothedMapList' => [ + 'description' => 'The forwarding rules of the Dubbo service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method mapping object.'."\n", + 'type' => 'object', + 'properties' => [ + 'DubboMothedName' => [ + 'description' => 'The method name of the Dubbo service.'."\n", + 'type' => 'string', + 'example' => 'sayHello', + ], + 'HttpMothed' => [ + 'description' => 'The HTTP method.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* ALL_GET'."\n" + ."\n" + .'* ALL_POST'."\n" + ."\n" + .'* ALL_PUT'."\n" + ."\n" + .'* ALL_DELETE'."\n" + ."\n" + .'* ALL_PATCH'."\n", + 'type' => 'string', + 'example' => 'ALL_GET', + ], + 'Mothedpath' => [ + 'description' => 'The path used for method matching.'."\n", + 'type' => 'string', + 'example' => '/mytestzbk/sayhello', + ], + 'PassThroughAllHeaders' => [ + 'description' => 'The pass-through type of the header.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* PASS_ALL: All headers are passed through.'."\n" + ."\n" + .'* PASS_NOT: All headers are not passed through.'."\n" + ."\n" + .'* PASS_ASSIGN: Specified headers are passed through.'."\n", + 'type' => 'string', + 'example' => 'PASS_NOT', + ], + 'PassThroughList' => [ + 'description' => 'The list of headers to be passed through.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the header to be passed through.'."\n", + 'type' => 'string', + 'example' => 'x-forward', + ], + ], + 'ParamMapsList' => [ + 'description' => 'The information about parameter mappings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter mapping object.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExtractKeySpec' => [ + 'description' => 'The position of the input parameter.'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* `ALL_QUERY_PARAMETER`: request parameter'."\n" + ."\n" + .'* `ALL_HEADER`: request header'."\n" + ."\n" + .'* `ALL_PATH`: request path'."\n" + ."\n" + .'* `ALL_BODY`: request body'."\n", + 'type' => 'string', + 'example' => 'ALL_QUERY_PARAMETER', + ], + 'ExtractKey' => [ + 'description' => 'The key extracted from the input parameter.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'MappingType' => [ + 'description' => 'The type of the backend service parameter.'."\n", + 'type' => 'string', + 'example' => 'java.lang.String', + ], + ], + ], + ], + ], + ], + ], + 'DubboServiceGroup' => [ + 'description' => 'The Dubbo service group.'."\n", + 'type' => 'string', + 'example' => 'service group', + ], + ], + ], + 'ServicePort' => [ + 'description' => 'The Dubbo port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20880', + ], + 'HealthStatus' => [ + 'title' => '健康状态'."\n" + ."\n" + .'- Health'."\n" + ."\n" + .'- Unhealthy'."\n" + ."\n" + .'- Checking'."\n" + ."\n" + .'- Unknown', + 'type' => 'string', + 'example' => 'Health', + ], + 'UnhealthyEndpoints' => [ + 'title' => '非健康Endpoint列表', + 'type' => 'array', + 'items' => [ + 'title' => '非健康Endpoint', + 'type' => 'string', + 'example' => '192.168.1.2', + ], + ], + ], + ], + ], + 'DomainId' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '265', + ], + 'DomainName' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'y.com', + ], + 'DestinationType' => [ + 'description' => 'The destination service type.'."\n", + 'type' => 'string', + 'example' => 'Single', + ], + 'DirectResponse' => [ + 'description' => 'The information about service mocking.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Body' => [ + 'description' => 'The return value for service mocking.'."\n", + 'type' => 'string', + 'example' => 'hello', + ], + ], + ], + 'DomainIdList' => [ + 'description' => 'The domain IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The domain IDs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + 'DomainNameList' => [ + 'description' => 'The domain names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The domain names.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + ], + 'Redirect' => [ + 'description' => 'The information about redirection.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Host' => [ + 'description' => 'The hostname to be redirected to.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/test', + ], + ], + ], + 'Type' => [ + 'description' => 'The route type.'."\n", + 'type' => 'string', + 'example' => 'Op', + ], + 'Comment' => [ + 'description' => 'The route comment (ingress).'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'string', + 'example' => 'error', + ], + ], + ], + 'EnableWaf' => [ + 'description' => 'Indicates whether Web Application Firewall (WAF) is activated.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Fallback' => [ + 'description' => 'Indicates whether the Fallback service is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'FallbackServices' => [ + 'description' => 'The information about the Fallback service.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '353'."\n", + ], + 'ServiceName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'service name', + ], + 'Percent' => [ + 'description' => 'The weight in the form of a percentage value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Version' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The name.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'SourceType' => [ + 'description' => 'The source type.'."\n", + 'type' => 'string', + 'example' => 'MSE'."\n", + ], + 'Namespace' => [ + 'description' => 'The namespace to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'Namespace', + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AgreementType' => [ + 'description' => 'The type of the protocol.'."\n", + 'type' => 'string', + 'example' => 'DUBBO', + ], + 'ServicePort' => [ + 'description' => 'The service port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8848', + ], + ], + ], + ], + 'DynamicRoute' => [ + 'title' => '是否开启动态路由', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83F02EAB-ECDF-55C6-B332-8649E5E7AF2C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"You are not authorized to perform this operation.\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalSize\\": 36,\\n \\"PageNumber\\": 11,\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Id\\": 47,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-cf0e7f52ecc7429dbc7ba4d5e3656100\\",\\n \\"GatewayId\\": 496,\\n \\"Status\\": 2,\\n \\"RouteOrder\\": 1,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"DefaultServiceId\\": 1,\\n \\"Predicates\\": \\"{\\\\\\\\\\\\\\"PathPredicates\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/rpc/compute \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IgnoreCase\\\\\\\\\\\\\\":true}}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/getIp\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"userid\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"GmtCreate\\": \\"2022-01-25T07:14:01.817+0000\\",\\n \\"GmtModified\\": \\"2022-01-07 18:07:57\\",\\n \\"Services\\": \\"[]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 1563,\\n \\"ServiceName\\": \\"hu\\",\\n \\"Percent\\": 11,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"test\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"api\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"HttpDubboTranscoder\\": {\\n \\"DubboServiceName\\": \\"org.apache.dubbo.samples.basic.api.DemoService\\",\\n \\"DubboServiceVersion\\": \\"0.0.0\\",\\n \\"MothedMapList\\": [\\n {\\n \\"DubboMothedName\\": \\"sayHello\\",\\n \\"HttpMothed\\": \\"ALL_GET\\",\\n \\"Mothedpath\\": \\"/mytestzbk/sayhello\\",\\n \\"PassThroughAllHeaders\\": \\"PASS_NOT\\",\\n \\"PassThroughList\\": [\\n \\"x-forward\\"\\n ],\\n \\"ParamMapsList\\": [\\n {\\n \\"ExtractKeySpec\\": \\"ALL_QUERY_PARAMETER\\",\\n \\"ExtractKey\\": \\"name\\",\\n \\"MappingType\\": \\"java.lang.String\\"\\n }\\n ]\\n }\\n ],\\n \\"DubboServiceGroup\\": \\"service group\\"\\n },\\n \\"ServicePort\\": 20880,\\n \\"HealthStatus\\": \\"Health\\",\\n \\"UnhealthyEndpoints\\": [\\n \\"192.168.1.2\\"\\n ]\\n }\\n ],\\n \\"DomainId\\": 265,\\n \\"DomainName\\": \\"y.com\\",\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"hello\\"\\n },\\n \\"DomainIdList\\": [\\n 123\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"test.com\\",\\n \\"Path\\": \\"/test\\"\\n },\\n \\"Type\\": \\"Op\\",\\n \\"Comment\\": {\\n \\"Status\\": \\"error\\"\\n },\\n \\"EnableWaf\\": \\"false\\",\\n \\"Fallback\\": true,\\n \\"FallbackServices\\": [\\n {\\n \\"ServiceId\\": 353,\\n \\"ServiceName\\": \\"service name\\",\\n \\"Percent\\": 100,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"name\\",\\n \\"SourceType\\": \\"MSE\\\\n\\",\\n \\"Namespace\\": \\"Namespace\\",\\n \\"GroupName\\": \\"test\\",\\n \\"AgreementType\\": \\"DUBBO\\",\\n \\"ServicePort\\": 8848\\n }\\n ],\\n \\"DynamicRoute\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayRoute', + ], + 'UpdateGatewayRouteWafStatus' => [ + 'summary' => 'Updates the WAF status of a route.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '131361', + 'abilityTreeNodes' => [ + 'FEATUREmseXCPJ75', + ], + ], + 'parameters' => [ + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '645', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-86575c0bc9f04ecfbacb92b8e392****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnableWaf', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to activate Web Application Firewall (WAF).'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7466566F-F30F-4A29-965D-3E0AF21D****', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'The status code returned. A value of 200 indicates that the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Name' => [ + 'description' => 'The name of the route.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GatewayUniqueId' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'example' => 'gw-7ea3da97b96543e19f6c597cd4a9****', + ], + 'GatewayId' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '102', + ], + 'DefaultServiceId' => [ + 'description' => 'The default service ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DefaultServiceName' => [ + 'description' => 'The default service name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => 'The status of the route.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2022-01-26T09:52:41.000+0000', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2022-02-24T06:08:29.230+0000', + ], + 'RouteOrder' => [ + 'description' => 'The sequence number of the route.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Predicates' => [ + 'description' => 'The matching rule.'."\n", + 'type' => 'string', + 'example' => '{\\"PathPredicates\\":{\\"Path\\":\\"/metas\\",\\"Type\\":\\"PRE\\",\\"IgnoreCase\\":false}}', + ], + 'RoutePredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'PathPredicates' => [ + 'description' => 'The information about route matching.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/zookeeper/mmgw/unlogined/common.getBu', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + 'IgnoreCase' => [ + 'description' => 'Indicates whether case sensitivity is ignored.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'MethodPredicates' => [ + 'description' => 'The information about method matching.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The method.'."\n", + 'type' => 'string', + 'example' => 'GET', + ], + ], + 'HeaderPredicates' => [ + 'description' => 'The information about matching based on request headers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request header.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the request header.'."\n", + 'type' => 'string', + 'example' => 'alibo', + ], + 'Value' => [ + 'description' => 'The value of the request header.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Type' => [ + 'description' => 'The matching type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + ], + ], + ], + 'QueryPredicates' => [ + 'description' => 'The parameter matching rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'instanceId', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + ], + ], + ], + ], + ], + 'DomainId' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'DomainName' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'nbhamster.com', + ], + 'Services' => [ + 'description' => 'The information about services.'."\n", + 'type' => 'string', + 'example' => '[{\\"Percent\\":100,\\"ServiceId\\":126}]', + ], + 'RouteServices' => [ + 'description' => 'The information about services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about services.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceId' => [ + 'description' => 'The ID of the service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '547', + ], + 'ServiceName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'b-service', + ], + 'Percent' => [ + 'description' => 'The weight.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Version' => [ + 'description' => 'The version of the service.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Name' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'test-aixue-gray', + ], + 'SourceType' => [ + 'description' => 'The source type of the service.'."\n", + 'type' => 'string', + 'example' => 'K8s', + ], + 'Namespace' => [ + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'GroupName' => [ + 'description' => 'The name of the group to which the service belongs.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_GROUP', + ], + ], + ], + ], + 'HTTPRewrite' => [ + 'description' => 'The information about the rewrite policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The HTTP status.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + 'Path' => [ + 'description' => 'The HTTP request path.'."\n", + 'type' => 'string', + 'example' => '/test/client', + ], + 'Host' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'aliyuncs.com', + ], + 'PathType' => [ + 'description' => 'The path type of the HTTP request.'."\n", + 'type' => 'string', + 'example' => 'PRE', + ], + 'Pattern' => [ + 'description' => 'The matching pattern.'."\n", + 'type' => 'string', + 'example' => '/test', + ], + 'Substitution' => [ + 'description' => 'The replacement.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'HeaderOp' => [ + 'description' => 'The header settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + 'HeaderOpItems' => [ + 'description' => 'The policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'DirectionType' => [ + 'description' => 'The request or response.'."\n", + 'type' => 'string', + 'example' => 'Response', + ], + 'OpType' => [ + 'description' => 'The operation type.'."\n", + 'type' => 'string', + 'example' => 'Add', + ], + 'Key' => [ + 'description' => 'The header key.'."\n", + 'type' => 'string', + 'example' => 'debug', + ], + 'Value' => [ + 'description' => 'The header value.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'DestinationType' => [ + 'description' => 'The destination service type.'."\n", + 'type' => 'string', + 'example' => 'Single', + ], + 'DirectResponse' => [ + 'description' => 'The information about service mocking.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The return value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Body' => [ + 'description' => 'The mock return value.'."\n", + 'type' => 'string', + 'example' => '[{\\"key\\":\\"h68d13466.sqa.eu95\\",\\"dims\\":\\"groupName=All}]', + ], + ], + ], + 'Cors' => [ + 'description' => 'The configuration for cross-origin resource sharing (CORS).'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + 'AllowOrigins' => [ + 'description' => 'The origins allowed.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'AllowMethods' => [ + 'description' => 'The methods allowed.'."\n", + 'type' => 'string', + 'example' => 'GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH', + ], + 'AllowHeaders' => [ + 'description' => 'The headers allowed.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'ExposeHeaders' => [ + 'description' => 'The response headers.'."\n", + 'type' => 'string', + 'example' => '*', + ], + 'TimeUnit' => [ + 'description' => 'The time unit.'."\n", + 'type' => 'string', + 'example' => 's', + ], + 'UnitNum' => [ + 'description' => 'The unit number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AllowCredentials' => [ + 'description' => 'The credentials allowed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Timeout' => [ + 'description' => 'The timeout configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'UnitNum' => [ + 'description' => 'The unit number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TimeUnit' => [ + 'description' => 'The time unit.'."\n", + 'type' => 'string', + 'example' => 's', + ], + 'Status' => [ + 'description' => 'The status.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + ], + ], + 'Retry' => [ + 'description' => 'The retry configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Attempts' => [ + 'description' => 'The number of retries allowed for a request.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RetryOn' => [ + 'description' => 'The retry condition.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The retry condition.'."\n", + 'type' => 'string', + 'example' => '5xx', + ], + ], + 'HttpCodes' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '500', + ], + ], + 'Status' => [ + 'description' => 'The retry status.'."\n", + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + 'DomainIdList' => [ + 'description' => 'The list of domain IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of domain IDs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'DomainNameList' => [ + 'description' => 'The domain names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The domain names.'."\n", + 'type' => 'string', + 'example' => 'test.com', + ], + ], + 'Redirect' => [ + 'description' => 'The configuration of the redirection.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Host' => [ + 'description' => 'The hostname.'."\n", + 'type' => 'string', + 'example' => 'ww.al.c', + ], + 'Path' => [ + 'description' => 'The path.'."\n", + 'type' => 'string', + 'example' => '/', + ], + ], + ], + 'EnableWaf' => [ + 'description' => 'Indicates whether WAF is activated.'."\n", + 'type' => 'boolean', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7466566F-F30F-4A29-965D-3E0AF21D****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 12,\\n \\"Name\\": \\"test\\",\\n \\"GatewayUniqueId\\": \\"gw-7ea3da97b96543e19f6c597cd4a9****\\",\\n \\"GatewayId\\": 102,\\n \\"DefaultServiceId\\": 1,\\n \\"DefaultServiceName\\": \\"test\\",\\n \\"Status\\": 1,\\n \\"GmtCreate\\": \\"2022-01-26T09:52:41.000+0000\\",\\n \\"GmtModified\\": \\"2022-02-24T06:08:29.230+0000\\",\\n \\"RouteOrder\\": 1,\\n \\"Predicates\\": \\"{\\\\\\\\\\\\\\"PathPredicates\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/metas\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IgnoreCase\\\\\\\\\\\\\\":false}}\\",\\n \\"RoutePredicates\\": {\\n \\"PathPredicates\\": {\\n \\"Path\\": \\"/zookeeper/mmgw/unlogined/common.getBu\\",\\n \\"Type\\": \\"PRE\\",\\n \\"IgnoreCase\\": true\\n },\\n \\"MethodPredicates\\": [\\n \\"GET\\"\\n ],\\n \\"HeaderPredicates\\": [\\n {\\n \\"Key\\": \\"alibo\\",\\n \\"Value\\": \\"200\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ],\\n \\"QueryPredicates\\": [\\n {\\n \\"Key\\": \\"instanceId\\",\\n \\"Value\\": \\"test\\",\\n \\"Type\\": \\"PRE\\"\\n }\\n ]\\n },\\n \\"DomainId\\": 235,\\n \\"DomainName\\": \\"nbhamster.com\\",\\n \\"Services\\": \\"[{\\\\\\\\\\\\\\"Percent\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"ServiceId\\\\\\\\\\\\\\":126}]\\",\\n \\"RouteServices\\": [\\n {\\n \\"ServiceId\\": 547,\\n \\"ServiceName\\": \\"b-service\\",\\n \\"Percent\\": 80,\\n \\"Version\\": \\"v1\\",\\n \\"Name\\": \\"test-aixue-gray\\",\\n \\"SourceType\\": \\"K8s\\",\\n \\"Namespace\\": \\"default\\",\\n \\"GroupName\\": \\"DEFAULT_GROUP\\"\\n }\\n ],\\n \\"HTTPRewrite\\": {\\n \\"Status\\": \\"off\\",\\n \\"Path\\": \\"/test/client\\",\\n \\"Host\\": \\"aliyuncs.com\\",\\n \\"PathType\\": \\"PRE\\",\\n \\"Pattern\\": \\"/test\\",\\n \\"Substitution\\": \\"test\\"\\n },\\n \\"HeaderOp\\": {\\n \\"Status\\": \\"off\\",\\n \\"HeaderOpItems\\": [\\n {\\n \\"DirectionType\\": \\"Response\\",\\n \\"OpType\\": \\"Add\\",\\n \\"Key\\": \\"debug\\",\\n \\"Value\\": \\"test\\"\\n }\\n ]\\n },\\n \\"DestinationType\\": \\"Single\\",\\n \\"DirectResponse\\": {\\n \\"Code\\": 200,\\n \\"Body\\": \\"[{\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"h68d13466.sqa.eu95\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dims\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"groupName=All}]\\"\\n },\\n \\"Cors\\": {\\n \\"Status\\": \\"off\\",\\n \\"AllowOrigins\\": \\"*\\",\\n \\"AllowMethods\\": \\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\",\\n \\"AllowHeaders\\": \\"*\\",\\n \\"ExposeHeaders\\": \\"*\\",\\n \\"TimeUnit\\": \\"s\\",\\n \\"UnitNum\\": 1,\\n \\"AllowCredentials\\": true\\n },\\n \\"Timeout\\": {\\n \\"UnitNum\\": 10,\\n \\"TimeUnit\\": \\"s\\",\\n \\"Status\\": \\"off\\"\\n },\\n \\"Retry\\": {\\n \\"Attempts\\": 1,\\n \\"RetryOn\\": [\\n \\"5xx\\"\\n ],\\n \\"HttpCodes\\": [\\n \\"500\\"\\n ],\\n \\"Status\\": \\"on\\"\\n },\\n \\"DomainIdList\\": [\\n 1\\n ],\\n \\"DomainNameList\\": [\\n \\"test.com\\"\\n ],\\n \\"Redirect\\": {\\n \\"Code\\": 200,\\n \\"Host\\": \\"ww.al.c\\",\\n \\"Path\\": \\"/\\"\\n },\\n \\"EnableWaf\\": true\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayRouteWafStatus', + ], + 'ApplyGatewayRoute' => [ + 'summary' => 'Publishes a route for a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '28369', + 'abilityTreeNodes' => [ + 'FEATUREmseVZLJSD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '950', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-1a4ab101d5924b6f92c5ec98a841761f', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1DB1AB36-8395-540E-AACC-7571D6B2057A', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'The response code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data of the node.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DB1AB36-8395-540E-AACC-7571D6B2057A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'ApplyGatewayRoute', + ], + 'OfflineGatewayRoute' => [ + 'summary' => 'Disables a route for a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '645', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'gw-77e1153db6e14c0a8b1fae20bcb89ca5', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8EB24742-AB15-5953-BEFB-1FA18E770EEE', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'The request is successfully processed.'."\n", + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Indicates whether the route is unpublished.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8EB24742-AB15-5953-BEFB-1FA18E770EEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"请求处理成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'OfflineGatewayRoute', + ], + 'GetGatewayConfig' => [ + 'summary' => 'Obtains the parameter configurations of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '141101', + 'abilityTreeNodes' => [ + 'FEATUREmseS26K2N', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-61f465fa2dd044069e2208c4912*****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<GatewayConfig>', + 'description' => 'RestResult<GatewayConfig>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F6092602-C357-4750-89D9-E572FBEA****', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => '', + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-61f465fa2dd044069e2208c4912*****', + ], + 'EnableGenerateRequestId' => [ + 'title' => '是否生成requestId', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableGzip' => [ + 'title' => '是否启用gzip进行压缩', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EnableSlashMerge' => [ + 'title' => '是否合并‘/’, 开启后www.a.com//b多余的\'/\'会被合并，将会同www.a.com/b一致', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DownstreamIdleTime' => [ + 'title' => '客户端到网关处于指定的时间内[0-600]没有请求，则会断开链接', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'PreserveHeaderFormat' => [ + 'title' => '是否保持header头大小写, http1.1规范中 header头不区分大小写进行识别，为了保证与http2规范兼容，默认会统一转化为小写', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DownstreamConnectionBufferLimits' => [ + 'title' => '单条链接的buffer大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32768', + ], + 'EnableHardwareAccelerate' => [ + 'title' => '是否开启硬件加速(若您的地域处于底层不支持地域，或购买时未指定硬件加速会生效失败)', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'XffTrustedNum' => [ + 'title' => '网关前可信任的设备个数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EnableHttp2' => [ + 'title' => '是否默认开启http2', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DownstreamHttp2MaxConcurrentStream' => [ + 'title' => '下游http最大并发数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InitialStreamWindowSize' => [ + 'title' => 'http2 stream 初始窗口大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '65535', + ], + 'InitialConnectionWindowSize' => [ + 'title' => 'http2 连接 初始窗口大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1048576', + ], + 'XtraceDetails' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TraceOn' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '255', + ], + 'Sample' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-61f465fa2dd044069e2208c4912*****', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-08-12T09:39:07.000+0000', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-08-12T09:39:07.000+0000', + ], + 'TraceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OPENTELEMETRY', + ], + 'ServiceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '333', + ], + 'ServicePort' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8888', + ], + ], + ], + 'SlsConfigDetails' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LogOn' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ProjectName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'LogStoreName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mse_gw_access_log', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-61f465fa2dd044069e2208c4912*****'."\n", + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' ""', + ], + 'NginxCompatible' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'SupportWaf' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableWaf' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AccessLogHeader' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"requestMetadata":[],"responseHeaders":[],"requestHeaders":["x-test"],"responseMetadata":[]}', + ], + 'EnableHttp3' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'UpstreamIdleTimeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ZipAlgorithm' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["gzip"]', + ], + 'PathWithEscapedSlashes' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'KEEP_UNCHANGED', + ], + 'NoSupportedConfigList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '"EnableProxyProtocol,EnableCustomAuthConfigPush"', + ], + 'LogFilterConfig' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' ""', + ], + 'EnableProxyProtocol' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableCustomAuthConfigPush' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'KeepaliveHeaderTimeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WebsocketTermGracePeriod' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'EnableK8sSourceWorkloadFilter' => [ + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'type' => 'boolean', + ], + 'LabelKey' => [ + 'type' => 'string', + ], + 'LabelValue' => [ + 'type' => 'string', + ], + 'FilterOpt' => [ + 'type' => 'string', + ], + ], + ], + 'EnableXffTrustedCidrs' => [ + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'type' => 'boolean', + ], + 'IpListContent' => [ + 'type' => 'string', + ], + ], + ], + 'EnableGzipHardwareAccelerate' => [ + 'type' => 'boolean', + ], + 'PreserveExternalRequestID' => [ + 'type' => 'boolean', + ], + 'LiteMetrics' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6092602-C357-4750-89D9-E572FBEA****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": {\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\",\\n \\"EnableGenerateRequestId\\": true,\\n \\"EnableGzip\\": false,\\n \\"EnableSlashMerge\\": true,\\n \\"DownstreamIdleTime\\": 180,\\n \\"PreserveHeaderFormat\\": true,\\n \\"DownstreamConnectionBufferLimits\\": 32768,\\n \\"EnableHardwareAccelerate\\": true,\\n \\"XffTrustedNum\\": 0,\\n \\"EnableHttp2\\": false,\\n \\"DownstreamHttp2MaxConcurrentStream\\": 100,\\n \\"InitialStreamWindowSize\\": 65535,\\n \\"InitialConnectionWindowSize\\": 1048576,\\n \\"XtraceDetails\\": {\\n \\"TraceOn\\": true,\\n \\"Id\\": 255,\\n \\"Sample\\": 100,\\n \\"GatewayId\\": 500,\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\",\\n \\"GmtCreate\\": \\"2024-08-12T09:39:07.000+0000\\",\\n \\"GmtModified\\": \\"2024-08-12T09:39:07.000+0000\\",\\n \\"TraceType\\": \\"OPENTELEMETRY\\",\\n \\"ServiceId\\": 333,\\n \\"ServicePort\\": \\"8888\\"\\n },\\n \\"SlsConfigDetails\\": {\\n \\"LogOn\\": true,\\n \\"Id\\": 0,\\n \\"ProjectName\\": \\"test\\",\\n \\"LogStoreName\\": \\"mse_gw_access_log\\",\\n \\"GatewayUniqueId\\": \\"gw-61f465fa2dd044069e2208c4912*****\\\\n\\",\\n \\"GatewayId\\": 500,\\n \\"GmtCreate\\": \\"\\\\\\"\\\\\\"\\",\\n \\"GmtModified\\": \\" \\\\\\"\\\\\\"\\",\\n \\"NginxCompatible\\": false\\n },\\n \\"SupportWaf\\": true,\\n \\"EnableWaf\\": true,\\n \\"AccessLogHeader\\": \\"{\\\\\\"requestMetadata\\\\\\":[],\\\\\\"responseHeaders\\\\\\":[],\\\\\\"requestHeaders\\\\\\":[\\\\\\"x-test\\\\\\"],\\\\\\"responseMetadata\\\\\\":[]}\\",\\n \\"EnableHttp3\\": false,\\n \\"UpstreamIdleTimeout\\": 30,\\n \\"ZipAlgorithm\\": \\"[\\\\\\"gzip\\\\\\"]\\",\\n \\"PathWithEscapedSlashes\\": \\"KEEP_UNCHANGED\\",\\n \\"NoSupportedConfigList\\": \\"\\\\\\"EnableProxyProtocol,EnableCustomAuthConfigPush\\\\\\"\\",\\n \\"LogFilterConfig\\": \\" \\\\\\"\\\\\\"\\",\\n \\"EnableProxyProtocol\\": true,\\n \\"EnableCustomAuthConfigPush\\": \\"false\\",\\n \\"KeepaliveHeaderTimeout\\": 0,\\n \\"WebsocketTermGracePeriod\\": 30,\\n \\"EnableK8sSourceWorkloadFilter\\": {\\n \\"Enable\\": true,\\n \\"LabelKey\\": \\"\\",\\n \\"LabelValue\\": \\"\\",\\n \\"FilterOpt\\": \\"\\"\\n },\\n \\"EnableXffTrustedCidrs\\": {\\n \\"Enable\\": true,\\n \\"IpListContent\\": \\"\\"\\n },\\n \\"EnableGzipHardwareAccelerate\\": true,\\n \\"PreserveExternalRequestID\\": true,\\n \\"LiteMetrics\\": true\\n }\\n}","type":"json"}]', + 'title' => 'GetGatewayConfig', + ], + 'EnableProxyProtocol' => [ + 'summary' => 'Enables the proxy protocol. When an NLB instance is used as an ingress, you cannot obtain the real IP address of the client if you do not enable the proxy protocol. After you enable the proxy protocol, non-proxy requests are not adversely affected.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', + ], + ], + [ + 'name' => 'EnableProxyProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use the proxy protocol to preserve client IP addresses. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<List<GatewayPlugin>>', + 'description' => 'RestResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> For example, if the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the **DtsJobId** parameter in the request is invalid.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"316F5F64-F73D-42DC-8632-01E308B6****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'EnableProxyProtocol', + ], + 'EnableHttp2' => [ + 'summary' => 'Enables HTTP/2 for negotiation between the server and client. The modification takes effect in one to two minutes.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '142072', + 'abilityTreeNodes' => [ + 'FEATUREmseS26K2N', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-0adf3ad751284cc69fcf9669fba*****', + ], + ], + [ + 'name' => 'EnableHttp2', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable HTTP/2 for negotiation between the server and client. This parameter applies to requests. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> The request parameter **DtsJobId** is invalid if **The Value of Input Parameter %s is not valid** is returned for **ErrMessage** and **DtsJobId** is returned for **DynamicMessage**.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'Indicates whether HTTP/2 is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'EnableHttp2', + ], + 'PreserveHeaderFormat' => [ + 'summary' => 'Specifies whether to convert all letters of a header into lowercase letters. For requests and responses, HTTP/1.1 headers are not case-sensitive. By default, all letters of headers are converted into lowercase letters.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '142071', + 'abilityTreeNodes' => [ + 'FEATUREmseS26K2N', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-3f97e2989c344f35ab3fd62b19f1****', + ], + ], + [ + 'name' => 'PreserveHeaderFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the request header is case-sensitive. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code仅仅用来和success同步', + 'description' => 'The status code. A value of 200 is returned if the request is successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'DynamicCode' => [ + 'title' => '动态错误信息中的占位符', + 'description' => 'The dynamic part in the error message.'."\n", + 'type' => 'string', + 'example' => 'code', + ], + 'DynamicMessage' => [ + 'description' => 'The dynamic part in the error message. This parameter is used to replace the \\*\\*%s\\*\\* variable in the **ErrMessage** parameter.'."\n" + ."\n" + .'> The request parameter **DtsJobId** is invalid if **The Value of Input Parameter %s is not valid** is returned for **ErrMessage** and **DtsJobId** is returned for **DynamicMessage**.'."\n", + 'type' => 'string', + 'example' => 'The specified parameter is invalid.', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"DynamicCode\\": \\"code\\",\\n \\"DynamicMessage\\": \\"The specified parameter is invalid.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'PreserveHeaderFormat', + ], + 'CreateGatewayFlowRule' => [ + 'summary' => 'Creates a throttling rule for a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14407', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the route.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '52853', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the routing rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'routeName', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The overall queries per second (QPS) threshold.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the web fallback behavior.'."\n" + ."\n" + .'0: returns the specified content.'."\n" + ."\n" + .'1: redirects to the specified page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encoding format.'."\n" + ."\n" + .'0: normal text'."\n" + ."\n" + .'1: JSON'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTP text to be returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The address to be redirected to.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'www.******.com', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the throttling rule.'."\n" + ."\n" + .'0: disables the throttling rule.'."\n" + ."\n" + .'1: enables the throttling rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Long>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '72FC625E-9629-591B-9C01-3F0BFDAB****', + ], + 'Data' => [ + 'description' => 'The ID of the rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '608', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72FC625E-9629-591B-9C01-3F0BFDAB****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', + 'title' => 'CreateGatewayFlowRule', + ], + 'DeleteGatewayFlowRule' => [ + 'summary' => 'Deletes a throttling rule for a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11151', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'RestResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B74E7F7-DF54-5AB1-B8F2-67391B83****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayFlowRule', + ], + 'UpdateGatewayFlowRule' => [ + 'summary' => 'Queries throttling rules of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '549', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14407', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '48811', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'routeA', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.******.com', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<GatewayRouteFlowRule>', + 'description' => 'RestResult<GatewayRouteFlowRule>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2B74E7F7-DF54-5AB1-B8F2-67391B83****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '549', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14407', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '48811', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeA', + ], + 'Threshold' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'StatDurationMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LimitMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '429', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'ResponseAdditionalHeaders' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'key=value', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '549', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B74E7F7-DF54-5AB1-B8F2-67391B83****\\",\\n \\"Data\\": {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"StatDurationMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"Text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 549\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayFlowRule', + ], + 'ListGatewayFlowRule' => [ + 'summary' => 'Queries throttling rules of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'FilterParams', + 'in' => 'query', + 'schema' => [ + 'title' => 'just for POP', + 'description' => 'just for POP', + 'type' => 'string', + 'required' => true, + 'example' => 'param', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<PageResult<GatewayRouteFlowRule>>', + 'description' => 'RestResult<PageResult<GatewayRouteFlowRule>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0951EBF0-798E-5E0B-8D38-460A14AD****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'title' => '实例列表的页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalSize' => [ + 'title' => '查询到的实例总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '输入时设置的每页行数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '549', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14407', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '48811', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeA', + ], + 'Threshold' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '429', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'Results' => [ + 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '549', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14407', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '48811', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeA', + ], + 'Threshold' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'StatDurationMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LimitMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '429', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'ResponseAdditionalHeaders' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'key=value', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '549', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0951EBF0-798E-5E0B-8D38-460A14AD****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 1,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"Enable\\": 0\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 549,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 48811,\\n \\"RouteName\\": \\"routeA\\",\\n \\"Threshold\\": 10,\\n \\"StatDurationMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 549\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayFlowRule', + ], + 'CreateGatewayCircuitBreakerRule' => [ + 'summary' => 'Creates a gateway circuit breaking rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14407', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-c9bc5afd61014165bd58f621b491*****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '645', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'routeName', + ], + ], + [ + 'name' => 'Strategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'TriggerRatio', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'StatDurationSec', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'RecoveryTimeoutSec', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxAllowedMs', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.******.com', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Long>', + 'description' => 'RestResult<Long>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '28', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": 28\\n}","type":"json"}]', + 'title' => 'CreateGatewayCircuitBreakerRule', + ], + 'DeleteGatewayCircuitBreakerRule' => [ + 'summary' => 'Deletes a gateway circuit breaking rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-1cef5440bf2d484db419fb264d4f****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11151', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'RestResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '52BA6DA6-A702-4362-A32F-DFF79655****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52BA6DA6-A702-4362-A32F-DFF79655****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayCircuitBreakerRule', + ], + 'UpdateGatewayCircuitBreakerRule' => [ + 'summary' => 'Updates a gateway circuit breaking rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '369', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14407', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-c9bc5afd61014165bd58f621b491****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '645', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'routeName', + ], + ], + [ + 'name' => 'Strategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'TriggerRatio', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'StatDurationSec', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'RecoveryTimeoutSec', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'MinRequestAmount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxAllowedMs', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.******.com', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<GatewayRouteCircuitBreakerRule>', + 'description' => 'RestResult<GatewayRouteCircuitBreakerRule>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '369', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14407', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-c9bc5afd61014165bd58f621b491****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '645', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeName', + ], + 'Strategy' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TriggerRatio' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'StatDurationSec' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'RecoveryTimeoutSec' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'MinRequestAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxAllowedMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LimitMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '201', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'ResponseAdditionalHeaders' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'key=value', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '369', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"Id\\": 369,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-c9bc5afd61014165bd58f621b491****\\",\\n \\"RouteId\\": 645,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 201,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 369\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayCircuitBreakerRule', + ], + 'ListGatewayCircuitBreakerRule' => [ + 'summary' => 'Queries a gateway circuit breaking rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'FilterParams', + 'in' => 'query', + 'schema' => [ + 'title' => 'just for POP', + 'description' => 'just for POP', + 'type' => 'string', + 'required' => true, + 'example' => 'param', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<PageResult<GatewayRouteCircuitBreakerRule>>', + 'description' => 'RestResult<PageResult<GatewayRouteCircuitBreakerRule>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DC34E4A3-5F1C-4E40-86EA-02EDF967****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'title' => '实例列表的页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalSize' => [ + 'title' => '查询到的实例总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'PageSize' => [ + 'title' => '输入时设置的每页行数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '467', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11919', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-5017305290e14centbrveca****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3091', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeName', + ], + 'Strategy' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TriggerRatio' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'StatDurationSec' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'RecoveryTimeoutSec' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'MinRequestAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxAllowedMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14', + ], + 'LimitMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '204', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'ResponseAdditionalHeaders' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'key=value', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '467', + ], + ], + ], + ], + ], + 'Results' => [ + 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '467', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11919', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-1ee34548c68f4778a25c05abd657****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3450', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeName', + ], + 'Strategy' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TriggerRatio' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'StatDurationSec' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'RecoveryTimeoutSec' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'MinRequestAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxAllowedMs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LimitMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '204', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'ResponseAdditionalHeaders' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'key=value', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '467', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC34E4A3-5F1C-4E40-86EA-02EDF967****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 11,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 467,\\n \\"GatewayId\\": 11919,\\n \\"GatewayUniqueId\\": \\"gw-5017305290e14centbrveca****\\",\\n \\"RouteId\\": 3091,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 14,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 204,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 467\\n ]\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 467,\\n \\"GatewayId\\": 11919,\\n \\"GatewayUniqueId\\": \\"gw-1ee34548c68f4778a25c05abd657****\\",\\n \\"RouteId\\": 3450,\\n \\"RouteName\\": \\"routeName\\",\\n \\"Strategy\\": 0,\\n \\"TriggerRatio\\": 10,\\n \\"StatDurationSec\\": 11,\\n \\"RecoveryTimeoutSec\\": 12,\\n \\"MinRequestAmount\\": 10,\\n \\"MaxAllowedMs\\": 10,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 204,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 467\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayCircuitBreakerRule', + ], + 'CreateGatewayIsolationRule' => [ + 'summary' => 'Creates a concurrency rule for a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14407', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '52853', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'routeName', + ], + ], + [ + 'name' => 'MaxConcurrency', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.******.com', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Long>', + 'description' => 'RestResult<Long>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '608', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": 608\\n}","type":"json"}]', + 'title' => 'CreateGatewayIsolationRule', + ], + 'DeleteGatewayIsolationRule' => [ + 'summary' => 'Deletes the gateway concurrency rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11151', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'RestResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteGatewayIsolationRule', + ], + 'UpdateGatewayIsolationRule' => [ + 'summary' => 'Updates the concurrency rule of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '358', + ], + ], + [ + 'name' => 'GatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14407', + ], + ], + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + ], + [ + 'name' => 'RouteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '52853', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'routeName', + ], + ], + [ + 'name' => 'MaxConcurrency', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'BehaviorType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'BodyEncoding', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResponseStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '429', + ], + ], + [ + 'name' => 'ResponseContentBody', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'ResponseRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.******.com', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<GatewayRouteIsolationRule>', + 'description' => 'RestResult<GatewayRouteIsolationRule>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '94B12406-E44D-57C9-BF93-A8B35BFF****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '358', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14407', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52853', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeName', + ], + 'MaxConcurrency' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'LimitMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '429', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'ResponseAdditionalHeaders' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'key=value', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '358', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B12406-E44D-57C9-BF93-A8B35BFF****\\",\\n \\"Data\\": {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'UpdateGatewayIsolationRule', + ], + 'ListGatewayIsolationRule' => [ + 'summary' => 'Queries the concurrency rule of a gateway.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'FilterParams', + 'in' => 'query', + 'schema' => [ + 'title' => 'just for POP', + 'description' => 'just for POP', + 'type' => 'string', + 'required' => true, + 'example' => 'param', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<PageResult<GatewayRouteIsolationRule>>', + 'description' => 'RestResult<PageResult<GatewayRouteIsolationRule>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6F025D43-8632-5716-AE9B-7EDDF16C****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'title' => '实例列表的页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalSize' => [ + 'title' => '查询到的实例总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '输入时设置的每页行数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '358', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14407', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52853', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeName', + ], + 'MaxConcurrency' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'LimitMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '429', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'ResponseAdditionalHeaders' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'key:value', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '358', + ], + ], + ], + ], + ], + 'Results' => [ + 'title' => '从 com.alibaba.mse.common.dto.FetchListResponse#results', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '358', + ], + 'GatewayId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14407', + ], + 'GatewayUniqueId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gw-e2d226bba4b2445c9e29fa7f8216****', + ], + 'RouteId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52853', + ], + 'RouteName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'routeName', + ], + 'MaxConcurrency' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'LimitMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BehaviorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BodyEncoding' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResponseStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '429', + ], + 'ResponseContentBody' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'ResponseRedirectUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.******.com', + ], + 'ResponseAdditionalHeaders' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'key=value', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IdList' => [ + 'title' => '筛选规则id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '358', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F025D43-8632-5716-AE9B-7EDDF16C****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalSize\\": 1,\\n \\"PageSize\\": 100,\\n \\"Result\\": [\\n {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 0,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key:value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Id\\": 358,\\n \\"GatewayId\\": 14407,\\n \\"GatewayUniqueId\\": \\"gw-e2d226bba4b2445c9e29fa7f8216****\\",\\n \\"RouteId\\": 52853,\\n \\"RouteName\\": \\"routeName\\",\\n \\"MaxConcurrency\\": 100,\\n \\"LimitMode\\": 1,\\n \\"BehaviorType\\": 0,\\n \\"BodyEncoding\\": 0,\\n \\"ResponseStatusCode\\": 429,\\n \\"ResponseContentBody\\": \\"text\\",\\n \\"ResponseRedirectUrl\\": \\"www.******.com\\",\\n \\"ResponseAdditionalHeaders\\": \\"key=value\\",\\n \\"Enable\\": 0,\\n \\"IdList\\": [\\n 358\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListGatewayIsolationRule', + ], + 'InitializeServiceLinkRole' => [ + 'summary' => 'Creates a Microservices Engine (MSE) service-linked role.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'common', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '17049', + 'abilityTreeNodes' => [ + 'FEATUREmseRIJL6U', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunServiceRoleForMSE', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A5E7D4E3-D30C-56C1-817F-F2B8CE6BXXXX', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RoleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AliyunServiceRoleForMSE', + ], + 'RequiredPermission' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ram:CreateServiceLinkedRole', + ], + 'ServiceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mse.aliyuncs.com', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A5E7D4E3-D30C-56C1-817F-F2B8CE6BXXXX\\",\\n \\"Data\\": {\\n \\"RoleName\\": \\"AliyunServiceRoleForMSE\\",\\n \\"RequiredPermission\\": \\"ram:CreateServiceLinkedRole\\",\\n \\"ServiceName\\": \\"mse.aliyuncs.com\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'InitializeServiceLinkRole', + ], + 'CloneSentinelRuleFromAhas' => [ + 'summary' => 'Clones rules from Application High Availability Service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '209225', + 'abilityTreeNodes' => [ + 'FEATUREmseHJJ9Z1', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间', + 'description' => 'The namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'MseAppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the MSE application after migration. If this parameter is not specified, the name of the Application High Availability Service (AHAS) application is used by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称', + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'AhasNamespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'AHAS侧命名空间（环境）。', + 'description' => 'The namespace (environment) of Application High Availability Service (AHAS).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'IsAHASPublicRegion', + 'in' => 'query', + 'schema' => [ + 'title' => 'AHAS侧是否为公网地域。', + 'description' => 'Specifies whether AHAS is deployed in the Internet region.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Map<String, List<String>>>', + 'description' => 'RestResult\\<Map\\<String, List>>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Data' => [ + 'title' => '返回结果。', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '执行结果。', + 'description' => 'The execution result.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '"Finish AHAS prod:spring-cloud-b -> MSE prod:spring-cloud-b ..."'."\n", + 'description' => 'The execution result details.'."\n", + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE5C32A1-BC0E-4B79-817C-103E4EDF****\\",\\n \\"Data\\": {\\n \\"key\\": [\\n \\"\\\\\\"完成 AHAS prod:spring-cloud-b -> MSE prod:spring-cloud-b 应用的流控规则迁移。AHAS 侧总规则数: 14 ；成功迁移的规则数: 7 ；完成迁移但存在异常的规则数: 2 ；迁移失败的规则数: 5\\\\\\"\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'CloneSentinelRuleFromAhas', + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Resource Transfer', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'common', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '150111', + 'abilityTreeNodes' => [ + 'FEATUREmseYGMCYE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'Resource type, such as a registration and configuration center cluster or gateway instance', + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster,Gateway', + 'default' => 'Cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => 'Resource ID, which is the ID of the registration and configuration center instance or the unique ID of the gateway', + 'type' => 'string', + 'required' => true, + 'example' => 'mse-cn-xxxxxxxxxxx，'."\n" + .'gw-xxxxxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => 'Region ID', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => 'Target resource group', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-acfm34x43l*****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => 'The language in which the response is displayed. Values: zh (default): Chinese, en: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response Schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '54973C90-F379-4372-9AA5-053A3F7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => ' The specified resource is not found', + ], + [ + '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\\": \\"54973C90-F379-4372-9AA5-053A3F7****\\"\\n}","type":"json"}]', + 'title' => 'Change the Resource Group of an Instance', + 'translator' => 'machine', + ], + 'UpdateNacosGrayConfig' => [ + 'summary' => 'Updates the canary release settings, which include beta release and tag-based canary release.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215876', + 'abilityTreeNodes' => [ + 'FEATUREmseK09GZC', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'mse_prepaid_public_cn-st2212****', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间ID，默认为public', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6cf708a5-****-89f2-3ba62c5ee9ba', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'title' => '配置分组，默认为DEFAULT_GROUP', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'title' => '配置dataId', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'title' => '配置内容', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'asdf', + ], + ], + [ + 'name' => 'GrayType', + 'in' => 'query', + 'schema' => [ + 'title' => '灰度类型，支持Beta灰度(根据IP灰度)和标签灰度', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Tags', + 'enum' => [ + 'Beta', + 'Tags', + ], + ], + ], + [ + 'name' => 'GrayRule', + 'in' => 'query', + 'schema' => [ + 'title' => '灰度规则，如果是Beta灰度，此处是灰度的客户端的ip，使用逗号分隔；如果是标签灰度，此处是 标签名=标签值，多个标签值使用逗号分隔', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'key=value1,value2', + ], + ], + [ + 'name' => 'StopGray', + 'in' => 'query', + 'schema' => [ + 'title' => '是否停止灰度', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + 'title' => '参数弃用，无需填写', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'spring-cloud-a', + ], + ], + [ + 'name' => 'GrayRuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '灰度版本名称', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + ], + ], + [ + 'name' => 'GrayRulePriority', + 'in' => 'query', + 'schema' => [ + 'title' => '灰度版本优先级', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'OpType', + 'in' => 'query', + 'schema' => [ + 'title' => '操作类型，Create（创建新的灰度配置），Update（更新存在的灰度配置）', + 'type' => 'string', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'RestResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '316F5F64-F73D-42DC-8632-01E308B6****', + ], + 'Data' => [ + 'title' => '是否更新成功', + 'description' => '', + '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', + ], + ], + 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 \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'UpdateNacosGrayConfig', + ], + 'UpdateGatewayConfig' => [ + 'summary' => 'Updates gateway configurations.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'gateway', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '261694', + 'abilityTreeNodes' => [ + 'FEATUREmseS26K2N', + ], + ], + 'parameters' => [ + [ + 'name' => 'GatewayUniqueId', + 'in' => 'query', + 'schema' => [ + 'title' => '网关唯一ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gw-b525dc1adf3c486ab96224a6346*****', + ], + ], + [ + 'name' => 'ConfigName', + 'in' => 'query', + 'schema' => [ + 'title' => '参数配置名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'EnableK8sSourceWorkloadFilter', + ], + ], + [ + 'name' => 'ConfigValue', + 'in' => 'query', + 'schema' => [ + 'title' => '参数配置值', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '{"enable":true,"filterOpt":"EQUAL","labelKey":"key","labelValue":"value"}', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Void>', + 'description' => 'RestResult<Void>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4D****', + ], + ], + ], + ], + ], + '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\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4D****\\"\\n}","type":"json"}]', + 'title' => 'UpdateGatewayConfig', + ], + 'CreateSentinelBlockFallbackDefinition' => [ + 'summary' => '创建行为管理', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'msc', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '163988', + 'abilityTreeNodes' => [ + 'FEATUREmse6JRV3O', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'example-app', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'edasmsc', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'JAVA', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'abcde@12345', + ], + ], + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceClassification' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123456', + ], + 'AppName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34726', + ], + 'Namespace' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'FallbackBehavior' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"webRespStatusCode":429,"webRespMessage":"test","webFallbackMode":0,"webRespContentType":0}', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalRequest', + 'errorMessage' => 'Invalid request:%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation:%s', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'Not found:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Console error. Try again later:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"Data\\": {\\n \\"ResourceClassification\\": 1,\\n \\"UserId\\": \\"123456\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"Id\\": 34726,\\n \\"Namespace\\": \\"default\\",\\n \\"Name\\": \\"test\\",\\n \\"FallbackBehavior\\": \\"{\\\\\\"webRespStatusCode\\\\\\":429,\\\\\\"webRespMessage\\\\\\":\\\\\\"test\\\\\\",\\\\\\"webFallbackMode\\\\\\":0,\\\\\\"webRespContentType\\\\\\":0}\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + ], + 'CreateNacosMcpServer' => [ + 'summary' => '创建一个MCP Server', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '273078', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'public', + ], + ], + [ + 'name' => 'ServerSpecification', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Server描述的JSON字符串', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"description":"a mcp demo service","capabilities":[],"allVersions":[{"version":"1.0.0","release_date":"2025-08-13T01:58:42Z","is_latest":true}],"remoteServerConfig":{"exportPath":"/sse"},"enabled":true,"versionDetail":{"version":"1.0.1"},"backendEndpoints":[{"path":"/sse","address":"127.0.0.1","port":8080}],"protocol":"mcp-sse","name":"mcp-demo","frontProtocol":"mcp-sse"}', + ], + ], + [ + 'name' => 'ToolSpecification', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Tool的描述的JSON字符串', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"tools":[{"name":"demo-tool","description":"a demo tool","inputSchema":{"type":"object","properties":{"name":{"type":"string","description":"name"}}}}],"toolsMeta":{"demo-tool":{"enabled":true}}}', + ], + ], + [ + 'name' => 'EndpointSpecification', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Endpoint描述的Json字符串', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"type":"REF","data":{"namespaceId":"public","groupName":"mcp-endpoints","serviceName":"mcp-demo"}}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'ServerName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mcp-demo', + ], + ], + [ + 'name' => 'YamlConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'allowTools:'."\n" + .'- demo-tool'."\n" + .'securityScheme: {}'."\n" + .'server:'."\n" + .' name: mcp-demo'."\n" + .'tools:'."\n" + .'- args:'."\n" + .' - name: name'."\n" + .' description: name'."\n" + .' type: string'."\n" + .' description: a demo tool'."\n" + .' name: demo-tool'."\n", + ], + ], + [ + 'name' => 'EncryptToolSpec', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'RestResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AF21683A-29C7-4853-AC0F-B5ADEE4****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.exist', + 'errorMessage' => 'Resource %s already exists, cannot be created repeatedly.', + ], + [ + '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', + ], + ], + 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\\": \\"AF21683A-29C7-4853-AC0F-B5ADEE4****\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'DeleteNacosMcpServer' => [ + 'summary' => '删除一个MCP Server', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '273079', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-u0t2xzvxa06', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'fc0f6e40-****-946b-45e3af313707', + ], + ], + [ + 'name' => 'McpServerId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5e3c5211-d365-4013-8540-c4106ec2a5dc', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Boolean>', + 'description' => 'RestResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA', + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'GetNacosMcpServer' => [ + 'summary' => '获取MCP Server的详情', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '273076', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mse_prepaid_public_cn-tl327w****', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', + ], + ], + [ + 'name' => 'McpServerId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5e3c5211-d365-4013-8540-c4106ec2a5dc', + ], + ], + [ + 'name' => 'McpServerVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<McpServerDetail>', + 'description' => 'RestResult<McpServerDetail>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '72FC625E-9629-591B-9C01-3F0BFDAB****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RemoteServerConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServiceRef' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NamespaceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'public', + ], + 'GroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'ServiceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mcp-service', + ], + ], + ], + 'ExportPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/sse', + ], + ], + ], + 'LocalServerConfig' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => '', + ], + ], + 'BackendEndpoints' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Path' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/sse', + ], + ], + ], + ], + 'ToolSpec' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Tools' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'get_weather', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'a weather query tool', + ], + 'InputSchema' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{"type":"object","properties":{"name":{"type":"string","description":"name"}}}', + 'description' => '', + ], + ], + ], + ], + ], + 'ToolsMeta' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'type' => 'boolean', + 'example' => 'true', + 'description' => '', + ], + 'Templates' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => '{"requestTemplate":{"url":"https://api.example.com/endpoint/{{.args.NewArg1}}","method":"GET","headers":[{"key":"Authorization","value":"Bearer {{.security.token}}"}]},"responseTemplate":{"body":"{{.}}"},"argsPosition":{"NewArg1":"path"}}', + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + 'SpecificationType' => [ + 'type' => 'string', + ], + 'SecuritySchemes' => [ + 'type' => 'any', + ], + 'ToolDecryptStatus' => [ + 'type' => 'string', + ], + ], + ], + 'AllVersions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.0.9', + ], + 'Release_date' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-07-16'."\n", + ], + 'Is_latest' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'Enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => 'ID。', + 'type' => 'string', + 'example' => '5e3c5211-d365-4013-8540-c4106ec2a5dc', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mcp-demo', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Protocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mcp-sse', + ], + 'FrontProtocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mcp-sse', + ], + 'Capabilities' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'TOOL', + ], + ], + 'VersionDetail' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.11.0', + ], + 'ReleaseDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-07-16', + ], + 'IsLatest' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'YamlConfig' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'allowTools:'."\n" + .'- demo-tool'."\n" + .'securityScheme: {}'."\n" + .'server:'."\n" + .' name: mcp-demo'."\n" + .'tools:'."\n" + .'- args:'."\n" + .' - name: name'."\n" + .' description: name'."\n" + .' type: string'."\n" + .' description: a demo tool'."\n" + .' name: demo-tool'."\n", + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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\\\\\\": \\\\\\"<API_KEY>\\\\\\"\\\\n }\\\\n }\\\\n }\\\\n}\\\\n\\"\\n },\\n \\"BackendEndpoints\\": [\\n {\\n \\"Address\\": \\"127.0.0.1\\",\\n \\"Port\\": 80,\\n \\"Path\\": \\"/sse\\"\\n }\\n ],\\n \\"ToolSpec\\": {\\n \\"Tools\\": [\\n {\\n \\"Name\\": \\"get_weather\\",\\n \\"Description\\": \\"a weather query tool\\",\\n \\"InputSchema\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\":\\\\\\"object\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"name\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"string\\\\\\",\\\\\\"description\\\\\\":\\\\\\"name\\\\\\"}}}\\"\\n }\\n }\\n ],\\n \\"ToolsMeta\\": {\\n \\"key\\": {\\n \\"Enabled\\": true,\\n \\"Templates\\": {\\n \\"key\\": \\"{\\\\\\"requestTemplate\\\\\\":{\\\\\\"url\\\\\\":\\\\\\"https://api.example.com/endpoint/{{.args.NewArg1}}\\\\\\",\\\\\\"method\\\\\\":\\\\\\"GET\\\\\\",\\\\\\"headers\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"Authorization\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Bearer {{.security.token}}\\\\\\"}]},\\\\\\"responseTemplate\\\\\\":{\\\\\\"body\\\\\\":\\\\\\"{{.}}\\\\\\"},\\\\\\"argsPosition\\\\\\":{\\\\\\"NewArg1\\\\\\":\\\\\\"path\\\\\\"}}\\"\\n }\\n }\\n },\\n \\"SpecificationType\\": \\"\\",\\n \\"SecuritySchemes\\": \\"\\",\\n \\"ToolDecryptStatus\\": \\"\\"\\n },\\n \\"AllVersions\\": [\\n {\\n \\"Version\\": \\"1.0.9\\",\\n \\"Release_date\\": \\"2025-07-16\\\\n\\",\\n \\"Is_latest\\": true\\n }\\n ],\\n \\"Enabled\\": true,\\n \\"Id\\": \\"5e3c5211-d365-4013-8540-c4106ec2a5dc\\",\\n \\"Name\\": \\"mcp-demo\\",\\n \\"Description\\": \\"描述\\",\\n \\"Protocol\\": \\"mcp-sse\\",\\n \\"FrontProtocol\\": \\"mcp-sse\\",\\n \\"Capabilities\\": [\\n \\"TOOL\\"\\n ],\\n \\"VersionDetail\\": {\\n \\"Version\\": \\"1.11.0\\",\\n \\"ReleaseDate\\": \\"2025-07-16\\",\\n \\"IsLatest\\": true\\n },\\n \\"YamlConfig\\": \\"allowTools:\\\\n- demo-tool\\\\nsecurityScheme: {}\\\\nserver:\\\\n name: mcp-demo\\\\ntools:\\\\n- args:\\\\n - name: name\\\\n description: name\\\\n type: string\\\\n description: a demo tool\\\\n name: demo-tool\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'ListNacosMcpServers' => [ + 'summary' => '获取McpServer列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '273080', + 'abilityTreeNodes' => [ + 'FEATUREmseU5ZGQF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5e3ee449-b5c0-4aee-b857-32c0acbebf26', + ], + ], + [ + 'name' => 'Search', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'blur', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<Page<McpServer>>', + 'description' => 'RestResult<Page<McpServer>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ADDD8AB7-8D1C-4697-A83E-410D2607****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'PageNumber' => [ + 'title' => 'pageNumber.', + 'description' => 'pageNumber.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PagesAvailable' => [ + 'title' => 'pagesAvailable.', + 'description' => 'pagesAvailable.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'ID。', + 'type' => 'string', + 'example' => '2385420b-6176-4a37-aba4-d3d382e4bb84', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test ', + ], + 'Protocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'stdio', + ], + 'FrontProtocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mcp-sse', + ], + 'Capabilities' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'TOOL', + ], + ], + 'VersionDetail' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Release_date' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-07-16', + ], + 'Is_latest' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"ADDD8AB7-8D1C-4697-A83E-410D2607****\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 4,\\n \\"PageNumber\\": 1,\\n \\"PagesAvailable\\": 1,\\n \\"PageItems\\": [\\n {\\n \\"Id\\": \\"2385420b-6176-4a37-aba4-d3d382e4bb84\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test \\",\\n \\"Protocol\\": \\"stdio\\",\\n \\"FrontProtocol\\": \\"mcp-sse\\",\\n \\"Capabilities\\": [\\n \\"TOOL\\"\\n ],\\n \\"VersionDetail\\": {\\n \\"Version\\": \\"1.0.0\\",\\n \\"Release_date\\": \\"2025-07-16\\",\\n \\"Is_latest\\": true\\n },\\n \\"Version\\": \\"1.1.0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryNacosGrayConfig' => [ + 'summary' => 'Queries canary configurations of a Nacos instance.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'cluster', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216072', + 'abilityTreeNodes' => [ + 'FEATUREmseK09GZC', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'mse-cn-st21ri2****', + ], + ], + [ + 'name' => 'NamespaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6bafdde3-4fa7-4d67-b3da-a607ab87f7e4', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'title' => '配置分组', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT_GROUP', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'title' => '配置dataId', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'demo-develop', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RequestPars', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'GrayName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '返回结果显示的语言。取值：zh（默认值）：中文，en：英文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RestResult<GrayConfig>', + 'description' => 'RestResult<GrayConfig>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE5C32A1-BC0E-4B79-817C-103E4EDF****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GrayType' => [ + 'title' => '灰度类型，Beta或者Tag', + 'description' => '', + 'type' => 'string', + 'example' => 'Tags', + ], + 'GrayRule' => [ + 'title' => '灰度规则', + 'description' => '', + 'type' => 'string', + 'example' => 'nacos.config.gray.label=test', + ], + 'Group' => [ + 'title' => '配置分组', + 'description' => '', + 'type' => 'string', + 'example' => 'dubbo', + ], + 'DataId' => [ + 'title' => '配置dataId', + 'description' => '', + 'type' => 'string', + 'example' => 'test.yaml', + ], + 'Content' => [ + 'title' => '配置内容', + 'description' => '', + 'type' => 'string', + 'example' => 'text', + ], + 'Md5' => [ + 'title' => '配置内容md5', + 'description' => '', + 'type' => 'string', + 'example' => '87d14faf58a103ac8840b9c5f1c2a0fe', + ], + 'LastModified' => [ + 'title' => '配置最后修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '1742277568000', + ], + 'AppName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'spring-cloud-a', + ], + 'GrayRuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Beta(IP)', + ], + 'GrayRulePriority' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + '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 \\"Data\\": {\\n \\"GrayType\\": \\"Tags\\",\\n \\"GrayRule\\": \\"nacos.config.gray.label=test\\",\\n \\"Group\\": \\"dubbo\\",\\n \\"DataId\\": \\"test.yaml\\",\\n \\"Content\\": \\"text\\",\\n \\"Md5\\": \\"87d14faf58a103ac8840b9c5f1c2a0fe\\",\\n \\"LastModified\\": \\"1742277568000\\",\\n \\"AppName\\": \\"spring-cloud-a\\",\\n \\"GrayRuleName\\": \\"Beta(IP)\\",\\n \\"GrayRulePriority\\": \\"100\\"\\n }\\n}","type":"json"}]', + 'title' => 'QueryNacosGrayConfig', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'mse.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'mse.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'mse.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'mse.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'mse.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'mse.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'mse.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'mse.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'mse.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'mse.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'mse.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'mse.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'mse.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'mse.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'mse.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'mse.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'mse.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'mse.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'mse.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'mse.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'mse.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'mse.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'mse.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'mse.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'mse.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'mse.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'mse.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'mse.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'mse.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'mse.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'mse.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'mse.cn-shanghai-finance-1.aliyuncs.com', + ], + ], +]; |