summaryrefslogtreecommitdiff
path: root/data/en_us/ddosdiversion
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/ddosdiversion
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/ddosdiversion')
-rw-r--r--data/en_us/ddosdiversion/2023-07-01/api-docs.php1488
1 files changed, 515 insertions, 973 deletions
diff --git a/data/en_us/ddosdiversion/2023-07-01/api-docs.php b/data/en_us/ddosdiversion/2023-07-01/api-docs.php
index 662e268..1af9f63 100644
--- a/data/en_us/ddosdiversion/2023-07-01/api-docs.php
+++ b/data/en_us/ddosdiversion/2023-07-01/api-docs.php
@@ -1,29 +1,15 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'DdosDiversion',
- 'version' => '2023-07-01',
- ],
- 'directories' => [
- 'ConfigNetStatus',
- 'ListInstance',
- 'QueryNetList',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'DdosDiversion', 'version' => '2023-07-01'],
+ 'directories' => ['ConfigNetStatus', 'QueryNetList', 'ListInstance'],
'components' => [
'schemas' => [],
],
'apis' => [
'ConfigNetStatus' => [
'summary' => 'Configures the advertising of a CIDR block.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -33,10 +19,10 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '186873',
- 'abilityTreeNodes' => [
- 'FEATUREddosPJT0YW',
- ],
+ 'abilityTreeNodes' => ['FEATUREddosPJT0YW'],
'autoTest' => false,
'notSupportAutoTestReason' => '代播API 涉及IP网段的路由配置,支持宣告/撤销等操作,需要客户真实网段操作,无法进行自动化调度与验证。',
'tenantRelevance' => 'publicInformation',
@@ -45,22 +31,18 @@
[
'name' => 'SaleId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the anti-DDoS diversion instance.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx',
- ],
+ 'schema' => ['description' => 'The ID of the anti-DDoS diversion instance.', 'type' => 'string', 'required' => true, 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'Net',
'in' => 'query',
'schema' => [
- 'description' => 'The CIDR block of the anti-DDoS diversion instance.'."\n",
+ 'description' => 'The CIDR block of the anti-DDoS diversion instance.',
'type' => 'string',
'required' => true,
- 'example' => '192.168.XX.XX/22',
'enum' => [],
+ 'example' => '192.168.XX.XX/22',
+ 'title' => '',
],
],
[
@@ -69,15 +51,14 @@
'schema' => [
'description' => 'The status of the CIDR block. Valid values:'."\n"
."\n"
- .'* enable: advertises the CIDR block.'."\n"
- .'* disable: withdraws the advertising of the CIDR block.'."\n",
+ .'- enable: advertises the CIDR block.'."\n"
+ ."\n"
+ .'- disable: withdraws the advertising of the CIDR block.',
'type' => 'string',
'required' => true,
+ 'enum' => ['enable', 'disable'],
'example' => 'enable',
- 'enum' => [
- 'enable',
- 'disable',
- ],
+ 'title' => '',
],
],
[
@@ -87,15 +68,12 @@
'schema' => [
'description' => 'The regions in which the CIDR block needs to be advertised or withdrawn from advertising. If you leave this parameter empty, the CIDR blocks in all regions are configured.'."\n"
."\n"
- .'> You can call the [QueryNetList](~~2639086~~) operation to obtain the regions of the CIDR blocks.',
+ .'> You can call the [QueryNetList](~~2639086~~) operation to obtain the regions of the CIDR blocks.',
'type' => 'array',
- 'items' => [
- 'description' => 'The region in which the CIDR block needs to be advertised or withdrawn from advertising.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oe26',
- ],
+ 'items' => ['description' => 'The region in which the CIDR block needs to be advertised or withdrawn from advertising.', 'type' => 'string', 'required' => false, 'example' => 'oe26', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
@@ -103,15 +81,12 @@
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => 'The subnet CIDR blocks of the CIDR block.'."\n",
+ 'description' => 'The subnet CIDR blocks of the CIDR block.',
'type' => 'array',
- 'items' => [
- 'description' => 'The subnet CIDR block of the CIDR block.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.XX.XX/24',
- ],
+ 'items' => ['description' => 'The subnet CIDR block of the CIDR block.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX/24', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -120,214 +95,90 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'The status code.'."\n"
- ."\n"
- .'* **200**: The request was successful.'."\n"
- .'* Other codes: The request failed.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95',
- ],
- 'Message' => [
- 'description' => 'The response parameters.'."\n",
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['description' => 'The status code.'."\n"
+ ."\n"
+ .'- **200**: The request was successful.'."\n"
+ ."\n"
+ .'- Other codes: The request failed.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95', 'title' => ''],
+ 'Message' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'AuthenticationFailed', 'errorMessage' => 'User authentication failed.', 'description' => 'User authentication failed.'],
+ ['errorCode' => 'AutoScheduleRuleExist', 'errorMessage' => 'The auto schedule rule already exists.', 'description' => 'The scheduling rule already exists.'],
+ ['errorCode' => 'AutoScheduleRuleNotExist', 'errorMessage' => 'The auto schedule rule dose not exist.', 'description' => 'The scheduling rule does not exist.'],
+ ['errorCode' => 'BlackHoleConfigurationError', 'errorMessage' => 'A black hole configuration error occurred.', 'description' => 'The blackhole filtering configuration is invalid.'],
+ ['errorCode' => 'CleanConfigurationError', 'errorMessage' => 'A clean configuration error occurred.', 'description' => 'The traffic scrubbing configuration is invalid.'],
+ ['errorCode' => 'CoveredNet', 'errorMessage' => 'The CIDR block is overwritten.', 'description' => 'The specified CIDR block overlaps with another CIDR block.'],
+ ['errorCode' => 'DatabaseError', 'errorMessage' => 'A database error.', 'description' => 'The database is invalid.'],
+ ['errorCode' => 'DeclaredNet', 'errorMessage' => 'The CIDR block has been advertised.', 'description' => 'The CIDR block is in the Advertising state.'],
+ ['errorCode' => 'DefenseConfigurationError', 'errorMessage' => 'A defense configuration error occurred.', 'description' => 'The mitigation settings are invalid.'],
+ ['errorCode' => 'ForwardConfigurationNotExist', 'errorMessage' => 'The CIDR block forwarding configuration is not found.', 'description' => 'The forwarding configuration of the CIDR block does not exist.'],
+ ['errorCode' => 'ForwardNotExist', 'errorMessage' => 'The CIDR block zone forwarding configuration is not found.', 'description' => 'The zone forwarding configuration of the CIDR block does not exist.'],
+ ['errorCode' => 'ForwardRuleNotExist', 'errorMessage' => 'The CIDR block forwarding rule is not found.', 'description' => 'The CIDR block forwarding rule does not exist.'],
+ ['errorCode' => 'HttpFailed', 'errorMessage' => 'HTTP request failed.', 'description' => 'The HTTP request failed.'],
+ ['errorCode' => 'IDNSubnetsCountLimit', 'errorMessage' => 'The maximum number of IDCs of the instance is exceeded.', 'description' => 'The number of data centers for the instance has reached the upper limit.'],
+ ['errorCode' => 'InstanceExist', 'errorMessage' => 'The instance already exists.', 'description' => 'The instance already exists.'],
+ ['errorCode' => 'InstanceNetConfigurationExist', 'errorMessage' => 'The instance CIDR block configuration already exists.', 'description' => 'The CIDR block configuration of the instance already exists.'],
+ ['errorCode' => 'InstanceNotExist', 'errorMessage' => 'The instance is not found.', 'description' => 'The instance does not exist.'],
+ ['errorCode' => 'InstanceUpstreamLimit', 'errorMessage' => 'The maximum number of reinjection configurations for the instance is exceeded.', 'description' => 'The number of reinjection configurations of the instance is limited.'],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => 'An internal error occurred.'],
+ ['errorCode' => 'InvalidNet', 'errorMessage' => 'Invalid CIDR block.', 'description' => 'The CIDR block is invalid.'],
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter value.', 'description' => 'The parameter is invalid.'],
+ ['errorCode' => 'IPSubnetsCountLimit', 'errorMessage' => 'The maximum number of CIDR blocks of the instance is exceeded.', 'description' => 'The number of CIDR blocks of the instance has reached the upper limit.'],
+ ['errorCode' => 'NetCannotExtend', 'errorMessage' => 'The CIDR block cannot be extended.', 'description' => 'The CIDR block cannot be expanded.'],
+ ['errorCode' => 'NetConfigurationExist', 'errorMessage' => 'The CIDR block configuration already exists.', 'description' => 'The CIDR block configuration already exists.'],
+ ['errorCode' => 'NetConfigurationNotExist', 'errorMessage' => 'The CIDR block configuration is not found.', 'description' => 'The CIDR block configuration does not exist.'],
+ ['errorCode' => 'NetForwardDelete', 'errorMessage' => 'The CIDR block forwarding is being deleted.', 'description' => 'The forwarding configuration of the CIDR block is being deleted.'],
+ ['errorCode' => 'NetMaskOutOfRange', 'errorMessage' => 'The subnet mask of the CIDR block is invalid.', 'description' => 'The subnet mask exceeds the upper limit.'],
+ ['errorCode' => 'NetNeedExtend', 'errorMessage' => 'The CIDR block needs to be extended.', 'description' => 'The CIDR block needs to be expanded.'],
+ ['errorCode' => 'NetStatusNotReady', 'errorMessage' => 'The CIDR block reinjection configuration has not been completed.', 'description' => 'Failed to complete the reinjection configuration of the CIDR block.'],
+ ['errorCode' => 'NetworkDeclearedFailed', 'errorMessage' => 'Failed to advertise the CIDR block.', 'description' => 'Failed to advertise the CIDR block.'],
+ ['errorCode' => 'NetWorkNotExist', 'errorMessage' => 'The CIDR block is not found.', 'description' => 'The CIDR block does not exist.'],
+ ['errorCode' => 'NetworkUndeclearedFailed', 'errorMessage' => 'Failed to cancel the advertisement of the CIDR block.', 'description' => 'Failed to withdraw the advertising of the CIDR block.'],
+ ['errorCode' => 'ParameterNotEnough', 'errorMessage' => 'Required parameters are not specified.', 'description' => 'A required parameter is not specified.'],
+ ['errorCode' => 'ParameterOutOfRange', 'errorMessage' => 'Invalid parameter value.', 'description' => 'The value of the parameter is invalid.'],
+ ['errorCode' => 'RegionNotExist', 'errorMessage' => 'The region does not exist.', 'description' => 'The zone does not exist.'],
+ ['errorCode' => 'RequestMethodError', 'errorMessage' => 'An incorrect request method.', 'description' => 'The request method is invalid.'],
+ ['errorCode' => 'SubnetCountLimit', 'errorMessage' => 'The maximum number of subnets is exceeded.', 'description' => 'The number of subnets has reached the upper limit.'],
+ ['errorCode' => 'UnKnownError', 'errorMessage' => 'An unknown error occurred.', 'description' => 'An unknown error occurred.'],
+ ['errorCode' => 'UpsteamNotComplete', 'errorMessage' => 'The reinjection configuration has not been completed.', 'description' => 'Failed to complete the reinjection configuration of the CIDR block.'],
+ ['errorCode' => 'UpstreamConfigurationNotExist', 'errorMessage' => 'The reinjection configuration is not found.', 'description' => 'The reinjection configuration does not exist.'],
+ ['errorCode' => 'JsonDecodeError', 'errorMessage' => 'JSON string decoding failed.', 'description' => 'Failed to convert JSON string to JSON object.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ConfigNetStatus',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ddosdiversion:ConfigNetStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DdosDiversion', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]',
- 'title' => 'ConfigNetStatus',
],
'ListInstance' => [
- 'summary' => 'Queries anti-DDoS diversion instances.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Queries instances.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -337,10 +188,10 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '186870',
- 'abilityTreeNodes' => [
- 'FEATUREddos37DGH1',
- ],
+ 'abilityTreeNodes' => ['FEATUREddos37DGH1'],
'autoTest' => false,
'notSupportAutoTestReason' => '代播API 涉及IP网段的路由配置,支持宣告/撤销等操作,需要客户真实网段操作,无法进行自动化调度与验证。',
'tenantRelevance' => 'publicInformation',
@@ -349,61 +200,35 @@
[
'name' => 'SaleId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the anti-DDoS diversion instance.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx',
- ],
+ 'schema' => ['description' => 'The ID of the Anti-DDoS Diversion instance.', 'type' => 'string', 'required' => false, 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the instance.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'Test instance.', 'required' => false, 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => 'The status of the instance. Valid values:'."\n"
- ."\n"
- .'- normal'."\n"
- .'- expired'."\n"
- .'- deleting'."\n"
- .'- stopped',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
- ],
+ 'schema' => ['description' => 'The status of the instance. Valid values:'."\n"
+ ."\n"
+ .'- normal: The instance is running normally.'."\n"
+ ."\n"
+ .'- expired: The instance has expired.'."\n"
+ ."\n"
+ .'- deleting: The instance is being deleted.'."\n"
+ ."\n"
+ .'- stopped: The instance is stopped.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'name' => 'Page',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Default value: 100.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- 'default' => '100',
- ],
+ 'schema' => ['description' => 'The number of entries to return. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
@@ -411,368 +236,153 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'The status code.'."\n"
- ."\n"
- .'- 200: The request was successful.'."\n"
- .'- Other codes: The request failed.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.',
- 'type' => 'string',
- 'example' => 'B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95',
- ],
- 'Message' => [
- 'description' => 'The response parameters.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['description' => 'The response code. Valid values:'."\n"
+ ."\n"
+ .'- **200**: The request was successful.'."\n"
+ ."\n"
+ .'- Other codes: The request failed.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95', 'title' => ''],
+ 'Message' => ['description' => 'The additional information that is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Data' => [
'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'Total' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'description' => 'The total number of entries returned.',
- 'example' => '10'."\n",
- ],
- 'Page' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'description' => 'The page number.'."\n",
- 'example' => '1',
- ],
- 'Num' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'description' => 'The number of entries per page.'."\n",
- 'example' => '100',
- ],
+ 'Total' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'Page' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Num' => ['description' => 'The number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'Instances' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'type' => 'string',
- 'description' => 'The user ID.',
- 'example' => '177xxxxxxxxxxxxx'."\n",
- ],
- 'SaleId' => [
- 'type' => 'string',
- 'description' => 'The ID of the instance.',
- 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx'."\n",
- ],
- 'InstanceId' => [
- 'type' => 'string',
- 'description' => 'The alias of the instance.',
- 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx'."\n",
- ],
- 'Name' => [
- 'type' => 'string',
- 'description' => 'The name of the instance.',
- 'example' => 'test',
- ],
- 'Status' => [
- 'type' => 'string',
- 'description' => 'The status of the instance. Valid values:'."\n"
- ."\n"
- .'- normal'."\n"
- .'- expired'."\n"
- .'- deleting'."\n"
- .'- stopped',
- 'example' => 'normal'."\n",
- ],
- 'Comment' => [
- 'type' => 'string',
- 'description' => 'The description.',
- 'example' => 'description',
- ],
- 'Message' => [
- 'type' => 'string',
- 'description' => 'The configurations of the instance.',
- 'example' => 'successful'."\n",
- ],
+ 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '177xxxxxxxxxxxxx', 'title' => ''],
+ 'SaleId' => ['description' => 'The ID of the anti-DDoS diversion instance.', 'type' => 'string', 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx', 'title' => ''],
+ 'Name' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'Test instance.', 'title' => ''],
+ 'Status' => ['description' => 'The status of the instance. Valid values:'."\n"
+ ."\n"
+ .'- normal: The instance is running normally.'."\n"
+ ."\n"
+ .'- expired: The instance has expired.'."\n"
+ ."\n"
+ .'- deleting: The instance is being deleted.'."\n"
+ ."\n"
+ .'- stopped: The instance is stopped.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
+ 'Comment' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Test instance.', 'title' => ''],
+ 'Message' => ['description' => 'The configurations of the instance.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Spec' => [
'type' => 'object',
'properties' => [
- 'IdcNumbers' => [
- 'type' => 'string',
- 'description' => 'The number of data centers. Valid values: 1 to 10.',
- 'example' => '1',
- ],
- 'NormalBandwidth' => [
- 'type' => 'string',
- 'description' => 'The service traffic. Unit: Mbit/s.',
- 'example' => '100',
- ],
- 'IpSubnetNums' => [
- 'type' => 'string',
- 'description' => 'The number of CIDR blocks. Value range: 1 to 10000.',
- 'example' => '1',
- ],
- 'Coverage' => [
- 'type' => 'string',
- 'description' => 'The region of the asset.',
- 'example' => 'international_and_hmt'."\n",
- ],
- 'Edition' => [
- 'type' => 'string',
- 'description' => 'The mitigation plan.',
- 'example' => 'enterprise'."\n",
- ],
- 'MitigationCapacity' => [
- 'type' => 'string',
- 'description' => 'The maximum mitigation capability.',
- 'example' => 'unlimited'."\n",
- ],
- 'MitigationNums' => [
- 'type' => 'string',
- 'description' => 'The number of mitigation sessions.',
- 'example' => 'unlimited'."\n",
- ],
- 'DiversionType' => [
- 'type' => 'string',
- 'description' => 'The diversion mode. Valid values: on-demand always-on',
- 'example' => 'on-demand'."\n",
- ],
- 'MitigationAnalysis' => [
- 'type' => 'string',
- 'description' => 'The mitigation analysis feature.',
- 'example' => 'off'."\n",
- ],
- 'MitigationAnalysisCapacity' => [
- 'type' => 'string',
- 'description' => 'The log storage capacity.',
- 'example' => '3T',
- ],
- 'InitialInstallation' => [
- 'type' => 'string',
- 'description' => 'The initial installation mode.',
- 'example' => 'gre_tunnel_by_pccw'."\n",
- ],
- 'InitialQty' => [
- 'type' => 'string',
- 'description' => 'The initial installation quantity.',
- 'example' => '1',
- ],
+ 'IdcNumbers' => ['description' => 'The number of data centers. Valid values: 1-10.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'NormalBandwidth' => ['description' => 'The service traffic. Unit: Mbps.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'IpSubnetNums' => ['description' => 'The number of CIDR blocks. Valid values: 1-10000.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Coverage' => ['description' => 'The region of the asset.', 'type' => 'string', 'example' => 'international_and_hmt', 'title' => ''],
+ 'Edition' => ['description' => 'The mitigation plan.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''],
+ 'MitigationCapacity' => ['description' => 'The maximum mitigation capability.', 'type' => 'string', 'example' => 'unlimited', 'title' => ''],
+ 'MitigationNums' => ['description' => 'The mitigation sessions.', 'type' => 'string', 'example' => 'unlimited', 'title' => ''],
+ 'DiversionType' => ['description' => 'The diversion mode. Valid values: on-demand; always-on.', 'type' => 'string', 'example' => 'on-demand', 'title' => ''],
+ 'MitigationAnalysis' => ['description' => 'The mitigation analysis feature.', 'type' => 'string', 'example' => 'off', 'title' => ''],
+ 'MitigationAnalysisCapacity' => ['description' => 'The log storage capacity.', 'type' => 'string', 'example' => '3T', 'title' => ''],
+ 'InitialInstallation' => ['description' => 'The initial installation mode.', 'type' => 'string', 'example' => 'gre_tunnel_by_pccw', 'title' => ''],
+ 'InitialQty' => ['description' => 'The initial installation quantity.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
- 'description' => 'The specifications of the instance.',
- ],
- 'GmtExpire' => [
- 'type' => 'string',
- 'description' => 'The expiration time.',
- 'example' => '2023-02-23 00:00:00'."\n",
- ],
- 'GmtCreate' => [
- 'type' => 'string',
- 'description' => 'The purchase time.',
- 'example' => '2022-12-15 11:10:42'."\n",
- ],
- 'GmtModify' => [
- 'type' => 'string',
- 'description' => 'The update time.',
- 'example' => '2022-12-15 11:10:42'."\n",
+ 'description' => 'The specifications.',
+ 'title' => '',
+ 'example' => '',
],
+ 'GmtExpire' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2022-12-15 11:10:42', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The purchase time.', 'type' => 'string', 'example' => '2022-12-15 11:10:42', 'title' => ''],
+ 'GmtModify' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2022-12-15 11:10:42', 'title' => ''],
],
- 'description' => 'The details of the anti-DDoS diversion instance.',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'description' => 'The details of the anti-DDoS diversion instance.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'AuthenticationFailed', 'errorMessage' => 'User authentication failed.', 'description' => 'User authentication failed.'],
+ ['errorCode' => 'AutoScheduleRuleExist', 'errorMessage' => 'The auto schedule rule already exists.', 'description' => 'The scheduling rule already exists.'],
+ ['errorCode' => 'AutoScheduleRuleNotExist', 'errorMessage' => 'The auto schedule rule dose not exist.', 'description' => 'The scheduling rule does not exist.'],
+ ['errorCode' => 'BlackHoleConfigurationError', 'errorMessage' => 'A black hole configuration error occurred.', 'description' => 'The blackhole filtering configuration is invalid.'],
+ ['errorCode' => 'CleanConfigurationError', 'errorMessage' => 'A clean configuration error occurred.', 'description' => 'The traffic scrubbing configuration is invalid.'],
+ ['errorCode' => 'CoveredNet', 'errorMessage' => 'The CIDR block is overwritten.', 'description' => 'The specified CIDR block overlaps with another CIDR block.'],
+ ['errorCode' => 'DatabaseError', 'errorMessage' => 'A database error.', 'description' => 'The database is invalid.'],
+ ['errorCode' => 'DeclaredNet', 'errorMessage' => 'The CIDR block has been advertised.', 'description' => 'The CIDR block is in the Advertising state.'],
+ ['errorCode' => 'DefenseConfigurationError', 'errorMessage' => 'A defense configuration error occurred.', 'description' => 'The mitigation settings are invalid.'],
+ ['errorCode' => 'ForwardConfigurationNotExist', 'errorMessage' => 'The CIDR block forwarding configuration is not found.', 'description' => 'The forwarding configuration of the CIDR block does not exist.'],
+ ['errorCode' => 'ForwardNotExist', 'errorMessage' => 'The CIDR block zone forwarding configuration is not found.', 'description' => 'The zone forwarding configuration of the CIDR block does not exist.'],
+ ['errorCode' => 'ForwardRuleNotExist', 'errorMessage' => 'The CIDR block forwarding rule is not found.', 'description' => 'The CIDR block forwarding rule does not exist.'],
+ ['errorCode' => 'HttpFailed', 'errorMessage' => 'HTTP request failed.', 'description' => 'The HTTP request failed.'],
+ ['errorCode' => 'IDNSubnetsCountLimit', 'errorMessage' => 'The maximum number of IDCs of the instance is exceeded.', 'description' => 'The number of data centers for the instance has reached the upper limit.'],
+ ['errorCode' => 'InstanceExist', 'errorMessage' => 'The instance already exists.', 'description' => 'The instance already exists.'],
+ ['errorCode' => 'InstanceNetConfigurationExist', 'errorMessage' => 'The instance CIDR block configuration already exists.', 'description' => 'The CIDR block configuration of the instance already exists.'],
+ ['errorCode' => 'InstanceNotExist', 'errorMessage' => 'The instance is not found.', 'description' => 'The instance does not exist.'],
+ ['errorCode' => 'InstanceUpstreamLimit', 'errorMessage' => 'The maximum number of reinjection configurations for the instance is exceeded.', 'description' => 'The number of reinjection configurations of the instance is limited.'],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => 'An internal error occurred.'],
+ ['errorCode' => 'InvalidNet', 'errorMessage' => 'Invalid CIDR block.', 'description' => 'The CIDR block is invalid.'],
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter value.', 'description' => 'The parameter is invalid.'],
+ ['errorCode' => 'IPSubnetsCountLimit', 'errorMessage' => 'The maximum number of CIDR blocks of the instance is exceeded.', 'description' => 'The number of CIDR blocks of the instance has reached the upper limit.'],
+ ['errorCode' => 'NetCannotExtend', 'errorMessage' => 'The CIDR block cannot be extended.', 'description' => 'The CIDR block cannot be expanded.'],
+ ['errorCode' => 'NetConfigurationExist', 'errorMessage' => 'The CIDR block configuration already exists.', 'description' => 'The CIDR block configuration already exists.'],
+ ['errorCode' => 'NetConfigurationNotExist', 'errorMessage' => 'The CIDR block configuration is not found.', 'description' => 'The CIDR block configuration does not exist.'],
+ ['errorCode' => 'NetForwardDelete', 'errorMessage' => 'The CIDR block forwarding is being deleted.', 'description' => 'The forwarding configuration of the CIDR block is being deleted.'],
+ ['errorCode' => 'NetMaskOutOfRange', 'errorMessage' => 'The subnet mask of the CIDR block is invalid.', 'description' => 'The subnet mask exceeds the upper limit.'],
+ ['errorCode' => 'NetNeedExtend', 'errorMessage' => 'The CIDR block needs to be extended.', 'description' => 'The CIDR block needs to be expanded.'],
+ ['errorCode' => 'NetStatusNotReady', 'errorMessage' => 'The CIDR block reinjection configuration has not been completed.', 'description' => 'Failed to complete the reinjection configuration of the CIDR block.'],
+ ['errorCode' => 'NetworkDeclearedFailed', 'errorMessage' => 'Failed to advertise the CIDR block.', 'description' => 'Failed to advertise the CIDR block.'],
+ ['errorCode' => 'NetWorkNotExist', 'errorMessage' => 'The CIDR block is not found.', 'description' => 'The CIDR block does not exist.'],
+ ['errorCode' => 'NetworkUndeclearedFailed', 'errorMessage' => 'Failed to cancel the advertisement of the CIDR block.', 'description' => 'Failed to withdraw the advertising of the CIDR block.'],
+ ['errorCode' => 'ParameterNotEnough', 'errorMessage' => 'Required parameters are not specified.', 'description' => 'A required parameter is not specified.'],
+ ['errorCode' => 'ParameterOutOfRange', 'errorMessage' => 'Invalid parameter value.', 'description' => 'The value of the parameter is invalid.'],
+ ['errorCode' => 'RegionNotExist', 'errorMessage' => 'The region does not exist.', 'description' => 'The zone does not exist.'],
+ ['errorCode' => 'RequestMethodError', 'errorMessage' => 'An incorrect request method.', 'description' => 'The request method is invalid.'],
+ ['errorCode' => 'SubnetCountLimit', 'errorMessage' => 'The maximum number of subnets is exceeded.', 'description' => 'The number of subnets has reached the upper limit.'],
+ ['errorCode' => 'UnKnownError', 'errorMessage' => 'An unknown error occurred.', 'description' => 'An unknown error occurred.'],
+ ['errorCode' => 'UpsteamNotComplete', 'errorMessage' => 'The reinjection configuration has not been completed.', 'description' => 'Failed to complete the reinjection configuration of the CIDR block.'],
+ ['errorCode' => 'UpstreamConfigurationNotExist', 'errorMessage' => 'The reinjection configuration is not found.', 'description' => 'The reinjection configuration does not exist.'],
+ ['errorCode' => 'JsonDecodeError', 'errorMessage' => 'JSON string decoding failed.', 'description' => 'Failed to convert JSON string to JSON object.'],
],
],
- '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"}]',
+ '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\\": \\"Test instance.\\",\\n \\"Status\\": \\"normal\\",\\n \\"Comment\\": \\"Test instance.\\",\\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' => 'ListInstance',
- ],
- 'QueryNetList' => [
- 'summary' => 'Queries the CIDR blocks of an anti-DDoS diversion instance.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ddosdiversion:ListInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DdosDiversion', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'manual',
+ ],
+ 'QueryNetList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -782,10 +392,10 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '186874',
- 'abilityTreeNodes' => [
- 'FEATUREddosPJT0YW',
- ],
+ 'abilityTreeNodes' => ['FEATUREddosPJT0YW'],
'autoTest' => false,
'notSupportAutoTestReason' => '代播API 涉及IP网段的路由配置,支持宣告/撤销等操作,需要客户真实网段操作,无法进行自动化调度与验证。',
'tenantRelevance' => 'publicInformation',
@@ -794,12 +404,7 @@
[
'name' => 'SaleId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the anti-DDoS diversion instance.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx',
- ],
+ 'schema' => ['description' => 'The ID of the anti-DDoS diversion instance.', 'type' => 'string', 'required' => false, 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'Net',
@@ -807,11 +412,12 @@
'schema' => [
'description' => 'The CIDR block of the anti-DDoS diversion instance.'."\n"
."\n"
- .'> If no extended CIDR blocks are configured for the anti-DDoS diversion instance, this parameter specifies the CIDR block of the instance. If an extended CIDR block is configured for the anti-DDoS diversion instance, this parameter specifies the extended CIDR block that is configured for the instance. If this parameter is specified, the MainNet parameter is required.'."\n",
+ .'> If no extended CIDR blocks are configured for the anti-DDoS diversion instance, this parameter specifies the CIDR block of the instance. If an extended CIDR block is configured for the anti-DDoS diversion instance, this parameter specifies the extended CIDR block that is configured for the instance. If this parameter is specified, the MainNet parameter is required.',
'type' => 'string',
'required' => false,
- 'example' => '192.168.XX.XX/24',
'enum' => [],
+ 'example' => '192.168.XX.XX/24',
+ 'title' => '',
],
],
[
@@ -820,55 +426,31 @@
'schema' => [
'description' => 'The scheduling mode. Valid values:'."\n"
."\n"
- .'* manual: manual scheduling.'."\n"
- .'* netflow-auto: automatic scheduling.'."\n",
+ .'- manual: manual scheduling.'."\n"
+ ."\n"
+ .'- netflow-auto: automatic scheduling.',
+ 'enumValueTitles' => ['netflow-auto' => 'netflow-auto', 'manual' => 'manual'],
'type' => 'string',
+ 'enum' => ['manual', 'netflow-auto', 'beaver-auto'],
'required' => false,
- 'enumValueTitles' => [
- 'netflow-auto' => 'netflow-auto',
- 'manual' => 'manual',
- ],
'example' => 'netflow-auto',
- 'enum' => [
- 'manual',
- 'netflow-auto',
- 'beaver-auto',
- ],
+ 'title' => '',
],
],
[
'name' => 'MainNet',
'in' => 'query',
- 'schema' => [
- 'description' => 'The primary CIDR block of the anti-DDoS diversion instance for which an extended CIDR block is configured. If no extended CIDR blocks are configured for the anti-DDoS diversion instance, leave this parameter empty.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.XX.XX/22',
- ],
+ 'schema' => ['description' => 'The primary CIDR block of the anti-DDoS diversion instance for which an extended CIDR block is configured. If no extended CIDR blocks are configured for the anti-DDoS diversion instance, leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX/22', 'title' => ''],
],
[
'name' => 'Page',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Default value: 100.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- 'default' => '100',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
@@ -876,417 +458,377 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'The status code.'."\n"
- ."\n"
- .'- 200: The request was successful.'."\n"
- .'- Other codes: The request failed.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '24B652B5-AEFF-3F03-9114-00D053C42277',
- ],
- 'Message' => [
- 'description' => 'The response parameters.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['description' => 'The status code.'."\n"
+ ."\n"
+ .'- 200: The request was successful.'."\n"
+ ."\n"
+ .'- Other codes: The request failed.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '24B652B5-AEFF-3F03-9114-00D053C42277', 'title' => ''],
+ 'Message' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Data' => [
- 'description' => 'The CIDR blocks.'."\n",
+ 'description' => 'The CIDR blocks.',
'type' => 'object',
'properties' => [
- 'Total' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Page' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Num' => [
- 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 100.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100'."\n",
- ],
+ 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'Page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Num' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'Nets' => [
- 'description' => 'The CIDR blocks.'."\n",
+ 'description' => 'The CIDR blocks.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'description' => 'The user ID.'."\n",
- 'type' => 'string',
- 'example' => '177xxxxxxxxxxxxx'."\n",
- ],
- 'SaleId' => [
- 'description' => 'The ID of the anti-DDoS diversion instance.'."\n",
- 'type' => 'string',
- 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx',
- ],
+ 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '57690941xxxxxxxx', 'title' => ''],
+ 'SaleId' => ['description' => 'The ID of the anti-DDoS diversion instance.', 'type' => 'string', 'example' => 'ddos_diversion_public_cn-xxxxxxxxxxxxx', 'title' => ''],
'UpstreamType' => [
'description' => 'The reinjection type. Valid values:'."\n"
."\n"
- .'* aliyun_line'."\n"
- .'* pccw_line'."\n"
- .'* gre_line'."\n"
- .'* private_line'."\n",
- 'type' => 'string',
+ .'- aliyun\\_line'."\n"
+ ."\n"
+ .'- pccw\\_line'."\n"
+ ."\n"
+ .'- gre\\_line'."\n"
+ ."\n"
+ .'- private\\_line',
'enumValueTitles' => [],
- 'example' => 'aliyun_line'."\n",
- ],
- 'Net' => [
- 'description' => 'The CIDR block of the anti-DDoS diversion instance.'."\n",
- 'type' => 'string',
- 'example' => '192.168.XX.XX/24'."\n",
- ],
- 'NetType' => [
- 'description' => 'The type of the CIDR block.'."\n",
'type' => 'string',
- 'example' => 'ipv4'."\n",
+ 'example' => 'aliyun_line',
+ 'title' => '',
],
+ 'Net' => ['description' => 'The CIDR block of the anti-DDoS diversion instance.', 'type' => 'string', 'example' => '192.168.XX.XX/24', 'title' => ''],
+ 'NetType' => ['description' => 'The type of the CIDR block.', 'type' => 'string', 'example' => 'ipv4', 'title' => ''],
'Mode' => [
'description' => 'The scheduling mode. Valid values:'."\n"
."\n"
- .'* netflow-auto'."\n"
- .'* manual'."\n",
- 'type' => 'string',
+ .'- netflow-auto'."\n"
+ ."\n"
+ .'- manual',
'enumValueTitles' => [],
- 'example' => 'manual'."\n",
+ 'type' => 'string',
+ 'example' => 'manual',
+ 'title' => '',
],
'DeclaredState' => [
'description' => 'The advertising status of the CIDR block. Valid values:'."\n"
."\n"
- .'* 0: The CIDR block is not advertised.'."\n"
- .'* 1: The CIDR block is advertised.'."\n",
+ .'- 0: The CIDR block is not advertised.'."\n"
+ ."\n"
+ .'- 1: The CIDR block is advertised.',
+ 'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
- 'enumValueTitles' => [],
- 'example' => '1',
+ 'example' => '0',
+ 'title' => '',
],
'Declared' => [
- 'description' => 'The advertising details.'."\n",
+ 'description' => 'The advertising details.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Region' => [
- 'description' => 'The region in which the CIDR block is advertised. Valid values:'."\n"
- ."\n"
- .'* oe26: China (Hong Kong).'."\n"
- .'* us50: US (Virginia).'."\n"
- .'* oe24: US (Silicon Valley).'."\n"
- .'* oe28: Singapore.'."\n"
- .'* jp141: Japan (Tokyo).'."\n"
- .'* Gb145: UK (London).'."\n"
- .'* oi39: Germany (Frankfurt).'."\n",
- 'type' => 'string',
- 'example' => 'oe26'."\n",
- ],
+ 'Region' => ['description' => 'The region in which the CIDR block is advertised. Valid values:'."\n"
+ ."\n"
+ .'- oe26: China (Hong Kong).'."\n"
+ ."\n"
+ .'- us50: US (Virginia).'."\n"
+ ."\n"
+ .'- oe24: US (Silicon Valley).'."\n"
+ ."\n"
+ .'- oe28: Singapore.'."\n"
+ ."\n"
+ .'- jp141: Japan (Tokyo).'."\n"
+ ."\n"
+ .'- Gb145: UK (London).'."\n"
+ ."\n"
+ .'- oi39: Germany (Frankfurt).', 'type' => 'string', 'example' => 'oe26', 'title' => ''],
'Declared' => [
'description' => 'Indicates whether the CIDR block is advertised. Valid values:'."\n"
."\n"
- .'* 0: The CIDR block is not advertised.'."\n"
- .'* 1: The CIDR block is advertised.'."\n",
- 'type' => 'string',
+ .'- 0: The CIDR block is not advertised.'."\n"
+ ."\n"
+ .'- 1: The CIDR block is advertised.',
'enumValueTitles' => [],
+ 'type' => 'string',
'example' => '0',
+ 'title' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'GmtCreate' => [
- 'description' => 'The creation time.'."\n",
- 'type' => 'string',
- 'example' => '2023-02-23 00:00:00'."\n",
- ],
- 'GmtModify' => [
- 'description' => 'The modification time.'."\n",
- 'type' => 'string',
- 'example' => '2023-02-24 00:00:00'."\n",
- ],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-09-05 13:52:50', 'title' => ''],
+ 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2024-09-05 13:59:55', 'title' => ''],
'NetExtend' => [
'description' => 'Indicates whether the CIDR block needs to be extended. Valid values:'."\n"
."\n"
- .'* 0: The CIDR block does not need to be extended.'."\n"
- .'* 1: The CIDR block needs to be extended.'."\n",
- 'type' => 'string',
+ .'- 0: The CIDR block does not need to be extended.'."\n"
+ ."\n"
+ .'- 1: The CIDR block needs to be extended.',
'enumValueTitles' => [],
- 'example' => '1',
+ 'type' => 'string',
+ 'example' => '0',
+ 'title' => '',
],
'DDoSDefense' => [
- 'description' => 'The DDoS mitigation configuration of the CIDR block.'."\n",
+ 'description' => 'The DDoS mitigation configuration of the CIDR block.',
'type' => 'object',
'properties' => [
'DjPolicy' => [
- 'description' => 'The configuration of the mitigation policy.'."\n",
+ 'description' => 'The configuration of the mitigation policy.',
'type' => 'object',
'properties' => [
- 'PolicyName' => [
- 'description' => 'The name of the mitigation policy.'."\n",
- 'type' => 'string',
- 'example' => 'test_polilciy-xxx',
- ],
+ 'PolicyName' => ['description' => 'The name of the mitigation policy.', 'type' => 'string', 'example' => 'gf_origin_xxxxx', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'CleanTh' => [
- 'description' => 'The configuration of traffic scrubbing.'."\n",
+ 'description' => 'The configuration of traffic scrubbing.',
'type' => 'object',
'properties' => [
- 'Mbps' => [
- 'description' => 'The traffic scrubbing threshold in Mbit/s.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Pps' => [
- 'description' => 'The traffic scrubbing threshold in packets per second (pps).'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'Mbps' => ['description' => 'The traffic scrubbing threshold in Mbit/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Pps' => ['description' => 'The traffic scrubbing threshold in packets per second (pps).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'HoleTh' => [
- 'description' => 'The configuration of blackhole filtering.'."\n",
+ 'description' => 'The configuration of blackhole filtering.',
'type' => 'object',
'properties' => [
- 'ThreshMbps' => [
- 'description' => 'The blackhole filtering threshold in Mbit/s. The value 0 indicates best-effort protection.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'ThreshMbps' => ['description' => 'The blackhole filtering threshold in Mbit/s. The value 0 indicates best-effort protection.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'FwdEffect' => [
'description' => 'Indicates whether the forwarding configuration takes effect. Valid values:'."\n"
."\n"
- .'* 0: The forwarding configuration does not take effect.'."\n"
- .'* 1: The forwarding configuration takes effect.'."\n",
+ .'- 0: The forwarding configuration does not take effect.'."\n"
+ ."\n"
+ .'- 1: The forwarding configuration takes effect.',
+ 'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int64',
- 'enumValueTitles' => [],
'example' => '1',
+ 'title' => '',
],
- 'NetMain' => [
- 'description' => 'The primary CIDR block of the anti-DDoS diversion instance for which an extended CIDR block is configured. If no extended CIDR blocks are configured for the anti-DDoS diversion instance, this parameter is left empty.'."\n",
- 'type' => 'string',
- 'example' => '192.168.XX.XX/22'."\n",
- ],
+ 'NetMain' => ['description' => 'The primary CIDR block of the anti-DDoS diversion instance for which an extended CIDR block is configured. If no extended CIDR blocks are configured for the anti-DDoS diversion instance, this parameter is left empty.', 'type' => 'string', 'example' => '192.168.XX.XX/22', 'title' => ''],
'Permit' => [
'description' => 'The review status. Valid values:'."\n"
."\n"
- .'* 0: not reviewed.'."\n"
- .'* 1: reviewed.'."\n"
- .'* 2: under review.'."\n",
+ .'- 0: not reviewed.'."\n"
+ ."\n"
+ .'- 1: reviewed.'."\n"
+ ."\n"
+ .'- 2: under review.',
+ 'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
- 'enumValueTitles' => [],
'example' => '2',
+ 'title' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'AuthenticationFailed', 'errorMessage' => 'User authentication failed.', 'description' => 'User authentication failed.'],
+ ['errorCode' => 'AutoScheduleRuleExist', 'errorMessage' => 'The auto schedule rule already exists.', 'description' => 'The scheduling rule already exists.'],
+ ['errorCode' => 'AutoScheduleRuleNotExist', 'errorMessage' => 'The auto schedule rule dose not exist.', 'description' => 'The scheduling rule does not exist.'],
+ ['errorCode' => 'BlackHoleConfigurationError', 'errorMessage' => 'A black hole configuration error occurred.', 'description' => 'The blackhole filtering configuration is invalid.'],
+ ['errorCode' => 'CleanConfigurationError', 'errorMessage' => 'A clean configuration error occurred.', 'description' => 'The traffic scrubbing configuration is invalid.'],
+ ['errorCode' => 'CoveredNet', 'errorMessage' => 'The CIDR block is overwritten.', 'description' => 'The specified CIDR block overlaps with another CIDR block.'],
+ ['errorCode' => 'DatabaseError', 'errorMessage' => 'A database error.', 'description' => 'The database is invalid.'],
+ ['errorCode' => 'DeclaredNet', 'errorMessage' => 'The CIDR block has been advertised.', 'description' => 'The CIDR block is in the Advertising state.'],
+ ['errorCode' => 'DefenseConfigurationError', 'errorMessage' => 'A defense configuration error occurred.', 'description' => 'The mitigation settings are invalid.'],
+ ['errorCode' => 'ForwardConfigurationNotExist', 'errorMessage' => 'The CIDR block forwarding configuration is not found.', 'description' => 'The forwarding configuration of the CIDR block does not exist.'],
+ ['errorCode' => 'ForwardNotExist', 'errorMessage' => 'The CIDR block zone forwarding configuration is not found.', 'description' => 'The zone forwarding configuration of the CIDR block does not exist.'],
+ ['errorCode' => 'ForwardRuleNotExist', 'errorMessage' => 'The CIDR block forwarding rule is not found.', 'description' => 'The CIDR block forwarding rule does not exist.'],
+ ['errorCode' => 'HttpFailed', 'errorMessage' => 'HTTP request failed.', 'description' => 'The HTTP request failed.'],
+ ['errorCode' => 'IDNSubnetsCountLimit', 'errorMessage' => 'The maximum number of IDCs of the instance is exceeded.', 'description' => 'The number of data centers for the instance has reached the upper limit.'],
+ ['errorCode' => 'InstanceExist', 'errorMessage' => 'The instance already exists.', 'description' => 'The instance already exists.'],
+ ['errorCode' => 'InstanceNetConfigurationExist', 'errorMessage' => 'The instance CIDR block configuration already exists.', 'description' => 'The CIDR block configuration of the instance already exists.'],
+ ['errorCode' => 'InstanceNotExist', 'errorMessage' => 'The instance is not found.', 'description' => 'The instance does not exist.'],
+ ['errorCode' => 'InstanceUpstreamLimit', 'errorMessage' => 'The maximum number of reinjection configurations for the instance is exceeded.', 'description' => 'The number of reinjection configurations of the instance is limited.'],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => 'An internal error occurred.'],
+ ['errorCode' => 'InvalidNet', 'errorMessage' => 'Invalid CIDR block.', 'description' => 'The CIDR block is invalid.'],
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid parameter value.', 'description' => 'The parameter is invalid.'],
+ ['errorCode' => 'IPSubnetsCountLimit', 'errorMessage' => 'The maximum number of CIDR blocks of the instance is exceeded.', 'description' => 'The number of CIDR blocks of the instance has reached the upper limit.'],
+ ['errorCode' => 'NetCannotExtend', 'errorMessage' => 'The CIDR block cannot be extended.', 'description' => 'The CIDR block cannot be expanded.'],
+ ['errorCode' => 'NetConfigurationExist', 'errorMessage' => 'The CIDR block configuration already exists.', 'description' => 'The CIDR block configuration already exists.'],
+ ['errorCode' => 'NetConfigurationNotExist', 'errorMessage' => 'The CIDR block configuration is not found.', 'description' => 'The CIDR block configuration does not exist.'],
+ ['errorCode' => 'NetForwardDelete', 'errorMessage' => 'The CIDR block forwarding is being deleted.', 'description' => 'The forwarding configuration of the CIDR block is being deleted.'],
+ ['errorCode' => 'NetMaskOutOfRange', 'errorMessage' => 'The subnet mask of the CIDR block is invalid.', 'description' => 'The subnet mask exceeds the upper limit.'],
+ ['errorCode' => 'NetNeedExtend', 'errorMessage' => 'The CIDR block needs to be extended.', 'description' => 'The CIDR block needs to be expanded.'],
+ ['errorCode' => 'NetStatusNotReady', 'errorMessage' => 'The CIDR block reinjection configuration has not been completed.', 'description' => 'Failed to complete the reinjection configuration of the CIDR block.'],
+ ['errorCode' => 'NetworkDeclearedFailed', 'errorMessage' => 'Failed to advertise the CIDR block.', 'description' => 'Failed to advertise the CIDR block.'],
+ ['errorCode' => 'NetWorkNotExist', 'errorMessage' => 'The CIDR block is not found.', 'description' => 'The CIDR block does not exist.'],
+ ['errorCode' => 'NetworkUndeclearedFailed', 'errorMessage' => 'Failed to cancel the advertisement of the CIDR block.', 'description' => 'Failed to withdraw the advertising of the CIDR block.'],
+ ['errorCode' => 'ParameterNotEnough', 'errorMessage' => 'Required parameters are not specified.', 'description' => 'A required parameter is not specified.'],
+ ['errorCode' => 'ParameterOutOfRange', 'errorMessage' => 'Invalid parameter value.', 'description' => 'The value of the parameter is invalid.'],
+ ['errorCode' => 'RegionNotExist', 'errorMessage' => 'The region does not exist.', 'description' => 'The zone does not exist.'],
+ ['errorCode' => 'RequestMethodError', 'errorMessage' => 'An incorrect request method.', 'description' => 'The request method is invalid.'],
+ ['errorCode' => 'SubnetCountLimit', 'errorMessage' => 'The maximum number of subnets is exceeded.', 'description' => 'The number of subnets has reached the upper limit.'],
+ ['errorCode' => 'UnKnownError', 'errorMessage' => 'An unknown error occurred.', 'description' => 'An unknown error occurred.'],
+ ['errorCode' => 'UpsteamNotComplete', 'errorMessage' => 'The reinjection configuration has not been completed.', 'description' => 'Failed to complete the reinjection configuration of the CIDR block.'],
+ ['errorCode' => 'UpstreamConfigurationNotExist', 'errorMessage' => 'The reinjection configuration is not found.', 'description' => 'The reinjection configuration does not exist.'],
+ ['errorCode' => 'JsonDecodeError', 'errorMessage' => 'JSON string decoding failed.', 'description' => 'Failed to convert JSON string to JSON object.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'QueryNetList',
+ 'summary' => 'Queries the CIDR blocks of an anti-DDoS diversion instance.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ddosdiversion:QueryNetList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DdosDiversion', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'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' => 'QueryNetList',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'ddosdiversion.cn-hongkong.aliyuncs.com',
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ddosdiversion.cn-hongkong.aliyuncs.com', 'endpoint' => 'ddosdiversion.cn-hongkong.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AuthenticationFailed', 'message' => 'User authentication failed.', 'http_code' => 400, 'description' => 'User authentication failed.'],
+ ['code' => 'AutoScheduleRuleExist', 'message' => 'The auto schedule rule already exists.', 'http_code' => 400, 'description' => 'The scheduling rule already exists.'],
+ ['code' => 'AutoScheduleRuleNotExist', 'message' => 'The auto schedule rule dose not exist.', 'http_code' => 400, 'description' => 'The scheduling rule does not exist.'],
+ ['code' => 'BlackHoleConfigurationError', 'message' => 'A black hole configuration error occurred.', 'http_code' => 400, 'description' => 'The blackhole filtering configuration is invalid.'],
+ ['code' => 'CleanConfigurationError', 'message' => 'A clean configuration error occurred.', 'http_code' => 400, 'description' => 'The traffic scrubbing configuration is invalid.'],
+ ['code' => 'CoveredNet', 'message' => 'The CIDR block is overwritten.', 'http_code' => 400, 'description' => 'The specified CIDR block overlaps with another CIDR block.'],
+ ['code' => 'DatabaseError', 'message' => 'A database error.', 'http_code' => 400, 'description' => 'The database is invalid.'],
+ ['code' => 'DeclaredNet', 'message' => 'The CIDR block has been advertised.', 'http_code' => 400, 'description' => 'The CIDR block is in the Advertising state.'],
+ ['code' => 'DefenseConfigurationError', 'message' => 'A defense configuration error occurred.', 'http_code' => 400, 'description' => 'The mitigation settings are invalid.'],
+ ['code' => 'ForwardConfigurationNotExist', 'message' => 'The CIDR block forwarding configuration is not found.', 'http_code' => 400, 'description' => 'The forwarding configuration of the CIDR block does not exist.'],
+ ['code' => 'ForwardNotExist', 'message' => 'The CIDR block zone forwarding configuration is not found.', 'http_code' => 400, 'description' => 'The zone forwarding configuration of the CIDR block does not exist.'],
+ ['code' => 'ForwardRuleNotExist', 'message' => 'The CIDR block forwarding rule is not found.', 'http_code' => 400, 'description' => 'The CIDR block forwarding rule does not exist.'],
+ ['code' => 'GreLineExist', 'message' => 'local gre line still exist.', 'http_code' => 400, 'description' => 'Local gre lines still exist'],
+ ['code' => 'GreLineNotExist', 'message' => 'local gre line not exist.', 'http_code' => 400, 'description' => 'gre line does not exist'],
+ ['code' => 'GreRemoteAddrUsed', 'message' => 'GRE remote IP already in use.', 'http_code' => 400, 'description' => 'The GRE tunnel far-end IP is already in use.'],
+ ['code' => 'HttpFailed', 'message' => 'HTTP request failed.', 'http_code' => 400, 'description' => 'The HTTP request failed.'],
+ ['code' => 'IDNSubnetsCountLimit', 'message' => 'The maximum number of IDCs of the instance is exceeded.', 'http_code' => 400, 'description' => 'The number of data centers for the instance has reached the upper limit.'],
+ ['code' => 'InstanceExist', 'message' => 'The instance already exists.', 'http_code' => 400, 'description' => 'The instance already exists.'],
+ ['code' => 'InstanceNetConfigurationExist', 'message' => 'The instance CIDR block configuration already exists.', 'http_code' => 400, 'description' => 'The CIDR block configuration of the instance already exists.'],
+ ['code' => 'InstanceNotExist', 'message' => 'The instance is not found.', 'http_code' => 400, 'description' => 'The instance does not exist.'],
+ ['code' => 'InstanceUpstreamLimit', 'message' => 'The maximum number of reinjection configurations for the instance is exceeded.', 'http_code' => 400, 'description' => 'The number of reinjection configurations of the instance is limited.'],
+ ['code' => 'InternalError', 'message' => 'An internal error occurred.', 'http_code' => 400, 'description' => 'An internal error occurred.'],
+ ['code' => 'InvalidNet', 'message' => 'Invalid CIDR block.', 'http_code' => 400, 'description' => 'The CIDR block is invalid.'],
+ ['code' => 'InvalidParam', 'message' => 'Invalid parameter value.', 'http_code' => 400, 'description' => 'The parameter is invalid.'],
+ ['code' => 'IPSubnetsCountLimit', 'message' => 'The maximum number of CIDR blocks of the instance is exceeded.', 'http_code' => 400, 'description' => 'The number of CIDR blocks of the instance has reached the upper limit.'],
+ ['code' => 'JsonDecodeError', 'message' => 'JSON string decoding failed.', 'http_code' => 400, 'description' => 'Failed to convert JSON string to JSON object.'],
+ ['code' => 'NetCannotExtend', 'message' => 'The CIDR block cannot be extended.', 'http_code' => 400, 'description' => 'The CIDR block cannot be expanded.'],
+ ['code' => 'NetConfigNotPermit', 'message' => 'Network segment configuration not approved.', 'http_code' => 400, 'description' => 'Network segment configuration not approved'],
+ ['code' => 'NetConfigurationExist', 'message' => 'The CIDR block configuration already exists.', 'http_code' => 400, 'description' => 'The CIDR block configuration already exists.'],
+ ['code' => 'NetConfigurationNotExist', 'message' => 'The CIDR block configuration is not found.', 'http_code' => 400, 'description' => 'The CIDR block configuration does not exist.'],
+ ['code' => 'NetForwardDelete', 'message' => 'The CIDR block forwarding is being deleted.', 'http_code' => 400, 'description' => 'The forwarding configuration of the CIDR block is being deleted.'],
+ ['code' => 'NetMaskOutOfRange', 'message' => 'The subnet mask of the CIDR block is invalid.', 'http_code' => 400, 'description' => 'The subnet mask exceeds the upper limit.'],
+ ['code' => 'NetNeedExtend', 'message' => 'The CIDR block needs to be extended.', 'http_code' => 400, 'description' => 'The CIDR block needs to be expanded.'],
+ ['code' => 'NetNhpoolUsedByNet', 'message' => 'Nh Pool is Used By Net.', 'http_code' => 400, 'description' => 'The GRE reinjection line has been bound to a network segment and cannot be deleted.'],
+ ['code' => 'NetStatusNotReady', 'message' => 'The CIDR block reinjection configuration has not been completed.', 'http_code' => 400, 'description' => 'Failed to complete the reinjection configuration of the CIDR block.'],
+ ['code' => 'NetworkDeclearedFailed', 'message' => 'Failed to advertise the CIDR block.', 'http_code' => 400, 'description' => 'Failed to advertise the CIDR block.'],
+ ['code' => 'NetWorkNotExist', 'message' => 'The CIDR block is not found.', 'http_code' => 400, 'description' => 'The CIDR block does not exist.'],
+ ['code' => 'NetworkUndeclearedFailed', 'message' => 'Failed to cancel the advertisement of the CIDR block.', 'http_code' => 400, 'description' => 'Failed to withdraw the advertising of the CIDR block.'],
+ ['code' => 'NhPoolMemberExist', 'message' => 'nh pool member already exist.', 'http_code' => 400, 'description' => 'The nh pool member already exists.'],
+ ['code' => 'NhPoolMemberNotExist', 'message' => 'nh pool member not exist.', 'http_code' => 400, 'description' => 'nh pool does not exist'],
+ ['code' => 'NhpoolNotExist', 'message' => 'nh pool not exist.', 'http_code' => 400, 'description' => 'nh_pool does not exist'],
+ ['code' => 'ParameterNotEnough', 'message' => 'Required parameters are not specified.', 'http_code' => 400, 'description' => 'A required parameter is not specified.'],
+ ['code' => 'ParameterOutOfRange', 'message' => 'Invalid parameter value.', 'http_code' => 400, 'description' => 'The value of the parameter is invalid.'],
+ ['code' => 'RegionNotExist', 'message' => 'The region does not exist.', 'http_code' => 400, 'description' => 'The zone does not exist.'],
+ ['code' => 'RequestMethodError', 'message' => 'An incorrect request method.', 'http_code' => 400, 'description' => 'The request method is invalid.'],
+ ['code' => 'SubnetCountLimit', 'message' => 'The maximum number of subnets is exceeded.', 'http_code' => 400, 'description' => 'The number of subnets has reached the upper limit.'],
+ ['code' => 'UnKnownError', 'message' => 'An unknown error occurred.', 'http_code' => 400, 'description' => 'An unknown error occurred.'],
+ ['code' => 'UpsteamNotComplete', 'message' => 'The reinjection configuration has not been completed.', 'http_code' => 400, 'description' => 'Failed to complete the reinjection configuration of the CIDR block.'],
+ ['code' => 'UpstreamConfigurationNotExist', 'message' => 'The reinjection configuration is not found.', 'http_code' => 400, 'description' => 'The reinjection configuration does not exist.'],
+ ['code' => 'UpstreamRegionUsedByNet', 'message' => 'The reinjection region configuration is still used by CIDR block.', 'http_code' => 400, 'description' => 'Failed to delete the location because a CIDR block is associated with the location.'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ram' => [
+ 'productCode' => 'DdosDiversion',
+ 'productName' => 'Anti-DDoS',
+ 'ramCodes' => ['ddosdiversion'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'ListInstance',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ddosdiversion:ListInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DdosDiversion', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConfigNetStatus',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ddosdiversion:ConfigNetStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DdosDiversion', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryNetList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ddosdiversion:QueryNetList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'DdosDiversion', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];