diff options
Diffstat (limited to 'data/en_us/antiddos-public/2017-05-18')
| -rw-r--r-- | data/en_us/antiddos-public/2017-05-18/api-docs.php | 2161 |
1 files changed, 2161 insertions, 0 deletions
diff --git a/data/en_us/antiddos-public/2017-05-18/api-docs.php b/data/en_us/antiddos-public/2017-05-18/api-docs.php new file mode 100644 index 0000000..dcd1036 --- /dev/null +++ b/data/en_us/antiddos-public/2017-05-18/api-docs.php @@ -0,0 +1,2161 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'antiddos-public', + 'version' => '2017-05-18', + ], + 'directories' => [ + [ + 'id' => 177779, + 'title' => 'Regions', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 95144, + 'title' => 'Assets', + 'type' => 'directory', + 'children' => [ + 'DescribeDdosCredit', + 'DescribeInstance', + 'DescribeDdosThreshold', + 'DescribeBgpPackByIp', + 'DescribeInstanceIpAddress', + 'DescribeIpDdosThreshold', + 'DescribeIpLocationService', + ], + ], + [ + 'id' => 95150, + 'title' => 'Protection', + 'type' => 'directory', + 'children' => [ + 'ModifyIpDefenseThreshold', + 'ModifyDefenseThreshold', + 'DescribeDdosEventList', + 'DescribeDdosCount', + 'DescribeCap', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeRegions' => [ + 'summary' => 'Queries the regions in which Anti-DDoS Origin Basic is available.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5093C7EE-8E27-5FC9-9B88-40626BA540C0', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'An array consisting of regions in which Anti-DDoS Origin Basic is available.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the region.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionEnName' => [ + 'description' => 'The English name of the region.'."\n", + 'type' => 'string', + 'example' => 'East China 1', + ], + 'RegionName' => [ + 'description' => 'The Chinese name of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'RegionNoAlias' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionNo' => [ + 'description' => 'The code of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-dg-a01', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5093C7EE-8E27-5FC9-9B88-40626BA540C0\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEnName\\": \\"East China 1\\",\\n \\"RegionName\\": \\"华东1（杭州）\\",\\n \\"RegionNoAlias\\": \\"cn-hangzhou\\",\\n \\"RegionNo\\": \\"cn-hangzhou-dg-a01\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>5093C7EE-8E27-5FC9-9B88-40626BA540C0</RequestId>\\n <Regions>\\n <Region>\\n <RegionNo>cn-qingdao-cm5-a01</RegionNo>\\n <RegionName>华北1（青岛）</RegionName>\\n <RegionEnName>North China 1</RegionEnName>\\n <RegionNoAlias>cn-qingdao</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-zhangjiakou-spe-na62-a01</RegionNo>\\n <RegionName>张北SPE</RegionName>\\n <RegionEnName>Zhangbei SPE Zone</RegionEnName>\\n <RegionNoAlias>cn-zhangjiakou-spe</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-chengdu-wt97-a01</RegionNo>\\n <RegionName>西南1（成都）</RegionName>\\n <RegionEnName>China (Chengdu)</RegionEnName>\\n <RegionNoAlias>cn-chengdu</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-beijing-btc-a01</RegionNo>\\n <RegionName>华北2（北京）</RegionName>\\n <RegionEnName>North China 2</RegionEnName>\\n <RegionNoAlias>cn-beijing</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-nanjing-lnj1-a01</RegionNo>\\n <RegionName>华东5（南京-本地地域）</RegionName>\\n <RegionEnName>China (Nanjing-Local Region)</RegionEnName>\\n <RegionNoAlias>cn-nanjing</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-shanghai-eu13-a01</RegionNo>\\n <RegionName>华东2（上海）</RegionName>\\n <RegionEnName>East China 2</RegionEnName>\\n <RegionNoAlias>cn-shanghai</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>rus-west-1-ru151-a01</RegionNo>\\n <RegionName>俄罗斯（莫斯科）</RegionName>\\n <RegionEnName>Russia (Moscow)</RegionEnName>\\n <RegionNoAlias>rus-west-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>us-east-us44-a01</RegionNo>\\n <RegionName>美国（弗吉尼亚）</RegionName>\\n <RegionEnName>US East 1 (Virginia)</RegionEnName>\\n <RegionNoAlias>us-east-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>eu-west-1-gb33-a01</RegionNo>\\n <RegionName>英国（伦敦）</RegionName>\\n <RegionEnName>UK(London)</RegionEnName>\\n <RegionNoAlias>eu-west-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-hangzhou-dg-a01</RegionNo>\\n <RegionName>华东1（杭州）</RegionName>\\n <RegionEnName>East China 1</RegionEnName>\\n <RegionNoAlias>cn-hangzhou</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-hongkong-am4-c04</RegionNo>\\n <RegionName>中国（香港）</RegionName>\\n <RegionEnName>cn-hongkong</RegionEnName>\\n <RegionNoAlias>cn-hongkong</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>ap-southeast-my88-a01</RegionNo>\\n <RegionName>马来西亚（吉隆坡）</RegionName>\\n <RegionEnName>Asia Pacific SE 3 (Kuala Lumpur)</RegionEnName>\\n <RegionNoAlias>ap-southeast-3</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>us-west-ot7-a01</RegionNo>\\n <RegionName>美国（硅谷）</RegionName>\\n <RegionEnName>US West 1 (Silicon Valley)</RegionEnName>\\n <RegionNoAlias>us-west-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>me-east-db47-a01</RegionNo>\\n <RegionName>阿联酋（迪拜）</RegionName>\\n <RegionEnName>Middle East 1 (Dubai)</RegionEnName>\\n <RegionNoAlias>me-east-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>ap-northeast-jp59-a01</RegionNo>\\n <RegionName>日本（东京）</RegionName>\\n <RegionEnName>Asia Pacific NE 1 (Tokyo)</RegionEnName>\\n <RegionNoAlias>ap-northeast-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-huhehaote-nt12-a01</RegionNo>\\n <RegionName>华北5（呼和浩特）</RegionName>\\n <RegionEnName>China North 5 (Huhehaote)</RegionEnName>\\n <RegionNoAlias>cn-huhehaote</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>ap-southeast-au49-a01</RegionNo>\\n <RegionName>澳大利亚（悉尼）</RegionName>\\n <RegionEnName>Asia Pacific SE 2 (Sydney)</RegionEnName>\\n <RegionNoAlias>ap-southeast-2</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>ap-southeast-id35-a01</RegionNo>\\n <RegionName>印度尼西亚（雅加达）</RegionName>\\n <RegionEnName>Asia Pacific SE 5 (Jakarta)</RegionEnName>\\n <RegionNoAlias>ap-southeast-5</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>ap-south-in73-a01</RegionNo>\\n <RegionName>印度（孟买）</RegionName>\\n <RegionEnName>Asia Pacific SOU 1 (Mumbai)</RegionEnName>\\n <RegionNoAlias>ap-south-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-zhangjiakou-na62-a01</RegionNo>\\n <RegionName>华北3（张家口）</RegionName>\\n <RegionEnName>China North 3 (Zhangjiakou)</RegionEnName>\\n <RegionNoAlias>cn-zhangjiakou</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-shenzhen-st3-a01</RegionNo>\\n <RegionName>华南1（深圳）</RegionName>\\n <RegionEnName>South China 1</RegionEnName>\\n <RegionNoAlias>cn-shenzhen</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>eu-central-de46-a01</RegionNo>\\n <RegionName>德国（法兰克福）</RegionName>\\n <RegionEnName>EU Central 1 (Frankfurt)</RegionEnName>\\n <RegionNoAlias>eu-central-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-guangzhou-so157-a01</RegionNo>\\n <RegionName>华南3（广州）</RegionName>\\n <RegionEnName>China (Guangzhou)</RegionEnName>\\n <RegionNoAlias>cn-guangzhou</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>ap-southeast-6</RegionNo>\\n <RegionName>菲律宾（马尼拉）</RegionName>\\n <RegionEnName>Philippines (Manila)</RegionEnName>\\n <RegionNoAlias>ap-southeast-6</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-heyuan-sa127-a01</RegionNo>\\n <RegionName>华南2（河源）</RegionName>\\n <RegionEnName>China (Heyuan)</RegionEnName>\\n <RegionNoAlias>cn-heyuan</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>ap-southeast-os30-a01</RegionNo>\\n <RegionName>新加坡</RegionName>\\n <RegionEnName>Asia Pacific SE 1 (Singapore)</RegionEnName>\\n <RegionNoAlias>ap-southeast-1</RegionNoAlias>\\n </Region>\\n <Region>\\n <RegionNo>cn-wulanchabu-na130-a01</RegionNo>\\n <RegionName>华北6（乌兰察布）</RegionName>\\n <RegionEnName>China (Ulanqab)</RegionEnName>\\n <RegionNoAlias>cn-wulanchabu</RegionNoAlias>\\n </Region>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', + 'title' => 'DescribeRegions', + 'description' => 'You can call this operation to query information about the regions in which Anti-DDoS Origin Basic is available. The information includes the region ID, region name, and code.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeDdosCredit' => [ + 'summary' => 'Queries the details of the security credit score of the current Alibaba Cloud account in a specific region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E1F7BD73-8E9D-58D9-8658-CFC97112C641', + ], + 'DdosCredit' => [ + 'description' => 'The details of the security credit score of the current Alibaba Cloud account in the specified region.'."\n", + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => 'The security credit score. The full score is **1000**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '550', + ], + 'ScoreLevel' => [ + 'description' => 'The security credit level. Valid values:'."\n" + ."\n" + .'* **A**: outstanding'."\n" + .'* **B**: excellent'."\n" + .'* **C**: good'."\n" + .'* **D**: average'."\n" + .'* **E**: poor'."\n" + .'* **F**: poorer'."\n", + 'type' => 'string', + 'example' => 'D', + ], + 'BlackholeTime' => [ + 'description' => 'The time period after which blackhole filtering is automatically deactivated in the specified region. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E1F7BD73-8E9D-58D9-8658-CFC97112C641\\",\\n \\"DdosCredit\\": {\\n \\"Score\\": 550,\\n \\"ScoreLevel\\": \\"D\\",\\n \\"BlackholeTime\\": 150\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDdosCreditResponse>\\n <Success>true</Success>\\n <RequestId>E1F7BD73-8E9D-58D9-8658-CFC97112C641</RequestId>\\n <DdosCredit>\\n <Score>550</Score>\\n <ScoreLevel>D</ScoreLevel>\\n <BlackholeTime>150</BlackholeTime>\\n </DdosCredit>\\n</DescribeDdosCreditResponse>","errorExample":""}]', + 'title' => 'DescribeDdosCredit', + 'description' => 'You can call the DescribeDdosCredit operation to query the details of the security credit score of the current Alibaba Cloud account in a specific region. The details include the security credit score, security credit level, and the time period after which blackhole filtering is automatically deactivated.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeInstance' => [ + 'summary' => 'Queries the details of the assets within the current Alibaba Cloud account. The assets can be elastic IP addresses (EIPs). The assets can also be Elastic Compute Service (ECS) instances or Server Load Balancer (SLB) instances that are assigned public IP addresses. This operation is phased out. We recommend that you use the DescribeInstanceIpAddress operation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset to query. Valid values:'."\n" + ."\n" + .'* **ecs**: ECS instances.'."\n" + .'* **slb**: SLB instances.'."\n" + .'* **eip**: EIPs.'."\n" + .'* **ipv6**: IPv6 gateways.'."\n" + .'* **swas**: simple application servers.'."\n" + .'* **waf**: Web Application Firewall (WAF) instances of the Exclusive edition.'."\n" + .'* **ga_basic**: Global Accelerator (GA) instances.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the asset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'launch-advisor-2022****', + ], + ], + [ + 'name' => 'DdosStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DDoS mitigation status of the asset. Valid values:'."\n" + ."\n" + .'* **mitigating**: queries assets for which traffic scrubbing is triggered.'."\n" + .'* **blackholed**: queries assets for which blackhole filtering is triggered.'."\n" + .'* **normal**: queries assets that are not under DDoS attacks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'blackholed', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the asset. The formats of asset IDs vary based on the value of the **InstanceType**. parameter.'."\n" + ."\n" + .'* If you set **InstanceType** to **ecs**, specify the ID of the ECS instance. For example, you can specify i-bp1cb6x80tfgocid\\*\\*\\*\\*.'."\n" + .'* If you set **InstanceType** to **slb**, specify the ID of the SLB instance. For example, you can specify alb-vn2dqg3v31y2vd\\*\\*\\*\\*.'."\n" + .'* If you set **InstanceType** to **eip**, specify the ID of the EIP. For example, you can specify eip-j6ce6dcx9epi7rs46\\*\\*\\*\\*.', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1cb6x80tfgocid****', + ], + ], + [ + 'name' => 'InstanceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '121.199.XX.XX', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => 'The total number of the assets.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C728D7E9-9A39-52E0-966B-5C33118BDBB0', + ], + 'InstanceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => 'The details of the assets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceIp' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'example' => '121.199.XX.XX', + ], + 'IsBgppack' => [ + 'description' => 'Indicates whether the asset is associated with an Anti-DDoS Origin Basic instance. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'IpVersion' => [ + 'description' => 'The IP protocol that is supported by the asset. Valid values:'."\n" + ."\n" + .'* **v4**: IPv4'."\n" + .'* **v6**: IPv6'."\n", + 'type' => 'string', + 'example' => 'v4', + ], + 'ElasticThreshold' => [ + 'description' => 'The burstable protection threshold for the asset. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12310', + ], + 'BlackholeThreshold' => [ + 'description' => 'The basic protection threshold for the asset. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5200', + ], + 'DefenseBpsThreshold' => [ + 'description' => 'The traffic scrubbing threshold for the asset. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'InstanceName' => [ + 'description' => 'The name of the asset.'."\n", + 'type' => 'string', + 'example' => 'launch-advisor-2021****', + ], + 'InstanceStatus' => [ + 'description' => 'The DDoS mitigation status of the asset. Valid values:'."\n" + ."\n" + .'* **mitigating**: indicates that traffic scrubbing is triggered for the asset.'."\n" + .'* **blackholed**: indicates that blackhole filtering is triggered for the asset.'."\n" + .'* **normal**: indicates that the instance is normal.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'DefensePpsThreshold' => [ + 'description' => 'The packet scrubbing threshold for the asset. Unit: packets per second (pps).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70000', + ], + 'InstanceId' => [ + 'description' => 'The ID of the asset.'."\n", + 'type' => 'string', + 'example' => 'i-bp1cb6x80tfgocid****', + ], + 'InstanceType' => [ + 'description' => 'The type of the asset.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 1,\\n \\"RequestId\\": \\"C728D7E9-9A39-52E0-966B-5C33118BDBB0\\",\\n \\"InstanceList\\": {\\n \\"Instance\\": [\\n {\\n \\"InstanceIp\\": \\"121.199.XX.XX\\",\\n \\"IsBgppack\\": false,\\n \\"IpVersion\\": \\"v4\\",\\n \\"ElasticThreshold\\": 12310,\\n \\"BlackholeThreshold\\": 5200,\\n \\"DefenseBpsThreshold\\": 300,\\n \\"InstanceName\\": \\"launch-advisor-2021****\\",\\n \\"InstanceStatus\\": \\"normal\\",\\n \\"DefensePpsThreshold\\": 70000,\\n \\"InstanceId\\": \\"i-bp1cb6x80tfgocid****\\",\\n \\"InstanceType\\": \\"ecs\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceResponse>\\n <Total>1</Total>\\n <RequestId>C728D7E9-9A39-52E0-966B-5C33118BDBB0</RequestId>\\n <InstanceList>\\n <InstanceIp>121.199.XX.XX</InstanceIp>\\n <IsBgppack>false</IsBgppack>\\n <IpVersion>v4</IpVersion>\\n <ElasticThreshold>12310</ElasticThreshold>\\n <BlackholeThreshold>5200</BlackholeThreshold>\\n <DefenseBpsThreshold>300</DefenseBpsThreshold>\\n <InstanceName>launch-advisor-2021****</InstanceName>\\n <InstanceStatus>normal</InstanceStatus>\\n <DefensePpsThreshold>70000</DefensePpsThreshold>\\n <InstanceId>i-bp1cb6x80tfgocid****</InstanceId>\\n <InstanceType>ecs</InstanceType>\\n </InstanceList>\\n</DescribeInstanceResponse>","errorExample":""}]', + 'title' => 'DescribeInstance', + 'description' => 'You can call the DescribeInstance operation to query the details of the assets that are within the current Alibaba Cloud account by page. The details include the IDs and IP addresses of the assets, the basic protection thresholds and traffic scrubbing thresholds that are configured for the assets in Anti-DDoS Origin, and whether the assets are associated with Anti-DDoS Origin instances.'."\n" + ."\n" + .'### [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 200 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeDdosThreshold' => [ + 'summary' => 'Queries the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified assets. The assets can be elastic IP addresses (EIPs). The assets can also be Elastic Compute Service (ECS) instances or Server Load Balancer (SLB) instances that are assigned public IP addresses.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DdosType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the threshold. Valid values:'."\n" + ."\n" + .'* **defense**: traffic scrubbing threshold'."\n" + .'* **blackhole**: DDoS mitigation threshold'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'defense', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset that is assigned a public IP address. Valid values:'."\n" + ."\n" + .'* **ecs**: ECS instances.'."\n" + .'* **slb**: SLB instances.'."\n" + .'* **eip**: EIPs.'."\n" + .'* **ipv6**: IPv6 gateways.'."\n" + .'* **swas**: simple application servers.'."\n" + .'* **waf**: Web Application Firewall (WAF) instances of the Exclusive edition.'."\n" + .'* **ga_basic**: Global Accelerator (GA) instances.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of asset N to query.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of asset N. The maximum value of N is 200. You can specify up to 200 assets. Separate the IDs of multiple assets with commas (,).'."\n" + ."\n" + .'> You can call the [DescribeInstance](~~354191~~) operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp10bclrt56fblts****', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'E9B3C090-55AD-59C6-979E-FCFD81E7D9E7', + ], + 'Thresholds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Threshold' => [ + 'description' => 'An array that consists of the details of the threshold.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DdosType' => [ + 'description' => 'The type of the threshold. Valid values:'."\n" + ."\n" + .'* **defense**: traffic scrubbing threshold'."\n" + .'* **blackhole**: DDoS mitigation threshold'."\n", + 'type' => 'string', + 'example' => 'defense', + ], + 'IsAuto' => [ + 'description' => 'Indicates whether the threshold is automatically adjusted. Valid values:'."\n" + ."\n" + .'* **true**: The scrubbing thresholds are automatically adjusted based on the traffic load on the asset.'."\n" + .'* **false**: The scrubbing thresholds are not automatically adjusted. You must manually specify the scrubbing thresholds.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'MaxBps' => [ + 'description' => 'The maximum traffic scrubbing threshold. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'ElasticBps' => [ + 'description' => 'The burstable protection threshold (the maximum DDoS mitigation threshold). Unit: Mbit/s.'."\n" + ."\n" + .'> This parameter is returned only when the value of the **DdosType** parameter is **blackhole**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12310', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp10bclrt56fblts****', + ], + 'Bps' => [ + 'description' => 'If the value of the **DdosType** parameter is **defense**, the Bps parameter indicates the current traffic scrubbing threshold. Unit: Mbit/s.'."\n" + ."\n" + .'If the value of the **DdosType** parameter is **blackhole**, the Bps parameter indicates the basic protection threshold. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'Pps' => [ + 'description' => 'The packet scrubbing threshold. Unit: pps.'."\n" + ."\n" + .'> This parameter is returned only when the value of the **DdosType** parameter is **defense**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150000', + ], + 'MaxPps' => [ + 'description' => 'The maximum packet scrubbing threshold. Unit: pps.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150000', + ], + 'InternetIp' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E9B3C090-55AD-59C6-979E-FCFD81E7D9E7\\",\\n \\"Thresholds\\": {\\n \\"Threshold\\": [\\n {\\n \\"DdosType\\": \\"defense\\",\\n \\"IsAuto\\": false,\\n \\"MaxBps\\": 1024,\\n \\"ElasticBps\\": 12310,\\n \\"InstanceId\\": \\"i-bp10bclrt56fblts****\\",\\n \\"Bps\\": 500,\\n \\"Pps\\": 150000,\\n \\"MaxPps\\": 150000,\\n \\"InternetIp\\": \\"192.0.XX.XX\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDdosThresholdResponse>\\n <RequestId>E9B3C090-55AD-59C6-979E-FCFD81E7D9E7</RequestId>\\n <Thresholds>\\n <DdosType>defense</DdosType>\\n <IsAuto>false</IsAuto>\\n <MaxBps>1024</MaxBps>\\n <InstanceId>i-bp10bclrt56fblts****</InstanceId>\\n <Bps>500</Bps>\\n <Pps>150000</Pps>\\n <MaxPps>150000</MaxPps>\\n <InternetIp>192.0.XX.XX</InternetIp>\\n </Thresholds>\\n</DescribeDdosThresholdResponse>","errorExample":""}]', + 'title' => 'DescribeDdosThreshold', + 'description' => 'You can call the DescribeDdosThreshold operation to query the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified assets. The details include the current traffic scrubbing threshold, maximum traffic scrubbing threshold, current DDoS mitigation threshold, and maximum DDoS mitigation threshold.'."\n" + ."\n" + .'### Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeBgpPackByIp' => [ + 'summary' => 'Queries the configurations of the Anti-DDoS Origin instance that is associated with an asset. The asset is assigned a public IP address.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset to query.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the asset to query.'."\n" + ."\n" + .'> You can call the [DescribeInstanceIpAddress](~~472620~~) operation to query the IDs of Elastic Compute Service (ECS) instances, Server Load Balancer (SLB) instances, and elastic IP addresses (EIPs) within the current Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '118.31.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E46A08E4-A1CD-5BE9-B580-C4D6E9BC5484', + ], + 'Code' => [ + 'description' => 'The HTTP status code of the request.'."\n" + ."\n" + .'For more information about status codes, see [Common parameters](~~118841~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DdosbgpInfo' => [ + 'description' => 'The configurations of the instance that is associated with the asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'example' => '118.31.XX.XX', + ], + 'ExpireTime' => [ + 'description' => 'The expiration time of the instance. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640448000000', + ], + 'ElasticThreshold' => [ + 'description' => 'The burstable protection threshold of the instance. Unit: Gbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '301', + ], + 'BaseThreshold' => [ + 'description' => 'The basic protection threshold of the instance. Unit: Gbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'DdosbgpInstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'ddosbgp-cn-n6w1r7nz****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E46A08E4-A1CD-5BE9-B580-C4D6E9BC5484\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"DdosbgpInfo\\": {\\n \\"Ip\\": \\"118.31.XX.XX\\",\\n \\"ExpireTime\\": 1640448000000,\\n \\"ElasticThreshold\\": 301,\\n \\"BaseThreshold\\": 20,\\n \\"DdosbgpInstanceId\\": \\"ddosbgp-cn-n6w1r7nz****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBgpPackByIpResponse>\\n <RequestId>E46A08E4-A1CD-5BE9-B580-C4D6E9BC5484</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <DdosbgpInfo>\\n <Ip>118.31.XX.XX</Ip>\\n <ExpireTime>1640448000000</ExpireTime>\\n <ElasticThreshold>301</ElasticThreshold>\\n <BaseThreshold>20</BaseThreshold>\\n <DdosbgpInstanceId>ddosbgp-cn-n6w1r7nz****</DdosbgpInstanceId>\\n </DdosbgpInfo>\\n</DescribeBgpPackByIpResponse>","errorExample":""}]', + 'title' => 'DescribeBgpPackByIp', + 'description' => 'You can call the DescribeBgpPackByIp operation to query the configurations of the Anti-DDoS Origin instance that is associated with an asset. The configurations include the basic protection threshold, burstable protection threshold, and expiration time.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeInstanceIpAddress' => [ + 'summary' => 'Queries the details of the assets within the current Alibaba Cloud account and the details of the Anti-DDoS Origin instance to which the assets belong. The assets can be elastic IP addresses (EIPs). The assets can also be Elastic Compute Service (ECS) instances or Server Load Balancer (SLB) instances that are assigned public IP addresses.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset that is assigned a public IP address. Valid values:'."\n" + ."\n" + .'* **ecs**: ECS instances.'."\n" + .'* **slb**: SLB instances.'."\n" + .'* **eip**: EIPs.'."\n" + .'* **ipv6**: IPv6 gateways.'."\n" + .'* **swas**: simple application servers.'."\n" + .'* **waf**: Web Application Firewall (WAF) instances of the Exclusive edition.'."\n" + .'* **ga_basic**: Global Accelerator (GA) instances.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the asset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'launch-advisor-2021****', + ], + ], + [ + 'name' => 'DdosStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DDoS mitigation status of the asset. Valid values:'."\n" + ."\n" + .'* **defense**: queries assets for which traffic scrubbing is performed.'."\n" + .'* **blackhole**: queries assets for which blackhole filtering is triggered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to which the asset is added.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1cb6x80tfgocid****', + ], + ], + [ + 'name' => 'InstanceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => 'The total number of the assets.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'BC0907F8-A9F3-5E11-977B-D59CD98C64ED', + ], + 'InstanceList' => [ + 'description' => 'An array that consists of details of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp1cb6x80tfgocid****', + ], + 'InstanceType' => [ + 'description' => 'The type of the asset. Valid values:'."\n" + ."\n" + .'* **ecs**'."\n" + .'* **slb**'."\n" + .'* **eip**'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'InstanceName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'launch-advisor-2021****', + ], + 'InstanceStatus' => [ + 'description' => 'The DDoS mitigation status of the instance. Valid values:'."\n" + ."\n" + .'* **normal**: not under DDoS attacks.'."\n" + .'* **abnormal**: under DDoS attacks.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'IpAddressConfig' => [ + 'description' => 'An array that consists of the details of the asset.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceIp' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'IsBgppack' => [ + 'description' => 'Indicates whether the asset is added to the instance. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'IpVersion' => [ + 'description' => 'The IP version of the IP address. Valid values:'."\n" + ."\n" + .'* **v4**: IPv4.'."\n" + .'* **v6**: IPv6.'."\n", + 'type' => 'string', + 'example' => 'v4', + ], + 'IpStatus' => [ + 'description' => 'The DDoS mitigation status of the asset. Valid values:'."\n" + ."\n" + .'* **mitigating**: indicates that traffic scrubbing is in progress.'."\n" + .'* **blackholed**: indicates that blackhole filtering is triggered for the asset.'."\n" + .'* **normal**: indicates that no DDoS attacks are launched against the asset.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'RegionId' => [ + 'description' => 'The region code of the asset.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-dg-a01', + ], + 'ElasticThreshold' => [ + 'description' => 'The burstable protection threshold for the asset. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12310', + ], + 'BlackholeThreshold' => [ + 'description' => 'The basic protection threshold for the asset. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5200', + ], + 'DefenseBpsThreshold' => [ + 'description' => 'The traffic scrubbing threshold for the asset measured in Mbit/s. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'DefensePpsThreshold' => [ + 'description' => 'The traffic scrubbing threshold for the asset measured in packets per second (PPS). Unit: PPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70000', + ], + 'IsFullProtection' => [ + 'description' => 'Indicates whether best-effort protection is enabled for the asset. Valid values:'."\n" + ."\n" + .'* **0**: no.'."\n" + .'* **1**: yes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 1,\\n \\"RequestId\\": \\"BC0907F8-A9F3-5E11-977B-D59CD98C64ED\\",\\n \\"InstanceList\\": [\\n {\\n \\"InstanceId\\": \\"i-bp1cb6x80tfgocid****\\",\\n \\"InstanceType\\": \\"ecs\\",\\n \\"InstanceName\\": \\"launch-advisor-2021****\\",\\n \\"InstanceStatus\\": \\"normal\\",\\n \\"IpAddressConfig\\": [\\n {\\n \\"InstanceIp\\": \\"192.0.XX.XX\\",\\n \\"IsBgppack\\": true,\\n \\"IpVersion\\": \\"v4\\",\\n \\"IpStatus\\": \\"normal\\",\\n \\"RegionId\\": \\"cn-hangzhou-dg-a01\\",\\n \\"ElasticThreshold\\": 12310,\\n \\"BlackholeThreshold\\": 5200,\\n \\"DefenseBpsThreshold\\": 300,\\n \\"DefensePpsThreshold\\": 70000,\\n \\"IsFullProtection\\": 0\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceIpAddressResponse>\\n <Total>1</Total>\\n <RequestId>BC0907F8-A9F3-5E11-977B-D59CD98C64ED</RequestId>\\n <InstanceList>\\n <InstanceId>i-bp1cb6x80tfgocid****</InstanceId>\\n <InstanceType>ecs</InstanceType>\\n <InstanceName>launch-advisor-2021****</InstanceName>\\n <InstanceStatus>normal</InstanceStatus>\\n <IpAddressConfig>\\n <InstanceIp>192.0.XX.XX</InstanceIp>\\n <IsBgppack>true</IsBgppack>\\n <IpVersion>v4</IpVersion>\\n <IpStatus>normal</IpStatus>\\n <RegionId>cn-hangzhou-dg-a01</RegionId>\\n <ElasticThreshold>12310</ElasticThreshold>\\n <BlackholeThreshold>5200</BlackholeThreshold>\\n <DefenseBpsThreshold>300</DefenseBpsThreshold>\\n <DefensePpsThreshold>70000</DefensePpsThreshold>\\n </IpAddressConfig>\\n </InstanceList>\\n</DescribeInstanceIpAddressResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceIpAddress', + 'description' => 'If one or more assets of the current Alibaba Cloud account are added to an Anti-DDoS Origin instance, you can call the DescribeInstanceIpAddress operation to query the DDoS mitigation information and the details of the Anti-DDoS Origin instance. The information and the details include the basic protection threshold and traffic scrubbing threshold for the assets, DDoS mitigation status of the assets, ID of the instance, and the mitigation status of the instance.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 200 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeIpDdosThreshold' => [ + 'summary' => 'Queries the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified assets. The assets can be elastic IP addresses (EIPs). The assets can also be Elastic Compute Service (ECS) instances or Server Load Balancer (SLB) instances that are assigned public IP addresses.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DdosType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the threshold. Valid values:'."\n" + ."\n" + .'* **defense**: traffic scrubbing threshold'."\n" + .'* **blackhole**: DDoS mitigation threshold'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'defense', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset that is assigned a public IP address. Valid values:'."\n" + ."\n" + .'* **ecs**: ECS instances.'."\n" + .'* **slb**: SLB instances.'."\n" + .'* **eip**: EIPs.'."\n" + .'* **ipv6**: IPv6 gateways.'."\n" + .'* **swas**: simple application servers.'."\n" + .'* **waf**: Web Application Firewall (WAF) instances of the Exclusive edition.'."\n" + .'* **ga_basic**: Global Accelerator (GA) instances.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeInstanceIpAddress](~~429562~~) operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp1i88rqjza51s****', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.0.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '025F1688-680B-551A-9A8E-1A0D796315CF', + ], + 'Threshold' => [ + 'description' => 'An array that consists of the details of the threshold.'."\n", + 'type' => 'object', + 'properties' => [ + 'DdosType' => [ + 'description' => 'The type of the threshold. Valid values:'."\n" + ."\n" + .'* **defense**: traffic scrubbing threshold'."\n" + .'* **blackhole**: DDoS mitigation threshold'."\n", + 'type' => 'string', + 'example' => 'defense', + ], + 'IsAuto' => [ + 'description' => 'Indicates whether the threshold is automatically adjusted. Valid values:'."\n" + ."\n" + .'* **true**: The scrubbing thresholds are automatically adjusted based on the traffic load on the asset.'."\n" + .'* **false**: The scrubbing thresholds are not automatically adjusted. You must manually specify the scrubbing thresholds.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'MaxBps' => [ + 'description' => 'The maximum traffic scrubbing threshold. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7500', + ], + 'ElasticBps' => [ + 'description' => 'The burstable protection threshold (the maximum DDoS mitigation threshold). Unit: Mbit/s.'."\n" + ."\n" + .'> This parameter is returned only when the value of the **DdosType** parameter is **blackhole**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12310', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp1i88rqjza51s****', + ], + 'Bps' => [ + 'description' => 'If the value of the **DdosType** parameter is **defense**, the Bps parameter indicates the current traffic scrubbing threshold. Unit: Mbit/s.'."\n" + ."\n" + .'If the value of the **DdosType** parameter is **blackhole**, the Bps parameter indicates the basic protection threshold. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7500', + ], + 'Pps' => [ + 'description' => 'The packet scrubbing threshold. Unit: packets per second (pps).'."\n" + ."\n" + .'> This parameter is returned only when the value of the **DdosType** parameter is **defense**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000000', + ], + 'MaxPps' => [ + 'description' => 'The maximum packet scrubbing threshold. Unit: pps.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000000', + ], + 'InternetIp' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"025F1688-680B-551A-9A8E-1A0D796315CF\\",\\n \\"Threshold\\": {\\n \\"DdosType\\": \\"defense\\",\\n \\"IsAuto\\": false,\\n \\"MaxBps\\": 7500,\\n \\"ElasticBps\\": 12310,\\n \\"InstanceId\\": \\"i-bp1i88rqjza51s****\\",\\n \\"Bps\\": 7500,\\n \\"Pps\\": 5000000,\\n \\"MaxPps\\": 5000000,\\n \\"InternetIp\\": \\"192.0.XX.XX\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeIpDdosThresholdResponse>\\n <RequestId>025F1688-680B-551A-9A8E-1A0D796315CF</RequestId>\\n <Threshold>\\n <DdosType>defense</DdosType>\\n <IsAuto>false</IsAuto>\\n <MaxBps>7500</MaxBps>\\n <ElasticBps>12310</ElasticBps>\\n <InstanceId>i-bp1i88rqjza51s****</InstanceId>\\n <Bps>7500</Bps>\\n <Pps>5000000</Pps>\\n <MaxPps>5000000</MaxPps>\\n <InternetIp>192.0.XX.XX</InternetIp>\\n </Threshold>\\n</DescribeIpDdosThresholdResponse>","errorExample":""}]', + 'title' => 'DescribeIpDdosThreshold', + 'description' => 'If one or more assets of the current Alibaba Cloud account are added to an Anti-DDoS Origin instance, you can call the DescribeIpDdosThreshold operation to query the details of the DDoS mitigation threshold or traffic scrubbing threshold for a specific asset. The details include the current traffic scrubbing threshold, maximum scrubbing threshold, current DDoS mitigation threshold, and maximum DDoS mitigation threshold.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeIpLocationService' => [ + 'summary' => 'Queries the region to which the public IP address of the asset within the current Alibaba Cloud account belongs. The asset can be an elastic IP address (EIP). The asset can also be an Elastic Compute Service (ECS) instance or Server Load Balancer (SLB) instance that is assigned a public IP address.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the asset to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '121.199.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'C728D7E9-9A39-52E0-966B-5C33118BDBB0', + ], + 'Instance' => [ + 'title' => 'instance model', + 'description' => 'The details of the asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp1cb6x80tfgocid****', + ], + 'InstanceName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'launch-advisor-2021****', + ], + 'InternetIp' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'example' => '121.199.XX.XX', + ], + 'InstanceType' => [ + 'description' => 'The type of the asset. Valid values:'."\n" + ."\n" + .'* **ecs**: an ECS instance.'."\n" + .'* **slb**: an SLB instance.'."\n" + .'* **eip**: an EIP.'."\n" + .'* **ipv6**: an IPv6 gateway.'."\n" + .'* **swas**: a simple application server.'."\n" + .'* **waf**: a Web Application Firewall (WAF) instance of the Exclusive edition.'."\n" + .'* **ga_basic**: a Global Accelerator (GA) instance.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'Region' => [ + 'description' => 'The region to which the public IP address of the asset belongs.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C728D7E9-9A39-52E0-966B-5C33118BDBB0\\",\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"i-bp1cb6x80tfgocid****\\",\\n \\"InstanceName\\": \\"launch-advisor-2021****\\",\\n \\"InternetIp\\": \\"121.199.XX.XX\\",\\n \\"InstanceType\\": \\"ecs\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeIpLocationServiceResponse>\\n <RequestId>C728D7E9-9A39-52E0-966B-5C33118BDBB0</RequestId>\\n <Instance>\\n <InstanceId>i-bp1cb6x80tfgocid****</InstanceId>\\n <InstanceName>launch-advisor-2021****</InstanceName>\\n <InternetIp>121.199.XX.XX</InternetIp>\\n <InstanceType>ecs</InstanceType>\\n <Region>cn-hangzhou</Region>\\n </Instance>\\n</DescribeIpLocationServiceResponse>","errorExample":""}]', + 'title' => 'DescribeIpLocationService', + 'description' => 'You can call the DescribeIpLocationService operation to query the region of the public IP address for a specified asset that is within the current Alibaba Cloud account. You can also query the details of the Anti-DDoS Origin instance to which the asset is added. The details include the ID and name.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ModifyIpDefenseThreshold' => [ + 'summary' => 'Modifies the scrubbing thresholds for an asset that is assigned a public IP address. This operation is a synchronous operation that supports Terraform.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset. Valid values:'."\n" + ."\n" + .'* **ecs**: an Elastic Compute Service (ECS) instance.'."\n" + .'* **slb**: a Server Load Balancer (SLB) instance.'."\n" + .'* **eip**: an elastic IP address (EIP).'."\n" + .'* **ipv6**: an IPv6 gateway.'."\n" + .'* **swas**: a simple application server.'."\n" + .'* **waf**: a Web Application Firewall (WAF) instance of the Exclusive edition.'."\n" + .'* **ga_basic**: a Global Accelerator (GA) instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeInstance](~~354191~~) operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-uf6idy3c57psf7vu****', + ], + ], + [ + 'name' => 'Bps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The traffic scrubbing threshold. Unit: Mbit/s. The traffic scrubbing threshold cannot exceed the peak inbound or outbound Internet traffic, whichever is larger, of the asset. When you modify Bps, Pps is required. Otherwise, Bps does not take effect.'."\n" + ."\n" + .'You can use the monitoring tool that is provided by the asset to query the Internet traffic of the asset:'."\n" + ."\n" + .'* If the asset is an ECS instance, see [View instance monitoring information](~~25482~~).'."\n" + .'* If the asset is an SLB instance, see [View monitoring data](~~85982~~).'."\n" + .'* If the asset is an EIP, see [View monitoring data](~~85354~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Pps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The packet scrubbing threshold. Unit: packets per second (PPS). When you modify Pps, Bps is required. Otherwise, Pps does not take effect.'."\n" + ."\n" + .'The packet scrubbing threshold cannot exceed the peak number of inbound or outbound packets, whichever is larger, of the asset. You can use the monitoring tool that is provided by the asset to query the number of packets of the asset:'."\n" + ."\n" + .'* If the asset is an ECS instance, see [View instance monitoring information](~~25482~~).'."\n" + .'* If the asset is an SLB instance, see [View monitoring data](~~85982~~).'."\n" + .'* If the asset is an EIP, see [View monitoring data](~~85354~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '70000', + ], + ], + [ + 'name' => 'IsAuto', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically adjust the scrubbing threshold based on the traffic load on the asset. Valid values:'."\n" + ."\n" + .'* **true**: automatically adjusts the scrubbing threshold. You do not need to configure the **Bps** and **Pps** parameters.'."\n" + .'* **false**: The scrubbing threshold is not automatically adjusted. You must configure the **Bps** and **Pps** parameters. This is the default value.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.0.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'BC0607F8-A9F3-5E11-977B-D59CD58C64ED', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC0607F8-A9F3-5E11-977B-D59CD58C64ED\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyIpDefenseThresholdResponse>\\n <RequestId>BC0607F8-A9F3-5E11-977B-D59CD58C64ED</RequestId>\\n</ModifyIpDefenseThresholdResponse>","errorExample":""}]', + 'title' => 'ModifyIpDefenseThreshold', + 'description' => '### Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'ModifyDefenseThreshold' => [ + 'summary' => 'Changes the scrubbing thresholds for an asset that is assigned a public IP address.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREddosY9LLGQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset for which you want to change the scrubbing thresholds.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset. Valid values:'."\n" + ."\n" + .'* **ecs**: an Elastic Compute Service (ECS) instance.'."\n" + .'* **slb**: a Server Load Balancer (SLB) instance.'."\n" + .'* **eip**: an elastic IP address (EIP).'."\n" + .'* **ipv6**: an IPv6 gateway.'."\n" + .'* **swas**: a simple application server.'."\n" + .'* **waf**: a Web Application Firewall (WAF) instance of the Exclusive edition.'."\n" + .'* **ga_basic**: a Global Accelerator (GA) instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeInstance](~~354191~~) operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-uf6idy3c57psf7vu****', + ], + ], + [ + 'name' => 'Bps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The traffic scrubbing threshold. Unit: Mbit/s. The traffic scrubbing threshold cannot exceed the peak inbound or outbound Internet traffic, whichever is larger, of the asset. When you modify Bps, Pps is required. Otherwise, Bps does not take effect.'."\n" + ."\n" + .'You can use the monitoring tool that is provided by the asset to query the Internet traffic of the asset:'."\n" + ."\n" + .'* If the asset is an ECS instance, see [View instance monitoring information](~~25482~~).'."\n" + .'* If the asset is an SLB instance, see [View monitoring data](~~85982~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Pps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The packet scrubbing threshold. Unit: packets per second (PPS). When you modify Pps, Bps is required. Otherwise, Pps does not take effect.'."\n" + ."\n" + .'The packet scrubbing threshold cannot exceed the peak number of inbound or outbound packets, whichever is larger, of the asset. You can use the monitoring tool that is provided by the asset to query the number of packets of the asset:'."\n" + ."\n" + .'* If the asset is an ECS instance, see [View instance monitoring information](~~25482~~).'."\n" + .'* If the asset is an SLB instance, see [View monitoring data](~~85982~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '70000', + ], + ], + [ + 'name' => 'IsAuto', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically adjust the scrubbing threshold based on the traffic load on the asset. Valid values:'."\n" + ."\n" + .'* **true**: automatically adjusts the scrubbing thresholds. You do not need to configure the **Bps** and **Pps** parameters.'."\n" + .'* **false**: The scrubbing threshold is not automatically adjusted. You must configure the **Bps** and **Pps** parameters.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'BC0607F8-A9F3-5E11-977B-D59CD58C64ED', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC0607F8-A9F3-5E11-977B-D59CD58C64ED\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDefenseThresholdResponse>\\n <RequestId>BC0607F8-A9F3-5E11-977B-D59CD58C64ED</RequestId>\\n</ModifyDefenseThresholdResponse>","errorExample":""}]', + 'title' => 'ModifyDefenseThreshold', + 'description' => '## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDdosEventList' => [ + 'summary' => 'Queries the details of the DDoS attack events that occur on an asset. The asset is assigned a public IP address.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREddosOYL225', + ], + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset to query.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset to query. Valid values:'."\n" + ."\n" + .'* **ecs**: an Elastic Compute Service (ECS) instance.'."\n" + .'* **slb**: a Server Load Balancer (SLB) instance.'."\n" + .'* **eip**: an elastic IP address (EIP).'."\n" + .'* **ipv6**: an IPv6 gateway.'."\n" + .'* **swas**: a simple application server.'."\n" + .'* **waf**: a Web Application Firewall (WAF) instance of the Exclusive edition.'."\n" + .'* **ga_basic**: a Global Accelerator (GA) instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of asset to query.'."\n" + ."\n" + .'> You can call the [DescribeInstance](~~354191~~) operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp10bclrt56fblts****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: **10**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '20', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the asset to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '121.199.XX.XX', + ], + ], + [ + 'name' => 'QueryDays', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '186', + 'minimum' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => 'The total number of DDoS attack events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'BC0907F8-A9F3-5E11-977B-D59CD98C64ED', + ], + 'DdosEventList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DdosEvent' => [ + 'description' => 'The details of the DDoS attack events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the DDoS attack event.'."\n", + 'type' => 'object', + 'properties' => [ + 'DdosType' => [ + 'description' => 'The type of the DDoS attack event. Valid values:'."\n" + ."\n" + .'* **defense**: an attack event that triggers traffic scrubbing'."\n" + .'* **blackhole**: an attack event that triggers blackhole filtering'."\n", + 'type' => 'string', + 'example' => 'blackhole', + ], + 'EndTime' => [ + 'description' => 'The end time of the DDoS attack event. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637817679000', + ], + 'StartTime' => [ + 'description' => 'The start time of the DDoS attack event. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637812279000', + ], + 'DelayTime' => [ + 'description' => 'The time of the last attack. The value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> This parameter is returned only when the asset is attacked multiple times within a DDoS attack event.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637817679000', + ], + 'DdosStatus' => [ + 'description' => 'The status of the DDoS attack event. Valid values:'."\n" + ."\n" + .'* **mitigating**: indicates that traffic scrubbing is in progress.'."\n" + .'* **blackholed**: indicates that blackhole filtering is triggered for the asset.'."\n" + .'* **normal**: indicates that the DDoS attack event ends.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'UnBlackholeTime' => [ + 'description' => 'The time when blackhole filtering is deactivated. The value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> This parameter is returned only when the value of the **DdosType** parameter is **blackhole**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637814079000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 1,\\n \\"RequestId\\": \\"BC0907F8-A9F3-5E11-977B-D59CD98C64ED\\",\\n \\"DdosEventList\\": {\\n \\"DdosEvent\\": [\\n {\\n \\"DdosType\\": \\"blackhole\\",\\n \\"EndTime\\": 1637817679000,\\n \\"StartTime\\": 1637812279000,\\n \\"DelayTime\\": 1637817679000,\\n \\"DdosStatus\\": \\"normal\\",\\n \\"UnBlackholeTime\\": 1637814079000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDdosEventListResponse>\\n <Total>1</Total>\\n <RequestId>BC0907F8-A9F3-5E11-977B-D59CD98C64ED</RequestId>\\n <DdosEventList>\\n <DdosType>blackhole</DdosType>\\n <EndTime>1637817679000</EndTime>\\n <StartTime>1637812279000</StartTime>\\n <DelayTime>1637817679000</DelayTime>\\n <DdosStatus>normal</DdosStatus>\\n <UnBlackholeTime>1637814079000</UnBlackholeTime>\\n </DdosEventList>\\n</DescribeDdosEventListResponse>","errorExample":""}]', + 'title' => 'DescribeDdosEventList', + 'description' => 'You can call the DescribeDdosEventList operation to query the details of the DDoS attack events that occur on an asset by page. The details include the start time, end time, and status of each DDoS attack event.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeDdosCount' => [ + 'summary' => 'Queries the number of assets that are under DDoS attacks in a specific region. The assets are assigned public IP addresses.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset to query.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset to query. Valid values:'."\n" + ."\n" + .'* **ecs**: Elastic Compute Service (ECS) instances.'."\n" + .'* **slb**: Server Load Balancer (SLB) instances.'."\n" + .'* **eip**: elastic IP addresses (EIPs).'."\n" + .'* **ipv6**: IPv6 gateways.'."\n" + .'* **swas**: simple application servers.'."\n" + .'* **waf**: Web Application Firewall (WAF) instances of the Exclusive edition.'."\n" + .'* **ga_basic**: Global Accelerator (GA) instances.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7D66C762-324E-51CE-B461-2007996087B2', + ], + 'DdosCount' => [ + 'description' => 'The number of assets that are under DDoS attacks.'."\n", + 'type' => 'object', + 'properties' => [ + 'BlackholeCount' => [ + 'description' => 'The number of assets for which blackhole filtering is triggered.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstacenCount' => [ + 'description' => 'The total number of assets.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DefenseCount' => [ + 'description' => 'The number of assets for which traffic scrubbing is triggered.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D66C762-324E-51CE-B461-2007996087B2\\",\\n \\"DdosCount\\": {\\n \\"BlackholeCount\\": 0,\\n \\"InstacenCount\\": 0,\\n \\"DefenseCount\\": 4\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDdosCountResponse>\\n <RequestId>7D66C762-324E-51CE-B461-2007996087B2</RequestId>\\n <DdosCount>\\n <BlackholeCount>0</BlackholeCount>\\n <InstacenCount>0</InstacenCount>\\n <DefenseCount>4</DefenseCount>\\n </DdosCount>\\n</DescribeDdosCountResponse>","errorExample":""}]', + 'title' => 'DescribeDdosCount', + 'description' => '## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeCap' => [ + 'summary' => 'Queries the download link to the traffic data that is captured when a DDoS attack event occurs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the asset that is under DDoS attacks. The asset is assigned a public IP address.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~353250~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset that is under DDoS attacks. The asset is assigned a public IP address. Valid values:'."\n" + ."\n" + .'* **ecs**: an Elastic Compute Service (ECS) instance.'."\n" + .'* **slb**: a Server Load Balancer (SLB) instance.'."\n" + .'* **eip**: an elastic IP address (EIP).'."\n" + .'* **ipv6**: an IPv6 gateway.'."\n" + .'* **swas**: a simple application server.'."\n" + .'* **waf**: a Web Application Firewall (WAF) instance of the Exclusive edition.'."\n" + .'* **ga_basic**: a Global Accelerator (GA) instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the asset that is under DDoS attacks.'."\n" + ."\n" + .'> You can call the [DescribeInstance](~~354191~~) operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp10bclrt56fblts****', + ], + ], + [ + 'name' => 'BegTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the DDoS attack event. The value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> You can call the [DescribeDdosEventList](~~354236~~) operation to query the start time of each DDoS attack event that occurred on an asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1637812279000', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The public IP address of the asset that is under DDoS attacks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '121.199.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'C728D7E9-9A39-52E0-966B-5C33118BDBB0', + ], + 'CapUrl' => [ + 'description' => 'The download link to the traffic data that is captured when a DDoS attack event occurs.'."\n", + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => 'The download link to the traffic data.'."\n", + 'type' => 'string', + 'example' => 'http://beaver-pack****.oss-cn-hangzhou.aliyuncs.com/ddos-2021****-121.89.XX.XX.cap?Expires=1637****&OSSAccessKeyId=LTAI****************&Signature=******', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C728D7E9-9A39-52E0-966B-5C33118BDBB0\\",\\n \\"CapUrl\\": {\\n \\"Url\\": \\"http://beaver-pack****.oss-cn-hangzhou.aliyuncs.com/ddos-2021****-121.89.XX.XX.cap?Expires=1637****&OSSAccessKeyId=LTAI****************&Signature=******\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCapResponse>\\n <RequestId>C728D7E9-9A39-52E0-966B-5C33118BDBB0</RequestId>\\n <CapUrl>\\n <Url>http://beaver-pack****.oss-cn-hangzhou.aliyuncs.com/ddos-2021112511-121.89.XX.XX.cap?Expires=1637824408&OSSAccessKeyId=LTAIXu2lJhw3****&Signature=KKSzOMSUajtwcqfqxkU1nK69d4****</Url>\\n </CapUrl>\\n</DescribeCapResponse>","errorExample":""}]', + 'title' => 'DescribeCap', + 'description' => 'You can call the DescribeCap operation to query the download link to the traffic data that is captured when a DDoS attack event occurs. You can download the traffic data from the download link and use the data as evidence.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'antiddos-openapi.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'antiddos-openapi.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'antiddos-openapi.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'antiddos-openapi.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'antiddos-openapi.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'antiddos-openapi.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'antiddos-openapi.cn-hangzhou-cloudstone.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'antiddos-openapi.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1', + 'endpoint' => 'antiddos-openapi.rus-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'antiddos-openapi.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'antiddos-openapi.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'antiddos-openapi.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'antiddos-openapi.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'antiddos-openapi.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'antiddos-openapi.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'antiddos.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'antiddos-openapi.eu-central-1.aliyuncs.com', + ], + ], +]; |