diff options
Diffstat (limited to 'data/zh_cn/ddosdiversion/2023-07-01')
| -rw-r--r-- | data/zh_cn/ddosdiversion/2023-07-01/api-docs.php | 1278 |
1 files changed, 1278 insertions, 0 deletions
diff --git a/data/zh_cn/ddosdiversion/2023-07-01/api-docs.php b/data/zh_cn/ddosdiversion/2023-07-01/api-docs.php new file mode 100644 index 0000000..1e2d2e6 --- /dev/null +++ b/data/zh_cn/ddosdiversion/2023-07-01/api-docs.php @@ -0,0 +1,1278 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'DdosDiversion', + 'version' => '2023-07-01', + ], + 'directories' => [ + 'ConfigNetStatus', + 'ListInstance', + 'QueryNetList', + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ConfigNetStatus' => [ + 'summary' => '进行网段宣告配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '186873', + 'abilityTreeNodes' => [ + 'FEATUREddosPJT0YW', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '代播API 涉及IP网段的路由配置，支持宣告/撤销等操作，需要客户真实网段操作，无法进行自动化调度与验证。', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SaleId', + 'in' => 'query', + 'schema' => [ + 'description' => '代播实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'Net', + 'in' => 'query', + 'schema' => [ + 'description' => '代播实例的网段。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.XX.XX/22', + 'enum' => [], + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- enable：宣告。'."\n" + .'- disable：撤销。', + 'type' => 'string', + 'required' => true, + 'example' => 'enable', + 'enum' => [ + 'enable', + 'disable', + ], + ], + ], + [ + 'name' => 'Regions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '网段需要宣告/撤销的区域列表，当列表为空时，表示操作所有网段配置的区域。'."\n" + ."\n" + .'> 您可以调用[QueryNetList](~~2639086~~)获取网段配置的区域信息。', + 'type' => 'array', + 'items' => [ + 'description' => '网段需要宣告或者撤销的区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'oe26', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SubNets', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '代播实例网段的子网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '代播实例网段的子网段。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX/24', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AuthenticationFailed', + 'errorMessage' => 'User authentication failed.', + ], + [ + 'errorCode' => 'AutoScheduleRuleExist', + 'errorMessage' => 'The auto schedule rule already exists.', + ], + [ + 'errorCode' => 'AutoScheduleRuleNotExist', + 'errorMessage' => 'The auto schedule rule dose not exist.', + ], + [ + 'errorCode' => 'BlackHoleConfigurationError', + 'errorMessage' => 'A black hole configuration error occurred.', + ], + [ + 'errorCode' => 'CleanConfigurationError', + 'errorMessage' => 'A clean configuration error occurred.', + ], + [ + 'errorCode' => 'CoveredNet', + 'errorMessage' => 'The CIDR block is overwritten.', + ], + [ + 'errorCode' => 'DatabaseError', + 'errorMessage' => 'A database error.', + ], + [ + 'errorCode' => 'DeclaredNet', + 'errorMessage' => 'The CIDR block has been advertised.', + ], + [ + 'errorCode' => 'DefenseConfigurationError', + 'errorMessage' => 'A defense configuration error occurred.', + ], + [ + 'errorCode' => 'ForwardConfigurationNotExist', + 'errorMessage' => 'The CIDR block forwarding configuration is not found.', + ], + [ + 'errorCode' => 'ForwardNotExist', + 'errorMessage' => 'The CIDR block zone forwarding configuration is not found.', + ], + [ + 'errorCode' => 'ForwardRuleNotExist', + 'errorMessage' => 'The CIDR block forwarding rule is not found.', + ], + [ + 'errorCode' => 'HttpFailed', + 'errorMessage' => 'HTTP request failed.', + ], + [ + 'errorCode' => 'IDNSubnetsCountLimit', + 'errorMessage' => 'The maximum number of IDCs of the instance is exceeded.', + ], + [ + 'errorCode' => 'InstanceExist', + 'errorMessage' => 'The instance already exists.', + ], + [ + 'errorCode' => 'InstanceNetConfigurationExist', + 'errorMessage' => 'The instance CIDR block configuration already exists.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance is not found.', + ], + [ + 'errorCode' => 'InstanceUpstreamLimit', + 'errorMessage' => 'The maximum number of reinjection configurations for the instance is exceeded.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + [ + 'errorCode' => 'InvalidNet', + 'errorMessage' => 'Invalid CIDR block.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Invalid parameter value.', + ], + [ + 'errorCode' => 'IPSubnetsCountLimit', + 'errorMessage' => 'The maximum number of CIDR blocks of the instance is exceeded.', + ], + [ + 'errorCode' => 'NetCannotExtend', + 'errorMessage' => 'The CIDR block cannot be extended.', + ], + [ + 'errorCode' => 'NetConfigurationExist', + 'errorMessage' => 'The CIDR block configuration already exists.', + ], + [ + 'errorCode' => 'NetConfigurationNotExist', + 'errorMessage' => 'The CIDR block configuration is not found.', + ], + [ + 'errorCode' => 'NetForwardDelete', + 'errorMessage' => 'The CIDR block forwarding is being deleted.', + ], + [ + 'errorCode' => 'NetMaskOutOfRange', + 'errorMessage' => 'The subnet mask of the CIDR block is invalid.', + ], + [ + 'errorCode' => 'NetNeedExtend', + 'errorMessage' => 'The CIDR block needs to be extended.', + ], + [ + 'errorCode' => 'NetStatusNotReady', + 'errorMessage' => 'The CIDR block reinjection configuration has not been completed.', + ], + [ + 'errorCode' => 'NetworkDeclearedFailed', + 'errorMessage' => 'Failed to advertise the CIDR block.', + ], + [ + 'errorCode' => 'NetWorkNotExist', + 'errorMessage' => 'The CIDR block is not found.', + ], + [ + 'errorCode' => 'NetworkUndeclearedFailed', + 'errorMessage' => 'Failed to cancel the advertisement of the CIDR block.', + ], + [ + 'errorCode' => 'ParameterNotEnough', + 'errorMessage' => 'Required parameters are not specified.', + ], + [ + 'errorCode' => 'ParameterOutOfRange', + 'errorMessage' => 'Invalid parameter value.', + ], + [ + 'errorCode' => 'RegionNotExist', + 'errorMessage' => 'The region does not exist.', + ], + [ + 'errorCode' => 'RequestMethodError', + 'errorMessage' => 'An incorrect request method.', + ], + [ + 'errorCode' => 'SubnetCountLimit', + 'errorMessage' => 'The maximum number of subnets is exceeded.', + ], + [ + 'errorCode' => 'UnKnownError', + 'errorMessage' => 'An unknown error occurred.', + ], + [ + 'errorCode' => 'UpsteamNotComplete', + 'errorMessage' => 'The reinjection configuration has not been completed.', + ], + [ + 'errorCode' => 'UpstreamConfigurationNotExist', + 'errorMessage' => 'The reinjection configuration is not found.', + ], + [ + 'errorCode' => 'JsonDecodeError', + 'errorMessage' => 'JSON string decoding failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => '网段宣告配置', + ], + 'ListInstance' => [ + 'summary' => '查询实例列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '186870', + 'abilityTreeNodes' => [ + 'FEATUREddos37DGH1', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '代播API 涉及IP网段的路由配置，支持宣告/撤销等操作，需要客户真实网段操作，无法进行自动化调度与验证。', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SaleId', + 'in' => 'query', + 'schema' => [ + 'description' => '代播实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试实例。', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '实例状态。取值：'."\n" + ."\n" + .'- normal：表示正常运行的实例。'."\n" + .'- expired：表示过期的实例。'."\n" + .'- deleting：表示处于删除中的实例。'."\n" + .'- stopped：表示停止的实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。 默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Num', + 'in' => 'query', + 'schema' => [ + 'description' => '数量。默认值：100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Page' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Num' => [ + 'description' => '数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Instances' => [ + 'description' => '代播实例详情数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '177xxxxxxxxxxxxx', + ], + 'SaleId' => [ + 'description' => '代播实例的ID。', + 'type' => 'string', + 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx', + ], + 'Name' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => '测试实例。', + ], + 'Status' => [ + 'description' => '实例状态。取值：'."\n" + .'- normal：表示正常运行的实例。'."\n" + .'- expired：表示过期的实例。'."\n" + .'- deleting：表示处于删除中的实例。'."\n" + .'- stopped：表示停止的实例。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Comment' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '测试实例。', + ], + 'Message' => [ + 'description' => '实例配置信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Spec' => [ + 'description' => '规格信息。', + 'type' => 'object', + 'properties' => [ + 'IdcNumbers' => [ + 'description' => 'Idc数量。取值范围：1-10。', + 'type' => 'string', + 'example' => '1', + ], + 'NormalBandwidth' => [ + 'description' => '干净带宽。单位：Mbps。', + 'type' => 'string', + 'example' => '100', + ], + 'IpSubnetNums' => [ + 'description' => '网段（C段）数量。取值范围：1-10000。', + 'type' => 'string', + 'example' => '1', + ], + 'Coverage' => [ + 'description' => '资产区域。', + 'type' => 'string', + 'example' => 'international_and_hmt', + ], + 'Edition' => [ + 'description' => '防护套餐。', + 'type' => 'string', + 'example' => 'enterprise', + ], + 'MitigationCapacity' => [ + 'description' => '最大防护能力。', + 'type' => 'string', + 'example' => 'unlimited', + ], + 'MitigationNums' => [ + 'description' => '防护次数。', + 'type' => 'string', + 'example' => 'unlimited', + ], + 'DiversionType' => [ + 'description' => '代播模式。取值： on-demand； always-on。', + 'type' => 'string', + 'example' => 'on-demand', + ], + 'MitigationAnalysis' => [ + 'description' => '防护日志。', + 'type' => 'string', + 'example' => 'off', + ], + 'MitigationAnalysisCapacity' => [ + 'description' => '防护日志容量。', + 'type' => 'string', + 'example' => '3T', + ], + 'InitialInstallation' => [ + 'description' => '初装模式。', + 'type' => 'string', + 'example' => 'gre_tunnel_by_pccw', + ], + 'InitialQty' => [ + 'description' => '初装数量。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'GmtExpire' => [ + 'description' => '到期时间。', + 'type' => 'string', + 'example' => '2022-12-15 11:10:42', + ], + 'GmtCreate' => [ + 'description' => '购买时间。', + 'type' => 'string', + 'example' => '2022-12-15 11:10:42', + ], + 'GmtModify' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-12-15 11:10:42', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AuthenticationFailed', + 'errorMessage' => 'User authentication failed.', + ], + [ + 'errorCode' => 'AutoScheduleRuleExist', + 'errorMessage' => 'The auto schedule rule already exists.', + ], + [ + 'errorCode' => 'AutoScheduleRuleNotExist', + 'errorMessage' => 'The auto schedule rule dose not exist.', + ], + [ + 'errorCode' => 'BlackHoleConfigurationError', + 'errorMessage' => 'A black hole configuration error occurred.', + ], + [ + 'errorCode' => 'CleanConfigurationError', + 'errorMessage' => 'A clean configuration error occurred.', + ], + [ + 'errorCode' => 'CoveredNet', + 'errorMessage' => 'The CIDR block is overwritten.', + ], + [ + 'errorCode' => 'DatabaseError', + 'errorMessage' => 'A database error.', + ], + [ + 'errorCode' => 'DeclaredNet', + 'errorMessage' => 'The CIDR block has been advertised.', + ], + [ + 'errorCode' => 'DefenseConfigurationError', + 'errorMessage' => 'A defense configuration error occurred.', + ], + [ + 'errorCode' => 'ForwardConfigurationNotExist', + 'errorMessage' => 'The CIDR block forwarding configuration is not found.', + ], + [ + 'errorCode' => 'ForwardNotExist', + 'errorMessage' => 'The CIDR block zone forwarding configuration is not found.', + ], + [ + 'errorCode' => 'ForwardRuleNotExist', + 'errorMessage' => 'The CIDR block forwarding rule is not found.', + ], + [ + 'errorCode' => 'HttpFailed', + 'errorMessage' => 'HTTP request failed.', + ], + [ + 'errorCode' => 'IDNSubnetsCountLimit', + 'errorMessage' => 'The maximum number of IDCs of the instance is exceeded.', + ], + [ + 'errorCode' => 'InstanceExist', + 'errorMessage' => 'The instance already exists.', + ], + [ + 'errorCode' => 'InstanceNetConfigurationExist', + 'errorMessage' => 'The instance CIDR block configuration already exists.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance is not found.', + ], + [ + 'errorCode' => 'InstanceUpstreamLimit', + 'errorMessage' => 'The maximum number of reinjection configurations for the instance is exceeded.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + [ + 'errorCode' => 'InvalidNet', + 'errorMessage' => 'Invalid CIDR block.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Invalid parameter value.', + ], + [ + 'errorCode' => 'IPSubnetsCountLimit', + 'errorMessage' => 'The maximum number of CIDR blocks of the instance is exceeded.', + ], + [ + 'errorCode' => 'NetCannotExtend', + 'errorMessage' => 'The CIDR block cannot be extended.', + ], + [ + 'errorCode' => 'NetConfigurationExist', + 'errorMessage' => 'The CIDR block configuration already exists.', + ], + [ + 'errorCode' => 'NetConfigurationNotExist', + 'errorMessage' => 'The CIDR block configuration is not found.', + ], + [ + 'errorCode' => 'NetForwardDelete', + 'errorMessage' => 'The CIDR block forwarding is being deleted.', + ], + [ + 'errorCode' => 'NetMaskOutOfRange', + 'errorMessage' => 'The subnet mask of the CIDR block is invalid.', + ], + [ + 'errorCode' => 'NetNeedExtend', + 'errorMessage' => 'The CIDR block needs to be extended.', + ], + [ + 'errorCode' => 'NetStatusNotReady', + 'errorMessage' => 'The CIDR block reinjection configuration has not been completed.', + ], + [ + 'errorCode' => 'NetworkDeclearedFailed', + 'errorMessage' => 'Failed to advertise the CIDR block.', + ], + [ + 'errorCode' => 'NetWorkNotExist', + 'errorMessage' => 'The CIDR block is not found.', + ], + [ + 'errorCode' => 'NetworkUndeclearedFailed', + 'errorMessage' => 'Failed to cancel the advertisement of the CIDR block.', + ], + [ + 'errorCode' => 'ParameterNotEnough', + 'errorMessage' => 'Required parameters are not specified.', + ], + [ + 'errorCode' => 'ParameterOutOfRange', + 'errorMessage' => 'Invalid parameter value.', + ], + [ + 'errorCode' => 'RegionNotExist', + 'errorMessage' => 'The region does not exist.', + ], + [ + 'errorCode' => 'RequestMethodError', + 'errorMessage' => 'An incorrect request method.', + ], + [ + 'errorCode' => 'SubnetCountLimit', + 'errorMessage' => 'The maximum number of subnets is exceeded.', + ], + [ + 'errorCode' => 'UnKnownError', + 'errorMessage' => 'An unknown error occurred.', + ], + [ + 'errorCode' => 'UpsteamNotComplete', + 'errorMessage' => 'The reinjection configuration has not been completed.', + ], + [ + 'errorCode' => 'UpstreamConfigurationNotExist', + 'errorMessage' => 'The reinjection configuration is not found.', + ], + [ + 'errorCode' => 'JsonDecodeError', + 'errorMessage' => 'JSON string decoding failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Total\\": 10,\\n \\"Page\\": 1,\\n \\"Num\\": 100,\\n \\"Instances\\": [\\n {\\n \\"UserId\\": \\"177xxxxxxxxxxxxx\\",\\n \\"SaleId\\": \\"ddos_diversion_public_cn-xxxxxxxxxxxxx\\",\\n \\"InstanceId\\": \\"ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx\\",\\n \\"Name\\": \\"测试实例。\\",\\n \\"Status\\": \\"normal\\",\\n \\"Comment\\": \\"测试实例。\\",\\n \\"Message\\": \\"successful\\",\\n \\"Spec\\": {\\n \\"IdcNumbers\\": \\"1\\",\\n \\"NormalBandwidth\\": \\"100\\",\\n \\"IpSubnetNums\\": \\"1\\",\\n \\"Coverage\\": \\"international_and_hmt\\",\\n \\"Edition\\": \\"enterprise\\",\\n \\"MitigationCapacity\\": \\"unlimited\\",\\n \\"MitigationNums\\": \\"unlimited\\",\\n \\"DiversionType\\": \\"on-demand\\",\\n \\"MitigationAnalysis\\": \\"off\\",\\n \\"MitigationAnalysisCapacity\\": \\"3T\\",\\n \\"InitialInstallation\\": \\"gre_tunnel_by_pccw\\",\\n \\"InitialQty\\": \\"1\\"\\n },\\n \\"GmtExpire\\": \\"2022-12-15 11:10:42\\",\\n \\"GmtCreate\\": \\"2022-12-15 11:10:42\\",\\n \\"GmtModify\\": \\"2022-12-15 11:10:42\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询实例列表', + ], + 'QueryNetList' => [ + 'summary' => '查询代播的网段列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '186874', + 'abilityTreeNodes' => [ + 'FEATUREddosPJT0YW', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '代播API 涉及IP网段的路由配置，支持宣告/撤销等操作，需要客户真实网段操作，无法进行自动化调度与验证。', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SaleId', + 'in' => 'query', + 'schema' => [ + 'description' => '代播实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'Net', + 'in' => 'query', + 'schema' => [ + 'description' => '代播实例的网段。'."\n" + .'> 代播实例没有扩展网段时，表示实例的网段。代播实例有扩展网段时，表示扩展的网段，与MainNet参数配合使用。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX/24', + 'enum' => [], + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '调度模式。取值：'."\n" + ."\n" + .'- manual : 人工。'."\n" + .'- netflow-auto：netflow自动调度。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'netflow-auto' => 'netflow-auto', + 'manual' => 'manual', + ], + 'example' => 'netflow-auto', + 'enum' => [ + 'manual', + 'netflow-auto', + 'beaver-auto', + ], + ], + ], + [ + 'name' => 'MainNet', + 'in' => 'query', + 'schema' => [ + 'description' => '具有扩展网段的代播实例的主网段。如果查询的代播实例没有扩展网段，此参数为空。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX/22', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。 默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Num', + 'in' => 'query', + 'schema' => [ + 'description' => '数量。默认值：100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24B652B5-AEFF-3F03-9114-00D053C42277', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Data' => [ + 'description' => '网段列表。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '网段总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Page' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Num' => [ + 'description' => '每页展示的网段数量。取值范围：1~100，默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Nets' => [ + 'description' => '网段列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '57690941xxxxxxxx', + ], + 'SaleId' => [ + 'description' => '代播实例的ID。', + 'type' => 'string', + 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', + ], + 'UpstreamType' => [ + 'description' => '回注类型。枚举值：'."\n" + .'- aliyun_line：阿里云专线。'."\n" + .'- pccw_line：合作专线（pccw）。'."\n" + .'- gre_line：GRE专线。'."\n" + .'- private_line：私有专线。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'aliyun_line', + ], + 'Net' => [ + 'description' => '代播实例的网段。', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + 'NetType' => [ + 'description' => '网段类型。', + 'type' => 'string', + 'example' => 'ipv4', + ], + 'Mode' => [ + 'description' => '代播启动模式。枚举值：'."\n" + .'- netflow-auto：NetFlow自动。'."\n" + .'- manual：手动。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'manual', + ], + 'DeclaredState' => [ + 'description' => '牵引状态。枚举值：'."\n" + .'- 0：未牵引。'."\n" + .'- 1：牵引中。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [], + 'example' => '0', + ], + 'Declared' => [ + 'description' => '区域牵引状态。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '牵引区域。枚举值：'."\n" + .'- oe26：香港。'."\n" + .'- us50：美东。'."\n" + .'- oe24：美西。'."\n" + .'- oe28：新加坡。'."\n" + .'- jp141：日本。'."\n" + .'- gb145：英国。'."\n" + .'- oi39：德国。', + 'type' => 'string', + 'example' => 'oe26', + ], + 'Declared' => [ + 'description' => '区域牵引状态。枚举值：'."\n" + .'- 0：未牵引。'."\n" + .'- 1：牵引中。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '0', + ], + ], + ], + ], + 'GmtCreate' => [ + 'description' => '添加时间。', + 'type' => 'string', + 'example' => '2024-09-05 13:52:50', + ], + 'GmtModify' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2024-09-05 13:59:55', + ], + 'NetExtend' => [ + 'description' => '是否需要扩展。枚举值：'."\n" + .'- 0：不扩展。'."\n" + .'- 1：扩展。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '0', + ], + 'DDoSDefense' => [ + 'description' => '防护配置。', + 'type' => 'object', + 'properties' => [ + 'DjPolicy' => [ + 'description' => '防护模板。', + 'type' => 'object', + 'properties' => [ + 'PolicyName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'gf_origin_xxxxx', + ], + ], + ], + 'CleanTh' => [ + 'description' => '清洗阈值。', + 'type' => 'object', + 'properties' => [ + 'Mbps' => [ + 'description' => '每秒带宽清洗阈值。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Pps' => [ + 'description' => '每秒报文数清洗阈值。单位：Pps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'HoleTh' => [ + 'description' => '黑洞阈值。', + 'type' => 'object', + 'properties' => [ + 'ThreshMbps' => [ + 'description' => '黑洞阈值。单位：Mbps。0代表全力防护。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'FwdEffect' => [ + 'description' => '转发生效状态。枚举值：'."\n" + .'- 0：未生效。'."\n" + .'- 1：生效中。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [], + 'example' => '1', + ], + 'NetMain' => [ + 'description' => '子网段展示，主网段默认为空字符串。', + 'type' => 'string', + 'example' => '192.168.XX.XX/22', + ], + 'Permit' => [ + 'description' => '审核状态。'."\n" + .'枚举值：'."\n" + .'- 0：未审核。'."\n" + .'- 1：已审核。'."\n" + .'- 2：审核中。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [], + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AuthenticationFailed', + 'errorMessage' => 'User authentication failed.', + ], + [ + 'errorCode' => 'AutoScheduleRuleExist', + 'errorMessage' => 'The auto schedule rule already exists.', + ], + [ + 'errorCode' => 'AutoScheduleRuleNotExist', + 'errorMessage' => 'The auto schedule rule dose not exist.', + ], + [ + 'errorCode' => 'BlackHoleConfigurationError', + 'errorMessage' => 'A black hole configuration error occurred.', + ], + [ + 'errorCode' => 'CleanConfigurationError', + 'errorMessage' => 'A clean configuration error occurred.', + ], + [ + 'errorCode' => 'CoveredNet', + 'errorMessage' => 'The CIDR block is overwritten.', + ], + [ + 'errorCode' => 'DatabaseError', + 'errorMessage' => 'A database error.', + ], + [ + 'errorCode' => 'DeclaredNet', + 'errorMessage' => 'The CIDR block has been advertised.', + ], + [ + 'errorCode' => 'DefenseConfigurationError', + 'errorMessage' => 'A defense configuration error occurred.', + ], + [ + 'errorCode' => 'ForwardConfigurationNotExist', + 'errorMessage' => 'The CIDR block forwarding configuration is not found.', + ], + [ + 'errorCode' => 'ForwardNotExist', + 'errorMessage' => 'The CIDR block zone forwarding configuration is not found.', + ], + [ + 'errorCode' => 'ForwardRuleNotExist', + 'errorMessage' => 'The CIDR block forwarding rule is not found.', + ], + [ + 'errorCode' => 'HttpFailed', + 'errorMessage' => 'HTTP request failed.', + ], + [ + 'errorCode' => 'IDNSubnetsCountLimit', + 'errorMessage' => 'The maximum number of IDCs of the instance is exceeded.', + ], + [ + 'errorCode' => 'InstanceExist', + 'errorMessage' => 'The instance already exists.', + ], + [ + 'errorCode' => 'InstanceNetConfigurationExist', + 'errorMessage' => 'The instance CIDR block configuration already exists.', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance is not found.', + ], + [ + 'errorCode' => 'InstanceUpstreamLimit', + 'errorMessage' => 'The maximum number of reinjection configurations for the instance is exceeded.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + [ + 'errorCode' => 'InvalidNet', + 'errorMessage' => 'Invalid CIDR block.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Invalid parameter value.', + ], + [ + 'errorCode' => 'IPSubnetsCountLimit', + 'errorMessage' => 'The maximum number of CIDR blocks of the instance is exceeded.', + ], + [ + 'errorCode' => 'NetCannotExtend', + 'errorMessage' => 'The CIDR block cannot be extended.', + ], + [ + 'errorCode' => 'NetConfigurationExist', + 'errorMessage' => 'The CIDR block configuration already exists.', + ], + [ + 'errorCode' => 'NetConfigurationNotExist', + 'errorMessage' => 'The CIDR block configuration is not found.', + ], + [ + 'errorCode' => 'NetForwardDelete', + 'errorMessage' => 'The CIDR block forwarding is being deleted.', + ], + [ + 'errorCode' => 'NetMaskOutOfRange', + 'errorMessage' => 'The subnet mask of the CIDR block is invalid.', + ], + [ + 'errorCode' => 'NetNeedExtend', + 'errorMessage' => 'The CIDR block needs to be extended.', + ], + [ + 'errorCode' => 'NetStatusNotReady', + 'errorMessage' => 'The CIDR block reinjection configuration has not been completed.', + ], + [ + 'errorCode' => 'NetworkDeclearedFailed', + 'errorMessage' => 'Failed to advertise the CIDR block.', + ], + [ + 'errorCode' => 'NetWorkNotExist', + 'errorMessage' => 'The CIDR block is not found.', + ], + [ + 'errorCode' => 'NetworkUndeclearedFailed', + 'errorMessage' => 'Failed to cancel the advertisement of the CIDR block.', + ], + [ + 'errorCode' => 'ParameterNotEnough', + 'errorMessage' => 'Required parameters are not specified.', + ], + [ + 'errorCode' => 'ParameterOutOfRange', + 'errorMessage' => 'Invalid parameter value.', + ], + [ + 'errorCode' => 'RegionNotExist', + 'errorMessage' => 'The region does not exist.', + ], + [ + 'errorCode' => 'RequestMethodError', + 'errorMessage' => 'An incorrect request method.', + ], + [ + 'errorCode' => 'SubnetCountLimit', + 'errorMessage' => 'The maximum number of subnets is exceeded.', + ], + [ + 'errorCode' => 'UnKnownError', + 'errorMessage' => 'An unknown error occurred.', + ], + [ + 'errorCode' => 'UpsteamNotComplete', + 'errorMessage' => 'The reinjection configuration has not been completed.', + ], + [ + 'errorCode' => 'UpstreamConfigurationNotExist', + 'errorMessage' => 'The reinjection configuration is not found.', + ], + [ + 'errorCode' => 'JsonDecodeError', + 'errorMessage' => 'JSON string decoding failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"24B652B5-AEFF-3F03-9114-00D053C42277\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Total\\": 10,\\n \\"Page\\": 1,\\n \\"Num\\": 100,\\n \\"Nets\\": [\\n {\\n \\"UserId\\": \\"57690941xxxxxxxx\\",\\n \\"SaleId\\": \\"ddos_diversion_public_cn-xxxxxxxxxxxxx\\",\\n \\"UpstreamType\\": \\"aliyun_line\\",\\n \\"Net\\": \\"192.168.XX.XX/24\\",\\n \\"NetType\\": \\"ipv4\\",\\n \\"Mode\\": \\"manual\\",\\n \\"DeclaredState\\": 0,\\n \\"Declared\\": [\\n {\\n \\"Region\\": \\"oe26\\",\\n \\"Declared\\": \\"0\\"\\n }\\n ],\\n \\"GmtCreate\\": \\"2024-09-05 13:52:50\\",\\n \\"GmtModify\\": \\"2024-09-05 13:59:55\\",\\n \\"NetExtend\\": \\"0\\",\\n \\"DDoSDefense\\": {\\n \\"DjPolicy\\": {\\n \\"PolicyName\\": \\"gf_origin_xxxxx\\"\\n },\\n \\"CleanTh\\": {\\n \\"Mbps\\": 0,\\n \\"Pps\\": 0\\n },\\n \\"HoleTh\\": {\\n \\"ThreshMbps\\": 0\\n }\\n },\\n \\"FwdEffect\\": 1,\\n \\"NetMain\\": \\"192.168.XX.XX/22\\",\\n \\"Permit\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询网段列表', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ddosdiversion.cn-hongkong.aliyuncs.com', + ], + ], +]; |