'1.0',
'info' => ['style' => 'RPC', 'product' => 'ahas-openapi', 'version' => '2019-09-01'],
'directories' => [
[
'children' => ['ListActiveApps', 'OpenAhasService'],
'type' => 'directory',
'title' => '服务',
'id' => 314681,
],
[
'children' => ['GetMetricsOfApp', 'GetSentinelAppSumMetric', 'GetMetricsOfResource'],
'type' => 'directory',
'title' => '监控',
'id' => 314699,
],
[
'children' => ['CreateFlowRule', 'DeleteFlowRule', 'EnableFlowRule', 'DisableFlowRule', 'ModifyFlowRule', 'ListFlowRulesOfApp', 'ListFlowRulesOfResource'],
'type' => 'directory',
'title' => '流控规则',
'id' => 314703,
],
[
'children' => ['CreateDegradeRule', 'DeleteDegradeRule', 'EnableDegradeRule', 'DisableDegradeRule', 'ListDegradeRulesOfApp', 'ListDegradeRulesOfResource', 'ModifyDegradeRule'],
'type' => 'directory',
'title' => '降级规则',
'id' => 314711,
],
[
'children' => ['CreateIsolationRule', 'DeleteIsolationRule', 'EnableIsolationRule', 'DisableIsolationRule', 'ListIsolationRulesOfApp', 'ListIsolationRulesOfResource', 'ModifyIsolationRule'],
'type' => 'directory',
'title' => '隔离规则',
'id' => 314719,
],
[
'children' => ['CreateSystemRule', 'DeleteSystemRule', 'EnableSystemRule', 'DisableSystemRule', 'ListSystemRules', 'ModifySystemRule'],
'type' => 'directory',
'title' => '系统规则',
'id' => 314727,
],
[
'children' => ['CreateHotParamRule', 'CreateHotParamItems', 'DeleteHotParamRule', 'EnableHotParamRule', 'DisableHotParamRule', 'ListHotParamRulesOfApp', 'ListHotParamRulesOfResource', 'ModifyHotParamRule'],
'type' => 'directory',
'title' => '热点规则',
'id' => 314734,
],
[
'children' => ['DescribeRegions', 'GetLicenseKey'],
'title' => '其他',
'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateDegradeRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => 'AHAS命名空间,默认为default,可以在控制台上创建不同namespace用于逻辑隔离。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名(避免中文命名),若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台具体应用的基本信息页签中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => 'REST或RPC接口名,需符合REST或RPC接口格式规范。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleService'],
],
[
'name' => 'Strategy',
'in' => 'query',
'schema' => ['description' => '阈值类型,即降级的策略,取值为0时表示按慢调用比例降级,取值为1时表示按异常比例降级。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '阈值类型所对应的降级阈值,超过该值时会触发接口的降级。', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '0.6'],
],
[
'name' => 'Enable',
'in' => 'query',
'schema' => ['description' => '规则是否开启。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'RecoveryTimeoutMs',
'in' => 'query',
'schema' => ['description' => '熔断时长。在该时间段内,该接口的请求都会快速失败,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '5000'],
],
[
'name' => 'StatDurationMs',
'in' => 'query',
'schema' => ['description' => '统计窗口时长,单位毫秒。默认值为1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'SlowRtMs',
'in' => 'query',
'schema' => ['description' => '慢调用RT。请求的响应时间超过该值时统计为慢调用。阈值类型为“慢调用比例”时需设置该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'MinRequestAmount',
'in' => 'query',
'schema' => ['description' => '触发熔断的最小请求数目,若当前统计窗口请求数小于此值,即使达到熔断条件规则也不会触发。默认值为5。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'HalfOpenBaseAmountPerStep',
'in' => 'query',
'schema' => ['description' => '熔断恢复每步最小通过数目,默认值为5。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
[
'name' => 'HalfOpenRecoveryStepNum',
'in' => 'query',
'schema' => ['description' => '熔断恢复阶段数,默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求Request ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '规则数据。',
'type' => 'object',
'properties' => [
'SlowRtMs' => ['description' => '慢调用RT。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'HalfOpenRecoveryStepNum' => ['description' => '熔断恢复阶段数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '统计窗口时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Strategy' => ['description' => '阈值类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '资源名。', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“具体应用>基本信息页签”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'HalfOpenBaseAmountPerStep' => ['description' => '熔断恢复每步最小通过数目,默认值为5。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'RecoveryTimeoutMs' => ['description' => '熔断时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'MinRequestAmount' => ['description' => '触发熔断的最小请求数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Threshold' => ['description' => '降级阈值。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'Enable' => ['description' => '规则是否开启。', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.HalfOpenBaseAmountPerStep', 'errorMessage' => 'The specified HalfOpenBaseAmountPerStep is invalid.', 'description' => '参数HalfOpenBaseAmountPerStep不合法'],
['errorCode' => 'IllegalArgument.HalfOpenRecoveryStepNum', 'errorMessage' => 'The specified HalfOpenRecoveryStepNum is invalid.', 'description' => '参数HalfOpenRecoveryStepNum不合法'],
['errorCode' => 'IllegalArgument.MinRequestAmount', 'errorMessage' => 'The specified MinRequestAmount is invalid.', 'description' => '参数MinRequestAmount不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
['errorCode' => 'IllegalArgument.RecoveryTimeoutMs', 'errorMessage' => 'The specified RecoveryTimeoutMs is invalid.', 'description' => '参数RecoveryTimeoutMs不合法'],
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => '参数Resource不合法'],
['errorCode' => 'IllegalArgument.SlowRtMS', 'errorMessage' => 'The specified SlowRtMs is invalid.', 'description' => '参数SlowRtMs不合法'],
['errorCode' => 'IllegalArgument.StatDurationMs', 'errorMessage' => 'The specified StatDurationMs is invalid.', 'description' => '参数StatDurationMs不合法'],
['errorCode' => 'IllegalArgument.Strategy', 'errorMessage' => 'The specified Strategy is invalid.', 'description' => '参数Strategy不合法'],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => '参数Threshold不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"SlowRtMs\\": 2000,\\n \\"HalfOpenRecoveryStepNum\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"StatDurationMs\\": 2000,\\n \\"RuleId\\": 1,\\n \\"Strategy\\": 0,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"RecoveryTimeoutMs\\": 5000,\\n \\"MinRequestAmount\\": 10,\\n \\"Threshold\\": 0.6,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 2000\\n 1\\n default\\n 2000\\n 1\\n 0\\n handleService\\n ahas-demo\\n 5\\n 5000\\n 10\\n 0.6\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '创建降级规则',
'summary' => '调用CreateDegradeRule接口创建降级规则。',
'requestParamsDescription' => ' 详细参数说明参照文档[降级规则](https://help.aliyun.com/document_detail/101078.html)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'CreateFlowRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'RelationStrategy',
'in' => 'query',
'schema' => ['description' => '统计维度。0表示当前接口,1表示关联接口,2表示链路入口。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '流控规则的阈值,取值范围为≥0的整数。', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '50'],
],
[
'name' => 'Enable',
'in' => 'query',
'schema' => ['description' => '规则是否开启,默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => '资源名。不能超过1024个字符,且该资源名需要与接口详情页面的资源名称相对应。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleServiceA'],
],
[
'name' => 'LimitOrigin',
'in' => 'query',
'schema' => ['description' => '来源应用,默认为default。', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
'name' => 'RefResource',
'in' => 'query',
'schema' => ['description' => '关联接口名、入口资源名。当统计维度relationStrategy值为1(关联接口)或2(链路入口)时,需要设置该字段。', 'type' => 'string', 'required' => false, 'example' => 'handleServiceB'],
],
[
'name' => 'ControlBehavior',
'in' => 'query',
'schema' => ['description' => '流控效果。0表示快速失败,1表示预热启动,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'WarmUpPeriodSec',
'in' => 'query',
'schema' => ['description' => '预热时间,单位秒。当controlBehavior值为1(预热启动)时,需要设置该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'MaxQueueingTimeMs',
'in' => 'query',
'schema' => ['description' => '超时时间,单位毫秒。当controlBehavior值为2(排队等待)时,需要设置该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ThresholdMode',
'in' => 'query',
'schema' => ['description' => '流控阈值模式。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94E*****10'],
'Code' => ['description' => '返回码。返回200代表成功。', 'type' => 'string', 'example' => '200'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RefResource' => ['description' => '关联接口名、入口资源名。', 'type' => 'string', 'example' => 'handleServiceB'],
'ClusterFallbackThreshold' => ['description' => '退化单机阈值,当退化策略为退化到单机(ClusterFallbackStrategy=0)时返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用。', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '集群模式下统计窗口时长,单位为毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'ClusterThresholdType' => ['description' => '阈值模式,0表示单机均摊阈值,1表示集群阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'RelationStrategy' => ['description' => '统计维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Resource' => ['description' => '资源名。不能超过1024个字符,且该资源名需要与接口详情页面的资源名称相对应。', 'type' => 'string', 'example' => 'handleServiceA'],
'ClusterEstimatedMaxQps' => ['description' => '集群接口预估最大QPS。', 'type' => 'number', 'format' => 'float', 'example' => '5000'],
'ControlBehavior' => ['description' => '流控效果。0表示快速失败,1表示预热启动,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MaxQueueingTimeMs' => ['description' => '超时时间,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'ClusterFallbackStrategy' => ['description' => '集群流控通信失败退化策略,0表示退化到单机,1表示直接通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'WarmUpPeriodSec' => ['description' => '预热时间,单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'ClusterMode' => ['description' => '是否为集群模式。', 'type' => 'boolean', 'example' => 'true'],
'ThresholdMode' => ['description' => '流控阈值模式。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Threshold' => ['description' => '流控规则的阈值,取值范围为≥0的整数。', 'type' => 'number', 'format' => 'float', 'example' => '300'],
'Enable' => ['description' => '规则是否开启。', 'type' => 'boolean', 'example' => 'true'],
],
],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.MaxQueueingTimeM', 'errorMessage' => 'The specified MaxQueueingTimeMs is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.RefResource', 'errorMessage' => 'The specified RefResource is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.RelationStrategy', 'errorMessage' => 'The specified RelationStrategy is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.WarmUpPeriodSec', 'errorMessage' => 'The specified WarmUpPeriodSec is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94E*****10\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"ClusterFallbackThreshold\\": 30,\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"StatDurationMs\\": 5000,\\n \\"ClusterThresholdType\\": 0,\\n \\"RuleId\\": 123,\\n \\"RelationStrategy\\": 0,\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"ClusterEstimatedMaxQps\\": 5000,\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 2000,\\n \\"ClusterFallbackStrategy\\": 0,\\n \\"WarmUpPeriodSec\\": 30,\\n \\"ClusterMode\\": true,\\n \\"ThresholdMode\\": 2,\\n \\"Threshold\\": 300,\\n \\"Enable\\": true\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94E*****10\\n 200\\n \\n handleServiceB\\n 30\\n default\\n default\\n 5000\\n 0\\n 123\\n 0\\n ahas-demo\\n handleServiceA\\n 5000\\n 0\\n 2000\\n 0\\n 30\\n true\\n 2\\n 300\\n true\\n \\n true\\n","errorExample":""}]',
'title' => '创建流控规则',
'summary' => '调用CreateFlowRule接口创建流控规则。',
'requestParamsDescription' => ' 详细参数解释,请参见[配置流控规则](~~101077~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'CreateHotParamItems' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '热点规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'Items',
'in' => 'query',
'schema' => ['description' => '热点例外项', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"itemType":"String","itemValue":"apple","threshold":50.0},{"itemType":"String","itemValue":"orange","threshold":20.0}]'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求Request ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'ParamIdx' => ['description' => '参数位置索引', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'ParamFlowItemList' => [
'description' => '例外项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '例外项参数值', 'type' => 'string', 'example' => 'apple'],
'ItemType' => ['description' => '例外项类型', 'type' => 'string', 'example' => 'String'],
'Threshold' => ['description' => '例外项阈值', 'type' => 'number', 'format' => 'float', 'example' => '10'],
],
'description' => '',
],
],
'StatDurationSec' => ['description' => '统计周期时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BurstCount' => ['description' => '缓冲请求数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'],
'ControlBehavior' => ['description' => '流控效果,0表示快速失败,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MetricType' => ['description' => '统计维度,0表示并发数,1表示通过请求数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Threshold' => ['description' => '单机阈值', 'type' => 'number', 'format' => 'float', 'example' => '50'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码,success=true时返回200,否则返回对应的错误码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
['errorCode' => 'IllegalArgument.ParamItems', 'errorMessage' => 'The specified Items is invalid.', 'description' => '参数Items不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"ParamIdx\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"ParamFlowItemList\\": [\\n {\\n \\"ItemValue\\": \\"apple\\",\\n \\"ItemType\\": \\"String\\",\\n \\"Threshold\\": 10\\n }\\n ],\\n \\"StatDurationSec\\": 1,\\n \\"BurstCount\\": 2,\\n \\"RuleId\\": 123,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"MaxQueueingTimeMs\\": 3000,\\n \\"ControlBehavior\\": 0,\\n \\"MetricType\\": 1,\\n \\"Threshold\\": 50,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n default\\n \\n apple\\n String\\n 10\\n \\n 1\\n 2\\n 123\\n handleService\\n ahas-demo\\n 3000\\n 0\\n 1\\n 50\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '创建热点规则例外项',
'summary' => '调用CreateHotParamItems接口创建热点规则例外项。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'CreateHotParamRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'MetricType',
'in' => 'query',
'schema' => ['description' => '统计维度,0表示并发数,1表示通过请求数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '热点规则中针对每个热点参数的阈值,取值范围为≥0的整数。', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '20'],
],
[
'name' => 'Enable',
'in' => 'query',
'schema' => ['description' => '是否开启,默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => '资源名。不能超过1024个字符,且该资源名需要与接口详情页面的资源名称相对应。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleService'],
],
[
'name' => 'ParamIdx',
'in' => 'query',
'schema' => ['description' => '参数位置索引,埋点传入参数的索引位置。对应`SphU.entry(xxx,args)`中的参数索引位置。'."\n"
."\n"
.'例如:`SphU.entry(resourceName,Entry Type.IN,1,paramA,paramB)`埋点中,`paramA`的参数索引是0,`paramB`的参数索引是1。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'StatDurationSec',
'in' => 'query',
'schema' => ['description' => '统计周期时间,单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'ControlBehavior',
'in' => 'query',
'schema' => ['description' => '流控效果,0表示快速失败,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'BurstCount',
'in' => 'query',
'schema' => ['description' => '缓冲请求数,流控效果为快速失败时需要设置。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'MaxQueueingTimeMs',
'in' => 'query',
'schema' => ['description' => '超时时间,流控效果为排队等待时需要设置,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求Request ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '业务数据。',
'type' => 'object',
'properties' => [
'ParamIdx' => ['description' => '参数位置索引。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'ParamFlowItemList' => [
'description' => '热点参数例外项。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '例外项参数值。', 'type' => 'string', 'example' => 'apple'],
'ItemType' => ['description' => '例外项类型。'."\n", 'type' => 'string', 'example' => 'String'],
'Threshold' => ['description' => '例外项阈值。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
],
'description' => '',
],
],
'StatDurationSec' => ['description' => '统计周期时间,单位秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BurstCount' => ['description' => '缓冲请求数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RuleId' => ['description' => '热点规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Resource' => ['description' => '资源名。不能超过1024个字符,且该资源名需要与接口详情页面的资源名称相对应。', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。'."\n", 'type' => 'string', 'example' => 'ahas-demo'],
'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'],
'ControlBehavior' => ['description' => '流控效果,0表示快速失败,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MetricType' => ['description' => '统计维度,0表示并发数,1表示通过请求数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Threshold' => ['description' => '单机阈值。', 'type' => 'number', 'format' => 'float', 'example' => '20'],
'Enable' => ['description' => '规则是否开启。', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码、错误码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.BurstCount', 'errorMessage' => 'The specified BurstCount is invalid.', 'description' => '参数BurstCount不合法'],
['errorCode' => 'IllegalArgument.ControlBehavior', 'errorMessage' => 'The specified ControlBehavior is invalid.', 'description' => '参数ControlBehavior不合法'],
['errorCode' => 'IllegalArgument.DurationInSec', 'errorMessage' => 'The specified DurationInSec is invalid.', 'description' => '参数DurationInSec不合法'],
['errorCode' => 'IllegalArgument.MaxQueueingTimeM', 'errorMessage' => 'The specified MaxQueueingTimeMs is invalid.', 'description' => '参数MaxQueueingTimeMs不合法'],
['errorCode' => 'IllegalArgument.MetricType', 'errorMessage' => 'The specified MetricType is invalid.', 'description' => '参数MetricType不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
['errorCode' => 'IllegalArgument.ParamIdx', 'errorMessage' => 'The specified ParamIdx is invalid.', 'description' => '参数ParamIdx不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"ParamIdx\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"ParamFlowItemList\\": [\\n {\\n \\"ItemValue\\": \\"apple\\",\\n \\"ItemType\\": \\"String\\",\\n \\"Threshold\\": 10\\n }\\n ],\\n \\"StatDurationSec\\": 1,\\n \\"BurstCount\\": 2,\\n \\"RuleId\\": 123,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"MaxQueueingTimeMs\\": 3000,\\n \\"ControlBehavior\\": 0,\\n \\"MetricType\\": 0,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n default\\n \\n apple\\n String\\n 10\\n \\n 1\\n 2\\n 123\\n handleService\\n ahas-demo\\n 3000\\n 0\\n 0\\n 20\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '创建热点规则',
'summary' => '调用CreateHotParamRule接口创建热点规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'CreateIsolationRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'RelationStrategy',
'in' => 'query',
'schema' => ['description' => '统计维度,0表示当前接口,1表示关联接口,2表示链路入口。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '并发数阈值,取值范围为≥0的整数。', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'Enable',
'in' => 'query',
'schema' => ['description' => '是否开启,默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => '资源名。不能超过1024个字符,且该资源名需要与接口详情页面的资源名称相对应。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleServiceA'],
],
[
'name' => 'LimitOrigin',
'in' => 'query',
'schema' => ['description' => '来源应用,默认为default。', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
'name' => 'RefResource',
'in' => 'query',
'schema' => ['description' => '关联接口名、callstack入口名,当统计维度为关联接口或链路入口时需设置该值。', 'type' => 'string', 'required' => false, 'example' => 'handleServiceB'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '隔离规则数据',
'type' => 'object',
'properties' => [
'RelationStrategy' => ['description' => '统计维度', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '接口资源名', 'type' => 'string', 'example' => 'handleServiceA'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'RefResource' => ['description' => '关联接口名、callstack入口名', 'type' => 'string', 'example' => 'handleServiceB'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用', 'type' => 'string', 'example' => 'default'],
'Threshold' => ['description' => '并发数阈值', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'RuleId' => ['description' => '隔离规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.RelationStrategy', 'errorMessage' => 'The specified RelationStrategy is invalid.', 'description' => '参数RelationStrategy不合法'],
['errorCode' => 'IllegalArgument.RefResource', 'errorMessage' => 'The specified RefResource is invalid.', 'description' => '参数RefResource不合法'],
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => '参数Resource不合法'],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => '参数Threshold不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RelationStrategy\\": 0,\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"Threshold\\": 10,\\n \\"RuleId\\": 123,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 0\\n handleServiceA\\n ahas-demo\\n handleServiceB\\n default\\n default\\n 10\\n 123\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '创建隔离规则',
'summary' => '调用CreateIsolationRule接口创建隔离规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'CreateSystemRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'MetricType',
'in' => 'query',
'schema' => ['description' => '统计维度,0表示Load,1表示入口平均RT,2表示线程数,3表示入口总QPS,4表示CPU使用率。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '4'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => 'CPU阈值,取值范围0~1。', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '0.6'],
],
[
'name' => 'Enable',
'in' => 'query',
'schema' => ['description' => '规则是否开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '业务数据',
'type' => 'object',
'properties' => [
'MetricType' => ['description' => '统计维度', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'Threshold' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.MetricType', 'errorMessage' => 'The specified MetricType is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"MetricType\\": 4,\\n \\"Threshold\\": 0.6,\\n \\"RuleId\\": 123,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 4\\n 0.6\\n 123\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '创建系统规则',
'summary' => '调用CreateSystemRule接口创建系统规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeleteDegradeRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RuleId\\": 123\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 123\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '删除降级规则',
'summary' => '调用DeleteDegradeRule接口删除降级规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeleteFlowRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RuleId\\": 123\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 123\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '删除流控规则',
'summary' => '调用DeleteFlowRule接口删除流控规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeleteHotParamRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '热点规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RuleId\\": 123\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 123\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '删除热点规则',
'summary' => '调用DeleteHotParamRule接口删除热点规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeleteIsolationRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '隔离规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RuleId\\": 123\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 123\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '删除隔离规则',
'summary' => '调用DeleteIsolationRule接口删除隔离规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeleteSystemRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '系统规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RuleId\\": 123\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 123\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '删除系统规则',
'summary' => '调用DeleteSystemRule接口删除系统规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DescribeRegions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '20659',
'abilityTreeNodes' => ['FEATUREahasF8SZSQ'],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Regions' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LocalName' => ['type' => 'string'],
'RegionEndpoint' => ['type' => 'string'],
'RegionId' => ['type' => 'string'],
],
],
],
'Code' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"\\",\\n \\"RegionEndpoint\\": \\"\\",\\n \\"RegionId\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DisableDegradeRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '降级规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '业务数据',
'type' => 'object',
'properties' => [
'SlowRtMs' => ['description' => '慢调用RT', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'HalfOpenRecoveryStepNum' => ['description' => '熔断恢复阶段数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default '],
'StatDurationMs' => ['description' => '统计窗口时长', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'RuleId' => ['description' => '降级规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Strategy' => ['description' => '阈值类型', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'HalfOpenBaseAmountPerStep' => ['description' => '熔断恢复每步最小通过数目', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'RecoveryTimeoutMs' => ['description' => '熔断时长', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'MinRequestAmount' => ['description' => '触发熔断的最小请求数目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Threshold' => ['description' => '阈值类型所对应的降级阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'Enable' => ['description' => '规则是否启用', 'type' => 'boolean', 'example' => 'false'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"SlowRtMs\\": 2000,\\n \\"HalfOpenRecoveryStepNum\\": 1,\\n \\"Namespace\\": \\"default \\",\\n \\"StatDurationMs\\": 2000,\\n \\"RuleId\\": 123,\\n \\"Strategy\\": 0,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"RecoveryTimeoutMs\\": 5000,\\n \\"MinRequestAmount\\": 10,\\n \\"Threshold\\": 0.6,\\n \\"Enable\\": false\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 2000\\n 1\\n default \\n 2000\\n 123\\n 0\\n handleService\\n ahas-demo\\n 5\\n 5000\\n 10\\n 0.6\\n false\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '关闭降级规则',
'summary' => '调用DisableDegradeRule接口关闭降级规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DisableFlowRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '流控规则数据。',
'type' => 'object',
'properties' => [
'RefResource' => ['description' => '关联接口名、入口资源名。', 'type' => 'string', 'example' => 'handleServiceB'],
'ClusterFallbackThreshold' => ['description' => '退化单机阈值,当退化策略为退化到单机(ClusterFallbackStrategy=0)时返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用。', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '集群模式下统计窗口时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'ClusterThresholdType' => ['description' => '阈值模式,0表示单机均摊阈值,1表示集群阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RuleId' => ['description' => '流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'RelationStrategy' => ['description' => '统计维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Resource' => ['description' => '资源名。', 'type' => 'string', 'example' => 'handleServiceA'],
'MaxQueueingTimeMs' => ['description' => '超时时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'ClusterEstimatedMaxQps' => ['description' => '集群接口预估最大QPS。', 'type' => 'number', 'format' => 'float', 'example' => '5000'],
'ControlBehavior' => ['description' => '流控效果。0表示快速失败,1表示预热启动,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'WarmUpPeriodSec' => ['description' => '预热时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'ClusterFallbackStrategy' => ['description' => '集群流控通信失败退化策略,0表示退化到单机,1表示直接通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Threshold' => ['description' => '阈值。', 'type' => 'number', 'format' => 'float', 'example' => '300'],
'ClusterMode' => ['description' => '是否为集群模式。', 'type' => 'boolean', 'example' => 'true'],
'Enable' => ['description' => '是否开启。', 'type' => 'boolean', 'example' => 'false'],
],
],
'Code' => ['description' => '返回码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"ClusterFallbackThreshold\\": 30,\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"StatDurationMs\\": 5000,\\n \\"ClusterThresholdType\\": 0,\\n \\"RuleId\\": 123,\\n \\"RelationStrategy\\": 0,\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"MaxQueueingTimeMs\\": 2000,\\n \\"ClusterEstimatedMaxQps\\": 5000,\\n \\"ControlBehavior\\": 0,\\n \\"WarmUpPeriodSec\\": 30,\\n \\"ClusterFallbackStrategy\\": 0,\\n \\"Threshold\\": 300,\\n \\"ClusterMode\\": true,\\n \\"Enable\\": false\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n handleServiceB\\n 30\\n default\\n default\\n 5000\\n 0\\n 123\\n 0\\n ahas-demo\\n handleServiceA\\n 2000\\n 5000\\n 0\\n 30\\n 0\\n 300\\n true\\n false\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '关闭流控规则',
'summary' => '调用DisableFlowRule接口关闭流控规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DisableHotParamRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '热点规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '热点规则数据',
'type' => 'object',
'properties' => [
'ParamIdx' => ['description' => '参数位置索引', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'StatDurationSec' => ['description' => '统计周期时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BurstCount' => ['description' => '缓冲请求数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RuleId' => ['description' => '热点规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleService'],
'ControlBehavior' => ['description' => '流控效果,0表示快速失败,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'],
'MetricType' => ['description' => '统计维度,0表示并发数,1表示通过请求数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Threshold' => ['description' => '单机阈值', 'type' => 'number', 'format' => 'float', 'example' => '20'],
'Enable' => ['description' => '规则是否启用', 'type' => 'boolean', 'example' => 'false'],
'ParamFlowItemList' => [
'description' => '热点参数例外项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '例外项参数值', 'type' => 'string', 'example' => 'apple'],
'Threshold' => ['description' => '例外项阈值', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'ItemType' => ['description' => '例外项类型', 'type' => 'string', 'example' => 'String'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ParamIdx\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"StatDurationSec\\": 1,\\n \\"BurstCount\\": 2,\\n \\"RuleId\\": 123,\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Resource\\": \\"handleService\\",\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 3000,\\n \\"MetricType\\": 0,\\n \\"Threshold\\": 20,\\n \\"Enable\\": false,\\n \\"ParamFlowItemList\\": [\\n {\\n \\"ItemValue\\": \\"apple\\",\\n \\"Threshold\\": 10,\\n \\"ItemType\\": \\"String\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nnull\\n3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n\\n 0\\n 123\\n handleService\\n 3000\\n default\\n ahas-demo\\n 2\\n \\n apple\\n String\\n 10\\n \\n 0\\n 1\\n false\\n 1\\n 20\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => '关闭热点规则',
'summary' => '调用DisableHotParamRule接口关闭热点规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DisableIsolationRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '隔离规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '100000000000000', 'minimum' => '0', 'example' => '123', 'isFileTransferUrl' => false],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '隔离规则数据',
'type' => 'object',
'properties' => [
'RelationStrategy' => ['description' => '统计维度', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleServiceA'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'RefResource' => ['description' => '关联接口名、callstack入口名', 'type' => 'string', 'example' => 'handleServiceB'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用', 'type' => 'string', 'example' => 'default'],
'Threshold' => ['description' => '并发数阈值', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'RuleId' => ['description' => '隔离规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '规则是否启用', 'type' => 'boolean', 'example' => 'false'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RelationStrategy\\": 0,\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"Threshold\\": 10,\\n \\"RuleId\\": 123,\\n \\"Enable\\": false\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 0\\n handleServiceA\\n ahas-demo\\n handleServiceB\\n default\\n default\\n 10\\n 123\\n false\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '关闭隔离规则',
'summary' => '调用DisableIsolationRule接口关闭隔离规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DisableSystemRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '系统规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '系统规则数据',
'type' => 'object',
'properties' => [
'MetricType' => ['description' => '统计维度', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'Threshold' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'RuleId' => ['description' => '系统规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'false'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"MetricType\\": 4,\\n \\"Threshold\\": 0.6,\\n \\"RuleId\\": 123,\\n \\"Enable\\": false\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 4\\n 0.6\\n 123\\n false\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '关闭系统规则',
'summary' => '调用DisableSystemRule接口关闭系统规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'EnableDegradeRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '降级规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '降级规则数据',
'type' => 'object',
'properties' => [
'SlowRtMs' => ['description' => '慢调用RT', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'HalfOpenRecoveryStepNum' => ['description' => '熔断恢复阶段数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '统计窗口时长', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'RuleId' => ['description' => '降级规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Strategy' => ['description' => '阈值类型', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'HalfOpenBaseAmountPerStep' => ['description' => '熔断恢复每步最小通过数目,默认值为5。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'RecoveryTimeoutMs' => ['description' => '熔断时长'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'MinRequestAmount' => ['description' => '触发熔断的最小请求数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Threshold' => ['description' => '降级阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"SlowRtMs\\": 2000,\\n \\"HalfOpenRecoveryStepNum\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"StatDurationMs\\": 2000,\\n \\"RuleId\\": 123,\\n \\"Strategy\\": 200,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"RecoveryTimeoutMs\\": 5000,\\n \\"MinRequestAmount\\": 10,\\n \\"Threshold\\": 0.6,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 2000\\n 1\\n default\\n 2000\\n 123\\n 200\\n handleService\\n ahas-demo\\n 5\\n 5000\\n 10\\n 0.6\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '开启降级规则',
'summary' => '调用EnableDegradeRule接口开启降级规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'EnableFlowRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '流控规则数据。',
'type' => 'object',
'properties' => [
'RefResource' => ['description' => '关联接口名、入口资源名。', 'type' => 'string', 'example' => 'handleServiceB'],
'ClusterFallbackThreshold' => ['description' => '退化单机阈值,当退化策略为退化到单机(ClusterFallbackStrategy=0)时返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '集群模式下统计窗口时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'LimitOrigin' => ['description' => '来源应用。', 'type' => 'string', 'example' => 'default'],
'ClusterThresholdType' => ['description' => '阈值模式,0表示单机均摊阈值,1表示集群阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RuleId' => ['description' => '流控规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'RelationStrategy' => ['description' => '统计维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '接口资源名。', 'type' => 'string', 'example' => 'handleServiceA'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'MaxQueueingTimeMs' => ['description' => '超时时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'ControlBehavior' => ['description' => '流控效果。0表示快速失败,1表示预热启动,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ClusterEstimatedMaxQps' => ['description' => '集群接口预估最大QPS。', 'type' => 'number', 'format' => 'float', 'example' => '3000'],
'WarmUpPeriodSec' => ['description' => '预热时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'ClusterFallbackStrategy' => ['description' => '集群流控通信失败退化策略,0表示退化到单机,1表示直接通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Threshold' => ['description' => '流控阈值。', 'type' => 'number', 'format' => 'float', 'example' => '50'],
'ClusterMode' => ['description' => '是否为集群模式。', 'type' => 'boolean', 'example' => 'true'],
'Enable' => ['description' => '规则是否开启。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"ClusterFallbackThreshold\\": 30,\\n \\"Namespace\\": \\"default\\",\\n \\"StatDurationMs\\": 5000,\\n \\"LimitOrigin\\": \\"default\\",\\n \\"ClusterThresholdType\\": 0,\\n \\"RuleId\\": 123,\\n \\"RelationStrategy\\": 0,\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"MaxQueueingTimeMs\\": 2000,\\n \\"ControlBehavior\\": 0,\\n \\"ClusterEstimatedMaxQps\\": 3000,\\n \\"WarmUpPeriodSec\\": 30,\\n \\"ClusterFallbackStrategy\\": 1,\\n \\"Threshold\\": 50,\\n \\"ClusterMode\\": true,\\n \\"Enable\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nnull\\n3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n\\n handleServiceB\\n true\\n 123\\n handleServiceA\\n 2000\\n default\\n ahas-demo\\n 30\\n 0\\n 1\\n 0\\n 30\\n true\\n 0\\n default\\n 3000\\n 50\\n 5000\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => '开启流控规则',
'summary' => '调用EnableFlowRule接口开启流控规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'EnableHotParamRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '热点规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'ParamIdx' => ['description' => '参数位置索引'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'ParamFlowItemList' => [
'description' => '热点例外项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '例外项参数值', 'type' => 'string', 'example' => 'apple'],
'ItemType' => ['description' => '例外项类型', 'type' => 'string', 'example' => 'String '],
'Threshold' => ['description' => '例外项阈值', 'type' => 'number', 'format' => 'float', 'example' => '10'],
],
'description' => '',
],
],
'StatDurationSec' => ['description' => '统计周期时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BurstCount' => ['description' => '缓冲请求数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RuleId' => ['description' => '热点规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'],
'ControlBehavior' => ['description' => '流控效果,0表示快速失败,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MetricType' => ['description' => ' '."\n"
.'统计维度,0表示并发数,1表示通过请求数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Threshold' => ['description' => '单机阈值', 'type' => 'number', 'format' => 'float', 'example' => '20'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"ParamIdx\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"ParamFlowItemList\\": [\\n {\\n \\"ItemValue\\": \\"apple\\",\\n \\"ItemType\\": \\"String \\",\\n \\"Threshold\\": 10\\n }\\n ],\\n \\"StatDurationSec\\": 1,\\n \\"BurstCount\\": 2,\\n \\"RuleId\\": 123,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"MaxQueueingTimeMs\\": 3000,\\n \\"ControlBehavior\\": 0,\\n \\"MetricType\\": 0,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n default\\n \\n apple\\n String \\n 10\\n \\n 1\\n 2\\n 123\\n handleService\\n ahas-demo\\n 3000\\n 0\\n 0\\n 20\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '开启热点规则',
'summary' => '调用EnableHotParamRule接口开启热点规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'EnableIsolationRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '隔离规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'RelationStrategy' => ['description' => '统计维度'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '接口资源名', 'type' => 'string', 'example' => 'handleServiceA'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'RefResource' => ['description' => '关联接口名、callstack入口名'."\n", 'type' => 'string', 'example' => 'handleServiceB'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用'."\n", 'type' => 'string', 'example' => 'default'],
'Threshold' => ['description' => '并发数阈值', 'type' => 'number', 'format' => 'float', 'example' => '30'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RelationStrategy\\": 0,\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"Threshold\\": 30,\\n \\"RuleId\\": 123,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 0\\n handleServiceA\\n ahas-demo\\n handleServiceB\\n default\\n default\\n 30\\n 123\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '开启隔离规则',
'summary' => '调用EnableIsolationRule接口开启隔离规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'EnableSystemRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '系统规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'MetricType' => ['description' => '统计维度', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'Threshold' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"MetricType\\": 4,\\n \\"Threshold\\": 0.6,\\n \\"RuleId\\": 123,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 4\\n 0.6\\n 123\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '开启系统规则',
'summary' => '调用EnableSystemRule接口开启系统规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetLicenseKey' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '20678',
'abilityTreeNodes' => ['FEATUREahasF8SZSQ'],
],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Data' => ['type' => 'string'],
'Code' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetLicenseKey'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetMetricsOfApp' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台具体应用的基本信息页签中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1596081600000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1596081780000'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'InnerMetrics' => [
'description' => '应用监控metrics数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RtP99' => ['description' => '应用RT 99分位数值', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'SuccessQpsAvg' => ['description' => '应用success QPS平均值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'PassedQpsP99' => ['description' => '应用paas QPS 99分位数值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'RtAvg' => ['description' => '应用RT平均值', 'type' => 'number', 'format' => 'float', 'example' => '6.5'],
'Count' => ['description' => '集群机器数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ThreadStd' => ['description' => '应用并发数标准差值', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'PassedQpsAvg' => ['description' => '应用paas QPS 平均值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'ExceptionP95' => ['description' => '应用异常QPS 95分位数值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SuccessQpsMax' => ['description' => '应用success QPS最大值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'RtP95' => ['description' => '应用RT 95分位数值', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'BlockedQpsMin' => ['description' => '接口限流QPS最小值', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'BlockedQps' => ['description' => '集群接口限流QPS', 'type' => 'number', 'format' => 'float', 'example' => '173'],
'Timestamp' => ['description' => '时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1596593014000'],
'ThreadP95' => ['description' => '应用并发数95分位数值', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'RtStd' => ['description' => '应用RT 标准差值', 'type' => 'number', 'format' => 'float', 'example' => '0.7'],
'PassedQpsMin' => ['description' => '应用paas QPS 最小值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'BlockedQpsP99' => ['description' => '接口限流QPS 99分位数值', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'PassedQpsMax' => ['description' => '应用paas QPS 最大值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'ExceptionMax' => ['description' => '应用异常QPS最大值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SuccessQps' => ['description' => '应用集群success QPS', 'type' => 'number', 'format' => 'float', 'example' => '286'],
'SuccessQpsP75' => ['description' => '应用success QPS 75分位数值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'ThreadP75' => ['description' => '应用并发数75分位数值', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'SuccessQpsStd' => ['description' => '应用success QPS 标准差值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ExceptionMin' => ['description' => '应用异常QPS最小值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'PassedQpsP75' => ['description' => '应用paas QPS 75分位数值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'PassedQps' => ['description' => '集群paas QPS', 'type' => 'number', 'format' => 'float', 'example' => '286'],
'ThreadMax' => ['description' => '应用并发数最大值', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'SuccessQpsP99' => ['description' => '应用success QPS 99分位数值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'SuccessQpsMin' => ['description' => '应用success QPS最小值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'ThreadP99' => ['description' => '应用并发数99分位数值', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'ExceptionStd' => ['description' => '应用异常QPS 标准差值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'BlockedQpsP95' => ['description' => '接口限流QPS 95分位数值', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'Thread' => ['description' => '应用集群并发数', 'type' => 'number', 'format' => 'float', 'example' => '2'],
'ThreadMin' => ['description' => '应用并发数最小值', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'RtMin' => ['description' => '应用RT最小值', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'BlockedQpsAvg' => ['description' => '接口限流QPS平均值', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'ThreadAvg' => ['description' => '应用并发数平均值', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'BlockedQpsP75' => ['description' => '接口限流QPS 75分位数值', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'RtP75' => ['description' => '应用RT 75分位数值', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'ExceptionP99' => ['description' => '应用异常QPS 99分位数值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ExceptionP75' => ['description' => '应用异常QPS 75分位数值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SuccessQpsP95' => ['description' => '应用success QPS 95分位数值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'Rt' => ['description' => '应用集群平均RT', 'type' => 'number', 'format' => 'float', 'example' => '6.5'],
'PassedQpsP95' => ['description' => '应用paas QPS 95分位数值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'RtMax' => ['description' => '应用RT最大值', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'BlockedQpsStd' => ['description' => '接口限流QPS 标准差值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'BlockedQpsMax' => ['description' => '接口限流QPS最大值', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'Exception' => ['description' => '集群异常QPS', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ExceptionAvg' => ['description' => '应用异常QPS平均值', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'PassedQpsStd' => ['description' => '应用paas QPS 标准差值', 'type' => 'number', 'format' => 'float', 'example' => '143'],
],
'description' => '',
],
],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Namespace\\": \\"default\\",\\n \\"InnerMetrics\\": [\\n {\\n \\"RtP99\\": 7,\\n \\"SuccessQpsAvg\\": 143,\\n \\"PassedQpsP99\\": 143,\\n \\"RtAvg\\": 6.5,\\n \\"Count\\": 0,\\n \\"ThreadStd\\": 1,\\n \\"PassedQpsAvg\\": 143,\\n \\"ExceptionP95\\": 0,\\n \\"SuccessQpsMax\\": 143,\\n \\"RtP95\\": 7,\\n \\"BlockedQpsMin\\": 86,\\n \\"BlockedQps\\": 173,\\n \\"Timestamp\\": 1596593014000,\\n \\"ThreadP95\\": 1,\\n \\"RtStd\\": 0.7,\\n \\"PassedQpsMin\\": 143,\\n \\"BlockedQpsP99\\": 86,\\n \\"PassedQpsMax\\": 143,\\n \\"ExceptionMax\\": 0,\\n \\"SuccessQps\\": 286,\\n \\"SuccessQpsP75\\": 143,\\n \\"ThreadP75\\": 1,\\n \\"SuccessQpsStd\\": 0,\\n \\"ExceptionMin\\": 0,\\n \\"PassedQpsP75\\": 143,\\n \\"PassedQps\\": 286,\\n \\"ThreadMax\\": 1,\\n \\"SuccessQpsP99\\": 143,\\n \\"SuccessQpsMin\\": 143,\\n \\"ThreadP99\\": 1,\\n \\"ExceptionStd\\": 0,\\n \\"BlockedQpsP95\\": 86,\\n \\"Thread\\": 2,\\n \\"ThreadMin\\": 1,\\n \\"RtMin\\": 7,\\n \\"BlockedQpsAvg\\": 86,\\n \\"ThreadAvg\\": 1,\\n \\"BlockedQpsP75\\": 86,\\n \\"RtP75\\": 7,\\n \\"ExceptionP99\\": 0,\\n \\"ExceptionP75\\": 0,\\n \\"SuccessQpsP95\\": 143,\\n \\"Rt\\": 6.5,\\n \\"PassedQpsP95\\": 143,\\n \\"RtMax\\": 7,\\n \\"BlockedQpsStd\\": 0,\\n \\"BlockedQpsMax\\": 86,\\n \\"Exception\\": 0,\\n \\"ExceptionAvg\\": 0,\\n \\"PassedQpsStd\\": 143\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n ahas-demo\\n default\\n \\n 7\\n 143\\n 143\\n 6.5\\n 0\\n 1\\n 143\\n 0\\n 143\\n 7\\n 86\\n 173\\n 1596593014000\\n 1\\n 0.7\\n 143\\n 86\\n 143\\n 0\\n 286\\n 143\\n 1\\n 0\\n 0\\n 143\\n 286\\n 1\\n 143\\n 143\\n 1\\n 0\\n 86\\n 2\\n 1\\n 7\\n 86\\n 1\\n 86\\n 7\\n 0\\n 0\\n 143\\n \\n 143\\n 7\\n 0\\n 86\\n 0\\n 0\\n 143\\n \\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取应用监控指标',
'summary' => '调用GetMetricsOfApp接口获取应用监控指标。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetMetricsOfResource' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => '资源名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleService'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间。支持的格式:'."\n"
."\n"
.'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n"
.'- Format格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1596081600000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。支持的格式:'."\n"
."\n"
.'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n"
.'- Format格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1596081780000'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94E*****10'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Resource' => ['description' => '资源名。', 'type' => 'string', 'example' => 'handleService'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'InnerMetrics' => [
'description' => '资源Metric数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RtP99' => ['description' => '接口RT 99分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'SuccessQpsAvg' => ['description' => '接口Success QPS平均值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'PassedQpsP99' => ['description' => '接口Pass QPS 99分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'RtAvg' => ['description' => '接口RT平均值。', 'type' => 'number', 'format' => 'float', 'example' => '6.5'],
'Count' => ['description' => '机器数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'ThreadStd' => ['description' => '接口并发数标准差值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'PassedQpsAvg' => ['description' => '接口Pass QPS平均值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'ExceptionP95' => ['description' => '接口异常QPS 95分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SuccessQpsMax' => ['description' => '接口Success QPS最大值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'RtP95' => ['description' => '接口RT 95分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'BlockedQpsMin' => ['description' => '接口限流QPS最小值。', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'BlockedQps' => ['description' => '接口集群限流QPS。', 'type' => 'number', 'format' => 'float', 'example' => '173'],
'Timestamp' => ['description' => '时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596593014000'],
'ThreadP95' => ['description' => '接口并发数95分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'RtStd' => ['description' => '接口RT标准差值。', 'type' => 'number', 'format' => 'float', 'example' => '0.7'],
'PassedQpsMin' => ['description' => '接口Pass QPS最小值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'BlockedQpsP99' => ['description' => '接口限流QPS 99分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'PassedQpsMax' => ['description' => '接口Pass QPS最大值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'ExceptionMax' => ['description' => '接口异常QPS最大值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SuccessQps' => ['description' => '接口集群Success QPS。', 'type' => 'number', 'format' => 'float', 'example' => '286'],
'SuccessQpsP75' => ['description' => '接口Success QPS 75分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'ThreadP75' => ['description' => '接口并发数75分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'SuccessQpsStd' => ['description' => '接口Success QPS 标准差值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ExceptionMin' => ['description' => '接口异常QPS最小值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'PassedQpsP75' => ['description' => '接口Pass QPS 75分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'PassedQps' => ['description' => '接口集群Pass QPS。', 'type' => 'number', 'format' => 'float', 'example' => '286'],
'ThreadMax' => ['description' => '接口并发数最大值。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'SuccessQpsP99' => ['description' => '接口Success QPS 95分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'SuccessQpsMin' => ['description' => '接口Success QPS最小值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'ThreadP99' => ['description' => '接口并发数99分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'ExceptionStd' => ['description' => '接口异常QPS标准差值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'BlockedQpsP95' => ['description' => '接口限流QPS 95分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'Thread' => ['description' => '接口集群并发数。', 'type' => 'number', 'format' => 'float', 'example' => '2'],
'ThreadMin' => ['description' => '接口并发数最小值。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'RtMin' => ['description' => '接口RT最小值。', 'type' => 'number', 'format' => 'float', 'example' => '6.5'],
'BlockedQpsAvg' => ['description' => '接口限流QPS平均值。', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'ThreadAvg' => ['description' => '接口并发数平均值。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'BlockedQpsP75' => ['description' => '接口限流QPS 75分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'RtP75' => ['description' => '接口RT 75分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'ExceptionP99' => ['description' => '接口异常QPS 99分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ExceptionP75' => ['description' => '接口异常QPS 75分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SuccessQpsP95' => ['description' => '接口Success QPS 95分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'Rt' => ['description' => '接口集群平均RT。', 'type' => 'number', 'format' => 'float', 'example' => '6.5'],
'PassedQpsP95' => ['description' => '接口Pass QPS 95分位数值。', 'type' => 'number', 'format' => 'float', 'example' => '143'],
'RtMax' => ['description' => '接口RT最大值。', 'type' => 'number', 'format' => 'float', 'example' => '7'],
'BlockedQpsStd' => ['description' => '接口限流QPS标准差值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'BlockedQpsMax' => ['description' => '接口限流QPS最大值。', 'type' => 'number', 'format' => 'float', 'example' => '86'],
'Exception' => ['description' => '接口集群异常QPS。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ExceptionAvg' => ['description' => '接口异常QPS平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'PassedQpsStd' => ['description' => '接口Pass QPS标准差值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
],
'description' => '',
],
],
],
],
'Code' => ['description' => '返回码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => '参数Resource不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94E*****10\\",\\n \\"Data\\": {\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Resource\\": \\"handleService\\",\\n \\"Namespace\\": \\"default\\",\\n \\"InnerMetrics\\": [\\n {\\n \\"RtP99\\": 7,\\n \\"SuccessQpsAvg\\": 143,\\n \\"PassedQpsP99\\": 143,\\n \\"RtAvg\\": 6.5,\\n \\"Count\\": 2,\\n \\"ThreadStd\\": 0,\\n \\"PassedQpsAvg\\": 143,\\n \\"ExceptionP95\\": 0,\\n \\"SuccessQpsMax\\": 143,\\n \\"RtP95\\": 7,\\n \\"BlockedQpsMin\\": 86,\\n \\"BlockedQps\\": 173,\\n \\"Timestamp\\": 1596593014000,\\n \\"ThreadP95\\": 1,\\n \\"RtStd\\": 0.7,\\n \\"PassedQpsMin\\": 143,\\n \\"BlockedQpsP99\\": 86,\\n \\"PassedQpsMax\\": 143,\\n \\"ExceptionMax\\": 0,\\n \\"SuccessQps\\": 286,\\n \\"SuccessQpsP75\\": 143,\\n \\"ThreadP75\\": 1,\\n \\"SuccessQpsStd\\": 0,\\n \\"ExceptionMin\\": 0,\\n \\"PassedQpsP75\\": 143,\\n \\"PassedQps\\": 286,\\n \\"ThreadMax\\": 1,\\n \\"SuccessQpsP99\\": 143,\\n \\"SuccessQpsMin\\": 143,\\n \\"ThreadP99\\": 1,\\n \\"ExceptionStd\\": 0,\\n \\"BlockedQpsP95\\": 86,\\n \\"Thread\\": 2,\\n \\"ThreadMin\\": 1,\\n \\"RtMin\\": 6.5,\\n \\"BlockedQpsAvg\\": 86,\\n \\"ThreadAvg\\": 1,\\n \\"BlockedQpsP75\\": 86,\\n \\"RtP75\\": 7,\\n \\"ExceptionP99\\": 0,\\n \\"ExceptionP75\\": 0,\\n \\"SuccessQpsP95\\": 143,\\n \\"Rt\\": 6.5,\\n \\"PassedQpsP95\\": 143,\\n \\"RtMax\\": 7,\\n \\"BlockedQpsStd\\": 0,\\n \\"BlockedQpsMax\\": 86,\\n \\"Exception\\": 0,\\n \\"ExceptionAvg\\": 0,\\n \\"PassedQpsStd\\": 0\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94E*****10\\n \\n ahas-demo\\n handleService\\n default\\n \\n 7\\n 143\\n 143\\n 6.5\\n 2\\n 0\\n 143\\n 0\\n 143\\n 7\\n 86\\n 173\\n 1596593014000\\n 1\\n 0.7\\n 143\\n 86\\n 143\\n 0\\n 286\\n 143\\n 1\\n 0\\n 0\\n 143\\n 286\\n 1\\n 143\\n 143\\n 1\\n 0\\n 86\\n 2\\n 1\\n 6.5\\n 86\\n 1\\n 86\\n 7\\n 0\\n 0\\n 143\\n \\n 143\\n 7\\n 0\\n 86\\n 0\\n 0\\n 0\\n \\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取资源metric数据',
'summary' => '调用GetMetricsOfResource接口获取资源metric数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetSentinelAppSumMetric' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Code' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
'MetricData' => [
'type' => 'object',
'properties' => [
'AppName' => ['type' => 'string'],
'PassCount' => ['type' => 'number', 'format' => 'float'],
'MachineCount' => ['type' => 'integer', 'format' => 'int64'],
'AvgRt' => ['type' => 'number', 'format' => 'float'],
'UserId' => ['type' => 'string'],
'Namespace' => ['type' => 'string'],
'TotalCount' => ['type' => 'number', 'format' => 'float'],
'BlockCount' => ['type' => 'number', 'format' => 'float'],
],
],
],
],
],
],
'errorCodes' => [],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSentinelAppSumMetric'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true,\\n \\"MetricData\\": {\\n \\"AppName\\": \\"\\",\\n \\"PassCount\\": 0,\\n \\"MachineCount\\": 0,\\n \\"AvgRt\\": 0,\\n \\"UserId\\": \\"\\",\\n \\"Namespace\\": \\"\\",\\n \\"TotalCount\\": 0,\\n \\"BlockCount\\": 0\\n }\\n}","type":"json"}]',
],
'ListActiveApps' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'AppType',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppName' => ['type' => 'string'],
'LastHealthPingTime' => ['type' => 'integer', 'format' => 'int64'],
'CurrentLevel' => ['type' => 'integer', 'format' => 'int32'],
'Namespace' => ['type' => 'string'],
'AppType' => ['type' => 'integer', 'format' => 'int32'],
'DirtyLevel' => ['type' => 'integer', 'format' => 'int32'],
'AhasAppName' => ['type' => 'string'],
],
],
],
'Code' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
],
],
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"AppName\\": \\"\\",\\n \\"LastHealthPingTime\\": 0,\\n \\"CurrentLevel\\": 0,\\n \\"Namespace\\": \\"\\",\\n \\"AppType\\": 0,\\n \\"DirtyLevel\\": 0,\\n \\"AhasAppName\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'ListDegradeRulesOfApp' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => '当前页码,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页数据条数,默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '降级规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SlowRtMs' => ['description' => '慢调用RT'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'HalfOpenRecoveryStepNum' => ['description' => '熔断恢复阶段数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '统计窗口时长'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Strategy' => ['description' => '阈值类型'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleServiceA'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'HalfOpenBaseAmountPerStep' => ['description' => '熔断恢复每步最小通过数目,默认值为5。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'RecoveryTimeoutMs' => ['description' => '熔断时长'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'MinRequestAmount' => ['description' => '触发熔断的最小请求数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Threshold' => ['description' => '降级阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数据量', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"SlowRtMs\\": 2000,\\n \\"HalfOpenRecoveryStepNum\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"StatDurationMs\\": 2000,\\n \\"RuleId\\": 123,\\n \\"Strategy\\": 0,\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"RecoveryTimeoutMs\\": 5000,\\n \\"MinRequestAmount\\": 10,\\n \\"Threshold\\": 0.6,\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n \\n 2000\\n 1\\n default\\n 2000\\n 123\\n 0\\n handleServiceA\\n ahas-demo\\n 5\\n 5000\\n 10\\n 0.6\\n true\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取应用降级规则',
'summary' => '调用ListDegradeRulesOfApp接口获取应用降级规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ListDegradeRulesOfResource' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => '资源名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleServiceA'],
],
[
'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' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '降级规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SlowRtMs' => ['description' => '慢调用RT'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'HalfOpenRecoveryStepNum' => ['description' => '熔断恢复阶段数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '统计窗口时长'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Strategy' => ['description' => '阈值类型'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '接口资源名', 'type' => 'string', 'example' => 'handleSerivice'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'HalfOpenBaseAmountPerStep' => ['description' => '熔断恢复每步最小通过数目,默认值为5。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'RecoveryTimeoutMs' => ['description' => '熔断时长'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'MinRequestAmount' => ['description' => '触发熔断的最小请求数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Threshold' => ['description' => '降级阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'false'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '数据总数', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"SlowRtMs\\": 2000,\\n \\"HalfOpenRecoveryStepNum\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"StatDurationMs\\": 2000,\\n \\"RuleId\\": 123,\\n \\"Strategy\\": 0,\\n \\"Resource\\": \\"handleSerivice\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"HalfOpenBaseAmountPerStep\\": 5,\\n \\"RecoveryTimeoutMs\\": 5000,\\n \\"MinRequestAmount\\": 10,\\n \\"Threshold\\": 0.6,\\n \\"Enable\\": false\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n \\n 2000\\n 1\\n default\\n 2000\\n 123\\n 0\\n handleSerivice\\n ahas-demo\\n 5\\n 5000\\n 10\\n 0.6\\n false\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取资源对应的降级规则',
'summary' => '调用ListDegradeRulesOfResource接口获取资源对应的降级规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ListFlowRulesOfApp' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'abilityTreeNodes' => ['FEATUREahasSBJFYF'],
],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'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' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RefResource' => ['description' => '关联接口名/入口资源名'."\n", 'type' => 'string', 'example' => 'handleServiceB'],
'ClusterFallbackThreshold' => ['description' => '退化单机阈值,当退化策略为退化到单机(ClusterFallbackStrategy=0)时返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '集群模式下统计窗口时长'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ClusterThresholdType' => ['description' => '阈值模式,0表示单机均摊阈值,1表示集群阈值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'RelationStrategy' => ['description' => '统计维度'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Resource' => ['description' => '接口资源名', 'type' => 'string', 'example' => 'handleServiceA'],
'ClusterEstimatedMaxQps' => ['description' => '集群接口预估最大QPS', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ControlBehavior' => ['description' => '流控效果。0表示快速失败,1表示预热启动,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MaxQueueingTimeMs' => ['description' => '超时时间'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'ClusterFallbackStrategy' => ['description' => '集群流控通信失败退化策略,0表示退化到单机,1表示直接通过', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'WarmUpPeriodSec' => ['description' => '预热时间', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'ClusterMode' => ['description' => '是否为集群模式', 'type' => 'boolean', 'example' => 'false'],
'ThresholdMode' => ['description' => '流控阈值类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Threshold' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'example' => '30'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '数据总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"ClusterFallbackThreshold\\": 0,\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"StatDurationMs\\": 0,\\n \\"ClusterThresholdType\\": 0,\\n \\"RuleId\\": 123,\\n \\"RelationStrategy\\": 0,\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"ClusterEstimatedMaxQps\\": 0,\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 2000,\\n \\"ClusterFallbackStrategy\\": 0,\\n \\"WarmUpPeriodSec\\": 30,\\n \\"ClusterMode\\": false,\\n \\"ThresholdMode\\": 2,\\n \\"Threshold\\": 30,\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n \\n handleServiceB\\n 0\\n default\\n default\\n 0\\n 0\\n 123\\n 0\\n ahas-demo\\n handleServiceA\\n 0\\n 0\\n 2000\\n 0\\n 30\\n false\\n 30\\n true\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取应用流控规则列表',
'summary' => '调用ListFlowRulesOfApp接口获取应用流控规则列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFlowRulesOfApp'],
],
],
],
'ListFlowRulesOfResource' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => '接口资源名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleServiceA'],
],
[
'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' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null '],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94E*****10'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '规则列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RefResource' => ['description' => '关联接口名、入口资源名。'."\n", 'type' => 'string', 'example' => 'handleServiceB'],
'ClusterFallbackThreshold' => ['description' => '退化单机阈值,当退化策略为退化到单机(ClusterFallbackStrategy=0)时返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用。'."\n", 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '集群模式下统计窗口时长。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ClusterThresholdType' => ['description' => '阈值模式,0表示单机均摊阈值,1表示集群阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'RelationStrategy' => ['description' => '统计维度。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Resource' => ['description' => '接口资源名。', 'type' => 'string', 'example' => 'handleServiceA'],
'ClusterEstimatedMaxQps' => ['description' => '集群接口预估最大QPS。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ControlBehavior' => ['description' => '流控效果。0表示快速失败,1表示预热启动,2表示排队等待。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MaxQueueingTimeMs' => ['description' => '超时时间。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'ClusterFallbackStrategy' => ['description' => '集群流控通信失败退化策略,0表示退化到单机,1表示直接通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'WarmUpPeriodSec' => ['description' => '预热时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'ClusterMode' => ['description' => '是否为集群模式。', 'type' => 'boolean', 'example' => 'false'],
'ThresholdMode' => ['description' => '流控阈值类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Threshold' => ['description' => '阈值。', 'type' => 'number', 'format' => 'float', 'example' => '30'],
'Enable' => ['description' => '规则是否开启。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => '返回码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => '参数Resource不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null \\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94E*****10\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"ClusterFallbackThreshold\\": 0,\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"StatDurationMs\\": 0,\\n \\"ClusterThresholdType\\": 0,\\n \\"RuleId\\": 123,\\n \\"RelationStrategy\\": 0,\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"ClusterEstimatedMaxQps\\": 0,\\n \\"ControlBehavior\\": 0,\\n \\"MaxQueueingTimeMs\\": 2000,\\n \\"ClusterFallbackStrategy\\": 0,\\n \\"WarmUpPeriodSec\\": 30,\\n \\"ClusterMode\\": false,\\n \\"ThresholdMode\\": 2,\\n \\"Threshold\\": 30,\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null \\n 3FEEAD12-CE22-4EDE-A729-CE94E*****10\\n \\n 1\\n \\n handleServiceB\\n 0\\n default\\n default\\n 0\\n 0\\n 123\\n 0\\n ahas-demo\\n handleServiceA\\n 0\\n 0\\n 2000\\n 0\\n 30\\n false\\n 2\\n 30\\n true\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取资源对应的流控规则列表',
'summary' => '调用ListFlowRulesOfResource接口获取资源对应的流控规则列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ListHotParamRulesOfApp' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'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' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '热点规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ParamIdx' => ['description' => '参数索引', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'ParamFlowItemList' => [
'description' => '热点参数例外项'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '例外项参数值'."\n", 'type' => 'string', 'example' => 'apple'],
'ItemType' => ['description' => '例外项类型'."\n", 'type' => 'string', 'example' => 'String'],
'Threshold' => ['description' => '例外项阈值'."\n", 'type' => 'number', 'format' => 'float', 'example' => '20'],
],
'description' => '',
],
],
'StatDurationSec' => ['description' => '统计周期时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BurstCount' => ['description' => '缓冲请求数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Resource' => ['description' => '接口资源名', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3000'],
'ControlBehavior' => ['description' => '流控效果,0表示快速失败,2表示排队等待。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MetricType' => ['description' => '统计维度,0表示并发数,1表示通过请求数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Threshold' => ['description' => '单机阈值', 'type' => 'number', 'format' => 'float', 'example' => '20'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '数据总量', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => ' 返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"ParamIdx\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"ParamFlowItemList\\": [\\n {\\n \\"ItemValue\\": \\"apple\\",\\n \\"ItemType\\": \\"String\\",\\n \\"Threshold\\": 20\\n }\\n ],\\n \\"StatDurationSec\\": 1,\\n \\"BurstCount\\": 2,\\n \\"RuleId\\": 123,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"MaxQueueingTimeMs\\": 3000,\\n \\"ControlBehavior\\": 0,\\n \\"MetricType\\": 0,\\n \\"Threshold\\": 20,\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n \\n 1\\n default\\n \\n apple\\n String\\n 20\\n \\n 1\\n 2\\n 123\\n handleService\\n ahas-demo\\n 3000\\n 0\\n 0\\n 20\\n true\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取应用热点规则',
'summary' => '调用ListHotParamRulesOfApp接口获取应用热点规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotParamRulesOfApp'],
],
],
],
'ListHotParamRulesOfResource' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => '资源名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleService'],
],
[
'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' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '热点规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ParamIdx' => ['description' => '热点参数索引', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'ParamFlowItemList' => [
'description' => '热点参数例外项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '例外项参数值'."\n", 'type' => 'string', 'example' => 'apple'],
'ItemType' => ['description' => '例外项类型'."\n", 'type' => 'string', 'example' => 'String'],
'Threshold' => ['description' => '例外项阈值'."\n", 'type' => 'number', 'format' => 'float', 'example' => '10'],
],
'description' => '',
],
],
'StatDurationSec' => ['description' => '统计周期时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BurstCount' => ['description' => '缓冲请求数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3000'],
'ControlBehavior' => ['description' => '流控效果,0表示快速失败,2表示排队等待。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MetricType' => ['description' => '统计维度,0表示并发数,1表示通过请求数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Threshold' => ['description' => '例外项阈值'."\n", 'type' => 'number', 'format' => 'float', 'example' => '10'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数据量', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"ParamIdx\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"ParamFlowItemList\\": [\\n {\\n \\"ItemValue\\": \\"apple\\",\\n \\"ItemType\\": \\"String\\",\\n \\"Threshold\\": 10\\n }\\n ],\\n \\"StatDurationSec\\": 1,\\n \\"BurstCount\\": 2,\\n \\"RuleId\\": 123,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"MaxQueueingTimeMs\\": 3000,\\n \\"ControlBehavior\\": 0,\\n \\"MetricType\\": 0,\\n \\"Threshold\\": 10,\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n \\n 1\\n default\\n \\n apple\\n String\\n 10\\n \\n 1\\n 2\\n 123\\n handleService\\n ahas-demo\\n 3000\\n 0\\n 0\\n 10\\n true\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取资源对应的热点规则',
'summary' => '调用ListHotParamRulesOfResource接口获取资源对应的热点规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ListIsolationRulesOfApp' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '0'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '10', 'isFileTransferUrl' => false, 'default' => '0'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '隔离规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RelationStrategy' => ['description' => '统计维度'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '接口资源名', 'type' => 'string', 'example' => 'handleServiceA'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'RefResource' => ['description' => '关联接口名、callstack入口名'."\n", 'type' => 'string', 'example' => 'hanldeServiceB'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用'."\n", 'type' => 'string', 'example' => 'default'],
'Threshold' => ['description' => '并发数阈值', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数据量', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"RelationStrategy\\": 0,\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"RefResource\\": \\"hanldeServiceB\\",\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"Threshold\\": 10,\\n \\"RuleId\\": 123,\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n \\n 0\\n handleServiceA\\n ahas-demo\\n hanldeServiceB\\n default\\n default\\n 10\\n 123\\n true\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取应用隔离规则',
'summary' => '调用ListIsolationRulesOfApp接口获取应用隔离规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ListIsolationRulesOfResource' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => '资源名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'handleServiceA'],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'isFileTransferUrl' => false, 'default' => '0'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '10', 'isFileTransferUrl' => false, 'default' => '0'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '隔离规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RelationStrategy' => ['description' => '统计维度'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleServiceA'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'RefResource' => ['description' => '关联接口名、callstack入口名'."\n", 'type' => 'string', 'example' => 'handleServiceB'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用', 'type' => 'string', 'example' => 'default'],
'Threshold' => ['description' => '并发数阈值', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数据量', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => '参数Resource不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"RelationStrategy\\": 0,\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"Threshold\\": 10,\\n \\"RuleId\\": 123,\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n \\n 0\\n handleServiceA\\n ahas-demo\\n handleServiceB\\n default\\n default\\n 10\\n 123\\n true\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取资源对应的隔离规则',
'summary' => '调用ListIsolationRulesOfResource接口获取资源对应的隔离规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIsolationRulesOfResource'],
],
],
],
'ListSystemRules' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ahas-demo'],
],
[
'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' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'PageIndex' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Datas' => [
'description' => '系统规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'MetricType' => ['description' => '统计维度'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'Threshold' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'Enable' => ['description' => '是否开启', 'type' => 'boolean', 'example' => 'true'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
'description' => '',
],
],
'TotalPage' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PageSize' => ['description' => '每页数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数据量', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"Datas\\": [\\n {\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Namespace\\": \\"default\\",\\n \\"MetricType\\": 4,\\n \\"Threshold\\": 0.6,\\n \\"Enable\\": true,\\n \\"RuleId\\": 123\\n }\\n ],\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n \\n ahas-demo\\n default\\n 4\\n 0.6\\n true\\n 123\\n \\n 3\\n 10\\n 23\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '获取系统规则',
'summary' => '调用ListSystemRules接口获取系统规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ModifyDegradeRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Strategy',
'in' => 'query',
'schema' => ['description' => '阈值类型,即降级的策略,取值为0时表示按慢调用比例降级,取值为1时表示按异常比例降级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '阈值类型所对应的降级阈值,超过该值时会触发接口的降级。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '降级规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'RecoveryTimeoutMs',
'in' => 'query',
'schema' => ['description' => '熔断时长。在该时间段内,该接口的请求都会快速失败,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'StatDurationMs',
'in' => 'query',
'schema' => ['description' => '统计窗口时长,单位MS。默认值为1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'SlowRtMs',
'in' => 'query',
'schema' => ['description' => '慢调用RT。请求的响应时间超过该值时统计为慢调用。阈值类型为“慢调用比例”时需设置该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000'],
],
[
'name' => 'MinRequestAmount',
'in' => 'query',
'schema' => ['description' => '触发熔断的最小请求数目,若当前统计窗口请求数小于此值,即使达到熔断条件规则也不会触发。默认值为5。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'HalfOpenBaseAmountPerStep',
'in' => 'query',
'schema' => ['description' => '熔断恢复每步最小通过数目,默认值为5。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'HalfOpenRecoveryStepNum',
'in' => 'query',
'schema' => ['description' => '熔断恢复阶段数,默认值为1。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'SlowRtMs' => ['description' => '慢调用RT'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
'HalfOpenRecoveryStepNum' => ['description' => '熔断恢复阶段数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '统计窗口时长', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Strategy' => ['description' => '阈值类型'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'HalfOpenBaseAmountPerStep' => ['description' => '熔断恢复每步最小通过数目,默认值为5。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RecoveryTimeoutMs' => ['description' => '熔断时长'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'MinRequestAmount' => ['description' => '触发熔断的最小请求数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Threshold' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'Enable' => ['description' => '是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.HalfOpenBaseAmountPerStep', 'errorMessage' => 'The specified HalfOpenBaseAmountPerStep is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.HalfOpenRecoveryStepNum', 'errorMessage' => 'The specified HalfOpenRecoveryStepNum is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.MinRequestAmount', 'errorMessage' => 'The specified MinRequestAmount is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.RecoveryTimeoutMs', 'errorMessage' => 'The specified RecoveryTimeoutMs is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.SlowRtMS', 'errorMessage' => 'The specified SlowRtMs is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Strategy', 'errorMessage' => 'The specified Strategy is invalid.', 'description' => ''],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"SlowRtMs\\": 5000,\\n \\"HalfOpenRecoveryStepNum\\": 2,\\n \\"Namespace\\": \\"default\\",\\n \\"StatDurationMs\\": 2000,\\n \\"RuleId\\": 123,\\n \\"Strategy\\": 0,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"HalfOpenBaseAmountPerStep\\": 3,\\n \\"RecoveryTimeoutMs\\": 2000,\\n \\"MinRequestAmount\\": 10,\\n \\"Threshold\\": 0.5,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 5000\\n 2\\n default\\n 2000\\n 123\\n 0\\n handleService\\n ahas-demo\\n 3\\n 2000\\n 10\\n 0.5\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '修改降级规则',
'summary' => '调用ModifyDegradeRule接口修改降级规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ModifyFlowRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'default'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'RelationStrategy',
'in' => 'query',
'schema' => ['description' => '统计维度。0表示当前接口,1表示关联接口,2表示链路入口。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '流控阈值。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '50'],
],
[
'name' => 'LimitOrigin',
'in' => 'query',
'schema' => ['description' => '来源应用。', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
'name' => 'RefResource',
'in' => 'query',
'schema' => ['description' => '关联接口名、入口资源名。当统计维度relationStrategy值为1(关联接口)或2(链路入口)时,需要设置该字段。', 'type' => 'string', 'required' => false, 'example' => 'handleServiceB'],
],
[
'name' => 'ControlBehavior',
'in' => 'query',
'schema' => ['description' => '流控效果。0表示快速失败,1表示预热启动,2表示排队等待。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'WarmUpPeriodSec',
'in' => 'query',
'schema' => ['description' => '预热时间。当controlBehavior值为1(预热启动)时,需要设置该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'MaxQueueingTimeMs',
'in' => 'query',
'schema' => ['description' => '超时时间。当controlBehavior值为2(排队等待)时,需要设置该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ThresholdMode',
'in' => 'query',
'schema' => ['description' => '流控阈值模式。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94E*****10'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RefResource' => ['description' => '关联接口名、入口资源名。', 'type' => 'string', 'example' => 'handleServiceB'],
'ClusterFallbackThreshold' => ['description' => '退化单机阈值,当退化策略为退化到单机(ClusterFallbackStrategy=0)时返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用。', 'type' => 'string', 'example' => 'default'],
'StatDurationMs' => ['description' => '集群模式下统计窗口时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ClusterThresholdType' => ['description' => '阈值模式,0表示单机均摊阈值,1表示集群阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'RelationStrategy' => ['description' => '统计维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'Resource' => ['description' => '接口资源名。', 'type' => 'string', 'example' => 'handleServiceA'],
'MaxQueueingTimeMs' => ['description' => '超时时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'ClusterEstimatedMaxQps' => ['description' => '集群接口预估最大QPS。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ControlBehavior' => ['description' => '流控效果。0表示快速失败,1表示预热启动,2表示排队等待。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'WarmUpPeriodSec' => ['description' => '预热时间。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'ClusterFallbackStrategy' => ['description' => '集群流控通信失败退化策略,0表示退化到单机,1表示直接通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Threshold' => ['description' => '流控阈值。', 'type' => 'number', 'format' => 'float', 'example' => '50'],
'ThresholdMode' => ['description' => '流控阈值模式。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'ClusterMode' => ['description' => '是否为集群模式。', 'type' => 'boolean', 'example' => 'false'],
'Enable' => ['description' => '规则是否开启。', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.AppName', 'errorMessage' => 'The specified AppName is invalid.', 'description' => '参数AppName不合法'],
['errorCode' => 'IllegalArgument.ControlBehavior', 'errorMessage' => 'The specified ControlBehavior is invalid.', 'description' => '参数ControlBehavior不合法'],
['errorCode' => 'IllegalArgument.Namespace', 'errorMessage' => 'The specified Namespace is invalid.', 'description' => '参数Namespace不合法'],
['errorCode' => 'IllegalArgument.RefResource', 'errorMessage' => 'The specified RefResource is invalid.', 'description' => '参数RefResource不合法'],
['errorCode' => 'IllegalArgument.RelationStrategy', 'errorMessage' => 'The specified RelationStrategy is invalid.', 'description' => '参数RelationStrategy不合法'],
['errorCode' => 'IllegalArgument.Resource', 'errorMessage' => 'The specified Resource is invalid.', 'description' => '参数Resource不合法'],
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => '参数Threshold不合法'],
['errorCode' => 'IllegalArgument.WarmUpPeriodSec', 'errorMessage' => 'The specified WarmUpPeriodSec is invalid.', 'description' => '参数WarmUpPeriodSec不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94E*****10\\",\\n \\"Data\\": {\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"ClusterFallbackThreshold\\": 0,\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"StatDurationMs\\": 0,\\n \\"ClusterThresholdType\\": 0,\\n \\"RuleId\\": 123,\\n \\"RelationStrategy\\": 0,\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"MaxQueueingTimeMs\\": 2000,\\n \\"ClusterEstimatedMaxQps\\": 0,\\n \\"ControlBehavior\\": 0,\\n \\"WarmUpPeriodSec\\": 30,\\n \\"ClusterFallbackStrategy\\": 0,\\n \\"Threshold\\": 50,\\n \\"ThresholdMode\\": 2,\\n \\"ClusterMode\\": false,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94E*****10\\n \\n handleServiceB\\n 0\\n default\\n default\\n 0\\n 0\\n 123\\n 0\\n ahas-demo\\n handleServiceA\\n 2000\\n 0\\n 0\\n 30\\n 0\\n 50\\n 2\\n false\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '修改流控规则',
'summary' => '调用ModifyFlowRule接口修改流控规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyFlowRule'],
],
],
],
'ModifyHotParamRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'MetricType',
'in' => 'query',
'schema' => ['description' => '统计维度,0表示并发数,1表示通过请求数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '热点规则中针对每个热点参数的阈值,取值范围为≥0的整数。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20'],
],
[
'name' => 'Enable',
'in' => 'query',
'schema' => ['description' => '规则是否开启。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'ParamIdx',
'in' => 'query',
'schema' => ['description' => '参数位置索引,埋点传入参数的索引位置。对应`SphU.entry(xxx,args)`中的参数索引位置。'."\n"
."\n"
.'例如:`SphU.entry(resourceName,Entry Type.IN,1,paramA,paramB)`埋点中,`paramA`的参数索引是0,`paramB`的参数索引是1。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'StatDurationSec',
'in' => 'query',
'schema' => ['description' => '统计周期时间,单位秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'ControlBehavior',
'in' => 'query',
'schema' => ['description' => '流控效果,0表示快速失败,2表示排队等待。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'BurstCount',
'in' => 'query',
'schema' => ['description' => '缓冲请求数,流控效果为快速失败时需要设置。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'MaxQueueingTimeMs',
'in' => 'query',
'schema' => ['description' => '超时时间,单位秒。流控效果为排队等待时需要设置。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'ParamIdx' => ['description' => '热点参数索引。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'default'],
'ParamFlowItemList' => [
'description' => '热点参数例外项。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '例外项参数值。', 'type' => 'string', 'example' => 'apple'],
'ItemType' => ['description' => '例外项类型。', 'type' => 'string', 'example' => 'String'],
'Threshold' => ['description' => '例外项阈值。'."\n", 'type' => 'number', 'format' => 'float', 'example' => '20'],
],
'description' => '',
],
],
'StatDurationSec' => ['description' => '统计周期时间,单位秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BurstCount' => ['description' => '缓冲请求数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RuleId' => ['description' => '热点规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Resource' => ['description' => '资源名。', 'type' => 'string', 'example' => 'handleService'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID,可在EDAS控制台“应用管理>基本信息”中查看对应的ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'MaxQueueingTimeMs' => ['description' => '流控效果为排队等待时对应的超时时间,单位毫秒。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3000'],
'ControlBehavior' => ['description' => '流控效果,0表示快速失败,2表示排队等待。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MetricType' => ['description' => '统计维度,0表示并发数,1表示通过请求数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Threshold' => ['description' => '单机阈值。', 'type' => 'number', 'format' => 'float', 'example' => '20'],
'Enable' => ['description' => '规则是否开启。', 'type' => 'boolean', 'example' => 'false'],
],
],
'Code' => ['description' => '返回码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
['errorCode' => 'IllegalArgument.MetricType', 'errorMessage' => 'The specified MetricType is invalid.', 'description' => '参数MetricType不合法'],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => '参数Threshold不合法'],
['errorCode' => 'IllegalArgument.ParamIdx', 'errorMessage' => 'The specified ParamIdx is invalid.', 'description' => '参数ParamIdx不合法'],
['errorCode' => 'IllegalArgument.ControlBehavior', 'errorMessage' => 'The specified ControlBehavior is invalid.', 'description' => '参数ControlBehavior不合法'],
['errorCode' => 'IllegalArgument.MaxQueueingTimeM', 'errorMessage' => 'The specified MaxQueueingTimeMs is invalid.', 'description' => '参数MaxQueueingTimeMs不合法'],
['errorCode' => 'IllegalArgument.BurstCount', 'errorMessage' => 'The specified BurstCount is invalid.', 'description' => '参数BurstCount不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"ParamIdx\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"ParamFlowItemList\\": [\\n {\\n \\"ItemValue\\": \\"apple\\",\\n \\"ItemType\\": \\"String\\",\\n \\"Threshold\\": 20\\n }\\n ],\\n \\"StatDurationSec\\": 1,\\n \\"BurstCount\\": 2,\\n \\"RuleId\\": 123,\\n \\"Resource\\": \\"handleService\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"MaxQueueingTimeMs\\": 3000,\\n \\"ControlBehavior\\": 0,\\n \\"MetricType\\": 1,\\n \\"Threshold\\": 20,\\n \\"Enable\\": false\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 1\\n default\\n \\n apple\\n String\\n 20\\n \\n 1\\n 2\\n 123\\n handleService\\n ahas-demo\\n 3000\\n 0\\n 1\\n 20\\n false\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '修改热点规则',
'summary' => '调用ModifyHotParamRule接口修改热点规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ModifyIsolationRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '隔离规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'RelationStrategy',
'in' => 'query',
'schema' => ['description' => '统计维度,0表示当前接口,1表示关联接口,2表示链路入口。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '并发数阈值。'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'LimitOrigin',
'in' => 'query',
'schema' => ['description' => '来源应用。', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
'name' => 'RefResource',
'in' => 'query',
'schema' => ['description' => '关联接口名、callstack入口名,当统计维度为关联接口或链路入口时需设置该值。'."\n", 'type' => 'string', 'required' => false, 'example' => 'handleServiceB'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'RelationStrategy' => ['description' => '统计维度'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Resource' => ['description' => '资源名', 'type' => 'string', 'example' => 'handleServiceA'],
'AppName' => ['description' => '应用名,若为EDAS应用,则AppName为EDAS中的App ID。', 'type' => 'string', 'example' => 'ahas-demo'],
'RefResource' => ['description' => '关联接口名、callstack入口名'."\n", 'type' => 'string', 'example' => 'handleServiceB'],
'Namespace' => ['description' => '命名空间'."\n", 'type' => 'string', 'example' => 'default'],
'LimitOrigin' => ['description' => '来源应用'."\n", 'type' => 'string', 'example' => 'default'],
'Threshold' => ['description' => '并发数阈值', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'RuleId' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '规则是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
['errorCode' => 'IllegalArgument.RelationStrategy', 'errorMessage' => 'The specified RelationStrategy is invalid.', 'description' => '参数RelationStrategy不合法'],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => '参数Threshold不合法'],
['errorCode' => 'IllegalArgument.RefResource', 'errorMessage' => 'The specified RefResource is invalid.', 'description' => '参数RefResource不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"RelationStrategy\\": 0,\\n \\"Resource\\": \\"handleServiceA\\",\\n \\"AppName\\": \\"ahas-demo\\",\\n \\"RefResource\\": \\"handleServiceB\\",\\n \\"Namespace\\": \\"default\\",\\n \\"LimitOrigin\\": \\"default\\",\\n \\"Threshold\\": 10,\\n \\"RuleId\\": 123,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 0\\n handleServiceA\\n ahas-demo\\n handleServiceB\\n default\\n default\\n 10\\n 123\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '修改隔离规则',
'summary' => '调用ModifyIsolationRule接口修改隔离规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ModifySystemRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => 'CPU阈值,取值范围0~1。', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '0.5'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '系统规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'AhasRegionId',
'in' => 'query',
'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'MetricType' => ['description' => '统计维度'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'Threshold' => ['description' => '阈值', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'RuleId' => ['description' => '系统规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Enable' => ['description' => '是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
'Code' => ['description' => '返回码', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalArgument.RuleId', 'errorMessage' => 'The specified RuleId is invalid.', 'description' => '参数RuleId不合法'],
['errorCode' => 'IllegalArgument.Threshold', 'errorMessage' => 'The specified Threshold is invalid.', 'description' => '参数Threshold不合法'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"Data\\": {\\n \\"MetricType\\": 4,\\n \\"Threshold\\": 0.5,\\n \\"RuleId\\": 123,\\n \\"Enable\\": true\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 3FEEAD12-CE22-4EDE-A729-CE94EC070610\\n \\n 4\\n 0.5\\n 123\\n true\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '修改系统规则',
'summary' => '调用ModifySystemRule接口修改系统规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'OpenAhasService' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FEEAD12-CE22-4EDE-A729-CE94EC070610'],
'OrderId' => ['description' => '服务开通订单号。', 'type' => 'string', 'example' => '212307989980192'],
],
'description' => '',
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3FEEAD12-CE22-4EDE-A729-CE94EC070610\\",\\n \\"OrderId\\": \\"212307989980192\\"\\n}","type":"json"}]',
'title' => '开通AHAS服务',
'summary' => '开通AHAS服务。',
'changeSet' => [],
],
],
'endpoints' => [
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ahas.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ahas.ap-southeast-1.aliyuncs.com', 'vpc' => 'ahas-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ahas.cn-beijing.aliyuncs.com', 'endpoint' => 'ahas.cn-beijing.aliyuncs.com', 'vpc' => 'ahas-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ahas.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ahas.cn-hangzhou.aliyuncs.com', 'vpc' => 'ahas-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ahas.cn-hongkong.aliyuncs.com', 'endpoint' => 'ahas.cn-hongkong.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ahas.cn-shanghai.aliyuncs.com', 'endpoint' => 'ahas.cn-shanghai.aliyuncs.com', 'vpc' => 'ahas-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ahas.cn-shenzhen.aliyuncs.com', 'endpoint' => 'ahas.cn-shenzhen.aliyuncs.com', 'vpc' => 'ahas-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ahas.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'ahas.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'ahas-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'ahas.eu-central-1.aliyuncs.com', 'endpoint' => 'ahas.eu-central-1.aliyuncs.com', 'vpc' => 'ahas-vpc.eu-central-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'CreateRule.Failed', 'message' => 'Failed to create the rule.', 'http_code' => 403, 'description' => '创建规则失败'],
['code' => 'DeleteRule.Failed', 'message' => 'Failed to delete the rule.', 'http_code' => 403, 'description' => '删除规则失败'],
['code' => 'DisableRule.Failed', 'message' => 'Failed to disable the rule.', 'http_code' => 403, 'description' => '关闭规则失败'],
['code' => 'EnableRule.Failed', 'message' => 'Failed to enable the rule.', 'http_code' => 403, 'description' => '开启规则失败'],
['code' => 'IllegalArgument.AppName', 'message' => 'The specified AppName is invalid.', 'http_code' => 400, 'description' => '参数AppName不合法'],
['code' => 'IllegalArgument.BurstCount', 'message' => 'The specified BurstCount is invalid.', 'http_code' => 400, 'description' => '参数BurstCount不合法'],
['code' => 'IllegalArgument.ClusterFallbackThreshold', 'message' => 'The specified ClusterFallbackThreshold is invalid.', 'http_code' => 400, 'description' => '参数ClusterFallbackThreshold不合法'],
['code' => 'IllegalArgument.ClusterThresholdType', 'message' => 'The specified ClusterThresholdType is invalid.', 'http_code' => 400, 'description' => '参数ClusterThresholdType不合法'],
['code' => 'IllegalArgument.ControlBehavior', 'message' => 'The specified ControlBehavior is invalid.', 'http_code' => 400, 'description' => '参数ControlBehavior不合法'],
['code' => 'IllegalArgument.Count', 'message' => 'The specified Count is invalid.', 'http_code' => 400, 'description' => '参数Count不合法'],
['code' => 'IllegalArgument.Count.ExceedMaxClusterQps', 'message' => 'The specified Count exceeds the cluster maximum QPS.', 'http_code' => 400, 'description' => '参数Count超出集群Qps最大值'],
['code' => 'IllegalArgument.DurationInSec', 'message' => 'The specified DurationInSec is invalid.', 'http_code' => 400, 'description' => '参数DurationInSec不合法'],
['code' => 'IllegalArgument.HalfOpenBaseAmountPerStep', 'message' => 'The specified HalfOpenBaseAmountPerStep is invalid.', 'http_code' => 400, 'description' => '参数HalfOpenBaseAmountPerStep不合法'],
['code' => 'IllegalArgument.HalfOpenRecoveryStepNum', 'message' => 'The specified HalfOpenRecoveryStepNum is invalid.', 'http_code' => 400, 'description' => '参数HalfOpenRecoveryStepNum不合法'],
['code' => 'IllegalArgument.MaxQueueingTimeM', 'message' => 'The specified MaxQueueingTimeMs is invalid.', 'http_code' => 400, 'description' => '参数MaxQueueingTimeMs不合法'],
['code' => 'IllegalArgument.MetricType', 'message' => 'The specified MetricType is invalid.', 'http_code' => 400, 'description' => '参数MetricType不合法'],
['code' => 'IllegalArgument.MinRequestAmount', 'message' => 'The specified MinRequestAmount is invalid.', 'http_code' => 400, 'description' => '参数MinRequestAmount不合法'],
['code' => 'IllegalArgument.Namespace', 'message' => 'The specified Namespace is invalid.', 'http_code' => 400, 'description' => '参数Namespace不合法'],
['code' => 'IllegalArgument.ParamIdx', 'message' => 'The specified ParamIdx is invalid.', 'http_code' => 400, 'description' => '参数ParamIdx不合法'],
['code' => 'IllegalArgument.ParamItems', 'message' => 'The specified Items is invalid.', 'http_code' => 400, 'description' => '参数Items不合法'],
['code' => 'IllegalArgument.RecoveryTimeoutMs', 'message' => 'The specified RecoveryTimeoutMs is invalid.', 'http_code' => 400, 'description' => '参数RecoveryTimeoutMs不合法'],
['code' => 'IllegalArgument.RefResource', 'message' => 'The specified RefResource is invalid.', 'http_code' => 400, 'description' => '参数RefResource不合法'],
['code' => 'IllegalArgument.RelationStrategy', 'message' => 'The specified RelationStrategy is invalid.', 'http_code' => 400, 'description' => '参数RelationStrategy不合法'],
['code' => 'IllegalArgument.Resource', 'message' => 'The specified Resource is invalid.', 'http_code' => 400, 'description' => '参数Resource不合法'],
['code' => 'IllegalArgument.RuleId', 'message' => 'The specified RuleId is invalid.', 'http_code' => 400, 'description' => '参数RuleId不合法'],
['code' => 'IllegalArgument.SampleCount', 'message' => 'The specified SampleCount is invalid.', 'http_code' => 400, 'description' => '参数SampleCount不合法'],
['code' => 'IllegalArgument.SampleCount.DivideError', 'message' => 'The specified SampleCount is invalid.', 'http_code' => 400, 'description' => '参数SampleCount不合法'],
['code' => 'IllegalArgument.SlowRtMS', 'message' => 'The specified SlowRtMs is invalid.', 'http_code' => 400, 'description' => '参数SlowRtMs不合法'],
['code' => 'IllegalArgument.StatDurationMs', 'message' => 'The specified StatDurationMs is invalid.', 'http_code' => 400, 'description' => '参数StatDurationMs不合法'],
['code' => 'IllegalArgument.Strategy', 'message' => 'The specified Strategy is invalid.', 'http_code' => 400, 'description' => '参数Strategy不合法'],
['code' => 'IllegalArgument.Threshold', 'message' => 'The specified Threshold is invalid.', 'http_code' => 400, 'description' => '参数Threshold不合法'],
['code' => 'IllegalArgument.UserId', 'message' => 'The specified UserId is invalid.', 'http_code' => 400, 'description' => '参数UserId不合法'],
['code' => 'IllegalArgument.WarmUpPeriodSec', 'message' => 'The specified WarmUpPeriodSec is invalid.', 'http_code' => 400, 'description' => '参数WarmUpPeriodSec不合法'],
['code' => 'IllegalArgument.WindowIntervalMs', 'message' => 'The specified WindowIntervalMs is invalid.', 'http_code' => 400, 'description' => '参数WindowIntervalMs不合法'],
['code' => 'Insufficient.ClusterQuota', 'message' => 'The cluster QPS quota is insufficient.', 'http_code' => 400, 'description' => '集群剩余qps quota不足'],
['code' => 'InvalidApp.NotFound', 'message' => 'The specified App does not exist.', 'http_code' => 404, 'description' => '指定的App不存在'],
['code' => 'InvalidCluster.NotFound', 'message' => 'The specified cluster does not exist.', 'http_code' => 404, 'description' => '找不到对应集群'],
['code' => 'InvalidRule.NotFound', 'message' => 'The specified RuleId does not exist.', 'http_code' => 404, 'description' => '指定的RuleId不存在'],
['code' => 'InvalidRule.UserNotMatch', 'message' => 'The speicified rule and user do not match.', 'http_code' => 400, 'description' => '规则和用户不匹配'],
['code' => 'PublishRule.Failed', 'message' => 'Failed to publish the rule.', 'http_code' => 403, 'description' => '规则推送失败'],
['code' => 'RedirectToCommonBuy', 'message' => 'AHAS service is not activated.', 'http_code' => 200, 'description' => 'AHAS 服务未开通,请先到产品页开通产品'],
['code' => 'RuleLimit.Exceed', 'message' => 'The maximum number of rules is exceeded.', 'http_code' => 400, 'description' => '规则数超过最大限制'],
['code' => 'system.error', 'message' => 'An internal server error occurred.', 'http_code' => 200, 'description' => '服务端内部异常,请重试或联系产品人员'],
['code' => 'SystemRule.Duplicated', 'message' => 'The system rule is duplicated.', 'http_code' => 400, 'description' => '系统规则重复'],
['code' => 'UpdateRule.Failed', 'message' => 'Failed to update the rule.', 'http_code' => 403, 'description' => '更新规则失败'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHotParamItems'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableIsolationRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSystemRules'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotParamRulesOfResource'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHotParamRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDegradeRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDegradeRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDegradeRule'],
['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMetricsOfApp'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDegradeRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSystemRule'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListActiveApps'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDegradeRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHotParamRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSystemRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDegradeRulesOfResource'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFlowRulesOfResource'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIsolationRule'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDegradeRulesOfApp'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHotParamRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyFlowRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSystemRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIsolationRulesOfApp'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySystemRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFlowRulesOfApp'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFlowRule'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableFlowRule'],
['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSentinelAppSumMetric'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIsolationRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableIsolationRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableFlowRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSystemRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHotParamRule'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMetricsOfResource'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotParamRulesOfApp'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIsolationRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHotParamRule'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetLicenseKey'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFlowRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIsolationRulesOfResource'],
],
],
];