diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/waf-openapi/2019-09-10/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/waf-openapi/2019-09-10/api-docs.php')
| -rw-r--r-- | data/en_us/waf-openapi/2019-09-10/api-docs.php | 5249 |
1 files changed, 5249 insertions, 0 deletions
diff --git a/data/en_us/waf-openapi/2019-09-10/api-docs.php b/data/en_us/waf-openapi/2019-09-10/api-docs.php new file mode 100644 index 0000000..18c0c40 --- /dev/null +++ b/data/en_us/waf-openapi/2019-09-10/api-docs.php @@ -0,0 +1,5249 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'waf-openapi', + 'version' => '2019-09-10', + ], + 'directories' => [ + [ + 'id' => 40429, + 'title' => 'Instance information', + 'type' => 'directory', + 'children' => [ + 'DescribeInstanceInfo', + 'DescribeInstanceSpecInfo', + 'DeleteInstance', + ], + ], + [ + 'id' => 40434, + 'title' => 'Domain configurations', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainNames', + 'DescribeDomain', + 'CreateDomain', + 'ModifyDomain', + 'DeleteDomain', + 'DescribeCertificates', + 'DescribeCertMatchStatus', + 'CreateCertificate', + 'CreateCertificateByCertificateId', + 'DescribeDomainBasicConfigs', + 'DescribeDomainAdvanceConfigs', + 'DescribeDomainList', + ], + ], + [ + 'id' => 40447, + 'title' => 'Protection configuration', + 'type' => 'directory', + 'children' => [ + 'DescribeProtectionModuleMode', + 'ModifyDomainIpv6Status', + 'DescribeProtectionModuleStatus', + 'ModifyProtectionModuleStatus', + 'ModifyProtectionModuleMode', + 'DescribeProtectionModuleRules', + 'CreateProtectionModuleRule', + 'ModifyProtectionModuleRule', + 'ModifyProtectionRuleStatus', + 'DescribeDomainRuleGroup', + 'SetDomainRuleGroup', + 'ModifyProtectionRuleCacheStatus', + 'DeleteProtectionModuleRule', + 'DescribeProtectionModuleCodeConfig', + 'DescribeRuleGroups', + 'DescribeRules', + ], + ], + [ + 'id' => 40462, + 'title' => 'Log management', + 'type' => 'directory', + 'children' => [ + 'ModifyLogRetrievalStatus', + 'ModifyLogServiceStatus', + 'DescribeLogServiceStatus', + ], + ], + [ + 'id' => 40466, + 'title' => 'System management', + 'type' => 'directory', + 'children' => [ + 'DescribeWafSourceIpSegment', + ], + ], + [ + 'id' => 171036, + 'title' => 'Resource operations', + 'type' => 'directory', + 'children' => [ + 'MoveResourceGroup', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeInstanceInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the WAF instance.'."\n" + ."\n" + .'If you do not configure this parameter, all WAF instances in the Chinese mainland or all WAF instances outside the Chinese mainland are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'waf-cn-tl32ast****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the WAF instance belongs in Resource Management. If you do not configure this parameter, the WAF instance belongs to the default resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the WAF instance is deployed. Valid values:'."\n" + ."\n" + .'* **cn-hangzhou**: Chinese mainland.'."\n" + .'* **ap-southeast-1**: outside the Chinese mainland.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + 'InstanceInfo' => [ + 'description' => 'The information about the WAF instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Indicates whether the WAF instance expires. Valid values:'."\n" + ."\n" + .'* **0**: The instance expires.'."\n" + .'* **1**: The instance does not expire.'."\n" + ."\n" + .'> If the value of **PayType** is **0**, this parameter is not returned. The value 0 indicates that no WAF instances are purchased.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EndDate' => [ + 'description' => 'The expiration time of the WAF instance. This value is a UNIX timestamp. Unit: seconds.'."\n" + ."\n" + .'> If the value of **PayType** is **0**, this parameter is not returned. The value 0 indicates that no WAF instances are purchased.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1512921600', + ], + 'Version' => [ + 'description' => 'The edition of the WAF instance. Valid values:'."\n" + ."\n" + .'* **version_pro_china**: a WAF Pro instance in the Chinese mainland'."\n" + .'* **version_business_china**: a WAF Business instance in the Chinese mainland'."\n" + .'* **version_enterprise_china**: a WAF Enterprise instance in the Chinese mainland'."\n" + .'* **version_exclusive_china**: a WAF Exclusive instance in the Chinese mainland'."\n" + .'* **version_hybrid_cloud_standard_china**: a Hybrid Cloud WAF instance in the Chinese mainland'."\n" + .'* **version_pro_china**: a WAF Pro instance outside the Chinese mainland'."\n" + .'* **version_business**: a WAF Business instance outside the Chinese mainland'."\n" + .'* **version_enterprise**: a WAF Enterprise instance outside the Chinese mainland'."\n" + .'* **version_exclusive**: a WAF Exclusive instance outside the Chinese mainland'."\n" + .'* **version_hybrid_cloud_standard**: a Hybrid Cloud WAF instance outside the Chinese mainland'."\n" + ."\n" + .'The preceding list contains all the editions of WAF instances within accounts that are created at the International site. If the returned version is not in the list, check whether your account is created at the International site.'."\n" + ."\n" + .'> If the value of **PayType** is **0**, this parameter is not returned. The value 0 indicates that no WAF instances are purchased.'."\n", + 'type' => 'string', + 'example' => 'version_3', + ], + 'RemainDay' => [ + 'description' => 'The number of remaining days before the trial period of the WAF instance ends.'."\n" + ."\n" + .'> This parameter is returned only if the value of **Trial** is **1**. The value 1 indicates that the free trial of a WAF instance is activated.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Region' => [ + 'description' => 'The region in which the WAF instance resides. Valid values:'."\n" + ."\n" + .'* **cn**: a region in the Chinese mainland'."\n" + .'* **cn-hongkong**: a region outside the Chinese mainland'."\n" + ."\n" + .'> If the value of **PayType** is **0**, this parameter is not returned. The value 0 indicates that no WAF instances are purchased.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + 'PayType' => [ + 'description' => 'The activation status of WAF. Valid values:'."\n" + ."\n" + .'* **0**: No WAF instances are purchased within the Alibaba Cloud account.'."\n" + .'* **1**: A subscription WAF instance is purchased within the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InDebt' => [ + 'description' => 'Indicates whether the WAF instance has overdue payments. Valid values:'."\n" + ."\n" + .'* **0**: The instance has overdue payments.'."\n" + .'* **1**: The instance does not have overdue payments.'."\n" + ."\n" + .'> If the value of **PayType** is **0**, this parameter is not returned. The value 0 indicates that no WAF instances are purchased.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceId' => [ + 'description' => 'The ID of the WAF instance.'."\n" + ."\n" + .'> If the value of **PayType** is **0**, this parameter is not returned. The value 0 indicates that no WAF instances are purchased.'."\n", + 'type' => 'string', + 'example' => 'waf-cn-tl32ast****', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method of the WAF instance: The value is fixed as **Subscription**.'."\n" + ."\n" + .'> If the value of **PayType** is **0**, this parameter is not returned. The value 0 indicates that no WAF instances are purchased.'."\n", + 'type' => 'string', + 'example' => 'Subscription', + ], + 'Trial' => [ + 'description' => 'Indicates whether a WAF instance of the free trial edition is activated within the Alibaba Cloud account. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n" + ."\n" + .'> This parameter is returned only if a WAF instance of the free trial edition is activated within the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbbiden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\",\\n \\"InstanceInfo\\": {\\n \\"Status\\": 1,\\n \\"EndDate\\": 1512921600,\\n \\"Version\\": \\"version_3\\",\\n \\"RemainDay\\": 1,\\n \\"Region\\": \\"cn\\",\\n \\"PayType\\": 1,\\n \\"InDebt\\": 1,\\n \\"InstanceId\\": \\"waf-cn-tl32ast****\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"Trial\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceInfoResponse>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n <InstanceInfo>\\n <Status>1</Status>\\n <EndDate>1512921600</EndDate>\\n <Version>version_3</Version>\\n <Region>cn</Region>\\n <PayType>1</PayType>\\n <InDebt>1</InDebt>\\n <InstanceId>waf-cn-tl32ast****</InstanceId>\\n <SubscriptionType>Subscription</SubscriptionType>\\n </InstanceInfo>\\n</DescribeInstanceInfoResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceInfo', + 'description' => '## Usage notes'."\n" + ."\n" + .'You can call the DescribeInstanceInfo operation to query the information about the WAF instance within your Alibaba Cloud account. The information includes the ID, version, status, and expiration time of the instance.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceSpecInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'waf-cn-st2225l****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E906513E-F6B5-495E-98DC-7BA888671D76', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'waf-cn-st2225l****', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1677168000000', + ], + 'Version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'InstanceSpecInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '103', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbbiden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E906513E-F6B5-495E-98DC-7BA8****1D76\\",\\n \\"InstanceId\\": \\"waf-cn-st2225l****\\",\\n \\"ExpireTime\\": 1677168000000,\\n \\"Version\\": \\"version_3\\",\\n \\"InstanceSpecInfos\\": [\\n {\\n \\"Code\\": \\"103\\",\\n \\"Value\\": \\"640\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceSpecInfoResponse>\\n <RequestId>E906513E-F6B5-495E-98DC-7BA888671D76</RequestId>\\n <InstanceId>waf-cn-st2225l****</InstanceId>\\n <ExpireTime>1677168000000</ExpireTime>\\n <Version>version_3或version_pro_china</Version>\\n <InstanceSpecInfos>\\n <Code>103</Code>\\n <Value>640</Value>\\n </InstanceSpecInfos>\\n</DescribeInstanceSpecInfoResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceSpecInfo', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62D****E840\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteInstanceResponse>\\r\\n<RequestId>F35F45B0-5D6B-4238-BE02-A62D0760E840</RequestId>\\r\\n</DeleteInstanceResponse>","errorExample":""}]', + 'title' => 'DeleteInstance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainNames' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + 'DomainNames' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["1.example.com","2.example.com","3.example.com"]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbbiden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\",\\n \\"DomainNames\\": [\\n \\"1.example.com\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeDomainNamesResponse>\\n\\t<DomainNames>1.example.com</DomainNames>\\n\\t<DomainNames>2.example.com</DomainNames>\\n\\t<DomainNames>3.example.com</DomainNames>\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</DescribeDomainNamesResponse>","errorExample":""}]', + 'title' => 'DescribeDomainNames', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-7pp26f1****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D827FCFE-90A7-4330-9326-D33C8B4C7726', + ], + 'Domain' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HttpToUserIp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SniStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsAccessProduct' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AccessHeaderMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HttpsRedirect' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IpFollowStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LoadBalancing' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AccessType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'waf-cloud-dns', + ], + 'Version' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'ClusterType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ReadTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'WriteTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'SniHost' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'waf.example.com', + ], + 'ResourceGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rg-acfm2mkrunv****', + ], + 'Cname' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com', + ], + 'ConnectionTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LogHeaders' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'k' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ALIWAF-TAG', + ], + 'v' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Yes', + ], + ], + ], + ], + 'CloudNativeInstances' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RedirectionTypeName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ALB', + ], + 'CloudNativeProductName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ALB', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'alb-s65nua68wdedsp****', + ], + 'IPAddressList' => [ + 'description' => '', + 'type' => 'array', + 'example' => '["39.XX.XX.197"]', + 'items' => [ + 'type' => 'string', + ], + ], + 'ProtocolPortConfigs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ports' => [ + 'description' => '', + 'type' => 'array', + 'example' => '[80]', + 'items' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'Protocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http', + ], + ], + ], + ], + ], + ], + ], + 'HttpPort' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'example' => '[80]', + 'format' => 'int32', + ], + ], + 'Http2Port' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'example' => '[443,8443]', + 'format' => 'int32', + ], + ], + 'SourceIps' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["39.XX.XX.197"]', + ], + ], + 'HttpsPort' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'example' => '[443,8443]', + 'format' => 'int32', + ], + ], + 'AccessHeaders' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["X-Client-IP"]', + ], + ], + 'Retry' => [ + 'type' => 'boolean', + 'default' => 'true', + ], + 'Keepalive' => [ + 'type' => 'boolean', + 'default' => 'true', + ], + 'KeepaliveRequests' => [ + 'type' => 'integer', + 'format' => 'int32', + 'default' => '1000', + ], + 'KeepaliveTimeout' => [ + 'type' => 'integer', + 'format' => 'int32', + 'default' => '15', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D827FCFE-90A7-4330-9326-D33C8B4C7726\\",\\n \\"Domain\\": {\\n \\"HttpToUserIp\\": 0,\\n \\"SniStatus\\": 1,\\n \\"IsAccessProduct\\": 1,\\n \\"AccessHeaderMode\\": 1,\\n \\"HttpsRedirect\\": 0,\\n \\"IpFollowStatus\\": 1,\\n \\"LoadBalancing\\": 2,\\n \\"AccessType\\": \\"waf-cloud-dns\\",\\n \\"Version\\": 40,\\n \\"ClusterType\\": 0,\\n \\"ReadTime\\": 120,\\n \\"WriteTime\\": 120,\\n \\"SniHost\\": \\"waf.example.com\\",\\n \\"ResourceGroupId\\": \\"rg-acfm2mkrunv****\\",\\n \\"Cname\\": \\"kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com\\",\\n \\"ConnectionTime\\": 5,\\n \\"LogHeaders\\": [\\n {\\n \\"k\\": \\"ALIWAF-TAG\\",\\n \\"v\\": \\"Yes\\"\\n }\\n ],\\n \\"CloudNativeInstances\\": [\\n {\\n \\"RedirectionTypeName\\": \\"ALB\\",\\n \\"CloudNativeProductName\\": \\"ALB\\",\\n \\"InstanceId\\": \\"alb-s65nua68wdedsp****\\",\\n \\"IPAddressList\\": [\\n \\"39.XX.XX.197\\"\\n ],\\n \\"ProtocolPortConfigs\\": [\\n {\\n \\"Ports\\": [\\n 80\\n ],\\n \\"Protocol\\": \\"http\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpPort\\": [\\n 80\\n ],\\n \\"Http2Port\\": [\\n 8443\\n ],\\n \\"SourceIps\\": [\\n \\"39.XX.XX.197\\"\\n ],\\n \\"HttpsPort\\": [\\n 443\\n ],\\n \\"AccessHeaders\\": [\\n \\"X-Client-IP\\"\\n ],\\n \\"Retry\\": false,\\n \\"Keepalive\\": true,\\n \\"KeepaliveRequests\\": 1000,\\n \\"KeepaliveTimeout\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeDomainResponse>\\n\\t<RequestId>D827FCFE-90A7-4330-9326-D33C8B4C7726</RequestId>\\n\\t<Domain>\\n\\t\\t<HttpToUserIp>0</HttpToUserIp>\\n\\t\\t<HttpPort>80</HttpPort>\\n\\t\\t<IsAccessProduct>1</IsAccessProduct>\\n\\t\\t<AccessHeaderMode>1</AccessHeaderMode>\\n\\t\\t<ResourceGroupId>rg-acfm2mkrunv****</ResourceGroupId>\\n\\t\\t<AccessHeaders>X-Client-IP</AccessHeaders>\\n\\t\\t<ReadTime>120</ReadTime>\\n\\t\\t<SourceIps>39.XX.XX.197</SourceIps>\\n\\t\\t<IpFollowStatus>1</IpFollowStatus>\\n\\t\\t<ClusterType>0</ClusterType>\\n\\t\\t<LoadBalancing>2</LoadBalancing>\\n\\t\\t<Cname>kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com</Cname>\\n\\t\\t<LogHeaders>\\n\\t\\t\\t<v>Yes</v>\\n\\t\\t\\t<k>ALIWAF-TAG</k>\\n\\t\\t</LogHeaders>\\n\\t\\t<WriteTime>120</WriteTime>\\n\\t\\t<Http2Port>443</Http2Port>\\n\\t\\t<Http2Port>8443</Http2Port>\\n\\t\\t<Version>40</Version>\\n\\t\\t<HttpsRedirect>0</HttpsRedirect>\\n\\t\\t<ConnectionTime>5</ConnectionTime>\\n\\t\\t<AccessType>waf-cloud-dns</AccessType>\\n\\t\\t<HttpsPort>443</HttpsPort>\\n\\t\\t<HttpsPort>8443</HttpsPort>\\n\\t</Domain>\\n</DescribeDomainResponse>\\n","errorExample":""}]', + 'title' => 'DescribeDomain', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the WAF instance.'."\n" + ."\n" + .'> You can call the [DescribeInstanceInfo](~~140857~~) operation to query the ID of the WAF instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-7pp26f1****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name that you want to add to WAF.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'SourceIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address or domain name of the origin server. You can specify only one type of address.'."\n" + ."\n" + .'* If you use an IP address, specify the value in the `["ip1","ip2",...]` format. You can specify up to 20 IP addresses.'."\n" + .'* If you use a domain name, specify the value in the `["domain"]` format. You can enter only one domain name.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["39.XX.XX.197"]', + ], + ], + [ + 'name' => 'IsAccessProduct', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether a Layer 7 proxy is configured in front of WAF. A Layer 7 proxy is used to filter inbound traffic before the traffic reaches the WAF instance. Layer 7 proxies include Anti-DDoS Pro, Anti-DDoS Premium, and Alibaba Cloud CDN. Valid values:'."\n" + ."\n" + .'* **0**: No Layer 7 proxy is configured in front of WAF.'."\n" + .'* **1**: A Layer 7 proxy is configured in front of WAF.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AccessHeaderMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that you want WAF to use to obtain the actual IP address of a client. Valid values:'."\n" + ."\n" + .'* **0**: WAF reads the first value of the X-Forwarded-For (XFF) header field as the actual IP address of a client. This is the default value.'."\n" + .'* **1**: WAF reads the value of a custom header field as the actual IP address of a client.'."\n" + ."\n" + .'> This parameter is required only if you set **IsAccessProduct** to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'AccessHeaders', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom header fields that you want WAF to use to obtain the actual IP address of a client. Specify the value in the `["header1","header2",...]` format.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessHeaderMode** to **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["X-Client-IP"]', + ], + ], + [ + 'name' => 'LoadBalancing', + 'in' => 'query', + 'schema' => [ + 'description' => 'The load balancing algorithm that you want WAF to use to forward requests to the origin server. Valid values:'."\n" + ."\n" + .'* **0**: The IP hash algorithm.'."\n" + .'* **1**: The round-robin algorithm.'."\n" + .'* **2**: The least time algorithm.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'LogHeaders', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key-value pairs that you want to use to label the requests that pass through the WAF instance.'."\n" + ."\n" + .'Specify the key-value pair in the `[{"k":"_key_","v":"_value_"}]` format. `key` is the custom header field, and `value` is the value of the custom header field.'."\n" + ."\n" + .'The WAF can automatically add custom key-value pairs as traffic markers to the request headers of traffic destined for the protected domain. This allows backend services to easily identify requests that have passed through the WAF.'."\n" + ."\n" + .'> If a request contains a custom header field, WAF overwrites the original value of the field with the specified value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"k":"ALIWAF-TAG","v":"Yes"}]', + ], + ], + [ + 'name' => 'HttpPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTPS ports. Specify the value in the `["port1","port2",...]` format.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns**. If you specify this parameter, your website uses HTTP. You must specify **HttpPort** or **HttpsPort**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[80]', + ], + ], + [ + 'name' => 'HttpsPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTPS ports. Specify the value in the `["port1","port2",...]` format.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns**. If you specify this parameter, your website uses HTTPS. You must specify **HttpPort** or **HttpsPort**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[443]', + ], + ], + [ + 'name' => 'Http2Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTP/2 ports. Specify the value in the `["port1","port2",...]` format.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns** and specify **HttpsPort**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[443]', + ], + ], + [ + 'name' => 'HttpToUserIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable HTTPS to HTTP redirection for back-to-origin requests. If you enable this feature, WAF forwards requests to the origin server over HTTP. The default port is 80. Valid values:'."\n" + ."\n" + .'* **0**: Disables HTTPS to HTTP redirection for back-to-origin requests. This is the default value.'."\n" + .'* **1**: Enables HTTPS to HTTP redirection for back-to-origin requests.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns** and specify **HttpsPort**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'HttpsRedirect', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the feature of redirecting HTTP requests to HTTPS requests. Specifies whether to enable HTTP to HTTPS redirection. If you enable this feature, requests are sent over HTTPS. The default port is 443. Valid values:'."\n" + ."\n" + .'* **0**: Disables HTTP to HTTPS redirection. This is the default value.'."\n" + .'* **1**: Enables HTTP to HTTPS redirection.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns** and specify **HttpsPort**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the WAF protection cluster. Valid values:'."\n" + ."\n" + .'* **0**: Shared cluster. This is the default value.'."\n" + .'* **1**: Exclusive cluster.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the WAF instance belongs in Resource Management. This parameter is empty by default, which specifies that the instance belongs to the default resource group.'."\n" + ."\n" + .'For more information about resource groups, see [Create a resource group](~~94485~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'ConnectionTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period for connections of WAF exclusive clusters. Unit: seconds.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns** and **ClusterType** to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '5', + ], + ], + [ + 'name' => 'ReadTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period for read connections of WAF exclusive clusters. Unit: seconds.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns** and **ClusterType** to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + 'default' => '120', + ], + ], + [ + 'name' => 'WriteTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period for write connections of WAF exclusive clusters. Unit: seconds.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns** and **ClusterType** to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + 'default' => '120', + ], + ], + [ + 'name' => 'AccessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode in which you want to add the domain name to WAF. Valid values:'."\n" + ."\n" + .'* **waf-cloud-dns**: CNAME record mode. This is the default value.'."\n" + .'* **waf-cloud-native**: Transparent proxy mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'waf-cloud-dns', + ], + ], + [ + 'name' => 'CloudNativeInstances', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of server and port configurations for the transparent proxy mode. Set the value to a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that contains the following fields:'."\n" + ."\n" + .'* **ProtocolPortConfigs**: The list of protocol and port configurations. This field is required. Data type: array. Each element in a JSON array is a JSON struct that contains the following fields:'."\n" + ."\n" + .' * **Ports**:The list of ports. This field is required. Data type: array. Specify the value in the `[port1,port2,……]` format.'."\n" + .' * **Protocol**: The protocol. This field is required. Data type: string. Valid values: **http** and **https**.'."\n" + ."\n" + .'* **CloudNativeProductName**: The type of the cloud service instance. This field is required. Data type: string. Valid values: **ECS**, **SLB**, and **ALB**.'."\n" + ."\n" + .'* **RedirectionTypeName**: The type of traffic redirection port. This field is required. Data type: string. Valid values: **ECS**, **SLB-L4**, **SLB-L7**, and **ALB**.'."\n" + ."\n" + .'* **InstanceId**: The ID of the cloud service instance. This field is required. Data type: string.'."\n" + ."\n" + .'* **IPAddressList**: The list of public IP addresses of the cloud service instance. This field is required. Data type: array. Specify the value in the `["ip1","ip2",...]` format.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-native**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}]', + ], + ], + [ + 'name' => 'IpFollowStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the feature of forwarding requests to the origin servers that use the IP address type specified in the requests. If you enable the feature, WAF forwards requests from IPv4 addresses to origin servers that use IPv4 addresses and requests from IPv6 addresses to origin servers that use IPv6 addresses. Valid values:'."\n" + ."\n" + .'* **0**: Disables the feature of forwarding requests to the origin servers that use the IP address type that is specified in the requests. This is the default value.'."\n" + .'* **1**: Enables the feature of forwarding requests to the origin servers that use the IP address type that is specified in the requests.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SniStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable origin Server Name Indication (SNI). Origin SNI specifies the domain name that must be used for establishing an HTTPS connection during the initial handshake. This occurs when the WAF forwards requests to the origin server. If the origin server hosts multiple domain names, you must enable this feature. Valid values:'."\n" + ."\n" + .'* **0**: Disables origin SNI.'."\n" + .'* **1**: Enables origin SNI.'."\n" + ."\n" + .'By default, origin SNI is disabled for WAF instances in Chinese mainland and enabled for WAF instances outside the Chinese mainland.'."\n" + ."\n" + .'> This parameter is required only if you set **AccessType** to **waf-cloud-dns** and specify **HttpsPort**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SniHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the custom SNI extended field. If you do not specify this parameter, the value of the **Host** field in the request header is automatically used as the value of the SNI field.'."\n" + ."\n" + .'In most cases, you do not need to specify a custom value for the SNI field. However, if you want WAF to use an SNI field whose value is different from the value of the Host header field in back-to-origin requests, you can specify a custom value for the SNI field.'."\n" + ."\n" + .'> This parameter is required only if you set SniStatus to **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'waf.example.com', + ], + ], + [ + 'name' => 'Retry', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether WAF retries to forward requests when the requests fail to be forwarded to the origin server. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'Keepalive', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the persistent connection feature. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'KeepaliveRequests', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of requests that reuse persistent connections. Valid values: 60 to 1000.'."\n" + ."\n" + .'> This parameter specifies the number of persistent connections that can be reused after you enable the persistent connection feature.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '60', + 'example' => '1000', + 'default' => '1000', + ], + ], + [ + 'name' => 'KeepaliveTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period of persistent connections that are in the idle state. Valid values: 1 to 60. Default value: 15. Unit: seconds.'."\n" + ."\n" + .'> This parameter specifies the duration for which a reused persistent connection can remain in the idle state before it is released.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '1', + 'example' => '15', + 'default' => '15', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the WAF instance. Valid values:'."\n" + ."\n" + .'* **cn-hangzhou**: Chinese mainland.'."\n" + .'* **ap-southeast-1**: Outside the Chinese mainland.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cname' => [ + 'description' => 'The CNAME assigned by WAF to the domain name.'."\n" + ."\n" + .'> This parameter is returned only if you set **AccessType** to **waf-cloud-dns**.'."\n", + 'type' => 'string', + 'example' => 'mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Cname\\": \\"mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com\\",\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<CreateDomainResponse>\\n\\t<Cname>mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com</Cname>\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</CreateDomainResponse>","errorExample":""}]', + 'title' => 'CreateDomain', + 'summary' => 'Adds a domain name to a Web Application Firewall (WAF) instance.', + 'requestParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see [Common parameters](~~162719~~).'."\n" + ."\n" + .'For more information about sample requests, see the **"Examples"** section of this topic.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the WAF instance.'."\n" + ."\n" + .'> You can call the [DescribeInstanceInfo](~~140857~~) operation to query the ID of the WAF instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-7pp26f1****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the WAF instance.'."\n" + ."\n" + .'> You can call the [DescribeInstanceInfo](~~140857~~) operation to query the ID of the WAF instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-7pp26f1****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name whose configurations you want to modify.'."\n" + ."\n" + .'> You can call the [DescribeDomainNames](~~86373~~) operation to query the domain names that are added to Web Application Firewall (WAF).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'SourceIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The address type of the origin server. The address can be an IP address or a domain name. You can specify only one type of address.'."\n" + ."\n" + .'* If you use the IP address type, specify the value in the `["ip1","ip2",...]` format. You can add up to 20 IP addresses.'."\n" + .'* If you use the domain name type, specify the value in the `["domain"]` format. You can enter only one domain name.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["39.XX.XX.197"]', + ], + ], + [ + 'name' => 'LoadBalancing', + 'in' => 'query', + 'schema' => [ + 'description' => 'The load balancing algorithm that is used when WAF forwards requests to the origin server. Valid values:'."\n" + ."\n" + .'* **0**: IP hash'."\n" + .'* **1**: round-robin'."\n" + .'* **2**: least time'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'HttpPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTP ports. Specify the value in the `["port1","port2",...]` format.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns**. If you specify this parameter, your website uses HTTP. You must specify at least one of the **HttpPort** and **HttpsPort** parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[80]', + ], + ], + [ + 'name' => 'HttpsPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTPS ports. Specify the value in the `["port1","port2",...]` format.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns**. If you specify this parameter, your website uses HTTPS. You must specify at least one of the **HttpPort** and **HttpsPort** parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[443]', + ], + ], + [ + 'name' => 'Http2Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTP/2 ports. Specify the value in the `["port1","port2",...]` format.'."\n" + ."\n" + .'> You need to specify this parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns** and the **HttpsPort** parameter is not empty. If the HttpsPort parameter is not empty, your website uses HTTPS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[443]', + ], + ], + [ + 'name' => 'HttpsRedirect', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the feature of redirecting HTTP requests to HTTPS requests. If you enable the feature, HTTP requests are redirected to HTTPS requests on port 443, which is used by default. Valid values:'."\n" + ."\n" + .'* **0**: disables the feature. This is the default value.'."\n" + .'* **1**: enables the feature.'."\n" + ."\n" + .'> You need to specify this parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns** and the **HttpsPort** parameter is not empty. If the HttpsPort parameter is not empty, your website uses HTTPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'HttpToUserIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the feature of redirecting HTTPS requests to HTTP requests. If you enable the feature, HTTPS requests are redirected to HTTP requests on port 80, which is used by default. Valid values:'."\n" + ."\n" + .'* **0**: disables the feature. This is the default value.'."\n" + .'* **1**: enables the feature.'."\n" + ."\n" + .'> You need to specify this parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns** and the **HttpsPort** parameter is not empty. If the HttpsPort parameter is not empty, your website uses HTTPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'IsAccessProduct', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to deploy a Layer 7 proxy, which is used to filter inbound traffic before the traffic reaches the WAF instance. The supported Layer 7 proxies include Anti-DDoS Pro, Anti-DDoS Premium, and Alibaba Cloud CDN. Valid values:'."\n" + ."\n" + .'* **0**: does not configure a Layer 7 proxy'."\n" + .'* **1**: configures a Layer 7 proxy'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AccessHeaderMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that WAF uses to obtain the actual IP address of a client. Valid values:'."\n" + ."\n" + .'* **0**: WAF reads the first value of the X-Forwarded-For (XFF) header field as the actual IP address of the client. This is the default value.'."\n" + .'* **1**: WAF reads the value of a custom header field as the actual IP address of the client.'."\n" + ."\n" + .'> You need to specify the parameter only when the **IsAccessProduct** parameter is set to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'AccessHeaders', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom header fields that are used to obtain the actual IP address of a client. Specify the value in the `["header1","header2",...]` format.'."\n" + ."\n" + .'> You need to specify the parameter only when the **AccessHeaderMode** parameter is set to **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["X-Client-IP"]', + ], + ], + [ + 'name' => 'LogHeaders', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key-value pair that is used to mark the requests that pass through the WAF instance.'."\n" + ."\n" + .'Specify the key-value pair in the `[{"k":"_key_","v":"_value_"}]` format. `_key_` specifies a header field in a custom request. `_value_` specifies the value of the field.'."\n" + ."\n" + .'WAF automatically adds the key-value pair to the headers of requests. This way, the requests that pass through WAF are identified.'."\n" + ."\n" + .'> If requests contain the custom header field, WAF overwrites the original value of the field with the specified value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"k":"ALIWAF-TAG","v":"Yes"}]', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of WAF protection cluster. Valid values:'."\n" + ."\n" + .'* **0**: shared cluster. This is the default value.'."\n" + .'* **1**: exclusive cluster.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ConnectionTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period for connections of WAF exclusive clusters. Unit: seconds.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns** and the value of the **ClusterType** parameter is set to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '5', + ], + ], + [ + 'name' => 'ReadTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period for read connections of WAF exclusive clusters. Unit: seconds.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns** and the value of the **ClusterType** parameter is set to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + 'default' => '120', + ], + ], + [ + 'name' => 'WriteTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period for write connections of WAF exclusive clusters. Unit: seconds.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns** and the value of the **ClusterType** parameter is set to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + 'default' => '120', + ], + ], + [ + 'name' => 'AccessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode that is used to add the domain name. Valid values:'."\n" + ."\n" + .'* **waf-cloud-dns**: CNAME record mode. This is the default value.'."\n" + .'* **waf-cloud-native**: transparent proxy mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'waf-cloud-dns', + ], + ], + [ + 'name' => 'CloudNativeInstances', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of server and port configurations for the transparent proxy mode. The value is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that contains the following fields:'."\n" + ."\n" + .'* **ProtocolPortConfigs**: the list of protocol and port configurations. This field is required. Data type: array. Each element in a JSON array is a JSON struct that contains the following fields:'."\n" + ."\n" + .' * **Ports**: the list of ports. This field is required. Data type: array. The value is in the `[port1,port2,……]` format.'."\n" + .' * **Protocol**: the protocol. This field is required. Data type: string. Valid values: **http** and **https**.'."\n" + ."\n" + .'* **CloudNativeProductName**: the type of the cloud service instance. This field is required. Data type: string. Valid values: **ECS**, **SLB**, and **ALB**.'."\n" + ."\n" + .'* **RedirectionTypeName**: the type of traffic redirection port. This field is required. Data type: string. Valid values: **ECS**, **SLB-L4**, **SLB-L7**, and **ALB**.'."\n" + ."\n" + .'* **InstanceId**: the ID of the cloud service instance. This field is required. Data type: string.'."\n" + ."\n" + .'* **IPAddressList**: the list of public IP addresses of the cloud service instance. This field is required. Data type: array. The value is in the `["ip1","ip2",...]` format.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-native**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}]', + ], + ], + [ + 'name' => 'IpFollowStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the feature of forwarding requests to the origin servers that use the IP address type specified in the requests. If you enable the feature, WAF forwards requests from IPv4 addresses to origin servers that use IPv4 addresses and requests from IPv6 addresses to origin servers that use IPv6 addresses. Valid values:'."\n" + ."\n" + .'* **0**: disables the feature. This is the default value.'."\n" + .'* **1**: enables the feature.'."\n" + ."\n" + .'> You need to specify the parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SniStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable origin SNI. Origin Server Name Indication (SNI) specifies the domain name to which an HTTPS connection needs to be established at the start of the TLS handshaking process when WAF forwards requests to the origin server. If the origin server hosts multiple domain names, you must enable this feature. Valid values:'."\n" + ."\n" + .'* **0**: disables origin SNI.'."\n" + .'* **1**: enables origin SNI.'."\n" + ."\n" + .'By default, origin SNI is disabled for WAF instances in the Chinese mainland and enabled for WAF instances outside the Chinese mainland.'."\n" + ."\n" + .'> You need to specify this parameter only when the value of the **AccessType** parameter is set to **waf-cloud-dns** and the **HttpsPort** parameter is not empty. If the HttpsPort parameter is not empty, your website uses HTTPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SniHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the custom SNI field. If this parameter is not specified, the value of the **Host** field in the request header is automatically used as the value of the SNI field.'."\n" + ."\n" + .'If you want WAF to use an SNI field whose value is different from the value of the Host field, you can specify a custom value for the SNI field.'."\n" + ."\n" + .'> This parameter needs to be set only when the value of the **SniStatus** parameter is set to **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'waf.example.com', + ], + ], + [ + 'name' => 'Retry', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Keepalive', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'KeepaliveRequests', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '60', + 'example' => '1000', + 'default' => '1000', + ], + ], + [ + 'name' => 'KeepaliveTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '1', + 'example' => '60', + 'default' => '15', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the WAF instance is deployed. Valid values:'."\n" + ."\n" + .'* **cn-hangzhou**: Chinese mainland.'."\n" + .'* **ap-southeast-1**: outside the Chinese mainland.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19****5EB0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyDomainResponse>\\r\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\r\\n</ModifyDomainResponse>","errorExample":""}]', + 'title' => 'ModifyDomain', + 'summary' => 'Modifies the configurations of a domain name.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteDomainResponse>\\r\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\r\\n</DeleteDomainResponse>","errorExample":""}]', + 'title' => 'DeleteDomain', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCertificates' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-zz11sr5****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ECF65091-3704-55D5-BC88-EC208B0E238C', + ], + 'Certificates' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsUsing' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CertificateName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '*.aliyundoc.com', + ], + 'CertificateId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2329260', + ], + 'CommonName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '*.aliyundoc.com', + ], + 'Sans' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '*.aliyundoc.com', + ], + ], + 'EndTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ECF65091-3704-55D5-BC88-EC208B0E238C\\",\\n \\"Certificates\\": [\\n {\\n \\"IsUsing\\": false,\\n \\"CertificateName\\": \\"*.aliyundoc.com\\",\\n \\"CertificateId\\": 2329260,\\n \\"CommonName\\": \\"*.aliyundoc.com\\",\\n \\"Sans\\": [\\n \\"*.aliyundoc.com\\"\\n ],\\n \\"EndTime\\": 1971273600000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCertificatesResponse>\\n <RequestId>ECF65091-3704-55D5-BC88-EC208B0E238C</RequestId>\\n <Certificates>\\n <IsUsing>false</IsUsing>\\n <CertificateName>*.aliyundoc.com</CertificateName>\\n <CertificateId>2329260</CertificateId>\\n <CommonName>*.aliyundoc.com</CommonName>\\n <Sans>*.aliyundoc.com</Sans>\\n </Certificates>\\n</DescribeCertificatesResponse>","errorExample":""}]', + 'title' => 'DescribeCertificates', + 'summary' => 'Queries the SSL certificates that are associated with a domain name and managed by Alibaba Cloud Certificate Management Service.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCertMatchStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN CERTIFICATE----- 62EcYPWd2Oy1vs6MTXcJSfN9Z7rZ9fmxWr2BFN2XbahgnsSXM48ixZJ4krc+1M+j2kcubVpsE2cgHdj4v8H6jUz9Ji4mr7vMNS6dXv8PUkl/qoDeNGCNdyTS5NIL5ir+g92cL8IGOkjgvhlqt9vc65Cgb4mL+n5+DV9uOyTZTW/MojmlgfUekC2xiXa54nxJf17Y1TADGSbyJbsC0Q9nIrHsPl8YKkvRWvIAqYxXZ7wRwWWmv4TMxFhWRiNY7yZIo2ZUhl02SIDNggIEeg== -----END CERTIFICATE-----', + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN RSA PRIVATE KEY----- DADTPZoOHd9WtZ3UKHJTRgNQmioPQn2bqdKHop+B/dn/4VZL7Jt8zSDGM9sTMThLyvsmLQKBgQCr+ujntC1kN6pGBj2Fw2l/EA/W3rYEce2tyhjgmG7rZ+A/jVE9fld5sQra6ZdwBcQJaiygoIYoaMF2EjRwc0qwHaluq0C15f6ujSoHh2e+D5zdmkTg/3NKNjqNv6xA2gYpinVDzFdZ9Zujxvuh9o4Vqf0YF8bv5UK5G04RtKadOw== -----END RSA PRIVATE KEY-----', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MatchStatus' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MatchStatus\\": false,\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeCertMatchStatusResponse>\\n\\t<MatchStatus>false</MatchStatus>\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</DescribeCertMatchStatusResponse>","errorExample":""}]', + 'title' => 'DescribeCertMatchStatus', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCertificate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE----- 62EcYPWd2Oy1vs6MTXcJSfN9Z7rZ9fmxWr2BFN2XbahgnsSXM48ixZJ4krc+1M+j2kcubVpsE2cgHdj4v8H6jUz9Ji4mr7vMNS6dXv8PUkl/qoDeNGCNdyTS5NIL5ir+g92cL8IGOkjgvhlqt9vc65Cgb4mL+n5+DV9uOyTZTW/MojmlgfUekC2xiXa54nxJf17Y1TADGSbyJbsC0Q9nIrHsPl8YKkvRWvIAqYxXZ7wRwWWmv4TMxFhWRiNY7yZIo2ZUhl02SIDNggIEeg== -----END CERTIFICATE-----', + 'default' => 'cn', + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN RSA PRIVATE KEY----- DADTPZoOHd9WtZ3UKHJTRgNQmioPQn2bqdKHop+B/dn/4VZL7Jt8zSDGM9sTMThLyvsmLQKBgQCr+ujntC1kN6pGBj2Fw2l/EA/W3rYEce2tyhjgmG7rZ+A/jVE9fld5sQra6ZdwBcQJaiygoIYoaMF2EjRwc0qwHaluq0C15f6ujSoHh2e+D5zdmkTg/3NKNjqNv6xA2gYpinVDzFdZ9Zujxvuh9o4Vqf0YF8bv5UK5G04RtKadOw== -----END RSA PRIVATE KEY-----', + ], + ], + [ + 'name' => 'CertificateName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CertName', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CertificateId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2329260', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertificateId\\": 2329260,\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<CreateCertificateResponse>\\n\\t<CertificateId>2329260</CertificateId>\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</CreateCertificateResponse>","errorExample":""}]', + 'title' => 'CreateCertificate', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCertificateByCertificateId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'CertificateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3384669', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-zz11sr5****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CertificateId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3384669', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertificateId\\": 3384669,\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCertificateByCertificateIdResponse>\\n <CertificateId>3384669</CertificateId>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</CreateCertificateByCertificateIdResponse>","errorExample":""}]', + 'title' => 'CreateCertificateByCertificateId', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainBasicConfigs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-tl32ast****', + ], + ], + [ + 'name' => 'DomainKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyundoc', + ], + ], + [ + 'name' => 'AccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'waf-cloud-dns', + ], + ], + [ + 'name' => 'CloudNativeProductId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm2pz25js****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + 'DomainConfigs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Domain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.aliyundoc.com', + ], + 'Owner' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'WAF', + ], + 'CcMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CcStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AccessType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'waf-cloud-dns', + ], + 'Version' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AclStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WafStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WafMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbbiden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\",\\n \\"DomainConfigs\\": [\\n {\\n \\"Status\\": 1,\\n \\"Domain\\": \\"www.aliyundoc.com\\",\\n \\"Owner\\": \\"WAF\\",\\n \\"CcMode\\": 0,\\n \\"CcStatus\\": 1,\\n \\"AccessType\\": \\"waf-cloud-dns\\",\\n \\"Version\\": 0,\\n \\"AclStatus\\": 1,\\n \\"WafStatus\\": 1,\\n \\"WafMode\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainBasicConfigsResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n <DomainConfigs>\\n <Status>1</Status>\\n <Domain>www.aliyundoc.com</Domain>\\n <Owner>WAF</Owner>\\n <CcMode>0</CcMode>\\n <CcStatus>1</CcStatus>\\n <Version>0</Version>\\n <AclStatus>1</AclStatus>\\n <WafStatus>1</WafStatus>\\n <WafMode>0</WafMode>\\n </DomainConfigs>\\n</DescribeDomainBasicConfigsResponse>","errorExample":""}]', + 'title' => 'DescribeDomainBasicConfigs', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainAdvanceConfigs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-2r427ng****', + ], + ], + [ + 'name' => 'DomainList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + 'DomainConfigs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.aliyundoc.com', + ], + 'Profile' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Http2Port' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + ], + 'Ipv6Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HttpPort' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + 'GSLBStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'on', + ], + 'Rs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '38.XX.XX.42', + ], + 'example' => '["39.XX.XX.197"]', + ], + 'VipServiceStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ClusterType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExclusiveVipStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cname' => [ + 'description' => '', + 'type' => 'string', + 'example' => '****dsbpkt75zeiok5mta2j5l7hggcrm.****.com', + ], + 'CertStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HttpsPort' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + ], + 'ResolvedType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\",\\n \\"DomainConfigs\\": [\\n {\\n \\"Domain\\": \\"www.aliyundoc.com\\",\\n \\"Profile\\": {\\n \\"Http2Port\\": [\\n 443\\n ],\\n \\"Ipv6Status\\": 1,\\n \\"HttpPort\\": [\\n 80\\n ],\\n \\"GSLBStatus\\": \\"on\\",\\n \\"Rs\\": [\\n \\"38.XX.XX.42\\"\\n ],\\n \\"VipServiceStatus\\": 0,\\n \\"ClusterType\\": 0,\\n \\"ExclusiveVipStatus\\": 0,\\n \\"Cname\\": \\"****dsbpkt75zeiok5mta2j5l7hggcrm.****.com\\",\\n \\"CertStatus\\": 1,\\n \\"HttpsPort\\": [\\n 443\\n ],\\n \\"ResolvedType\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainAdvanceConfigsResponse>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n <DomainConfigs>\\n <Domain>www.aliyundoc.com</Domain>\\n <Profile>\\n <Http2Port>443</Http2Port>\\n <Ipv6Status>1</Ipv6Status>\\n <HttpPort>80</HttpPort>\\n <GSLBStatus>on</GSLBStatus>\\n <Rs>38.XX.XX.42</Rs>\\n <VipServiceStatus>0</VipServiceStatus>\\n <ClusterType>0</ClusterType>\\n <ExclusiveVipStatus>0</ExclusiveVipStatus>\\n <Cname>****dsbpkt75zeiok5mta2j5l7hggcrm.****.com</Cname>\\n <CertStatus>1</CertStatus>\\n <HttpsPort>443</HttpsPort>\\n <ResolvedType>0</ResolvedType>\\n </Profile>\\n </DomainConfigs>\\n</DescribeDomainAdvanceConfigsResponse>","errorExample":""}]', + 'title' => 'DescribeDomainAdvanceConfigs', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm2pz25js****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-7pp26f1****', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'IsSub', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'example' => 'example.com', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '592E866F-6C05-4E7C-81DE-B4D8E86B91EF', + ], + 'DomainNames' => [ + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["www.example.com","test.example.com"]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"592E866F-6C05-4E7C-81DE-B4D8E86B91EF\\",\\n \\"DomainNames\\": [\\n \\"www.example.com\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeDomainListResponse>\\r\\n\\t<TotalCount>2</TotalCount>\\r\\n\\t<RequestId>592E866F-6C05-4E7C-81DE-B4D8E86B91EF</RequestId>\\r\\n\\t<DomainNames>www.example.com</DomainNames>\\r\\n\\t<DomainNames>test.example.com</DomainNames>\\r\\n</DescribeDomainListResponse>","errorExample":""}]', + 'title' => 'DescribeDomainList', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeProtectionModuleMode' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + 'Mode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DE14845A-F46F-59BE-B8F7-6ED7A787D213\\",\\n \\"Mode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<DescribeProtectionModuleModeResponse>\\n <LearnStatus>3</LearnStatus>\\n <RequestId>DE14845A-F46F-59BE-B8F7-6ED7A787D213</RequestId>\\n <Mode>0</Mode>\\n</DescribeProtectionModuleModeResponse>","errorExample":""}]', + 'title' => 'DescribeProtectionModuleMode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDomainIpv6Status' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-mp9153****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyDomainIpv6StatusResponse>\\r\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\r\\n</ModifyDomainIpv6StatusResponse>","errorExample":""}]', + 'title' => 'ModifyDomainIpv6Status', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeProtectionModuleStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-zz11sr5****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModuleStatus\\": 1,\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeProtectionModuleStatusResponse>\\n <ModuleStatus>1</ModuleStatus>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</DescribeProtectionModuleStatusResponse>","errorExample":""}]', + 'title' => 'DescribeProtectionModuleStatus', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyProtectionModuleStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf', + ], + ], + [ + 'name' => 'ModuleStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-zz11sr5****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\"\\n}","type":"json"}]', + 'title' => 'ModifyProtectionModuleStatus', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyProtectionModuleMode' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyProtectionModuleModeResponse>\\r\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\r\\n</ModifyProtectionModuleModeResponse>","errorExample":""}]', + 'title' => 'ModifyProtectionModuleMode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeProtectionModuleRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac_highfreq', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'e2ZpbHRlcjp7InJ1bGVJZCI6NDI3NTV9LG9yZGVyQnk6ImdtdF9tb2RpZmllZCIsZGVzYzp0cnVlfQ==', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm2pz25js****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + 'Rules' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Time' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1570700044', + ], + 'Content' => [ + 'description' => '', + 'type' => 'object', + 'example' => '{"count":60,"interval":60,"ttl":300}', + ], + 'Version' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42755', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\",\\n \\"Rules\\": [\\n {\\n \\"Status\\": 1,\\n \\"Time\\": 1570700044,\\n \\"Content\\": {\\n \\"count\\": 60,\\n \\"interval\\": 60,\\n \\"ttl\\": 300\\n },\\n \\"Version\\": 2,\\n \\"RuleId\\": 42755\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeProtectionModuleRulesResponse>\\n\\t<TotalCount>1</TotalCount>\\n\\t<Rules>\\n\\t\\t<Version>2</Version>\\n\\t\\t<Status>1</Status>\\n\\t\\t<Content>\\n\\t\\t\\t<count>60</count>\\n\\t\\t\\t<interval>60</interval>\\n\\t\\t\\t<ttl>300</ttl>\\n\\t\\t</Content>\\n\\t\\t<RuleId>42755</RuleId>\\n\\t\\t<Time>1570700044</Time>\\n\\t</Rules>\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</DescribeProtectionModuleRulesResponse>","errorExample":""}]', + 'title' => 'DescribeProtectionModuleRules', + 'extraInfo' => ' ', + ], + 'CreateProtectionModuleRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac_custom', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => ' {"action":"monitor","name":"test","scene":"custom_acl","conditions":[{"opCode":1,"key":"URL","values":"/example"}]}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateProtectionModuleRuleResponse>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</CreateProtectionModuleRuleResponse>","errorExample":""}]', + 'title' => 'CreateProtectionModuleRule', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyProtectionModuleRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac_custom', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => ' {"action":"monitor","name":"test","scene":"custom_acl","conditions":[{"opCode":1,"key":"URL","values":"/example"}]}', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '369998', + ], + ], + [ + 'name' => 'LockVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-0xldbqt****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyProtectionModuleRuleResponse>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</ModifyProtectionModuleRuleResponse>","errorExample":""}]', + 'title' => 'ModifyProtectionModuleRule', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyProtectionRuleStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '93408', + 'abilityTreeNodes' => [ + 'FEATUREwafNZKQ0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'tamperproof', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '42755', + ], + ], + [ + 'name' => 'RuleStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'LockVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyProtectionRuleStatusResponse>\\r\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\r\\n</ModifyProtectionRuleStatusResponse>","errorExample":""}]', + 'title' => 'ModifyProtectionRuleStatus', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRuleGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-tl32ast****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RuleGroupId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1012', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + 'WafAiStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RuleGroupId\\": 1012,\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\",\\n \\"WafAiStatus\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainRuleGroupResponse>\\n <RuleGroupId>1012</RuleGroupId>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n <WafAiStatus>1</WafAiStatus>\\n</DescribeDomainRuleGroupResponse>","errorExample":""}]', + 'title' => 'DescribeDomainRuleGroup', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetDomainRuleGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Domains', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '["www.aliyundoc.com"]', + ], + ], + [ + 'name' => 'RuleGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1012', + ], + ], + [ + 'name' => 'WafVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-tl32ast****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm2pz25js****', + ], + ], + [ + 'name' => 'WafAiStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<SetDomainRuleGroupResponse>\\n <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\n</SetDomainRuleGroupResponse>","errorExample":""}]', + 'title' => 'SetDomainRuleGroup', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyProtectionRuleCacheStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '93407', + 'abilityTreeNodes' => [ + 'FEATUREwafI1HM4C', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '42755', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'tamperproof', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyProtectionRuleCacheStatusResponse>\\r\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\r\\n</ModifyProtectionRuleCacheStatusResponse>","errorExample":""}]', + 'title' => 'ModifyProtectionRuleCacheStatus', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteProtectionModuleRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'DefenseType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac_custom', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '42754', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-mp9153****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1557B42F-B889-460A-B17F-1DE5C5AD7FF2', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1557B42F-B889-460A-B17F-1DE5C5AD7FF2\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProtectionModuleRuleResponse>\\n <RequestId>1557B42F-B889-460A-B17F-1DE5C5AD7FF2</RequestId>\\n</DeleteProtectionModuleRuleResponse>","errorExample":""}]', + 'title' => 'DeleteProtectionModuleRule', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeProtectionModuleCodeConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '14', + ], + ], + [ + 'name' => 'CodeValue', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm2pz25js****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CodeConfigs' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[{"code":0,"name":"310000,530000,150000,110000,TW_01,220000,510000,120000,640000,340000,370000,140000,440000,450000,650000,320000,360000,130000,410000,330000,460000,420000,430000,MO_01,620000,350000,540000,520000,210000,500000,610000,630000,HK_01,230000","env":"online"}]', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BE3911B8-9D96-5B39-8875-503BBC9DA4BF', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CodeConfigs\\": \\"[{\\\\\\"code\\\\\\":0,\\\\\\"name\\\\\\":\\\\\\"310000,530000,150000,110000,TW_01,220000,510000,120000,640000,340000,370000,140000,440000,450000,650000,320000,360000,130000,410000,330000,460000,420000,430000,MO_01,620000,350000,540000,520000,210000,500000,610000,630000,HK_01,230000\\\\\\",\\\\\\"env\\\\\\":\\\\\\"online\\\\\\"}]\\",\\n \\"RequestId\\": \\"BE3911B8-9D96-5B39-8875-503BBC9DA4BF\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeProtectionModuleCodeConfigResponse>\\r\\n\\t<RequestId>BE3911B8-9D96-5B39-8875-503BBC9DA4BF</RequestId>\\r\\n\\t<CodeConfigs>\\r\\n\\t\\t<code>0</code>\\r\\n\\t\\t<name>310000,530000,150000,110000,TW_01,220000,510000,120000,640000,340000,370000,140000,440000,450000,650000,320000,360000,130000,410000,330000,460000,420000,430000,MO_01,620000,350000,540000,520000,210000,500000,610000,630000,HK_01,230000</name>\\r\\n\\t\\t<env>online</env>\\r\\n\\t</CodeConfigs>\\r\\n</DescribeProtectionModuleCodeConfigResponse>","errorExample":""}]', + 'title' => 'DescribeProtectionModuleCodeConfig', + 'extraInfo' => ' ', + ], + 'DescribeRuleGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '93352', + 'abilityTreeNodes' => [ + 'FEATUREwaf10VDFG', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60.208.111.213', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'WafLang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ZH', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'enum' => [ + '1', + '10', + ], + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1011', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_cdnsdf3****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + 'default' => 'cn', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek23puu7m3kmea', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '02E9A4B8-90FB-5F41-A049-C82277EB82FB', + ], + 'TaskStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WafTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'RuleGroups' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleGroupUpdateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711445265', + ], + 'PolicyId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '116562', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rule_group_test', + ], + 'TemplatePolicyId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1102', + ], + 'RuleGroupTemplateName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rule_group_test', + ], + 'Desc' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'desc', + ], + 'WafVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'DomainList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.aliyundome.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"02E9A4B8-90FB-5F41-A049-*\\",\\n \\"TaskStatus\\": 2,\\n \\"Total\\": 1,\\n \\"WafTaskId\\": \\"123\\",\\n \\"RuleGroups\\": [\\n {\\n \\"Type\\": 1,\\n \\"RuleCnt\\": 1,\\n \\"RuleGroupUpdateTime\\": 1711445265,\\n \\"PolicyId\\": 116562,\\n \\"Name\\": \\"rule_group_test\\",\\n \\"TemplatePolicyId\\": 1102,\\n \\"RuleGroupTemplateName\\": \\"rule_group_test\\",\\n \\"Desc\\": \\"desc\\",\\n \\"WafVersion\\": 11,\\n \\"DomainList\\": [\\n \\"test.aliyundome.com\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '93355', + 'abilityTreeNodes' => [ + 'FEATUREwaf10VDFG', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '42.84.*.*', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleIdKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' 1131*0', + ], + ], + [ + 'name' => 'CveIdKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'CVE ID', + 'type' => 'string', + 'required' => false, + 'example' => 'CVE-*-*5', + ], + ], + [ + 'name' => 'ProtectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '11', + ], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1012', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-*', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + 'default' => 'cn', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-*', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RuleGroupTemplateId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1012', + ], + 'RuleGroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test111', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-*', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleGroupTemplateName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rule_group_test', + ], + 'IsSubscribe' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Rules' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684120148.0', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CveUrl' => [ + 'description' => '', + 'type' => 'string', + ], + 'ApplicationType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'CveId' => [ + 'description' => 'CVE ID。', + 'type' => 'string', + 'example' => 'CVE-2021-*', + ], + 'ProtectionType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'RuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rules_41', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42755', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RuleGroupTemplateId\\": \\"1012\\",\\n \\"RuleGroupName\\": \\"test111\\",\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-*\\",\\n \\"TotalCount\\": 1,\\n \\"RuleGroupTemplateName\\": \\"rule_group_test\\",\\n \\"IsSubscribe\\": 1,\\n \\"Rules\\": [\\n {\\n \\"RiskLevel\\": 0,\\n \\"UpdateTime\\": 1684120148,\\n \\"Description\\": \\"默认\\",\\n \\"CveUrl\\": \\"https://avd.aliyun.com/\\",\\n \\"ApplicationType\\": 15,\\n \\"CveId\\": \\"CVE-2021-*\\",\\n \\"ProtectionType\\": 11,\\n \\"RuleName\\": \\"rules_41\\",\\n \\"RuleId\\": 42755\\n }\\n ]\\n}","type":"json"}]', + ], + 'ModifyLogRetrievalStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbbiden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyLogRetrievalStatusResponse>\\r\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\r\\n</ModifyLogRetrievalStatusResponse>","errorExample":""}]', + 'title' => 'ModifyLogRetrievalStatus', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyLogServiceStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf_elasticity-cn-0xldbqt****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D7861F61-5B61-46CE-A47C-6B19160D5EB0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbbiden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19160D5EB0\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyLogServiceStatusResponse>\\r\\n\\t<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>\\r\\n</ModifyLogServiceStatusResponse>","errorExample":""}]', + 'title' => 'ModifyLogServiceStatus', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLogServiceStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-zz11sr5****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + 'default' => 'cn', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm2pz25js****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'example' => 'www.aliyun.com', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C2E97B3F-1623-4CDF-A7E2-FD9D4CF1027A', + ], + 'DomainStatus' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.aliyun.com', + ], + 'SlsLogActive' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 63,\\n \\"RequestId\\": \\"D7861F61-5B61-46CE-A47C-6B19****5EB0\\",\\n \\"DomainStatus\\": [\\n {\\n \\"Domain\\": \\"www.aliyun.com\\",\\n \\"SlsLogActive\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeLogServiceStatusResponse>\\r\\n\\t<RequestId>C2E97B3F-1623-4CDF-A7E2-FD9D4CF1027A</RequestId>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<DomainStatus>\\r\\n\\t\\t<Domain>www.aliyun.com</Domain>\\r\\n\\t\\t<SlsLogActive>1</SlsLogActive>\\r\\n\\t</DomainStatus>\\r\\n</DescribeLogServiceStatusResponse>","errorExample":""}]', + 'title' => 'DescribeLogServiceStatus', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeWafSourceIpSegment' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-zz11sr5****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm2pz25js****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AB2F5E31-EE96-4FD7-9560-45FF5D5377FF', + ], + 'Ips' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.XXX.XXX.192/26,……,47.XXX.XXX.0/24', + ], + 'IpV6s' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39.XXX.XXX.0/24,……,2408:400a:XXXX:XXXX::/56', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AB2F5E31-EE96-4FD7-9560-45FF****77FF\\",\\n \\"Ips\\": \\"47.XXX.XXX.192/26,……,47.XXX.XXX.0/24\\",\\n \\"IpV6s\\": \\"39.XXX.XXX.0/24,……,2408:400a:XXXX:XXXX::/56\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeWafSourceIpSegmentResponse>\\r\\n\\t<RequestId>AB2F5E31-EE96-4FD7-9560-45FF5D5377FF</RequestId>\\r\\n\\t<IpV6s>39.XXX.XXX.0/24,……,2408:400a:XXXX:XXXX::/56</IpV6s>\\r\\n\\t<Ips>47.XXX.XXX.192/26,……,47.XXX.XXX.0/24</Ips>\\r\\n</DescribeWafSourceIpSegmentResponse>\\t","errorExample":""}]', + 'title' => 'DescribeWafSourceIpSegment', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MoveResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'waf-cn-09k1rd5****~www.example.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-atstuj3rtop****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'domain', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C33EB3D5-AF96-43CA-9C7E-37A8****6A1E\\"\\n}","type":"json"}]', + 'title' => 'MoveResourceGroup', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'wafopenapi.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'wafopenapi.ap-southeast-1.aliyuncs.com', + ], + ], +]; |