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/cloudfw/2017-12-07 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/cloudfw/2017-12-07')
| -rw-r--r-- | data/en_us/cloudfw/2017-12-07/api-docs.php | 58527 |
1 files changed, 58527 insertions, 0 deletions
diff --git a/data/en_us/cloudfw/2017-12-07/api-docs.php b/data/en_us/cloudfw/2017-12-07/api-docs.php new file mode 100644 index 0000000..b868b20 --- /dev/null +++ b/data/en_us/cloudfw/2017-12-07/api-docs.php @@ -0,0 +1,58527 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cloudfw', + 'version' => '2017-12-07', + ], + 'directories' => [ + [ + 'id' => 362724, + 'title' => 'Overview', + 'type' => 'directory', + 'children' => [ + 'DescribeUserBuyVersion', + 'DescribeSlrGrant', + 'DescribeMemberInfo', + 'DescribeInstanceRiskLevels', + 'DescribeInternetOpenStatistic', + 'ModifyCfwInstance', + 'ReleasePostInstance', + 'ReleaseExpiredInstance', + 'DescribeRiskEventTopAttackAsset', + 'DescribeAttackAppCategory', + 'DescribeOutgoingRiskTrend', + 'DescribeUnprotectedPortTrend', + 'DescribeVpcFirewallDropTrafficTrend', + 'DescribeOutgoingRiskDomainAndIpCount', + [ + 'id' => 362739, + 'title' => 'Traffic Trend', + 'type' => 'directory', + 'children' => [ + 'DescribeNatFirewallDropTrafficTrend', + 'DescribeInternetDropTrafficTrend', + 'DescribeInvadeEcsTrend', + ], + ], + [ + 'id' => 362743, + 'title' => 'Pay by volume', + 'type' => 'directory', + 'children' => [ + 'DescribePostpayEnabledProtection', + 'DescribePostpayTrafficTotal', + 'DescribePostpayTrafficDetail', + 'DescribePostpayUserInternetStatus', + 'DescribePostpayUserNatStatus', + 'DescribePostpayUserVpcStatus', + 'UpdatePostpayUserInternetStatus', + 'UpdatePostpayUserNatStatus', + 'UpdatePostpayUserVpcStatus', + ], + ], + ], + ], + [ + 'id' => 362753, + 'title' => 'Firewall switch', + 'type' => 'directory', + 'children' => [ + 'DescribeRegionInfo', + 'DescribeCtrlInstanceMemberAccounts', + 'DescribeFirewallTask', + [ + 'id' => 362757, + 'title' => 'Internet Border Firewall', + 'type' => 'directory', + 'children' => [ + 'DescribeResourceTypeAutoEnable', + 'DescribeAssetList', + 'DescribeAssetStatistic', + 'DescribeAssetRiskList', + 'CreateInstanceSyncTask', + 'ModifyResourceTypeAutoEnable', + 'PutEnableFwSwitch', + 'PutEnableAllFwSwitch', + 'PutDisableFwSwitch', + 'PutDisableAllFwSwitch', + ], + ], + [ + 'id' => 362768, + 'title' => 'NAT Border Firewall', + 'type' => 'directory', + 'children' => [ + 'DescribeNatFirewallQuota', + 'DescribeNatFirewallList', + 'DescribeFirewallVSwitch', + 'DescribeNatFirewallPrecheckDetail', + 'DescribeFirewallVswitchResources', + 'DescribeSecurityProxyResources', + 'CreateNatFirewallSyncTask', + 'CreateNatFirewallPreCheck', + 'CreateSecurityProxy', + 'SwitchSecurityProxy', + 'UpdateSecurityProxy', + 'DeleteSecurityProxy', + ], + ], + [ + 'id' => 362781, + 'title' => 'VPC perimeter firewall', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallSummaryInfo', + 'DescribeVpcFirewallAccessDetail', + 'DescribeVpcFirewallPrecheckDetail', + 'CreateVpcFirewallPrecheck', + 'CreateVpcFirewallTask', + [ + 'id' => 362787, + 'title' => 'Cloud Enterprise Network (Enterprise Edition)', + 'type' => 'directory', + 'children' => [ + 'DescribeTrFirewallsV2List', + 'DescribeTrFirewallsV2Detail', + 'DescribeTrFirewallsV2RouteList', + 'DescribeTrFirewallV2RoutePolicyList', + 'DescribeTrFirewallPolicyBackUpAssociationList', + 'DescribeTransitRouterResourcesList', + 'CreateTrFirewallV2', + 'CreateTrFirewallV2RoutePolicy', + 'ModifyTrFirewallV2Configuration', + 'ModifyFirewallV2RoutePolicySwitch', + 'ModifyTrFirewallV2RoutePolicyScope', + 'DeleteTrFirewallV2', + 'DeleteFirewallV2RoutePolicies', + ], + ], + [ + 'id' => 362801, + 'title' => 'Cloud Enterprise Network (Basic Edition)', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallCenSummaryList', + 'DescribeVpcFirewallCenList', + 'DescribeVpcFirewallCenDetail', + 'DescribeNetworkInstanceList', + 'DescribeVpcZone', + 'DescribeVpcFirewallZone', + 'DescribeVpcFirewallManualVSwitchList', + 'CreateVpcFirewallCenConfigure', + 'ModifyVpcFirewallCenConfigure', + 'ModifyVpcFirewallCenSwitchStatus', + 'DeleteVpcFirewallCenConfigure', + ], + ], + [ + 'id' => 362813, + 'title' => 'high-speed channel', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallList', + 'DescribeVpcFirewallDetail', + 'CreateVpcFirewallConfigure', + 'ModifyVpcFirewallConfigure', + 'ModifyVpcFirewallSwitchStatus', + 'DeleteVpcFirewallConfigure', + ], + ], + ], + ], + ], + ], + [ + 'id' => 362820, + 'title' => 'flow analysis', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 362821, + 'title' => 'Active outreach', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 362822, + 'title' => 'Visual Analysis', + 'type' => 'directory', + 'children' => [ + 'DescribeInternetTimeTop', + 'DescribeNatFirewallTimeTop', + ], + ], + 'DescribeNetworkTrafficTopRatio', + 'DescribeOutgoingStatistic', + 'DescribeOutgoingAssetList', + 'DescribeConfiguredDomainNames', + 'DescribeConfiguredDestinationIP', + 'DescribeOutgoingDestinationCategory', + 'DescribeOutgoingTag', + 'DescribeOutgoingDomain', + 'DescribeOutgoingDomainDetail', + 'DescribeOutgoingDestination', + 'DescribeOutgoingDestinationIP', + 'DescribeOutgoingDestinationIPDetail', + ], + ], + [ + 'id' => 362837, + 'title' => 'Public network exposure', + 'type' => 'directory', + 'children' => [ + 'DescribeInternetTrafficTop', + 'DescribeInternetTrafficTrend', + 'DescribeNatFirewallTrafficTrend', + 'DescribeInternetServiceNameList', + 'DescribeInternetOpenIp', + 'DescribeInternetOpenPort', + 'DescribeInternetOpenService', + 'DescribeInternetOpenDetail', + 'DescribeInternetSlb', + 'DescribeOpenIpAccessSrcStat', + ], + ], + [ + 'id' => 362848, + 'title' => 'VPC exchange visits', + 'type' => 'directory', + 'children' => [ + 'DescribeNetworkInstanceRelationList', + 'DescribeVpcFirewallAssetList', + ], + ], + [ + 'id' => 362851, + 'title' => 'AI access traffic', + 'type' => 'directory', + 'children' => [ + 'DescribeAITrafficAnalysisStatus', + 'DescribeVpcFirewallDomainList', + 'DescribeVpcFirewallDomainRelationList', + 'UpdateAITrafficAnalysisStatus', + 'ModifyObjectGroupOperation', + ], + ], + ], + ], + [ + 'id' => 362857, + 'title' => 'Detection Response', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 362858, + 'title' => 'intrusion prevention', + 'type' => 'directory', + 'children' => [ + 'DescribeRiskEventTopAttackApp', + 'DescribeRiskEventTopAttackType', + 'DescribeRiskEventStatistic', + 'DescribeRiskEventPayload', + 'DescribeRiskEventGroup', + ], + ], + [ + 'id' => 362864, + 'title' => 'Vulnerability Protection', + 'type' => 'directory', + 'children' => [ + 'DescribeVulnerabilityProtectedList', + 'DescribeUnprotectedVulnTrend', + ], + ], + [ + 'id' => 362867, + 'title' => 'Fall-down perception', + 'type' => 'directory', + 'children' => [ + 'DescribeInvadeEventList', + 'DescribeInvadeEventNameList', + 'DescribeInvadeEventStatistic', + 'DescribeInvadeEventDetail', + ], + ], + [ + 'id' => 362872, + 'title' => 'Data leakage', + 'type' => 'directory', + 'children' => [ + 'DescribeSdlEventList', + 'DescribeSdlEventSdList', + 'DescribeSdlEventDetail', + 'DescribeSdlEventStatistic', + 'DescribeSdlStatistic', + 'DescribeSensitiveSwitch', + 'ModifySensitiveSwitch', + 'EnableSdlProtectedAsset', + 'DisableSdlProtectedAsset', + ], + ], + ], + ], + [ + 'id' => 362882, + 'title' => 'Protection Configuration', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 362883, + 'title' => 'Access Control', + 'type' => 'directory', + 'children' => [ + 'DescribeAclApps', + 'DescribeAclWhitelist', + [ + 'id' => 362886, + 'title' => 'Boundaries of the Internet', + 'type' => 'directory', + 'children' => [ + 'DescribeAclRuleCount', + 'DescribeControlPolicy', + 'DescribeACLProtectTrend', + 'DescribePolicyAdvancedConfig', + 'DescribePolicyPriorUsed', + 'DescribeControlPolicyDomainResolve', + 'AddControlPolicy', + 'AddDomainResolveRealtimeTask', + 'ModifyControlPolicy', + 'ModifyControlPolicyPriority', + 'ModifyPolicyAdvancedConfig', + 'DeleteControlPolicy', + 'DeleteControlPolicyTemplate', + 'ResetRuleHitCount', + ], + ], + [ + 'id' => 362901, + 'title' => 'NAT Border', + 'type' => 'directory', + 'children' => [ + 'DescribeNatAclPageStatus', + 'DescribeNatFirewallAclGroupList', + 'DescribeNatFirewallControlPolicy', + 'DescribeNatFirewallPolicyPriorUsed', + 'CreateNatFirewallControlPolicy', + 'ModifyNatFirewallControlPolicy', + 'ModifyNatFirewallControlPolicyPosition', + 'ResetNatFirewallRuleHitCount', + 'DeleteNatFirewallControlPolicy', + 'DeleteNatFirewallControlPolicyBatch', + ], + ], + [ + 'id' => 362912, + 'title' => 'VPC Boundary', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallAssetRegionList', + 'DescribeVpcFirewallAclGroupList', + 'DescribeVpcFirewallControlPolicy', + 'DescribeVpcFirewallPolicyPriorUsed', + 'CreateVpcFirewallControlPolicy', + 'ModifyVpcFirewallControlPolicy', + 'ModifyVpcFirewallControlPolicyPosition', + 'ModifyVpcFirewallAclEngineMode', + 'ResetVpcFirewallRuleHitCount', + 'DeleteVpcFirewallControlPolicy', + 'BatchDeleteVpcFirewallControlPolicy', + ], + ], + [ + 'id' => 362924, + 'title' => 'DNS boundary', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcListLite', + 'DescribeDnsFirewallPolicy', + 'DescribePrefixLists', + 'AddDnsFirewallPolicy', + 'ModifyDnsFirewallPolicy', + 'DeleteDnsFirewallPolicy', + ], + ], + ], + ], + [ + 'id' => 362931, + 'title' => 'IPS Protection', + 'type' => 'directory', + 'children' => [ + 'DescribeThreatIntelligenceSwitch', + 'ModifyThreatIntelligenceSwitch', + 'ModifyIpsRulesToDefault', + 'DescribeSignatureLibVersion', + [ + 'id' => 362936, + 'title' => 'Boundaries of the Internet', + 'type' => 'directory', + 'children' => [ + 'DescribeDefaultIPSConfig', + 'DescribeUserIPSWhitelist', + 'ModifyIpsRules', + 'ModifyDefaultIPSConfig', + 'ModifyUserIPSWhitelist', + [ + 'id' => 362942, + 'title' => 'Private Network Traceability', + 'type' => 'directory', + 'children' => [ + 'DescribeIpsPrivateAssoc', + 'CreateIpsPrivateAssoc', + 'DeleteIpsPrivateAssoc', + ], + ], + ], + ], + [ + 'id' => 362946, + 'title' => 'VPC Boundary', + 'type' => 'directory', + 'children' => [ + 'DescribeVfwIPSConfigList', + 'DescribeVpcFirewallDefaultIPSConfig', + 'DescribeVpcFirewallIPSWhitelist', + 'ModifyVpcFirewallDefaultIPSConfig', + 'ModifyVpcFirewallIPSWhitelist', + ], + ], + ], + ], + [ + 'id' => 362952, + 'title' => 'TLS Check', + 'type' => 'directory', + 'children' => [ + 'ListTlsInspectCACertificates', + 'GetTlsInspectCertificateDownloadUrl', + ], + ], + [ + 'id' => 362955, + 'title' => 'strategy analysis', + 'type' => 'directory', + 'children' => [ + 'DescribeAclCheckQuota', + 'DescribeAclChecks', + 'DescribeAclCheck', + 'CreateAclCheck', + 'UpdateAclCheckDetailStatus', + ], + ], + [ + 'id' => 362961, + 'title' => 'Address Book', + 'type' => 'directory', + 'children' => [ + 'DescribeAddressBook', + 'AddAddressBook', + 'ModifyAddressBook', + 'DeleteAddressBook', + ], + ], + [ + 'id' => 362966, + 'title' => 'Synchronize nodes', + 'type' => 'directory', + 'children' => [ + 'DescribeAccessInstanceRegionList', + 'DescribeAccessInstanceTask', + 'DescribeAccessInstanceVpcList', + 'DescribeAccessInstanceVSwitchList', + 'DescribeAccessInstanceZoneList', + [ + 'id' => 362972, + 'title' => 'ACK Cluster', + 'type' => 'directory', + 'children' => [ + 'DescribeAckClusters', + 'DescribeAckClusterConnectors', + 'DescribeAckClusterConnector', + 'DescribeAckClusterNamespaces', + 'DescribeAckClusterPodLabels', + 'CreateAckClusterConnector', + 'UpdateAckClusterConnector', + 'DeleteAckClusterConnector', + ], + ], + [ + 'id' => 362981, + 'title' => 'Private DNS', + 'type' => 'directory', + 'children' => [ + 'DescribePrivateDnsEndpointList', + 'DescribePrivateDnsEndpointDetail', + 'DescribePrivateDnsStatistics', + 'CreatePrivateDnsEndpoint', + 'ModifyPrivateDnsEndpoint', + 'DeletePrivateDnsEndpoint', + 'DescribePrivateDnsDomainNameList', + 'AddPrivateDnsDomainName', + 'DeletePrivateDnsDomainName', + 'DeletePrivateDnsAllDomainName', + ], + ], + ], + ], + ], + ], + [ + 'id' => 362992, + 'title' => 'Log Monitoring', + 'type' => 'directory', + 'children' => [ + 'DescribeLogStoreInfo', + 'DescribeTrafficLog', + 'DescribeSlsAnalyzeOpenStatus', + 'DescribeClearAuthInfo', + 'DescribeLocationInfo', + 'DescribeIspInfo', + 'DescribeCreatedNatFirewall', + 'DescribeBatchSlsDispatchStatus', + 'CreateSlsLogDispatch', + 'ModifySlsDispatchStatus', + 'ModifyUserSlsLogStorageTime', + 'ClearLogStoreStorage', + ], + ], + [ + 'id' => 363005, + 'title' => 'System Settings', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 363006, + 'title' => 'Alarm Notification', + 'type' => 'directory', + 'children' => [ + 'DescribeUserAlarmConfig', + 'ModifyUserAlarmConfig', + ], + ], + [ + 'id' => 363009, + 'title' => 'Unified management of multiple accounts', + 'type' => 'directory', + 'children' => [ + 'DescribeInstanceRdAccounts', + 'DescribeInstanceMembers', + 'AddInstanceMembers', + 'ModifyInstanceMemberAttributes', + 'DeleteInstanceMembers', + ], + ], + [ + 'id' => 363015, + 'title' => 'Download Tasks', + 'type' => 'directory', + 'children' => [ + 'DescribeDownloadTask', + 'DescribeDownloadTaskType', + 'CreateDownloadTask', + 'DeleteDownloadTask', + ], + ], + [ + 'id' => 363020, + 'title' => 'Toolbox', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 363021, + 'title' => 'Policy Backup and Rollback', + 'type' => 'directory', + 'children' => [ + 'DescribeAclBackupList', + 'AddAclBackupData', + 'UseAclBackupData', + 'DeleteAclBackupData', + ], + ], + 'DescribeSecurityMode', + ], + ], + ], + ], + [ + 'id' => 363027, + 'title' => 'Abandoned', + 'type' => 'directory', + 'children' => [ + 'DescribePageDocuments', + 'DescribeDomainResolve', + 'DescribeFirewallDropStatistics', + 'DescribeUserAssetIPTrafficInfo', + 'DescribeCfwRiskLevelSummary', + 'DescribeRiskSecurityGroupDetail', + 'DescribeSecurityProxy', + 'CreateVpcFirewallCenManualConfigure', + 'BatchCopyVpcFirewallControlPolicy', + 'ModifyControlPolicyPosition', + ], + ], + [ + 'id' => 363038, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallTrafficAssetList', + 'SetAutoProtectNewAssets', + 'DescribeRegionResourceTypeAutoEnable', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeUserBuyVersion' => [ + 'summary' => 'Queries the edition information about Cloud Firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68399', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID. If the Instance ID is provided, the query will be based on this ID. If not provided, the latest instance will be queried by default.', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used to purchase Cloud Firewall.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '119898001566xxxx', + ], + 'InstanceId' => [ + 'description' => 'The instance ID of Cloud Firewall.'."\n" + ."\n" + .'> If you use a trial of Cloud Firewall, ignore this parameter.'."\n", + 'type' => 'string', + 'example' => 'vipcloudfw-cn-xxxxx', + ], + 'StartTime' => [ + 'description' => 'The time when Cloud Firewall was activated.'."\n" + ."\n" + .'> The value is a timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1692504764000', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F71B03EE-xxxxx-91D79CC6AA1A', + ], + 'Version' => [ + 'description' => 'The edition of Cloud Firewall. Valid values:'."\n" + ."\n" + .'* **2**: Premium Edition.'."\n" + .'* **3**: Enterprise Edition.'."\n" + .'* **4**: Ultimate Edition.'."\n" + .'* **10**: Cloud Firewall that uses the pay-as-you-go billing method.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UserStatus' => [ + 'description' => 'Indicates whether Cloud Firewall is valid. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Expire' => [ + 'description' => 'The time when Cloud Firewall expires.'."\n" + ."\n" + .'> The value is a timestamp in milliseconds.'."\n" + ."\n" + .'> If you use Cloud Firewall that uses the pay-as-you-go billing method, ignore this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1726934400000', + ], + 'LogStatus' => [ + 'description' => 'Indicates whether log delivery is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceStatus' => [ + 'description' => 'The status of Cloud Firewall. Valid values:'."\n" + ."\n" + .'* **normal**: Cloud Firewall is running as expected.'."\n" + .'* **init**: Cloud Firewall is being initialized.'."\n" + .'* **deleting**: Cloud Firewall is being deleted.'."\n" + .'* **abnormal**: An exception occurs in Cloud Firewall.'."\n" + .'* **free**: Cloud Firewall is invalid.'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'MaxOverflow' => [ + 'description' => 'The status of the burstable protected traffic feature. Valid values:'."\n" + ."\n" + .'* **1000000**: enabled.'."\n" + .'* **0**: disabled.'."\n" + ."\n" + .'> This parameter takes effect only for Cloud Firewall that uses the subscription billing method.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'VpcNumber' => [ + 'description' => 'The number of virtual private clouds (VPCs) that can be protected.'."\n" + ."\n" + .'> This parameter takes effect only for Cloud Firewall that uses the subscription billing method.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'IpNumber' => [ + 'description' => 'The number of public IP addresses that can be protected.'."\n" + ."\n" + .'> This parameter takes effect only for Cloud Firewall that uses the subscription billing method.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63', + ], + 'LogStorage' => [ + 'description' => 'The log storage capacity.'."\n" + ."\n" + .'> This parameter takes effect only for Cloud Firewall that uses the subscription billing method.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'InternetBandwidth' => [ + 'description' => 'The peak Internet traffic that can be protected.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'VpcBandwidth' => [ + 'description' => 'The peak cross-VPC traffic that can be protected.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'NatBandwidth' => [ + 'description' => 'The peak traffic of NAT private network that can be protected.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'MajorVersion' => [ + 'title' => '主版本', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DefaultBandwidth' => [ + 'title' => '版本默认带宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ExtensionBandwidth' => [ + 'title' => '拓展带宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'TemporaryBandwidth' => [ + 'title' => '临时升级带宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'GeneralInstance' => [ + 'title' => '通用实例规格数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ThreatIntelligence' => [ + 'title' => '威胁情报开通状态', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Sdl' => [ + 'title' => '数据泄漏开通状态', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PrivateDnsConnectorQuota' => [ + 'title' => '私有DNS连接器配额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'AckClusterConnectorQuota' => [ + 'title' => 'ACK集群连接器配额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AliUid\\": 0,\\n \\"InstanceId\\": \\"vipcloudfw-cn-xxxxx\\",\\n \\"StartTime\\": 1692504764000,\\n \\"RequestId\\": \\"F71B03EE-xxxxx-91D79CC6AA1A\\",\\n \\"Version\\": 2,\\n \\"UserStatus\\": true,\\n \\"Expire\\": 1726934400000,\\n \\"LogStatus\\": true,\\n \\"InstanceStatus\\": \\"normal\\",\\n \\"MaxOverflow\\": 0,\\n \\"VpcNumber\\": 21,\\n \\"IpNumber\\": 63,\\n \\"LogStorage\\": 3000,\\n \\"InternetBandwidth\\": 3000,\\n \\"VpcBandwidth\\": 3000,\\n \\"NatBandwidth\\": 3000,\\n \\"MajorVersion\\": 1,\\n \\"DefaultBandwidth\\": 1000,\\n \\"ExtensionBandwidth\\": 1000,\\n \\"TemporaryBandwidth\\": 1000,\\n \\"GeneralInstance\\": 10,\\n \\"ThreatIntelligence\\": 1,\\n \\"Sdl\\": 1,\\n \\"PrivateDnsConnectorQuota\\": 5,\\n \\"AckClusterConnectorQuota\\": 5\\n}","type":"json"}]', + 'title' => 'DescribeUserBuyVersion', + 'description' => 'You can call this operation to query the edition information about Cloud Firewall.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'translator' => 'machine', + ], + 'DescribeSlrGrant' => [ + 'summary' => '获取用户SLR授权信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68366', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '113.225.22.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UserType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'sub' => '', + 'customer' => '', + ], + 'example' => 'sub', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1BD3D277-AE2F-5609-893F-FF7A72A****', + ], + 'IsGranted' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UserType\\": \\"sub\\",\\n \\"RequestId\\": \\"1BD3D277-AE2F-5609-893F-FF7A72A****\\",\\n \\"IsGranted\\": true\\n}","type":"json"}]', + ], + 'DescribeMemberInfo' => [ + 'summary' => '免费版获取成员信息', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92911', + 'abilityTreeNodes' => [ + 'FEATUREcfwATUJ57', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '150795602499****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F2665618-3C41-51A4-8DAF-586FB68****', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '128720273643****', + ], + 'AdminUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '164705101205****', + ], + 'AdminName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'IsMember' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2665618-3C41-51A4-8DAF-586FB68****\\",\\n \\"MemberUid\\": \\"128720273643****\\",\\n \\"AdminUid\\": \\"164705101205****\\",\\n \\"AdminName\\": \\"田壮\\",\\n \\"IsMember\\": true\\n}","type":"json"}]', + ], + 'DescribeInstanceRiskLevels' => [ + 'summary' => 'Queries the risk levels of instances.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174508', + 'abilityTreeNodes' => [ + 'FEATUREcfwE8FJHT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The information about the instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => 'The UUID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '181ad081-e4f2-4e3e-b925-03b67f648397', + ], + 'InstanceId' => [ + 'description' => 'The instance ID of your Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vipcloudfw-cn-7mz2fj8nm0u', + ], + 'IntranetIp' => [ + 'description' => 'The private IP address of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172.17.XX.XX', + ], + 'InternetIp' => [ + 'description' => 'The public IP addresses of instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The public IP address of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '60.205.XX.XX', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9AABB1B7-C81F-5158-9EF9-B2DD5D3DA014', + ], + 'InstanceRisks' => [ + 'description' => 'The information about the instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance ID of your Cloud Firewall.'."\n", + 'type' => 'string', + 'example' => 'vipcloudfw-cn-7mz2fj8nm0u', + ], + 'Level' => [ + 'description' => 'The risk levels. Valid values:'."\n" + ."\n" + .'* **medium**'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + 'Details' => [ + 'description' => 'The risk levels of the Elastic Compute Service (ECS) instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP addresses of servers.'."\n", + 'type' => 'string', + 'example' => '203.107.XX.XX', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotProtected', + ], + 'Level' => [ + 'description' => 'The risk levels. Valid values:'."\n" + ."\n" + .'* **medium**'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9AABB1B7-C81F-5158-9EF9-B2DD5D3DA014\\",\\n \\"InstanceRisks\\": [\\n {\\n \\"InstanceId\\": \\"vipcloudfw-cn-7mz2fj8nm0u\\",\\n \\"Level\\": \\"medium\\",\\n \\"Details\\": [\\n {\\n \\"Ip\\": \\"203.107.XX.XX\\",\\n \\"Type\\": \\"ResourceNotProtected\\",\\n \\"Level\\": \\"medium\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeInstanceRiskLevels', + ], + 'DescribeInternetOpenStatistic' => [ + 'summary' => '获取互联网开放统计', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68280', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '202.109.244.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1734386501', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1736386501', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InternetIpNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'InternetPortNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '38', + ], + 'InternetUnprotectedPortNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'InternetRiskServiceNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6AB7822C-0D73-5D1D-81FD-45D4FB7C****', + ], + 'InternetRiskPortNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'InternetRiskIpNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'InternetSlbIpNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InternetServiceNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'InternetSlbIpPortNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InternetIpNum\\": 9,\\n \\"InternetPortNum\\": 38,\\n \\"InternetUnprotectedPortNum\\": 6,\\n \\"InternetRiskServiceNum\\": 3,\\n \\"RequestId\\": \\"6AB7822C-0D73-5D1D-81FD-45D4FB7C****\\",\\n \\"InternetRiskPortNum\\": 5,\\n \\"InternetRiskIpNum\\": 8,\\n \\"InternetSlbIpNum\\": 10,\\n \\"InternetServiceNum\\": 15,\\n \\"InternetSlbIpPortNum\\": 16\\n}","type":"json"}]', + ], + 'ModifyCfwInstance' => [ + 'summary' => '更新用户版本信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68399', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cfw_elasticity_public_cn-zsk39m******', + ], + ], + [ + 'name' => 'UpdateList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Sdl', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\"\\n}","type":"json"}]', + ], + 'ReleasePostInstance' => [ + 'summary' => 'Releases Cloud Firewall that uses the pay-as-you-go billing method.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '103471', + 'abilityTreeNodes' => [ + 'FEATUREcfwATUJ57', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Cloud Firewall instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'The request ID, which is used to locate and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => 'EE316A19-xxxx-5043-9DF1-C04458ABC570', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReleaseStatus' => [ + 'description' => 'Indicates whether the release was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"EE316A19-xxxx-5043-9DF1-C04458ABC570\\",\\n \\"Success\\": true,\\n \\"ReleaseStatus\\": true\\n}","type":"json"}]', + 'title' => 'ReleasePostInstance', + ], + 'ReleaseExpiredInstance' => [ + 'summary' => '释放已过期的实例', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '139427', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cfw-y3gpqq705****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9EC1DB0F-EE53-5D36-B5DA-71CB******', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReleaseStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"9EC1DB0F-EE53-5D36-B5DA-71CB******\\",\\n \\"Success\\": true,\\n \\"ReleaseStatus\\": \\"true\\"\\n}","type":"json"}]', + ], + 'DescribeRiskEventTopAttackAsset' => [ + 'summary' => '获取Top风险事件资产', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68352', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '125.33.253.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1754273436', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1742955867', + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'AttackApp', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "MySQL",'."\n" + .' "Redis",'."\n" + .' "MemCached"'."\n" + .']', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BuyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 2 => '', + '', + '', + 10 => '', + ], + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B9BF7C33-9A23-5096-8568-A3DACAF0****', + ], + 'Assets' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_resource', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EcsPublicIP', + ], + 'ResourceInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-8vbdrjrxzt78****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-chengdu', + ], + 'Ip' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.3.54.XXX', + ], + 'AttackCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'DropCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B9BF7C33-9A23-5096-8568-A3DACAF0****\\",\\n \\"Assets\\": [\\n {\\n \\"ResourceInstanceName\\": \\"test_resource\\",\\n \\"ResourceType\\": \\"EcsPublicIP\\",\\n \\"ResourceInstanceId\\": \\"i-8vbdrjrxzt78****\\",\\n \\"RegionNo\\": \\"cn-chengdu\\",\\n \\"Ip\\": \\"10.3.54.XXX\\",\\n \\"AttackCnt\\": 12,\\n \\"DropCnt\\": 8\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAttackAppCategory' => [ + 'summary' => '获取敏感数据类别开关', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247466', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'B14757D0-4640-4B44-AC67-7F558FE****', + ], + 'AppCategories' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AttackApps' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Nacos', + ], + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B14757D0-4640-4B44-AC67-7F558FE****\\",\\n \\"AppCategories\\": [\\n {\\n \\"AttackApps\\": [\\n \\"Nacos\\"\\n ],\\n \\"CategoryName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOutgoingRiskTrend' => [ + 'summary' => '获取外联风险趋势图', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68330', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '219.145.94.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1733882648', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1755051062', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRiskDomain' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1CA8D98E-A71B-5856-A658-3E8B3152E****', + ], + 'Interval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'TotalRiskIp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659405600', + ], + 'RiskIp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RiskDomain' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRiskDomain\\": 7,\\n \\"RequestId\\": \\"1CA8D98E-A71B-5856-A658-3E8B3152E****\\",\\n \\"Interval\\": 60,\\n \\"TotalRiskIp\\": 6,\\n \\"DataList\\": [\\n {\\n \\"Time\\": 1659405600,\\n \\"RiskIp\\": 5,\\n \\"RiskDomain\\": 20\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeUnprotectedPortTrend' => [ + 'summary' => '获取未保护的端口趋势', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68393', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + 'FEATUREcfwIT6TRR', + 'FEATUREcfwQROEEE', + 'FEATUREcfw1FTUMS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '61.155.60.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1655778046', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1751210395', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Interval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E599A84E-CD22-5E42-A2A9-01A254AC****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659405600', + ], + 'Count' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Interval\\": 60,\\n \\"RequestId\\": \\"E599A84E-CD22-5E42-A2A9-01A254AC****\\",\\n \\"DataList\\": [\\n {\\n \\"Time\\": 1659405600,\\n \\"Count\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallDropTrafficTrend' => [ + 'summary' => '概览页-vpc防火墙拦截趋势', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146117', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '183.237.161.XXX', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1747792853', + ], + ], + [ + 'name' => 'TrafficTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1739337840', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'LastTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DropSessionMax' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C87C1797-02E6-5EEB-A943-4416207D****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659405600', + ], + 'AclDrop' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'IpsDrop' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'TotalSession' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '153188', + ], + 'DataTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-08-25 12:00:00', + ], + 'DropSession' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DropSessionMax\\": 0,\\n \\"RequestId\\": \\"C87C1797-02E6-5EEB-A943-4416207D****\\",\\n \\"DataList\\": [\\n {\\n \\"Time\\": 1659405600,\\n \\"AclDrop\\": 12,\\n \\"IpsDrop\\": 5,\\n \\"TotalSession\\": 153188,\\n \\"DataTime\\": \\"2018-08-25 12:00:00\\",\\n \\"DropSession\\": 10\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOutgoingRiskDomainAndIpCount' => [ + 'summary' => '获取外联风险域名与IP数', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '42917', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1749434787', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1751595213', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'EE258AC0-6EDD-5929-AB47-165E9B54****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'RiskDomainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'RiskIpCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '47', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE258AC0-6EDD-5929-AB47-165E9B54****\\",\\n \\"TotalCount\\": 6,\\n \\"RiskDomainCount\\": 6,\\n \\"RiskIpCount\\": 47\\n}","type":"json"}]', + ], + 'DescribeNatFirewallDropTrafficTrend' => [ + 'summary' => '概览页-nat防火墙拦截趋势', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203563', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '122.190.56.XXX', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1740968766', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1758334822', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DropSessionMax' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '62436', + ], + 'DropSessionMaxTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1525662720', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659405600', + ], + 'TotalSession' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '153188', + ], + 'DropSession' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DropSessionMax\\": 62436,\\n \\"DropSessionMaxTime\\": \\"1525662720\\",\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"DataList\\": [\\n {\\n \\"Time\\": 1659405600,\\n \\"TotalSession\\": 153188,\\n \\"DropSession\\": 10\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInternetDropTrafficTrend' => [ + 'summary' => '获取互联网方向删除会话趋势图', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68274', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '120.136.21.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'out', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1749176793', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1756346821', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DropSessionMax' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8090', + ], + 'RingRatioAverage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.23', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'RatioAverage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12.34', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659405600', + ], + 'AclDrop' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'DropRatio' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'RingDataTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-08-25 12:00:00', + ], + 'IpsDrop' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'TotalSession' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DataTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-08-25 12:00:00', + ], + 'DropSession' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'RingTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724982259', + ], + 'DropRing' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DropRingRatio' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDirectionError', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DropSessionMax\\": 8090,\\n \\"RingRatioAverage\\": \\"1.23\\",\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"RatioAverage\\": \\"12.34\\",\\n \\"DataList\\": [\\n {\\n \\"Time\\": 1659405600,\\n \\"AclDrop\\": 12,\\n \\"DropRatio\\": \\"1\\",\\n \\"RingDataTime\\": \\"2018-08-25 12:00:00\\",\\n \\"IpsDrop\\": 5,\\n \\"TotalSession\\": 10,\\n \\"DataTime\\": \\"2018-08-25 12:00:00\\",\\n \\"DropSession\\": 12,\\n \\"RingTime\\": 1724982259,\\n \\"DropRing\\": 0,\\n \\"DropRingRatio\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInvadeEcsTrend' => [ + 'summary' => '获取ECS漏洞趋势', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68288', + 'abilityTreeNodes' => [ + 'FEATUREcfwIT6TRR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '120.230.45.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1736561456', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1733796528', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736820365', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1742177725', + ], + 'InvadeEcsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F90E816D-BEE7-5BD6-95ED-474F54****', + ], + 'Interval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EcsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'Time' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659405600', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": 1736820365,\\n \\"StartTime\\": 1742177725,\\n \\"InvadeEcsCount\\": 2,\\n \\"RequestId\\": \\"F90E816D-BEE7-5BD6-95ED-474F54****\\",\\n \\"Interval\\": 60,\\n \\"DataList\\": [\\n {\\n \\"EcsCount\\": 27,\\n \\"Time\\": 1659405600\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribePostpayEnabledProtection' => [ + 'summary' => '按量付费是否开启过防护', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '144147', + 'abilityTreeNodes' => [ + 'FEATUREcfwATUJ57', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '95CA5E2B-E5FB-5838-BC50-6A2C763C****', + ], + 'IsEnabledProtection' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsOpenButDisabled' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DisabledDays' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'DisabledType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nat', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + [ + 'errorCode' => 'ErrorInstanceNotPostpay', + 'errorMessage' => 'instance is not postpay', + ], + [ + 'errorCode' => 'ErrorInstanceNotInDB', + 'errorMessage' => 'no instance for process in db', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95CA5E2B-E5FB-5838-BC50-6A2C763C****\\",\\n \\"IsEnabledProtection\\": false,\\n \\"IsOpenButDisabled\\": false,\\n \\"DisabledDays\\": 6,\\n \\"DisabledType\\": \\"nat\\"\\n}","type":"json"}]', + ], + 'DescribePostpayTrafficTotal' => [ + 'summary' => 'Queries the total volume of traffic that is billed based on the pay-as-you-go billing method, including all firewalls within the current account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183500', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalAssets' => [ + 'title' => '总数', + 'description' => 'The total number of assets protected all types of firewalls.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '826B6280-9704-5643-97B1-6B47AC3F027A', + ], + 'TotalTraffic' => [ + 'description' => 'The total volume of traffic. If you use Cloud Firewall that uses the subscription billing method, this parameter indicates the total volume of burstable protected traffic. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2320274874426', + ], + 'TotalNatAssets' => [ + 'description' => 'The total number of assets protected by NAT firewalls.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalNatTraffic' => [ + 'description' => 'The total traffic for NAT firewalls. If you use Cloud Firewall that uses the subscription billing method, this parameter indicates the total volume of burstable protected traffic on the NAT boundary. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '560646279', + ], + 'TotalVpcAssets' => [ + 'description' => 'The total number of assets protected by virtual private cloud (VPC) firewalls.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'TotalVpcTraffic' => [ + 'description' => 'The total traffic for VPC firewalls. If you use Cloud Firewall that uses the subscription billing method, this parameter indicates the total volume of burstable protected traffic on the VPC boundary. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2320274874426', + ], + 'TotalInternetAssets' => [ + 'description' => 'The total number of assets protected by the Internet firewall.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '128', + ], + 'TotalInternetTraffic' => [ + 'description' => 'The total traffic for the Internet firewall. If you use Cloud Firewall that uses the subscription billing method, this parameter indicates the total volume of burstable protected traffic on the Internet boundary. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2320274874426', + ], + 'TotalBillTraffic' => [ + 'description' => 'The volume of burstable protected traffic for which fees are generated. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2320274874426', + ], + 'TotalSdlFreeTraffic' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => 'Data Leak Detection Total free usage traffic.', + 'example' => '0', + ], + 'TotalSdlBillTraffic' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => 'Data Leak Detection Total Fee Flow.', + 'example' => '22879916142', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorNotPostpayUser', + 'errorMessage' => 'not Postpay User.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalAssets\\": 132,\\n \\"RequestId\\": \\"826B6280-9704-5643-97B1-6B47AC3F027A\\",\\n \\"TotalTraffic\\": 2320274874426,\\n \\"TotalNatAssets\\": 1,\\n \\"TotalNatTraffic\\": 560646279,\\n \\"TotalVpcAssets\\": 3,\\n \\"TotalVpcTraffic\\": 2320274874426,\\n \\"TotalInternetAssets\\": 128,\\n \\"TotalInternetTraffic\\": 2320274874426,\\n \\"TotalBillTraffic\\": 2320274874426,\\n \\"TotalSdlFreeTraffic\\": 0,\\n \\"TotalSdlBillTraffic\\": 0\\n}","type":"json"}]', + 'title' => 'DescribePostpayTrafficTotal', + 'description' => 'You can call this operation to query statistics of the current Cloud Firewall from the date of purchase.'."\n", + ], + 'DescribePostpayTrafficDetail' => [ + 'summary' => 'Queries the details of traffic billed based on the pay-as-you-go billing method.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183328', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => 'The beginning of the time range to query. Specify a value in the YYYYMMDD format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '20230101', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify a value in the YYYYMMDD format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '20230130', + ], + ], + [ + 'name' => 'SearchItem', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID or the IP address of the asset.', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'TrafficType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The traffic type. This parameter is required. Valid values:'."\n" + ."\n" + .'* **EIP_TRAFFIC**: traffic for the Internet firewall.'."\n" + .'* **NatGateway_TRAFFIC**: traffic for NAT firewalls.'."\n" + .'* **VPC_TRAFFIC**: traffic for virtual private cloud (VPC) firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'EIP_TRAFFIC', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field based on which you want to sort the query results. Valid values:'."\n" + ."\n" + .'* **resourceId**'."\n" + .'* **trafficDay**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'resourceId', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0525EADE-C112-5702-A5BC-0E2F6F94DB23', + ], + 'TrafficList' => [ + 'description' => 'The statistics on traffic.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TrafficDay' => [ + 'description' => 'The date on which the statistics are collected.'."\n", + 'type' => 'string', + 'example' => '20231001', + ], + 'TrafficType' => [ + 'description' => 'The traffic type. Valid values:'."\n" + ."\n" + .'* **EIP_TRAFFIC**: traffic for the Internet firewall'."\n" + .'* **NatGateway_TRAFFIC**: traffic for NAT firewalls'."\n" + .'* **VPC_TRAFFIC**: traffic for VPC firewalls'."\n", + 'type' => 'string', + 'example' => 'EIP_TRAFFIC', + ], + 'InstanceId' => [ + 'description' => 'The instance ID of the asset.'."\n", + 'type' => 'string', + 'example' => 'i-8vb2d7c9mtn0bo9qcraq', + ], + 'ResourceId' => [ + 'description' => 'The resource ID. The resource ID for the Internet firewall is the public IP address that is protected the Internet firewall, and the resource ID for a NAT firewall is the instance ID of the NAT firewall.'."\n", + 'type' => 'string', + 'example' => '39.106.146.214', + ], + 'InstanceType' => [ + 'description' => 'The asset type. This value takes effect only for the Internet firewall.'."\n", + 'type' => 'string', + 'example' => 'EcsPublicIP', + ], + 'TotalBytes' => [ + 'description' => 'The total inbound and outbound network throughput, which indicates the total number of bytes that are received and sent. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1215096939', + ], + 'InBytes' => [ + 'description' => 'The inbound network throughput, which indicates the total number of bytes that are received Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1115096939', + ], + 'OutBytes' => [ + 'description' => 'The outbound network throughput, which indicates the total number of bytes that are sent. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000', + ], + 'ProtectionDuration' => [ + 'description' => 'Protection duration. Unit: hours.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RegionNo' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorNotPostpayUser', + 'errorMessage' => 'not Postpay User.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 132,\\n \\"RequestId\\": \\"0525EADE-C112-5702-A5BC-0E2F6F94DB23\\",\\n \\"TrafficList\\": [\\n {\\n \\"TrafficDay\\": \\"20231001\\",\\n \\"TrafficType\\": \\"EIP_TRAFFIC\\",\\n \\"InstanceId\\": \\"i-8vb2d7c9mtn0bo9qcraq\\",\\n \\"ResourceId\\": \\"39.106.146.214\\",\\n \\"InstanceType\\": \\"EcsPublicIP\\",\\n \\"TotalBytes\\": 1215096939,\\n \\"InBytes\\": 1115096939,\\n \\"OutBytes\\": 100000000,\\n \\"ProtectionDuration\\": 20,\\n \\"RegionNo\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribePostpayTrafficDetail', + 'description' => 'If you use Cloud Firewall that uses the pay-as-you-go billing method, you can call this operation to query traffic details accurate to the granularity of specific resource instances. If you use Cloud Firewall that uses the subscription billing method, you can call this operation to query the overall traffic details.'."\n", + ], + 'DescribePostpayUserInternetStatus' => [ + 'summary' => 'Queries the status of the Internet Firewall feature in Cloud Firewall that uses the pay-as-you-go billing method.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '205830', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + 'FEATUREcfwATUJ57', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-zsk39m******', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '0DC783F1-B3A7-578D-8A63-*****', + ], + 'Status' => [ + 'description' => 'The status of the Internet Firewall feature. Valid values:'."\n" + ."\n" + .'* **open**: enabled'."\n" + .'* **init**: being enabled'."\n" + .'* **closed**: disabled'."\n", + 'type' => 'string', + 'example' => 'open', + ], + 'UnprotectedDate' => [ + 'description' => 'The number of days during which no asset is added to the Internet Firewall feature for protection. This parameter is valid only when the value of Status is open.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DC783F1-B3A7-578D-8A63-*****\\",\\n \\"Status\\": \\"open\\",\\n \\"UnprotectedDate\\": 20\\n}","type":"json"}]', + 'title' => 'DescribePostpayUserInternetStatus', + ], + 'DescribePostpayUserNatStatus' => [ + 'summary' => 'Queries the status of the NAT Firewall feature in Cloud Firewall that use the pay-as-you-go billing method.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200722', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + 'FEATUREcfwATUJ57', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-zsk39m******', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '6B780BD6-282C-51A9-A8E6-59F636******', + ], + 'Status' => [ + 'description' => 'The status of the NAT Firewall feature. Valid values:'."\n" + ."\n" + .'* **open**: enabled'."\n" + .'* **init**: being enabled'."\n" + .'* **closed**: disabled'."\n", + 'type' => 'string', + 'example' => 'open', + ], + 'UnprotectedDate' => [ + 'description' => 'The number of days during which no asset is added to the NAT Firewall feature for protection. This parameter is valid only when the value of Status is open.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B780BD6-282C-51A9-A8E6-59F636******\\",\\n \\"Status\\": \\"open\\",\\n \\"UnprotectedDate\\": 20\\n}","type":"json"}]', + 'title' => 'DescribePostpayUserNatStatus', + ], + 'DescribePostpayUserVpcStatus' => [ + 'summary' => 'Queries the status of the virtual private cloud (VPC) Firewall feature in Cloud Firewall that uses the pay-as-you-go billing method.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '224805', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-************', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '7447795A-39AB-52CB-8F92-128DF******', + ], + 'Status' => [ + 'description' => 'The status of the VPC Firewall feature. Valid values:'."\n" + ."\n" + .'* **open**: enabled'."\n" + .'* **init**: being enabled'."\n" + .'* **closed**: disabled'."\n", + 'type' => 'string', + 'example' => 'open', + ], + 'UnprotectedDate' => [ + 'description' => 'The number of days during which no asset is added to the VPC Firewall feature for protection. This parameter is valid only when the value of Status is open.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7447795A-39AB-52CB-8F92-128DF******\\",\\n \\"Status\\": \\"open\\",\\n \\"UnprotectedDate\\": 20\\n}","type":"json"}]', + 'title' => 'DescribePostpayUserVpcStatus', + ], + 'UpdatePostpayUserInternetStatus' => [ + 'summary' => 'Updates the status of the NAT firewall feature for Cloud Firewall that uses the pay-as-you-go billing method.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '205829', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-zsk39m******', + ], + ], + [ + 'name' => 'Operate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation type.'."\n" + ."\n" + .'* Set the value to open.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-000901******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-000901******\\"\\n}","type":"json"}]', + 'title' => 'UpdatePostpayUserInternetStatus', + ], + 'UpdatePostpayUserNatStatus' => [ + 'summary' => 'Updates the status of the NAT Firewall feature for Cloud Firewall that uses the pay-as-you-go billing method.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200723', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-************', + ], + ], + [ + 'name' => 'Operate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation type.'."\n" + ."\n" + .'* Set the value to open.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090******\\"\\n}","type":"json"}]', + 'title' => 'UpdatePostpayUserNatStatus', + ], + 'UpdatePostpayUserVpcStatus' => [ + 'summary' => 'Updates the status of the virtual private cloud (VPC) Firewall feature for Cloud Firewall that uses the pay-as-you-go billing method.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '224794', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-************', + ], + ], + [ + 'name' => 'Operate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation type.'."\n" + ."\n" + .'* Set the value to open.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '450D47F5-956E-543E-8502-2F71C8******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"450D47F5-956E-543E-8502-2F71C8******\\"\\n}","type":"json"}]', + 'title' => 'UpdatePostpayUserVpcStatus', + ], + 'DescribeRegionInfo' => [ + 'summary' => '获取地域信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68346', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '59.82.59.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '25E655B0-CAED-53D4-8054-F983126****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorQueryEcsByUid', + 'errorMessage' => 'An error occurred while querying ECS.', + ], + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorUnMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 8,\\n \\"RequestId\\": \\"25E655B0-CAED-53D4-8054-F983126****\\",\\n \\"DataList\\": [\\n {\\n \\"RegionName\\": \\"上海\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCtrlInstanceMemberAccounts' => [ + 'summary' => '获取成员账号列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68240', + 'abilityTreeNodes' => [ + 'FEATUREcfw98HUGQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9CC69FDA-69F6-585B-9262-A306F425****', + ], + 'InstanceMemberCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'MaxInstanceMemberNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CC69FDA-69F6-585B-9262-A306F425****\\",\\n \\"InstanceMemberCount\\": 3,\\n \\"MaxInstanceMemberNum\\": 1000\\n}","type":"json"}]', + ], + 'DescribeFirewallTask' => [ + 'summary' => '获取防火墙任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '120840', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ChildInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-cd6000c588214403****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '199431783', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsFound' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TaskStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'init', + ], + 'TaskWaitingTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'TaskSteps' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StepStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'init', + ], + 'StepName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Create Firewall', + ], + 'StepProgress' => [ + 'description' => '', + 'type' => 'string', + 'example' => '80', + ], + 'StepInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'abcd', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7D5483BF-2262-586D-8706-BDDB8B42****', + ], + 'TaskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'egressgw', + ], + 'TaskStartTimestamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '17151361285', + ], + 'TaskFinishTimestamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '17151381075', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '189997648', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IsFound\\": false,\\n \\"TaskStatus\\": \\"init\\",\\n \\"TaskWaitingTime\\": \\"30\\",\\n \\"TaskSteps\\": [\\n {\\n \\"StepStatus\\": \\"init\\",\\n \\"StepName\\": \\"Create Firewall\\",\\n \\"StepProgress\\": \\"80\\",\\n \\"StepInfo\\": \\"abcd\\"\\n }\\n ],\\n \\"RequestId\\": \\"7D5483BF-2262-586D-8706-BDDB8B42****\\",\\n \\"TaskName\\": \\"egressgw\\",\\n \\"TaskStartTimestamp\\": \\"17151361285\\",\\n \\"TaskFinishTimestamp\\": \\"17151381075\\",\\n \\"TaskId\\": 189997648\\n}","type":"json"}]', + ], + 'DescribeResourceTypeAutoEnable' => [ + 'summary' => '查询资产类型默认引流', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247466', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '7447795A-39AB-52CB-8F92-128DF******', + ], + 'ResourceTypeAutoEnable' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'boolean', + 'example' => '{"eip",true}'."\n", + 'description' => '', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7447795A-39AB-52CB-8F92-128DF******\\",\\n \\"ResourceTypeAutoEnable\\": {\\n \\"key\\": true\\n }\\n}","type":"json"}]', + ], + 'DescribeAssetList' => [ + 'summary' => 'Queries the assets that are protected by Cloud Firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Valid values: 1 to 50.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 1 to 50.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of your Cloud Firewall.'."\n" + ."\n" + .'> For more information about the regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the firewall. Valid values:'."\n" + ."\n" + .'* **open**: The firewall is enabled.'."\n" + .'* **opening**: The firewall is being enabled.'."\n" + .'* **closed**: The firewall is disabled.'."\n" + .'* **closing**: The firewall is being disabled.'."\n" + ."\n" + .'> If you do not specify this parameter, the assets that are configured for firewalls in all states are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'SearchItem', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID or IP address of the asset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eip', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the asset. Valid values:'."\n" + ."\n" + .'* **BastionHostEgressIP**: the egress IP address of a bastion host'."\n" + .'* **BastionHostIngressIP**: the ingress IP address of a bastion host'."\n" + .'* **EcsEIP**: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance'."\n" + .'* **EcsPublicIP**: the public IP address of an ECS instance'."\n" + .'* **EIP**: the EIP'."\n" + .'* **EniEIP**: the EIP of an elastic network interface (ENI)'."\n" + .'* **NatEIP**: the EIP of a NAT gateway'."\n" + .'* **SlbEIP**: the EIP of a Server Load Balancer (SLB) instance or a Classic Load Balancer (CLB) instance'."\n" + .'* **SlbPublicIP**: the public IP address of an SLB instance or a CLB instance'."\n" + .'* **NatPublicIP**: the public IP address of a NAT gateway'."\n" + .'* **HAVIP**: the high-availability virtual IP address (HAVIP)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EIP', + ], + ], + [ + 'name' => 'SgStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the security group policy. Valid values:'."\n" + ."\n" + .'* **pass**: delivered'."\n" + .'* **block**: undelivered'."\n" + .'* **unsupport**: unsupported'."\n" + ."\n" + .'> If you do not specify this parameter, the assets on which security group policies in all states take effect are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pass', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version of the asset that is protected by Cloud Firewall. Valid values:'."\n" + ."\n" + .'* **4**: IPv4 (default)'."\n" + .'* **6**: IPv6'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is added to Cloud Firewall.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of Cloud Firewall. Valid values:'."\n" + ."\n" + .'* **buy**: a paid edition (default)'."\n" + .'* **free**: Free Edition'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'buy', + ], + ], + [ + 'name' => 'NewResourceTag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the asset was added. Valid values:'."\n" + ."\n" + .'* **discovered in 1 hour**: within one hour.'."\n" + .'* **discovered in 1 day**: within one day.'."\n" + .'* **discovered in 7 days**: within seven days.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'discovered in 1 hour', + ], + ], + [ + 'name' => 'OutStatistic', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to query external traffic information.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SensitiveStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Data leakage detection activation status.', + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of the assets that are protected by Cloud Firewall.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + 'Assets' => [ + 'description' => 'The assets that are protected by Cloud Firewall.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => 'The risk level of the asset. Valid values:'."\n" + ."\n" + .'* **low**: low'."\n" + .'* **middle**: medium'."\n" + .'* **hight**: high'."\n" + ."\n" + .'> The value of this parameter is returned only when the UserType parameter is set to free.'."\n", + 'type' => 'string', + 'example' => 'low', + ], + 'BindInstanceName' => [ + 'description' => 'The instance name of the asset.'."\n", + 'type' => 'string', + 'example' => 'instance01', + ], + 'Type' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'string', + 'example' => 'eip', + ], + 'SgStatusTime' => [ + 'description' => 'The time when the status of the security group was last checked. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615082937', + ], + 'ResourceInstanceId' => [ + 'description' => 'The instance ID of the asset.'."\n", + 'type' => 'string', + 'example' => 'i-8vbdrjrxzt78****', + ], + 'MemberUid' => [ + 'description' => 'The UID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '258039427902****', + ], + 'IntranetAddress' => [ + 'description' => 'The internal IP address of the server.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'SyncStatus' => [ + 'description' => 'Indicates whether traffic redirection is supported for the asset. Valid values:'."\n" + ."\n" + .'* **enable**: yes'."\n" + .'* **disable**: no'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'AliUid' => [ + 'description' => 'The UID of the Alibaba Cloud account.'."\n" + ."\n" + .'> The value of this parameter indicates the management account to which the member is added.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158039427902****', + ], + 'ProtectStatus' => [ + 'description' => 'The status of the firewall. Valid values:'."\n" + ."\n" + .'* **open**: enabled.'."\n" + .'* **opening**: being enabled.'."\n" + .'* **closed**: disabled.'."\n" + .'* **closing**: being disabled.'."\n", + 'type' => 'string', + 'example' => 'open', + ], + 'InternetAddress' => [ + 'description' => 'The public IP address of the server.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'BindInstanceId' => [ + 'description' => 'The ID of the cloud resource with which the asset is associated.'."\n", + 'type' => 'string', + 'example' => 'i-8vbdrjrxzt78****', + ], + 'RegionID' => [ + 'description' => 'The ID of the region in which the asset resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionStatus' => [ + 'description' => 'Indicates whether the firewall is supported in the region in which the asset resides. Valid values:'."\n" + ."\n" + .'* **enable**: yes'."\n" + .'* **disable**: no'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'ResourceType' => [ + 'description' => 'The type of the asset. Valid values:'."\n" + ."\n" + .'* **BastionHostEgressIP**: the egress IP address of a bastion host'."\n" + .'* **BastionHostIngressIP**: the ingress IP address of a bastion host'."\n" + .'* **EcsEIP**: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance'."\n" + .'* **EcsPublicIP**: the public IP address of an ECS instance'."\n" + .'* **EIP**: the EIP'."\n" + .'* **EniEIP**: the EIP of an elastic network interface (ENI)'."\n" + .'* **NatEIP**: the EIP of a NAT gateway'."\n" + .'* **SlbEIP**: the EIP of a Server Load Balancer (SLB) instance'."\n" + .'* **SlbPublicIP**: the public IP address of an SLB instance'."\n" + .'* **NatPublicIP**: the public IP address of a NAT gateway'."\n" + .'* **HAVIP**: the high-availability virtual IP address (HAVIP)'."\n", + 'type' => 'string', + 'example' => 'EIP', + ], + 'IpVersion' => [ + 'description' => 'The IP version of the asset that is protected by Cloud Firewall.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **4**: IPv4'."\n" + .'* **6**: IPv6'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'SgStatus' => [ + 'description' => 'The status of the security group policy. Valid values:'."\n" + ."\n" + .'* **pass**: applied'."\n" + .'* **block**: not applied'."\n" + .'* **unsupport**: unsupported'."\n", + 'type' => 'string', + 'example' => 'block', + ], + 'Note' => [ + 'description' => 'The remarks of the asset. Valid values:'."\n" + ."\n" + .'* **REGION_NOT_SUPPORT**: The region is not supported.'."\n" + .'* **NETWORK_NOT_SUPPORT**: The network is not supported.'."\n", + 'type' => 'string', + 'example' => 'REGION_NOT_SUPPORT', + ], + 'Name' => [ + 'description' => 'The instance name of the asset that is protected by Cloud Firewall.'."\n", + 'type' => 'string', + 'example' => 'instance01', + ], + 'CreateTimeStamp' => [ + 'description' => 'The timestamp when the asset is added to Cloud Firewall.'."\n", + 'type' => 'string', + 'example' => '2023-02-28 10:29:58', + ], + 'NewResourceTag' => [ + 'description' => 'The time when the asset was added. Valid values:'."\n" + ."\n" + .'* **discovered in 1 hour**: within one hour.'."\n" + .'* **discovered in 1 day**: within one day.'."\n" + .'* **discovered in 7 days**: within seven days.'."\n", + 'type' => 'string', + 'example' => 'discovered in 1 hour', + ], + 'SensitiveDataStatus' => [ + 'description' => 'Data leakage detection enabled status.', + 'type' => 'string', + 'example' => 'open', + ], + 'Last7DayOutTrafficBytes' => [ + 'description' => 'Outbound traffic in the last 7 days.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 12,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"Assets\\": [\\n {\\n \\"RiskLevel\\": \\"low\\",\\n \\"BindInstanceName\\": \\"instance01\\",\\n \\"Type\\": \\"eip\\",\\n \\"SgStatusTime\\": 1615082937,\\n \\"ResourceInstanceId\\": \\"i-8vbdrjrxzt78****\\",\\n \\"MemberUid\\": 0,\\n \\"IntranetAddress\\": \\"192.168.XX.XX\\",\\n \\"SyncStatus\\": \\"enable\\",\\n \\"AliUid\\": 0,\\n \\"ProtectStatus\\": \\"open\\",\\n \\"InternetAddress\\": \\"192.0.XX.XX\\",\\n \\"BindInstanceId\\": \\"i-8vbdrjrxzt78****\\",\\n \\"RegionID\\": \\"cn-hangzhou\\",\\n \\"RegionStatus\\": \\"enable\\",\\n \\"ResourceType\\": \\"EIP\\",\\n \\"IpVersion\\": 4,\\n \\"SgStatus\\": \\"block\\",\\n \\"Note\\": \\"REGION_NOT_SUPPORT\\",\\n \\"Name\\": \\"instance01\\",\\n \\"CreateTimeStamp\\": \\"2023-02-28 10:29:58\\",\\n \\"NewResourceTag\\": \\"discovered in 1 hour\\",\\n \\"SensitiveDataStatus\\": \\"open\\",\\n \\"Last7DayOutTrafficBytes\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAssetListResponse>\\n <TotalCount>12</TotalCount>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n <Assets>\\n <RiskLevel>low</RiskLevel>\\n <BindInstanceName>instance01</BindInstanceName>\\n <Type>eip</Type>\\n <SgStatusTime>1615082937</SgStatusTime>\\n <ResourceInstanceId>i-8vbdrjrxzt78****</ResourceInstanceId>\\n <IntranetAddress>192.168.XX.XX</IntranetAddress>\\n <SyncStatus>enable</SyncStatus>\\n <ProtectStatus>open</ProtectStatus>\\n <InternetAddress>192.0.XX.XX</InternetAddress>\\n <BindInstanceId>i-8vbdrjrxzt78****</BindInstanceId>\\n <RegionID>cn-hangzhou</RegionID>\\n <RegionStatus>enable</RegionStatus>\\n <ResourceType>EIP</ResourceType>\\n <IpVersion>4</IpVersion>\\n <SgStatus>block</SgStatus>\\n <Note>REGION_NOT_SUPPORT</Note>\\n <Name>instance01</Name>\\n </Assets>\\n</DescribeAssetListResponse>","errorExample":""}]', + 'title' => 'DescribeAssetList', + 'description' => 'You can call the DescribeAssetList operation to query the assets that are protected by Cloud Firewall.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAssetStatistic' => [ + 'summary' => 'Queries statistics on the assets that are protected by Cloud Firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68206', + 'abilityTreeNodes' => [ + 'FEATUREcfwE8FJHT', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '112.239.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'title' => '语言', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'title' => '语言', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '850A84******25g4d2', + ], + 'ResourceSpecStatistic' => [ + 'description' => 'The statistics on specifications.'."\n", + 'type' => 'object', + 'properties' => [ + 'IpNumUsed' => [ + 'description' => 'The number of public IP addresses that are protected.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => 'IP使用数量', + ], + 'IpNumSpec' => [ + 'description' => 'The number of public IP addresses that can be protected.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => 'IP规格', + ], + 'SensitiveDataIpNumSpec' => [ + 'description' => 'The number of public IP addresses that can enable data leakage detection.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SensitiveDataIpNumUsed' => [ + 'description' => 'The number of public IP addresses that enabled data leakage detection.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + 'title' => '区域规格', + ], + 'GeneralInstanceSpecStatistic' => [ + 'title' => '售卖2.0通用实例规格', + 'type' => 'object', + 'properties' => [ + 'TotalGeneralInstanceUsedCnt' => [ + 'title' => '总规格', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCfwGeneralInstanceUsedCnt' => [ + 'title' => '互联网墙开启实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalVfwGeneralInstanceUsedCnt' => [ + 'title' => 'vpc墙开启实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalNatGeneralInstanceUsedCnt' => [ + 'title' => 'nat墙开启实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCfwGeneralInstanceCnt' => [ + 'title' => '互联网墙所有实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalNatGeneralInstanceCnt' => [ + 'title' => 'nat墙所有实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CfwGeneralInstanceRegionStatistic' => [ + 'title' => '互联网墙地域已使用规格统计', + 'type' => 'array', + 'items' => [ + 'title' => '互联网墙地域规格统计详情', + 'type' => 'object', + 'properties' => [ + 'RegionNo' => [ + 'title' => '地域信息', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MemberList' => [ + 'title' => '地域成员列表', + 'type' => 'array', + 'items' => [ + 'title' => '地域成员', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + 'CfwTotalGeneralInstanceRegionStatistic' => [ + 'title' => '互联网墙地域全量规格统计', + 'type' => 'array', + 'items' => [ + 'title' => '互联网墙地域规格统计详情', + 'type' => 'object', + 'properties' => [ + 'RegionNo' => [ + 'title' => '地域信息', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'MemberList' => [ + 'title' => '地域成员列表', + 'type' => 'array', + 'items' => [ + 'title' => '地域成员', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + 'title' => '返回对象', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84******25g4d2\\",\\n \\"ResourceSpecStatistic\\": {\\n \\"IpNumUsed\\": 10,\\n \\"IpNumSpec\\": 20,\\n \\"SensitiveDataIpNumSpec\\": 0,\\n \\"SensitiveDataIpNumUsed\\": 0\\n },\\n \\"GeneralInstanceSpecStatistic\\": {\\n \\"TotalGeneralInstanceUsedCnt\\": 1,\\n \\"TotalCfwGeneralInstanceUsedCnt\\": 1,\\n \\"TotalVfwGeneralInstanceUsedCnt\\": 1,\\n \\"TotalNatGeneralInstanceUsedCnt\\": 1,\\n \\"TotalCfwGeneralInstanceCnt\\": 1,\\n \\"TotalNatGeneralInstanceCnt\\": 1,\\n \\"CfwGeneralInstanceRegionStatistic\\": [\\n {\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"MemberList\\": [\\n \\"123\\"\\n ]\\n }\\n ],\\n \\"CfwTotalGeneralInstanceRegionStatistic\\": [\\n {\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"MemberList\\": [\\n \\"123\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAssetStatistic', + ], + 'DescribeAssetRiskList' => [ + 'summary' => 'Queries the risk levels of assets.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68205', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '47.100.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version of the asset that is protected by Cloud Firewall.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **4** (default): IPv4'."\n" + .'* **6**: IPv6'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '4', + ], + ], + [ + 'name' => 'IpAddrList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'flat', + 'schema' => [ + 'description' => 'The IP addresses to query. Separate the IP addresses with commas (,). You can specify up to 20 IP addresses at a time.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Example IPv4 address: 47.97.XX.XX.'."\n" + ."\n" + .'* Example IPv6 address: 2001:db8:ffff:ffff:ffff:XXXX:ffff.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address to query.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Example IPv4 address: 47.97.XX.XX.'."\n" + ."\n" + .'* Example IPv6 address: 2001:db8:ffff:ffff:ffff:XXXX:ffff.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '47.97.XX.XX', + ], + 'required' => false, + 'docRequired' => true, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '443C5781-1C03-5FCD-8EC5-FB9C0B9AC396', + ], + 'AssetList' => [ + 'description' => 'The details of the assets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => 'The risk level. Valid values:'."\n" + ."\n" + .'* **low**'."\n" + .'* **middle**'."\n" + .'* **high**'."\n", + 'type' => 'string', + 'example' => 'low', + ], + 'Ip' => [ + 'description' => 'The IP address of the server.'."\n", + 'type' => 'string', + 'example' => '39.108.XX.XX', + ], + 'IpVersion' => [ + 'description' => 'The IP version of the asset that is protected by Cloud Firewall.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **4**: IPv4'."\n" + .'* **6**: IPv6'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Reason' => [ + 'description' => 'The reason for the risk.'."\n", + 'type' => 'string', + 'example' => 'other', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 12,\\n \\"RequestId\\": \\"443C5781-1C03-5FCD-8EC5-FB9C0B9AC396\\",\\n \\"AssetList\\": [\\n {\\n \\"RiskLevel\\": \\"low\\",\\n \\"Ip\\": \\"39.108.XX.XX\\",\\n \\"IpVersion\\": 4,\\n \\"Reason\\": \\"other\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeAssetRiskList', + ], + 'CreateInstanceSyncTask' => [ + 'summary' => '创建实例资产同步任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68123', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60.182.79.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ips_server'."\n", + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D19D8F70-D64B-5A95-905A-6073BF4A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Module\\": \\"ips_server\\\\n\\",\\n \\"RequestId\\": \\"D19D8F70-D64B-5A95-905A-6073BF4A****\\"\\n}","type":"json"}]', + ], + 'ModifyResourceTypeAutoEnable' => [ + 'summary' => '开启资产类型默认引流', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240055', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + 'title' => '接收消息的语言类型。', + ], + ], + [ + 'name' => 'ResourceTypeAutoEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"SlbEIP":true,"GaEIP":false,"EcsIPv6":true,"NatPublicIP":true,"SlbIPv6":false,"BastionHostIngressIP":false,"EIP":true,"NatEIP":true,"SlbPublicIP":true,"EcsEIP":true,"EniEIP":true,"HAVIP":true,"NlbEIP":true,"NlbIPv6":false,"EniEIPv6":false,"EcsPublicIP":true,"AlbIPv6":true,"BastionHostIP":false,"BastionHostEgressIP":true,"GaEIPV6":false,"AlbEIP":false}', + 'title' => '资源类型开启自动保护。', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'title' => '地区编号', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'B14757D0-4640-4B44-AC67-7F558F****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B14757D0-4640-4B44-AC67-7F558F****\\"\\n}","type":"json"}]', + ], + 'PutEnableFwSwitch' => [ + 'summary' => 'Enables firewalls for specific assets.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68512', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.X.X', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response.'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpaddrList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IP addresses.'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address.'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + 'required' => false, + 'example' => '["192.0.X.X","192.0.X.X"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'RegionList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The regions.'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The region.'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou,cn-shanghai', + ], + 'required' => false, + 'example' => '["cn-hangzhou","cn-shanghai"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'ResourceTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The types of the assets.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* BastionHostIP: the egress IP address of a bastion host'."\n" + .'* BastionHostIngressIP: the ingress IP address of a bastion host'."\n" + .'* EcsEIP: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance'."\n" + .'* EcsPublicIP: the public IP address of an ECS instance'."\n" + .'* EIP: the EIP'."\n" + .'* EniEIP: the EIP of an elastic network interface (ENI)'."\n" + .'* NatEIP: the EIP of a NAT gateway'."\n" + .'* SlbEIP: the EIP of a Server Load Balancer (SLB) instance'."\n" + .'* SlbPublicIP: the public IP address of an SLB instance'."\n" + .'* NatPublicIP: the public IP address of a NAT gateway'."\n" + .'* HAVIP: the high-availability virtual IP address (HAVIP)'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the asset.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* BastionHostIP: the egress IP address of a bastion host'."\n" + .'* BastionHostIngressIP: the ingress IP address of a bastion host'."\n" + .'* EcsEIP: the EIP of an ECS instance'."\n" + .'* EcsPublicIP: the public IP address of an ECS instance'."\n" + .'* EIP: the EIP'."\n" + .'* EniEIP: the EIP of an ENI'."\n" + .'* NatEIP: the EIP of a NAT gateway'."\n" + .'* SlbEIP: the EIP of an SLB instance'."\n" + .'* SlbPublicIP: the public IP address of an SLB instance'."\n" + .'* NatPublicIP: the public IP address of a NAT gateway'."\n" + .'* HAVIP: the HAVIP'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EcsPublicIp,NatEip', + ], + 'required' => false, + 'example' => '["EcsPublicIp","NatEip"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'title' => '成员唯一标识符', + 'type' => 'string', + 'example' => '1234', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'IP版本号', + 'type' => 'string', + 'example' => '4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + 'AbnormalResourceStatusList' => [ + 'description' => 'The status information of the asset when it is not synchronized to Cloud Firewall.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Resource' => [ + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'example' => '203.0.113.0', + ], + 'Status' => [ + 'description' => 'The status of the asset when it is not synchronized to Cloud Firewall. Valid values:'."\n" + ."\n" + .'* ip_not_sync: The asset is not synchronized.'."\n", + 'type' => 'string', + 'example' => 'ip_not_sync', + ], + 'Msg' => [ + 'description' => 'The message displayed when the asset is not synchronized to Cloud Firewall. Valid values:'."\n" + ."\n" + .'* cloudfirewall do not sync this ip address: This IP address is not synchronized to Cloud Firewall.'."\n", + 'type' => 'string', + 'example' => 'cloudfirewall do not sync this ip address', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorInstanceOpenIpNumExceed', + 'errorMessage' => 'The maximum number of protected assets has been reached.', + ], + [ + 'errorCode' => 'ErrorInstanceStatusNotNormal', + 'errorMessage' => 'This operation is not supported when the instance is in the current state.', + ], + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorParamsInvalid', + 'errorMessage' => 'Invalid Params', + ], + [ + 'errorCode' => 'ErrorInstanceOpenIpRegionNumExceed', + 'errorMessage' => 'open ip region num exceed.', + ], + [ + 'errorCode' => 'ErrorBandwidthPenalty', + 'errorMessage' => 'Cloud Firewall bandwidth is being overused.', + ], + [ + 'errorCode' => 'ErrorGeneralInstanceSpecFull', + 'errorMessage' => 'Cloud Firewall instance specifications are full.', + ], + ], + [ + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'An authentication error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\",\\n \\"AbnormalResourceStatusList\\": [\\n {\\n \\"Resource\\": \\"203.0.113.0\\",\\n \\"Status\\": \\"ip_not_sync\\",\\n \\"Msg\\": \\"cloudfirewall do not sync this ip address\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<PutEnableFwSwitchResponse>\\n <RequestId>B2841452-CB8D-4F7D-B247-38E1CF7334F8</RequestId>\\n</PutEnableFwSwitchResponse>","errorExample":""}]', + 'title' => 'PutEnableFwSwitch', + 'description' => 'You can call this operation to enable a firewall. After you enable a firewall, traffic passes through Cloud Firewall.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to five times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutEnableAllFwSwitch' => [ + 'summary' => 'Enables a firewall for all public IP addresses within your Alibaba Cloud account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68511', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of your Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze8v2x5kd9qyvp2****', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorInstanceStatusNotNormal', + 'errorMessage' => 'This operation is not supported when the instance is in the current state.', + ], + [ + 'errorCode' => 'ErrorInstanceOpenIpNumExceed', + 'errorMessage' => 'The maximum number of protected assets has been reached.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + [ + 'errorCode' => 'ErrorInstanceOpenIpRegionNumExceed', + 'errorMessage' => 'open ip region num exceed.', + ], + [ + 'errorCode' => 'ErrorGeneralInstanceSpecFull', + 'errorMessage' => 'Cloud Firewall instance specifications are full.', + ], + [ + 'errorCode' => 'ErrorBandwidthPenalty', + 'errorMessage' => 'Cloud Firewall bandwidth is being overused.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\"\\n}","errorExample":""},{"type":"xml","example":"<PutEnableAllFwSwitchResponse>\\n <RequestId>B2841452-CB8D-4F7D-B247-38E1CF7334F8</RequestId>\\n</PutEnableAllFwSwitchResponse>","errorExample":""}]', + 'title' => 'PutEnableAllFwSwitch', + 'description' => 'You can call the PutEnableAllFwSwitch operation to enable a firewall for all public IP addresses within your Alibaba Cloud account. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see [Common parameters](~~94763~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutDisableFwSwitch' => [ + 'summary' => 'Disable a firewall for specific assets.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68509', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpaddrList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IP addresses.'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address.', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + 'required' => false, + 'example' => '["192.0.XX.XX","192.0.XX.XX"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'RegionList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The regions.'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the region.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'required' => false, + 'example' => '["cn-hangzhou","cn-shanghai"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'ResourceTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The types of the assets.'."\n" + ."\n" + .'> You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the asset. Valid values:'."\n" + ."\n" + .'* BastionHostIP: the egress IP address of a bastion host'."\n" + .'* BastionHostIngressIP: the ingress IP address of a bastion host'."\n" + .'* EcsEIP: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance'."\n" + .'* EcsPublicIP: the public IP address of an ECS instance'."\n" + .'* EIP: the EIP'."\n" + .'* EniEIP: the EIP of an elastic network interface (ENI)'."\n" + .'* NatEIP: the EIP of a Network Address Translation (NAT) gateway'."\n" + .'* SlbEIP: the EIP of a Server Load Balancer (SLB) instance'."\n" + .'* SlbPublicIP: the public IP address of an SLB instance'."\n" + .'* NatPublicIP: the public IP address of a NAT gateway'."\n" + .'* HAVIP: the high-availability virtual IP address (HAVIP)', + 'type' => 'string', + 'required' => false, + 'example' => 'EcsPublicIP', + ], + 'required' => false, + 'example' => '["EcsPublicIp","NatEip"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'title' => '成员唯一标识符', + 'type' => 'string', + 'example' => '1234', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'IP版本号', + 'type' => 'string', + 'example' => '4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorInstanceStatusNotNormal', + 'errorMessage' => 'This operation is not supported when the instance is in the current state.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + ], + [ + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'An authentication error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\"\\n}","errorExample":""},{"type":"xml","example":"<PutDisableFwSwitchResponse>\\n <RequestId>B2841452-CB8D-4F7D-B247-38E1CF7334F8</RequestId>\\n</PutDisableFwSwitchResponse>","errorExample":""}]', + 'title' => 'PutDisableFwSwitch', + 'description' => 'You can call the PutDisableFwSwitch operation to disable a firewall for specific assets. After you disable the firewall, traffic does not pass through Cloud Firewall. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see [Common parameters](~~94763~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutDisableAllFwSwitch' => [ + 'summary' => 'Turns off all firewall switches.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68508', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values: Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of your Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze8v2x5kd9qyvp2****', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorInstanceStatusNotNormal', + 'errorMessage' => 'This operation is not supported when the instance is in the current state.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + ], + [ + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'An authentication error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\"\\n}","errorExample":""},{"type":"xml","example":"<PutDisableAllFwSwitchResponse>\\r\\n<RequestId>B2841452-CB8D-4F7D-B247-38E1CF7334F8</RequestId>\\r\\n</PutDisableAllFwSwitchResponse>","errorExample":""}]', + 'title' => 'PutDisableAllFwSwitch', + 'description' => 'You can call the PutDisableAllFwSwitch operation to turn off all firewall switches.'."\n" + ."\n" + .'## [](#qps-)QPS limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see [Common parameters](~~94763~~). For more information about sample requests, see the **Examples** section of this topic.'."\n", + 'extraInfo' => ' ', + ], + 'DescribeNatFirewallQuota' => [ + 'summary' => '获取NAT防火墙配额', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '115963', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '113.132.26.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F98BAA59-5863-5B61-8FD4-C5E96813****', + ], + 'UsedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'ExceptionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'UnprotectedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorUserNotFound', + 'errorMessage' => 'User not found', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F98BAA59-5863-5B61-8FD4-C5E96813****\\",\\n \\"UsedCount\\": 10,\\n \\"TotalCount\\": 6,\\n \\"ExceptionCount\\": 1,\\n \\"UnprotectedCount\\": 20\\n}","type":"json"}]', + ], + 'DescribeNatFirewallList' => [ + 'summary' => 'Queries details of NAT firewalls.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '115925', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + .'* **zh** (default)'."\n" + .'* **en**', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + .'* **zh** (default)'."\n" + .'* **en**', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: **10**.**** Maximum value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT firewall.', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy-nat97a******'."\n", + ], + ], + [ + 'name' => 'ProxyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the NAT firewall. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (_). The name cannot start with an underscore.', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy-******', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the virtual private cloud (VPC).', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.', + 'type' => 'string', + 'required' => false, + 'example' => 'nat-bp123456g******', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the NAT firewall. Valid values:'."\n" + ."\n" + .'* configuring'."\n" + .'* deleting'."\n" + .'* normal'."\n" + .'* abnormal'."\n" + .'* opening'."\n" + .'* closing'."\n" + .'* closed'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '147783******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of NAT firewalls.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******'."\n", + ], + 'NatFirewallList' => [ + 'description' => 'The NAT firewalls.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MemberUid' => [ + 'description' => 'The UID of the member in Cloud Firewall.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19106481******', + ], + 'AliUid' => [ + 'description' => 'The UID of the Alibaba Cloud account.'."\n" + ."\n" + .'> The value of this parameter indicates the management account to which the member is added.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19106481******'."\n", + ], + 'ProxyId' => [ + 'description' => 'The ID of the NAT firewall.'."\n", + 'type' => 'string', + 'example' => 'proxy-nat30******', + ], + 'ProxyName' => [ + 'description' => 'The name of the NAT firewall.'."\n", + 'type' => 'string', + 'example' => 'proxy-******', + ], + 'ProxyStatus' => [ + 'description' => 'The status of the NAT firewall. Valid values:'."\n" + ."\n" + .'* configuring'."\n" + .'* deleting'."\n" + .'* normal'."\n" + .'* abnormal'."\n" + .'* opening'."\n" + .'* closing'."\n" + .'* closed'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'RegionId' => [ + 'description' => 'The region ID of your Cloud Firewall.'."\n" + ."\n" + .'> For more information about the supported regions of Cloud Firewall, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'NatGatewayId' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'example' => 'ngw-uf6tnblxip4qcxg******', + ], + 'NatGatewayName' => [ + 'description' => 'The name of the NAT gateway.'."\n", + 'type' => 'string', + 'example' => 'nat-******', + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-2ze26ya******', + ], + 'VpcName' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-******', + ], + 'ErrorDetail' => [ + 'description' => 'The cause of the error.'."\n", + 'type' => 'string', + 'example' => 'Create Failed.', + ], + 'StrictMode' => [ + 'description' => 'Indicates whether the strict mode is enabled. Valid values: 1, which specifies yes, and 0, which specifies no.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NatRouteEntryList' => [ + 'description' => 'The default route entries of the NAT gateway.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'The route table to which the default route of the NAT gateway belongs.'."\n", + 'type' => 'string', + 'example' => 'vtb-bp18o0gb******', + ], + 'NextHopId' => [ + 'description' => 'The next hop of the original NAT gateway.'."\n", + 'type' => 'string', + 'example' => 'ngw-2ze0s284r9atg5******', + ], + 'NextHopType' => [ + 'description' => 'The network type of the next hop. The value is fixed as NatGateway.'."\n", + 'type' => 'string', + 'example' => 'NatGateway', + ], + 'DestinationCidr' => [ + 'description' => 'The destination CIDR block of the default route.'."\n", + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + ], + ], + 'ProxyVSwitchId' => [ + 'type' => 'string', + ], + 'ProxyRouteTableId' => [ + 'type' => 'string', + ], + 'ProxyNetworkInterfaceId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorNatGatewayNotAvailable', + 'errorMessage' => 'Nat gateway not available.', + ], + [ + 'errorCode' => 'ErrorDnatNotSupport', + 'errorMessage' => 'NAT firewall does not support DAT entries.', + ], + [ + 'errorCode' => 'ErrorProxySnatIpEmpty', + 'errorMessage' => 'SNAT entry is empty.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"15FCCC52-1E23-57AE-B5EF-3E00A3******\\\\n\\",\\n \\"NatFirewallList\\": [\\n {\\n \\"MemberUid\\": 0,\\n \\"AliUid\\": 0,\\n \\"ProxyId\\": \\"proxy-nat30******\\",\\n \\"ProxyName\\": \\"nat-防火墙测试\\\\n\\",\\n \\"ProxyStatus\\": \\"normal\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"NatGatewayId\\": \\"ngw-uf6tnblxip4qcxg******\\",\\n \\"NatGatewayName\\": \\"NAT网关测试\\\\n\\",\\n \\"VpcId\\": \\"vpc-2ze26ya******\\",\\n \\"VpcName\\": \\"vpc-测试实例\\",\\n \\"ErrorDetail\\": \\"防火墙创建失败\\",\\n \\"StrictMode\\": 0,\\n \\"NatRouteEntryList\\": [\\n {\\n \\"RouteTableId\\": \\"vtb-bp18o0gb******\\",\\n \\"NextHopId\\": \\"ngw-2ze0s284r9atg5******\\",\\n \\"NextHopType\\": \\"NatGateway\\",\\n \\"DestinationCidr\\": \\"0.0.0.0/0\\"\\n }\\n ],\\n \\"ProxyVSwitchId\\": \\"vsw-bp1amn3t1ktjjy8******\\",\\n \\"ProxyRouteTableId\\": \\"vtb-bp1pmyga7p4j10a******\\",\\n \\"ProxyNetworkInterfaceId\\": \\"eni-bp127llmo4v5qju******\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeNatFirewallList', + ], + 'DescribeFirewallVSwitch' => [ + 'summary' => '获取防火墙创建的交换机', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68260', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1sqg9w******', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-5b202e7f0be64611****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '102910763545****', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A1562A68-99FA-5D6B-BD5B-2F959F25****', + ], + 'VswitchList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-2zeez7gymz5r4pi****am', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.XX/16', + ], + 'VswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-bp10qla9mgi42eo****', + ], + 'AvailableIpCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'VswitchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-test', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '184480249330****', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai-b', + ], + 'FirewallCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'FirewallList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FirewallName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-Firewall', + ], + 'FirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-tr-37145c8f5ede45e9****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"A1562A68-99FA-5D6B-BD5B-2F959F25****\\",\\n \\"VswitchList\\": [\\n {\\n \\"VpcId\\": \\"vpc-2zeez7gymz5r4pi****am\\",\\n \\"CidrBlock\\": \\"192.168.0.XX/16\\",\\n \\"VswitchId\\": \\"vsw-bp10qla9mgi42eo****\\",\\n \\"AvailableIpCount\\": \\"10\\",\\n \\"VswitchName\\": \\"vsw-test\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"MemberUid\\": \\"184480249330****\\",\\n \\"ZoneId\\": \\"cn-shanghai-b\\",\\n \\"FirewallCount\\": \\"10\\",\\n \\"FirewallList\\": [\\n {\\n \\"FirewallName\\": \\"test-Firewall\\",\\n \\"FirewallId\\": \\"vfw-tr-37145c8f5ede45e9****\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeNatFirewallPrecheckDetail' => [ + 'summary' => '查询NAT防火墙预检查结果', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '204316', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-bp1okz6k7dge****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsFound' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PrecheckDetail' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NetworkInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-m5emh0w6v2e15****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'FirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-tr-7a9c8901ed394****', + ], + 'PrecheckTimestamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1715136000', + ], + 'PrecheckStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'failed', + ], + 'PrecheckEntityGroups' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PrecheckEntities' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Precheck test', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'passed', + ], + 'Info' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Suggestion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'PrecheckEntityGroupStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'running', + ], + 'FailedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '99A65AA0-C5B5-5092-BFCF-8111B436****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorUnMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorPreCheckDoing', + 'errorMessage' => 'Pre-check in progress, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IsFound\\": false,\\n \\"PrecheckDetail\\": {\\n \\"NetworkInstanceId\\": \\"vpc-m5emh0w6v2e15****\\",\\n \\"RegionNo\\": \\"cn-shenzhen\\",\\n \\"FirewallId\\": \\"vfw-tr-7a9c8901ed394****\\",\\n \\"PrecheckTimestamp\\": \\"1715136000\\",\\n \\"PrecheckStatus\\": \\"failed\\",\\n \\"PrecheckEntityGroups\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"PrecheckEntities\\": [\\n {\\n \\"Name\\": \\"Precheck test\\",\\n \\"Status\\": \\"passed\\",\\n \\"Info\\": \\"VPC防火墙配额已满\\",\\n \\"Suggestion\\": \\"VPC防火墙配额已满，建议您提高防火墙配额\\"\\n }\\n ],\\n \\"PrecheckEntityGroupStatus\\": \\"running\\",\\n \\"FailedCount\\": 9\\n }\\n ]\\n },\\n \\"RequestId\\": \\"99A65AA0-C5B5-5092-BFCF-8111B436****\\"\\n}","type":"json"}]', + ], + 'DescribeFirewallVswitchResources' => [ + 'summary' => '获取防火墙交换机资源', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68261', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-2ze36yb348axtnf****', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'internet', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A81E99DF-07CF-5EE4-966A-9FF9F2F****', + ], + 'VswitchList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'open', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.XX/16', + ], + 'VswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-bp10qla9mgi42eo****', + ], + 'AvailableIpCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'VswitchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-test', + ], + 'RouteTableType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Custom', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai-b', + ], + 'RouteTableId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vtb-uf6ml7rgw5gzzdr****', + ], + 'Detail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[]', + ], + 'FirewallList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-tr-37145c8f5ede45e9****', + ], + 'FirewallName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-Firewall', + ], + 'FirewallType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NatFirewall', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorVpcIdError', + 'errorMessage' => 'vpc id invalid', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorVswitchNotFound', + 'errorMessage' => 'vswitch not found', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"A81E99DF-07CF-5EE4-966A-9FF9F2F****\\",\\n \\"VswitchList\\": [\\n {\\n \\"Status\\": \\"open\\",\\n \\"CidrBlock\\": \\"192.168.0.XX/16\\",\\n \\"VswitchId\\": \\"vsw-bp10qla9mgi42eo****\\",\\n \\"AvailableIpCount\\": \\"10\\",\\n \\"VswitchName\\": \\"vsw-test\\",\\n \\"RouteTableType\\": \\"Custom\\",\\n \\"ZoneId\\": \\"cn-shanghai-b\\",\\n \\"RouteTableId\\": \\"vtb-uf6ml7rgw5gzzdr****\\",\\n \\"Detail\\": \\"[]\\",\\n \\"FirewallList\\": [\\n {\\n \\"FirewallId\\": \\"vfw-tr-37145c8f5ede45e9****\\",\\n \\"FirewallName\\": \\"test-Firewall\\",\\n \\"FirewallType\\": \\"NatFirewall\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSecurityProxyResources' => [ + 'summary' => '获取正向代理资源', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68361', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-uf6y16l23fm8hq0****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '136481150091****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A8E8D50E-9F45-5662-B116-A1D0807F****', + ], + 'ResourceList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'VpcList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-8vbuzirdl3w1r7exw****', + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-wz94a4q37rgl7g****', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '157862808111****', + ], + 'NatGateways' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'Detail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-bp1bm0k2t8i6ooxu****', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'NatRouteEntryList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextHopId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-2zey0w2u02u1x584m****', + ], + 'DestinationCidr' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.0.70.XX/24', + ], + 'RouteTableId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vtb-2ze409pp09d994a****', + ], + 'NextHopType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NatGateway', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8E8D50E-9F45-5662-B116-A1D0807F****\\",\\n \\"ResourceList\\": [\\n {\\n \\"RegionNo\\": \\"cn-beijing\\",\\n \\"VpcList\\": [\\n {\\n \\"VpcId\\": \\"vpc-8vbuzirdl3w1r7exw****\\",\\n \\"VpcName\\": \\"vpc-wz94a4q37rgl7g****\\",\\n \\"CidrBlock\\": \\"192.168.0.0/16\\",\\n \\"MemberUid\\": \\"157862808111****\\",\\n \\"NatGateways\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"Detail\\": \\"Available\\",\\n \\"NatGatewayId\\": \\"ngw-bp1bm0k2t8i6ooxu****\\",\\n \\"NatGatewayName\\": \\"ngw-test\\",\\n \\"NatRouteEntryList\\": [\\n {\\n \\"NextHopId\\": \\"ngw-2zey0w2u02u1x584m****\\",\\n \\"DestinationCidr\\": \\"10.0.70.XX/24\\",\\n \\"RouteTableId\\": \\"vtb-2ze409pp09d994a****\\",\\n \\"NextHopType\\": \\"NatGateway\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateNatFirewallSyncTask' => [ + 'summary' => '创建NAT防火墙资产同步任务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237946', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '3E048D45-A563-5F81-9D97-536B4A84****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E048D45-A563-5F81-9D97-536B4A84****\\"\\n}","type":"json"}]', + ], + 'CreateNatFirewallPreCheck' => [ + 'summary' => '创建NAT防火墙预检查', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207105', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-2zeiljdml8pble168****', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-uf69hlxv5c817iqrk****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A426611F-04FA-5205-8D04-4F6DCF09****', + ], + 'PreCheckId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2122', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A426611F-04FA-5205-8D04-4F6DCF09****\\",\\n \\"PreCheckId\\": \\"2122\\"\\n}","type":"json"}]', + ], + 'CreateSecurityProxy' => [ + 'summary' => 'Creates a NAT firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68127', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the NAT firewall. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (\\_). However, it cannot start with an underscore.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'nat-idmp-fir', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the virtual private cloud (VPC).'."\n" + ."\n" + .'> For more information about Cloud Firewall supported regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-uf6b5lyul0xfgv74i01ph', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-bp1okz6k7s4n4mnk5f1g3', + ], + ], + [ + 'name' => 'VswitchAuto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the vSwitch that you want to use. Valid values:'."\n" + ."\n" + .'* **true**: automatic'."\n" + .'* **false**: manual'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch. This parameter is required if you set the VswitchAuto parameter to true.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1sqg9wms9w9y1uxcs1x', + ], + ], + [ + 'name' => 'NatRouteEntryList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The routes to be switched to the NAT gateway.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextHopId' => [ + 'description' => 'The next hop of the original NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-bp1okz6k7s4n4mnk5f1g3', + ], + 'DestinationCidr' => [ + 'description' => 'The destination CIDR block of the default route.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.0.0.0/0', + ], + 'NextHopType' => [ + 'description' => 'The network type of the next hop. Set the value to NatGateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NatGateway', + ], + 'RouteTableId' => [ + 'description' => 'The route table to which the default route of the NAT gateway belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vtb-2ze13wrgz7wsu9yiqeffg', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the NAT firewall. Valid values:'."\n" + ."\n" + .'* **open**: enabled'."\n" + .'* **close**: disabled'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'close', + ], + ], + [ + 'name' => 'StrictMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the strict mode. Valid values:'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'VswitchCidr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR block of the vSwitch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ProxyId' => [ + 'description' => 'The ID of the NAT firewall.'."\n", + 'type' => 'string', + 'example' => 'proxy-nat97ac4d7cc3834a5daf40', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3DC3CAB', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParamProxyNameError', + 'errorMessage' => 'proxy name invalid.', + ], + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'Region is error, please reselect', + ], + [ + 'errorCode' => 'ErrorVpcIdError', + 'errorMessage' => 'Vpc ID invalid.', + ], + [ + 'errorCode' => 'ErrorDnatNotSupport', + 'errorMessage' => 'Secure proxy does not support DNAT entries.', + ], + [ + 'errorCode' => 'ErrorProxySnatIpEmpty', + 'errorMessage' => 'SNAT entry is empty.', + ], + [ + 'errorCode' => 'ErrorSnatIpQuotaExceed', + 'errorMessage' => 'The number of SNAT IP exceeds the specification.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDefaultRouteConflicts', + 'errorMessage' => 'Default route conflicts.', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorVpcOpenApi', + 'errorMessage' => 'vpc open api failed', + ], + [ + 'errorCode' => 'ErrorVswitchNotFound', + 'errorMessage' => 'vswitch not found', + ], + [ + 'errorCode' => 'ErrorProxyRouteEntryConflicts', + 'errorMessage' => 'Proxy custom route table Nat Gateway and Attachment route entry conflict.', + ], + [ + 'errorCode' => 'ErrorVswitchNoAvailableCidr', + 'errorMessage' => 'No available CIDR to create a vswitch.', + ], + [ + 'errorCode' => 'ErrorCidrFormat', + 'errorMessage' => 'Network segment CIDR format error, please select again', + ], + [ + 'errorCode' => 'ErrorInternal', + 'errorMessage' => 'internal error', + ], + [ + 'errorCode' => 'ErrorVswitchCidrNotInVpc', + 'errorMessage' => 'Vswitch CIDR address not in vpc.', + ], + [ + 'errorCode' => 'ErrorVswitchRouteConflict', + 'errorMessage' => 'vswitch route conflict.', + ], + [ + 'errorCode' => 'ErrorVswitchCidrIpNumNotEnough', + 'errorMessage' => 'No enough private proxy IP in vswitch cidr.', + ], + [ + 'errorCode' => 'ErrorRouteEntryNotFound', + 'errorMessage' => 'route entry not found.', + ], + [ + 'errorCode' => 'ErrorUserNotFound', + 'errorMessage' => 'User not found', + ], + [ + 'errorCode' => 'ErrorProxyVpcNotSupportAdvFeature', + 'errorMessage' => 'This vpc advanced feature is not supported.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorProxyNumQuotaTop', + 'errorMessage' => 'Proxy num reaches maximum.', + ], + [ + 'errorCode' => 'ErrorProxyClusterNotAvailable', + 'errorMessage' => 'Can not find available cluster for nat firewall.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorBandwidthPenalty', + 'errorMessage' => 'Cloud Firewall bandwidth is being overused.', + ], + [ + 'errorCode' => 'ErrorGeneralInstanceSpecFull', + 'errorMessage' => 'Cloud Firewall instance specifications are full.', + ], + [ + 'errorCode' => 'ErrorNatVpnRouteEntryQuotaLimit', + 'errorMessage' => 'The number of VPN routes has reached the quota.', + ], + [ + 'errorCode' => 'ErrorVpcRouteTableQuotaLimit', + 'errorMessage' => 'The number of VPC routing tables has reached the specification limit.', + ], + [ + 'errorCode' => 'ErrorNatCustomRouteEntryDifferent', + 'errorMessage' => 'The custom route entries in the routing tables are inconsistent.', + ], + [ + 'errorCode' => 'ErrorSnatEntryQuotaExceed', + 'errorMessage' => 'SNAT entry quota exceeded.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProxyId\\": \\"proxy-nat97a******\\",\\n \\"RequestId\\": \\"15FCCC52-1E23-57AE-B5EF-3E00A3******\\"\\n}","type":"json"}]', + 'title' => 'CreateSecurityProxy', + ], + 'SwitchSecurityProxy' => [ + 'summary' => 'Enables or disables a NAT firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68530', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT firewall.', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy-natbfd2fafbb77042308d1b', + ], + ], + [ + 'name' => 'Switch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the NAT firewall. Valid values:'."\n" + ."\n" + .'* open: yes'."\n" + .'* close: no'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'F1E55690-3ABA-58FA-90E3-593EF05B73ED', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParamProxyNameError', + 'errorMessage' => 'proxy name invalid.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorProxyStatusNotNormal', + 'errorMessage' => 'proxy status is not normal.', + ], + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1E55690-3ABA-58FA-90E3-593EF******\\"\\n}","type":"json"}]', + 'title' => 'SwitchSecurityProxy', + ], + 'UpdateSecurityProxy' => [ + 'summary' => '更新安全正向代理', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68536', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy-natfdc73073e031****8e0d', + ], + ], + [ + 'name' => 'ProxyName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy_auto_heyuan', + ], + ], + [ + 'name' => 'StrictMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ips_server', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9E2CCAB4-E789-5BC9-88DC-5CE0358E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParamProxyNameError', + 'errorMessage' => 'proxy name invalid.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorProxyStatusNotNormal', + 'errorMessage' => 'proxy status is not normal.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Module\\": \\"ips_server\\",\\n \\"RequestId\\": \\"9E2CCAB4-E789-5BC9-88DC-5CE0358E****\\"\\n}","type":"json"}]', + ], + 'DeleteSecurityProxy' => [ + 'summary' => 'Deletes a NAT firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68156', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'proxy-nat00ab412ef93d4275a6b5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7447795A-39AB-52CB-8F92-128DF4898F36', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7447795A-39AB-52CB-8F92-128DF******\\"\\n}","type":"json"}]', + 'title' => 'DeleteSecurityProxy', + ], + 'DescribeVpcFirewallSummaryInfo' => [ + 'summary' => '获取VPC防火墙总结信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68427', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'buy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AvailableVpcFirewallQuota' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'CenExpressConnectVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'CenFirewallVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CenTrVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'ClosedCenFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClosedExpressConnectFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ClosedVpcFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ConfiguredCenFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ConfiguredCenFirewallRegionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfiguredCenFirewallVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + ], + 'ConfiguredCenTrFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfiguredExpressConnectFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfiguredExpressConnectVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfiguredVpcFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ConfiguredVpcFirewallVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExpressConnectVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NotConfiguredCenFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotConfiguredCenTrFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'NotConfiguredExpressConnectFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'NotConfiguredVpcFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'OpenedCenExpressConnectVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'OpenedCenFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'OpenedCenFirewallVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenedCenTrFirewallVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'OpenedEcrCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenedExpressConnectFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'OpenedExpressConnectVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'OpenedPeerTrCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'OpenedVbrCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenedVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + 'OpenedVpcFirewallCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'OpenedVpnCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8AABEF64-7ABF-52CB-BA6C-0598E3DB****', + ], + 'TotalEcrCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalPeerTrCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'TotalVbrCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalVpcFirewallQuota' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalVpnCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AvailableVpcFirewallQuota\\": 4,\\n \\"CenExpressConnectVpcCount\\": 7,\\n \\"CenFirewallVpcCount\\": 10,\\n \\"CenTrVpcCount\\": 13,\\n \\"ClosedCenFirewallCount\\": 1,\\n \\"ClosedExpressConnectFirewallCount\\": 10,\\n \\"ClosedVpcFirewallCount\\": 5,\\n \\"ConfiguredCenFirewallCount\\": 5,\\n \\"ConfiguredCenFirewallRegionCount\\": 2,\\n \\"ConfiguredCenFirewallVpcCount\\": 18,\\n \\"ConfiguredCenTrFirewallCount\\": 2,\\n \\"ConfiguredExpressConnectFirewallCount\\": 2,\\n \\"ConfiguredExpressConnectVpcCount\\": 2,\\n \\"ConfiguredVpcFirewallCount\\": 5,\\n \\"ConfiguredVpcFirewallVpcCount\\": 1,\\n \\"ExpressConnectVpcCount\\": 2,\\n \\"NotConfiguredCenFirewallCount\\": 0,\\n \\"NotConfiguredCenTrFirewallCount\\": 6,\\n \\"NotConfiguredExpressConnectFirewallCount\\": 7,\\n \\"NotConfiguredVpcFirewallCount\\": 12,\\n \\"OpenedCenExpressConnectVpcCount\\": 10,\\n \\"OpenedCenFirewallCount\\": 4,\\n \\"OpenedCenFirewallVpcCount\\": 0,\\n \\"OpenedCenTrFirewallVpcCount\\": 4,\\n \\"OpenedEcrCount\\": 0,\\n \\"OpenedExpressConnectFirewallCount\\": 15,\\n \\"OpenedExpressConnectVpcCount\\": 2,\\n \\"OpenedPeerTrCount\\": 3,\\n \\"OpenedVbrCount\\": 0,\\n \\"OpenedVpcCount\\": 17,\\n \\"OpenedVpcFirewallCount\\": 9,\\n \\"OpenedVpnCount\\": 6,\\n \\"RequestId\\": \\"8AABEF64-7ABF-52CB-BA6C-0598E3DB****\\",\\n \\"TotalEcrCount\\": 2,\\n \\"TotalPeerTrCount\\": 6,\\n \\"TotalVbrCount\\": 5,\\n \\"TotalVpcCount\\": 2,\\n \\"TotalVpcFirewallQuota\\": 5,\\n \\"TotalVpnCount\\": 1\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallAccessDetail' => [ + 'summary' => '获取VPC防火墙通过详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68411', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1655778046', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1729042555', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-2ze4xj5kmb5udb****', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + [ + 'name' => 'IPProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'PeerVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-90rq0anm6t8vbwbo****', + ], + ], + [ + 'name' => 'PeerAssetIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.125.1.XX', + ], + ], + [ + 'name' => 'PeerAssetInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'i-123451'."\n", + ], + ], + [ + 'name' => 'PeerAssetInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs22'."\n", + ], + ], + [ + 'name' => 'AssetIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'InBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8EAC2347-E85A-5DFF-9F49-B8E1BAFB****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'PeerAssetInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-123451', + ], + 'PeerAssetIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.125.1.XX', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17845821669.0', + ], + 'peerVpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-test', + ], + 'PeerVpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-123411'."\n", + ], + 'PeerAssetInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 9,\\n \\"RequestId\\": \\"8EAC2347-E85A-5DFF-9F49-B8E1BAFB****\\",\\n \\"DataList\\": [\\n {\\n \\"SessionCount\\": 27,\\n \\"PeerAssetInstanceId\\": \\"i-123451\\",\\n \\"PeerAssetIP\\": \\"10.125.1.XX\\",\\n \\"RegionNo\\": \\"cn-shenzhen\\",\\n \\"OutBytes\\": 1123,\\n \\"InBytes\\": 17845821669,\\n \\"peerVpcName\\": \\"vpc-test\\",\\n \\"PeerVpcId\\": \\"vpc-123411\\\\n\\",\\n \\"PeerAssetInstanceName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallPrecheckDetail' => [ + 'summary' => '获取VPC防火墙预检查详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '120839', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NetworkInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cen_firewall', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zev8s8rxao33xt****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-hxsqf2bv6di1a****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-2vcn4u2g86tm72****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '134388541648****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsFound' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PrecheckDetail' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NetworkInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-m5emh0w6v2e15****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-tr-7a9c8901ed394****', + ], + 'PrecheckTimestamp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1715136000', + ], + 'PrecheckStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'failed', + ], + 'PrecheckEntityGroups' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PrecheckEntities' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Precheck test', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'passed', + ], + 'Info' => [ + 'type' => 'string', + ], + 'Suggestion' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PrecheckEntityGroupStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'running', + ], + 'FailedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4FB718F0-CC04-5A12-B17B-188CFC3F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'Region is error, please reselect', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorPreCheckDoing', + 'errorMessage' => 'Pre-check in progress, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IsFound\\": false,\\n \\"PrecheckDetail\\": {\\n \\"NetworkInstanceId\\": \\"vpc-m5emh0w6v2e15****\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"FirewallId\\": \\"vfw-tr-7a9c8901ed394****\\",\\n \\"PrecheckTimestamp\\": \\"1715136000\\",\\n \\"PrecheckStatus\\": \\"failed\\",\\n \\"PrecheckEntityGroups\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"PrecheckEntities\\": [\\n {\\n \\"Name\\": \\"Precheck test\\",\\n \\"Status\\": \\"passed\\",\\n \\"Info\\": \\"VPC防火墙配额已满\\",\\n \\"Suggestion\\": \\"VPC防火墙配额已满，建议您提高防火墙配额\\"\\n }\\n ],\\n \\"PrecheckEntityGroupStatus\\": \\"running\\",\\n \\"FailedCount\\": 3\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4FB718F0-CC04-5A12-B17B-188CFC3F****\\"\\n}","type":"json"}]', + ], + 'CreateVpcFirewallPrecheck' => [ + 'summary' => '创建VPC防火墙开墙前置任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '120810', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NetworkInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cen_tr_firewall', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp132e2wpu9o6qth****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-chengdu', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-iv8m2lj2fqg1xt****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '128599825273****', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-t4n16htuv1jalj9cq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PrecheckId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4197', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C5BE1AA4-934A-5085-89CC-9AD1CAC3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorNetworkInstanceIdError', + 'errorMessage' => 'Network InstanceId ID is invalid', + ], + [ + 'errorCode' => 'ErrorCenId', + 'errorMessage' => 'CEN ID is error', + ], + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'Region invalid.', + ], + [ + 'errorCode' => 'ErrorDestCidrError', + 'errorMessage' => 'The target network segment is wrong. Please configure the target network segment correctly.', + ], + [ + 'errorCode' => 'ErrorDestCidrEmpty', + 'errorMessage' => 'The target network segment is empty and cannot be created', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'Vpc firewall not found.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorOwnerId', + 'errorMessage' => 'owner id invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallStatus', + 'errorMessage' => 'Firewall status error, please try again later.', + ], + [ + 'errorCode' => 'ErrorHubvpcCannotCreate', + 'errorMessage' => 'HUB VPC could not create vpc firewall', + ], + [ + 'errorCode' => 'ErrorFirewallQuotaNotEmpty', + 'errorMessage' => 'The quota for VPC firewalls is exceeded.', + ], + [ + 'errorCode' => 'ErrorCenVbrNotSupport', + 'errorMessage' => 'The cloud enterprise network VBR does not support firewall', + ], + [ + 'errorCode' => 'ErrorCenNotSupportCCN', + 'errorMessage' => 'vpc firewall CEN does not support ccn, cannot open vpc firewall.', + ], + [ + 'errorCode' => 'ErrorOwnerIdUnauthorized', + 'errorMessage' => 'owner id not authorized.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallVpcNumLimit', + 'errorMessage' => 'The number of vpcs in this region is limited to open the vpc firewall.', + ], + [ + 'errorCode' => 'ErrorCenExistPublicCidr', + 'errorMessage' => 'cen domain route exist public route.', + ], + [ + 'errorCode' => 'ErrorCenExistTrRoute', + 'errorMessage' => 'Cen VPC route exist tr route.', + ], + [ + 'errorCode' => 'ErrorCenNotSupportTREnterprise', + 'errorMessage' => 'VPC firewall does not support TR Enterprise Edition protection in this region.', + ], + [ + 'errorCode' => 'ErrorCenNotSupportTREnterpriseAutoMode', + 'errorMessage' => 'VPC firewall does not support TR Enterprise Edition auto mode protection, please use manual mode protection', + ], + [ + 'errorCode' => 'ErrorCenTRAssociationCustomRouteTable', + 'errorMessage' => 'CEN-TR association custom route table.', + ], + [ + 'errorCode' => 'ErrorVpcOpenApi', + 'errorMessage' => 'vpc open api failed', + ], + [ + 'errorCode' => 'ErrorVswitchNotFound', + 'errorMessage' => 'vswitch not found', + ], + [ + 'errorCode' => 'ErrorCidrFormat', + 'errorMessage' => 'Network segment CIDR format error, please select again', + ], + [ + 'errorCode' => 'ErrorRouteTableNotFound', + 'errorMessage' => 'route table not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PrecheckId\\": \\"4197\\",\\n \\"RequestId\\": \\"C5BE1AA4-934A-5085-89CC-9AD1CAC3****\\"\\n}","type":"json"}]', + ], + 'CreateVpcFirewallTask' => [ + 'summary' => '创建VPC防火墙资产同步任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68137', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'sync', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ips_server'."\n", + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '53252B14-BF7C-5A2D-9750-56F827EB****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Module\\": \\"ips_server\\\\n\\",\\n \\"RequestId\\": \\"53252B14-BF7C-5A2D-9750-56F827EB****\\"\\n}","type":"json"}]', + ], + 'DescribeTrFirewallsV2List' => [ + 'summary' => 'Queries the virtual private cloud (VPC) firewalls that are created for transit routers.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142848', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the transit router.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FirewallSwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: The VPC firewall is enabled.'."\n" + .'* **closed**: The VPC firewall is disabled.'."\n" + .'* **notconfigured**: The VPC firewall is not created.'."\n" + .'* **configured**: The VPC firewall is created but is not enabled.'."\n" + .'* **creating**: The VPC firewall is being created.'."\n" + .'* **opening**: The VPC firewall is being enabled.'."\n" + .'* **deleting**: The VPC firewall is being deleted.'."\n" + ."\n" + .'> If you do not specify this parameter, VPC firewalls in all states are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'opened', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-f1799baa9e254651****', + ], + ], + [ + 'name' => 'FirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'RouteMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The routing mode of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **managed**: automatic mode'."\n" + .'* **manual**: manual mode'."\n" + ."\n" + .'> If you do not specify this parameter, VPC firewalls in all routing modes are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'managed', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Cloud Enterprise Network (CEN) instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cen-rig0t5zi96crkl****', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the transit router.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tr-uf6egtvyaedvt20xl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1471E2EC-F706-5F11-A79B-BD583ACB8297', + ], + 'VpcTrFirewalls' => [ + 'description' => 'The VPC firewalls.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The VPC firewall.'."\n", + 'type' => 'object', + 'properties' => [ + 'CenId' => [ + 'description' => 'The ID of the CEN instance.'."\n", + 'type' => 'string', + 'example' => 'cen-03f8s0z052ka3v****', + ], + 'CenName' => [ + 'description' => 'The name of the CEN instance.'."\n", + 'type' => 'string', + 'example' => 'cen_swas', + ], + 'CloudFirewallVpcOrderType' => [ + 'description' => 'The party responsible for the TR fees generated by the VPC firewall. Values:'."\n" + ."\n" + .'- **PayByCloudFirewall**: Fees are borne by the Cloud Firewall.'."\n" + .'- **PayByCenOwner**: Fees are borne by the account to which the CEN instance belongs.', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PayByCenOwner', + ], + 'FirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-tr-99bc4f0fc88b4d00****', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: The VPC firewall is enabled.'."\n" + .'* **closed**: The VPC firewall is disabled.'."\n" + .'* **notconfigured**: The VPC firewall is not created.'."\n" + .'* **configured**: The VPC firewall is created but is not enabled.'."\n" + .'* **creating**: The VPC firewall is being created.'."\n" + .'* **opening**: The VPC firewall is being enabled.'."\n" + .'* **deleting**: The VPC firewall is being deleted.'."\n" + ."\n" + .'> If you do not specify this parameter, VPC firewalls in all states are queried.'."\n", + 'type' => 'string', + 'example' => 'opened', + ], + 'IpsConfig' => [ + 'description' => 'The intrusion prevention system (IPS) configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'BasicRules' => [ + 'description' => 'Indicates whether basic protection is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableAllPatch' => [ + 'description' => 'Indicates whether virtual patching is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleClass' => [ + 'description' => 'The level of the rule group for the IPS. Valid values:'."\n" + ."\n" + .'* **1**: loose.'."\n" + .'* **2**: medium.'."\n" + .'* **3**: strict.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RunMode' => [ + 'description' => 'The mode of the IPS. Valid values:'."\n" + ."\n" + .'* **1**: block mode'."\n" + .'* **0**: monitor mode'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'OwnerId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the VPC belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '171761785151****', + ], + 'PrecheckStatus' => [ + 'description' => 'Indicates whether the VPC firewall can be automatically enabled. Valid values:'."\n" + ."\n" + .'* **passed**: yes'."\n" + .'* **failed**: no'."\n" + .'* **unknown**'."\n", + 'type' => 'string', + 'example' => 'passed', + ], + 'ProtectedResource' => [ + 'description' => 'The protected resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => 'The number of protected resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EcrList' => [ + 'description' => 'The protected express connect routers.', + 'type' => 'array', + 'items' => [ + 'description' => 'The protected express connect router.', + 'type' => 'string', + 'example' => '['."\n" + .' "ecr-d6yi3kl5qxmvkz****"'."\n" + .']', + ], + ], + 'PeerTrList' => [ + 'description' => 'The protected peer transit routers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The protected peer transit router.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "tr-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VbrList' => [ + 'description' => 'The protected virtual border routers (VBRs).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The protected VBR.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "vbr-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VpcList' => [ + 'description' => 'The protected VPCs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The protected VPC.'."\n", + 'type' => 'string', + 'example' => '["vpc-2zegxdvs5f2je81ph****"]', + ], + ], + 'VpnList' => [ + 'description' => 'The protected VPN gateways.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The protected VPN gateway.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "vpn-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + ], + ], + 'RegionNo' => [ + 'description' => 'The region ID of the transit router.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionStatus' => [ + 'description' => 'Indicates whether you can create a VPC firewall in a specified region. Valid values:'."\n" + ."\n" + .'* **enable**: yes'."\n" + .'* **disable**: no'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'ResultCode' => [ + 'description' => 'The result code of the operation that creates the VPC firewall. Valid values:'."\n" + ."\n" + .'* **RegionDisable**: VPC Firewall is not supported in the region of the network instance. You cannot create a VPC firewall for the network instance.'."\n" + .'* **Empty string**: You can create a VPC firewall for the network instance.'."\n", + 'type' => 'string', + 'example' => ' RegionDisable', + ], + 'RouteMode' => [ + 'description' => 'The routing mode of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **managed**: automatic mode'."\n" + .'* **manual**: manual mode'."\n", + 'type' => 'string', + 'example' => 'managed', + ], + 'TransitRouterId' => [ + 'description' => 'The ID of the transit router.'."\n", + 'type' => 'string', + 'example' => 'tr-2vcmhjs88nil55fvu****', + ], + 'UnprotectedResource' => [ + 'description' => 'The unprotected resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => 'The number of unprotected resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EcrList' => [ + 'description' => 'The unprotected express connect routers.', + 'type' => 'array', + 'items' => [ + 'description' => 'The unprotected express connect router.', + 'type' => 'string', + 'example' => '['."\n" + .' "ecr-d6yi3kl5qxmvkz****"'."\n" + .']', + ], + ], + 'PeerTrList' => [ + 'description' => 'The unprotected peer transit routers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The unprotected peer transit router.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "tr-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VbrList' => [ + 'description' => 'The unprotected VBRs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The unprotected VBR.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "vbr-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VpcList' => [ + 'description' => 'The unprotected VPCs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The unprotected VPC.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "vpc-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VpnList' => [ + 'description' => 'The unprotected VPN gateways.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The unprotected VPN gateway.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "vpn-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + ], + ], + 'VpcFirewallName' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AclConfig' => [ + 'description' => 'ACL engine mode.', + 'type' => 'object', + 'properties' => [ + 'StrictMode' => [ + 'description' => 'Whether to enable strict mode'."\n" + .'- 1: Enable strict mode'."\n" + .'- 0: Disable strict mode', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorUserNotFound', + 'errorMessage' => 'User not found', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorUnMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"6\\",\\n \\"RequestId\\": \\"1471E2EC-F706-5F11-A79B-BD583ACB8297\\",\\n \\"VpcTrFirewalls\\": [\\n {\\n \\"CenId\\": \\"cen-03f8s0z052ka3v****\\",\\n \\"CenName\\": \\"cen_swas\\",\\n \\"CloudFirewallVpcOrderType\\": \\"PayByCenOwner\\",\\n \\"FirewallId\\": \\"vfw-tr-99bc4f0fc88b4d00****\\",\\n \\"FirewallSwitchStatus\\": \\"opened\\",\\n \\"IpsConfig\\": {\\n \\"BasicRules\\": 1,\\n \\"EnableAllPatch\\": 1,\\n \\"RuleClass\\": 3,\\n \\"RunMode\\": 1\\n },\\n \\"OwnerId\\": 0,\\n \\"PrecheckStatus\\": \\"passed\\",\\n \\"ProtectedResource\\": {\\n \\"Count\\": 1,\\n \\"EcrList\\": [\\n \\"[\\\\n \\\\\\"ecr-d6yi3kl5qxmvkz****\\\\\\"\\\\n]\\"\\n ],\\n \\"PeerTrList\\": [\\n \\"[\\\\n \\\\\\"tr-2zegxdvs5f2je81ph****\\\\\\"\\\\n]\\"\\n ],\\n \\"VbrList\\": [\\n \\"[\\\\n \\\\\\"vbr-2zegxdvs5f2je81ph****\\\\\\"\\\\n]\\"\\n ],\\n \\"VpcList\\": [\\n \\"[\\\\\\"vpc-2zegxdvs5f2je81ph****\\\\\\"]\\"\\n ],\\n \\"VpnList\\": [\\n \\"[\\\\n \\\\\\"vpn-2zegxdvs5f2je81ph****\\\\\\"\\\\n]\\"\\n ]\\n },\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"RegionStatus\\": \\"enable\\",\\n \\"ResultCode\\": \\" RegionDisable\\",\\n \\"RouteMode\\": \\"managed\\",\\n \\"TransitRouterId\\": \\"tr-2vcmhjs88nil55fvu****\\",\\n \\"UnprotectedResource\\": {\\n \\"Count\\": 1,\\n \\"EcrList\\": [\\n \\"[\\\\n \\\\\\"ecr-d6yi3kl5qxmvkz****\\\\\\"\\\\n]\\"\\n ],\\n \\"PeerTrList\\": [\\n \\"[\\\\n \\\\\\"tr-2zegxdvs5f2je81ph****\\\\\\"\\\\n]\\"\\n ],\\n \\"VbrList\\": [\\n \\"[\\\\n \\\\\\"vbr-2zegxdvs5f2je81ph****\\\\\\"\\\\n]\\"\\n ],\\n \\"VpcList\\": [\\n \\"[\\\\n \\\\\\"vpc-2zegxdvs5f2je81ph****\\\\\\"\\\\n]\\"\\n ],\\n \\"VpnList\\": [\\n \\"[\\\\n \\\\\\"vpn-2zegxdvs5f2je81ph****\\\\\\"\\\\n]\\"\\n ]\\n },\\n \\"VpcFirewallName\\": \\"VPC边界防火墙\\",\\n \\"AclConfig\\": {\\n \\"StrictMode\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeTrFirewallsV2List', + 'translator' => 'machine', + ], + 'DescribeTrFirewallsV2Detail' => [ + 'summary' => 'Queries the details of the virtual private cloud (VPC) firewalls that are created for transit routers.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142863', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-a5a6b89f46764928****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FirewallName' => [ + 'description' => 'The name of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'cloudfirewall-manual', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7E53A7FB-3EB9-5E33-8E50-B8F417D1E02B', + ], + 'FirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-tr-9c7c711abdfa4d80****', + ], + 'FirewallStatus' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* Creating'."\n" + .'* Deleting'."\n" + .'* Ready'."\n", + 'type' => 'string', + 'example' => 'Ready', + ], + 'CenId' => [ + 'description' => 'The ID of the Cloud Enterprise Network (CEN) instance.'."\n", + 'type' => 'string', + 'example' => 'cen-37nddhri7jf0d2****', + ], + 'TransitRouterId' => [ + 'description' => 'The ID of the transit router.'."\n", + 'type' => 'string', + 'example' => 'tr-wz9y8sgug8b1xb416****', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the transit router.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FirewallEniId' => [ + 'description' => 'The ID of the Elastic Network Interface (ENI) with which the VPC firewall is associated.'."\n", + 'type' => 'string', + 'example' => 'eni-uf621u00nafypeex****', + ], + 'FirewallEniVpcId' => [ + 'description' => 'The ID of the VPC to which the ENI is attached.'."\n", + 'type' => 'string', + 'example' => 'vpc-2zeppcci782zeh2bk****', + ], + 'FirewallEniVswitchId' => [ + 'description' => 'The ID of the vSwitch with which the ENI is associated.'."\n", + 'type' => 'string', + 'example' => 'vsw-uf6ptq1kl1c1d9pw9****', + ], + 'FirewallDescription' => [ + 'description' => 'The description of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'VPC Firewall', + ], + 'RouteMode' => [ + 'description' => 'The routing mode of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **managed**: automatic mode'."\n" + .'* **manual**: manual mode'."\n", + 'type' => 'string', + 'example' => 'managed', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: The VPC firewall is enabled.'."\n" + .'* **closed**: The VPC firewall is disabled.'."\n" + .'* **notconfigured**: The VPC firewall is not created.'."\n" + .'* **configured**: The VPC firewall is created but is not enabled.'."\n" + .'* **creating**: The VPC firewall is being created.'."\n" + .'* **opening**: The VPC firewall is being enabled.'."\n" + .'* **deleting**: The VPC firewall is being deleted.'."\n" + ."\n" + .'> If you do not specify this parameter, VPC firewalls in all states are queried.'."\n", + 'type' => 'string', + 'example' => 'opened', + ], + 'FirewallVpcCidr' => [ + 'description' => 'The CIDR block that is allocated to the VPC created for the VPC firewall in automatic mode.'."\n", + 'type' => 'string', + 'example' => '10.0.0.0/16', + ], + 'FirewallSubnetCidr' => [ + 'description' => 'The subnet CIDR block of the VPC in which the ENI of the firewall is stored in automatic mode.'."\n", + 'type' => 'string', + 'example' => '10.0.1.0/24', + ], + 'TrAttachmentMasterCidr' => [ + 'description' => 'The primary subnet CIDR block that the VPC uses to connect to the transit router in automatic mode.'."\n", + 'type' => 'string', + 'example' => '10.0.2.0/24', + ], + 'TrAttachmentSlaveZone' => [ + 'description' => 'In automatic mode, the backup availability zone for the subnet used to connect TR in the firewall VPC.', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'TrAttachmentSlaveCidr' => [ + 'description' => 'The secondary subnet CIDR block that the VPC uses to connect to the transit router in automatic mode.'."\n", + 'type' => 'string', + 'example' => '10.0.3.0/24', + ], + 'TrAttachmentMasterZone' => [ + 'description' => 'In automatic mode, the primary availability zone of the subnet in the firewall VPC used for connecting to TR.', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'TrAttachmentId' => [ + 'type' => 'string', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorTrFirewallNotExist', + 'errorMessage' => 'Cen TR firewall not exist', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorUnMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FirewallName\\": \\"cloudfirewall-manual\\",\\n \\"RequestId\\": \\"7E53A7FB-3EB9-5E33-8E50-B8F417D1E02B\\",\\n \\"FirewallId\\": \\"vfw-tr-9c7c711abdfa4d80****\\",\\n \\"FirewallStatus\\": \\"Ready\\",\\n \\"CenId\\": \\"cen-37nddhri7jf0d2****\\",\\n \\"TransitRouterId\\": \\"tr-wz9y8sgug8b1xb416****\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"FirewallEniId\\": \\"eni-uf621u00nafypeex****\\",\\n \\"FirewallEniVpcId\\": \\"vpc-2zeppcci782zeh2bk****\\",\\n \\"FirewallEniVswitchId\\": \\"vsw-uf6ptq1kl1c1d9pw9****\\",\\n \\"FirewallDescription\\": \\"VPC边界防火墙\\",\\n \\"RouteMode\\": \\"managed\\",\\n \\"FirewallSwitchStatus\\": \\"opened\\",\\n \\"FirewallVpcCidr\\": \\"10.0.0.0/16\\",\\n \\"FirewallSubnetCidr\\": \\"10.0.1.0/24\\",\\n \\"TrAttachmentMasterCidr\\": \\"10.0.2.0/24\\",\\n \\"TrAttachmentSlaveZone\\": \\"cn-hangzhou-i\\",\\n \\"TrAttachmentSlaveCidr\\": \\"10.0.3.0/24\\",\\n \\"TrAttachmentMasterZone\\": \\"cn-hangzhou-h\\",\\n \\"TrAttachmentId\\": \\"tr-attach-r1llaxxeha71jsm36v\\"\\n}","type":"json"}]', + 'title' => 'DescribeTrFirewallsV2Detail', + 'translator' => 'machine', + ], + 'DescribeTrFirewallsV2RouteList' => [ + 'summary' => 'Queries the route tables of the VPC firewalls that are created for transit routers.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142865', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the virtual private cloud (VPC) firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-8bcfa0f2f12d411e****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'policy-7d5c672e37ee4175****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FirewallRouteDetailList' => [ + 'description' => 'The route tables of Cloud Firewall.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TrFirewallRoutePolicyId' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'example' => 'policy-04ecbbc6720d4f90****', + ], + 'TrFirewallRouteTableId' => [ + 'description' => 'The ID of the route table to which the route entry belongs.'."\n", + 'type' => 'string', + 'example' => 'vtb-2zeockxxxorv0mnhz****', + ], + 'TrFirewallRouteDestination' => [ + 'description' => 'The destination address of the route.'."\n", + 'type' => 'string', + 'example' => '192.168.10.0/25', + ], + 'TrFirewallRouteNexthop' => [ + 'description' => 'The ID of the next hop for the route.'."\n", + 'type' => 'string', + 'example' => 'tr-attach-hnxab1y0pxn16p****', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ABF190A2-B4D0-53F6-995A-5690A721F91C', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorTrFirewallPolicyNotFound', + 'errorMessage' => 'TR firewall policy does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FirewallRouteDetailList\\": [\\n {\\n \\"TrFirewallRoutePolicyId\\": \\"policy-04ecbbc6720d4f90****\\",\\n \\"TrFirewallRouteTableId\\": \\"vtb-2zeockxxxorv0mnhz****\\",\\n \\"TrFirewallRouteDestination\\": \\"192.168.10.0/25\\",\\n \\"TrFirewallRouteNexthop\\": \\"tr-attach-hnxab1y0pxn16p****\\"\\n }\\n ],\\n \\"RequestId\\": \\"ABF190A2-B4D0-53F6-995A-5690A721F91C\\"\\n}","type":"json"}]', + 'title' => 'DescribeTrFirewallsV2RouteList', + ], + 'DescribeTrFirewallV2RoutePolicyList' => [ + 'summary' => 'Queries the routing policies of a virtual private cloud (VPC) firewall that is created for a transit router.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142849', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-d5ba592ac6c84aff****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'policy-7b66257c14e141fb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TrFirewallRoutePolicies' => [ + 'description' => 'The routing policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PolicyType' => [ + 'description' => 'The type of the traffic redirection scenario of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **fullmesh**: interconnected instances'."\n" + .'* **one_to_one**: instance to instance'."\n" + .'* **end_to_end**: instance to instances'."\n", + 'type' => 'string', + 'example' => 'fullmesh', + ], + 'PolicyName' => [ + 'description' => 'The name of the routing policy.'."\n", + 'type' => 'string', + 'example' => 'TEST_VPC_FW', + ], + 'PolicyDescription' => [ + 'description' => 'The description of the routing policy.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SrcCandidateList' => [ + 'description' => 'The primary traffic redirection instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => 'The ID of the primary traffic redirection instance.'."\n", + 'type' => 'string', + 'example' => 'vpc-2ze9epancaw8t4sha****', + ], + 'CandidateType' => [ + 'description' => 'The type of the primary traffic redirection instance.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + ], + ], + ], + 'DestCandidateList' => [ + 'description' => 'The secondary traffic redirection instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => 'The ID of the secondary traffic redirection instance.'."\n", + 'type' => 'string', + 'example' => 'vpc-2ze9epancaw8t4sha****', + ], + 'CandidateType' => [ + 'description' => 'The type of the secondary traffic redirection instance.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + ], + ], + ], + 'TrFirewallRoutePolicyId' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'example' => 'policy-7b66257c14e141fb****', + ], + 'PolicyStatus' => [ + 'description' => 'The status of the routing policy. Valid values:'."\n" + ."\n" + .'* creating: The policy is being created.'."\n" + .'* deleting: The policy is being deleted.'."\n" + .'* opening: The policy is being enabled.'."\n" + .'* opened: The policy is enabled.'."\n" + .'* closing: The policy is being disabled.'."\n" + .'* closed: The policy is disabled.'."\n", + 'type' => 'string', + 'example' => 'opened', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '95EB5F3A-67FE-5780-92BD-5ECBA772AB7E', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorTrFirewallNotExist', + 'errorMessage' => 'Cen TR firewall not exist', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrFirewallRoutePolicies\\": [\\n {\\n \\"PolicyType\\": \\"fullmesh\\",\\n \\"PolicyName\\": \\"新加坡点到多点\\",\\n \\"PolicyDescription\\": \\"点到多点\\",\\n \\"SrcCandidateList\\": [\\n {\\n \\"CandidateId\\": \\"vpc-2ze9epancaw8t4sha****\\",\\n \\"CandidateType\\": \\"VPC\\"\\n }\\n ],\\n \\"DestCandidateList\\": [\\n {\\n \\"CandidateId\\": \\"vpc-2ze9epancaw8t4sha****\\",\\n \\"CandidateType\\": \\"VPC\\"\\n }\\n ],\\n \\"TrFirewallRoutePolicyId\\": \\"policy-7b66257c14e141fb****\\",\\n \\"PolicyStatus\\": \\"opened\\"\\n }\\n ],\\n \\"RequestId\\": \\"95EB5F3A-67FE-5780-92BD-5ECBA772AB7E\\",\\n \\"TotalCount\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'DescribeTrFirewallV2RoutePolicyList', + ], + 'DescribeTrFirewallPolicyBackUpAssociationList' => [ + 'summary' => 'Queries information about the transit routers that are associated with a virtual private cloud (VPC) firewall created for a transit router.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '150101', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-8b268ce1b26e4c68****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'policy-5dcafb12ff794a56****', + ], + ], + [ + 'name' => 'CandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The traffic redirection instances.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => 'The ID of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9grb8ng3y7h7lf2****'."\n", + ], + 'CandidateType' => [ + 'description' => 'The type of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyAssociationBackupConfigs' => [ + 'description' => 'The route tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CandidateType' => [ + 'description' => 'The type of the traffic redirection instance.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'CandidateId' => [ + 'description' => 'The ID of the traffic redirection instance.'."\n", + 'type' => 'string', + 'example' => 'vpc-wz9grb8ng3y7h7lf2****', + ], + 'OriginalRouteTableId' => [ + 'description' => 'The ID of the route table.'."\n", + 'type' => 'string', + 'example' => 'vtb-wz9slp3s7m4qrzvnq****', + ], + 'CurrentRouteTableId' => [ + 'description' => 'The route table that is used after traffic redirection.'."\n", + 'type' => 'string', + 'example' => 'vtb-wz9898grickmh5j09****', + ], + 'CandidateName' => [ + 'description' => 'The name of the traffic redirection instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C264A756-9B48-57E3-B312-716941E146C6', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorTrFwBackUpAssocationNotExist', + 'errorMessage' => 'Tr firewall back up association not Exist.', + ], + [ + 'errorCode' => 'ErrorTrFirewallPolicyNotFound', + 'errorMessage' => 'TR firewall policy does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyAssociationBackupConfigs\\": [\\n {\\n \\"CandidateType\\": \\"VPC\\",\\n \\"CandidateId\\": \\"vpc-wz9grb8ng3y7h7lf2****\\",\\n \\"OriginalRouteTableId\\": \\"vtb-wz9slp3s7m4qrzvnq****\\",\\n \\"CurrentRouteTableId\\": \\"vtb-wz9898grickmh5j09****\\",\\n \\"CandidateName\\": \\"VPC引流实例\\"\\n }\\n ],\\n \\"RequestId\\": \\"C264A756-9B48-57E3-B312-716941E146C6\\"\\n}","type":"json"}]', + 'title' => 'DescribeTrFirewallPolicyBackUpAssociationList', + ], + 'DescribeTransitRouterResourcesList' => [ + 'summary' => '获取TR交换机资源列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '143494', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-djz1i6p8shzioz****', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-2zefgvkcl2qcexbb7****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-741de4c8956341****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VBR' => 'VBR', + 'VPC' => 'VPC', + 'TR' => 'TR', + 'CCN' => 'CCN', + ], + 'example' => 'TR', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9lllsbftdm0svpj****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A61A2516-0A22-5B3F-986B-3D4BF2A****', + ], + 'TransitRouterAttachedResources' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'eas-r-8k1a6jjofkp0cq****', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VPC', + ], + 'ResourceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorVswitchNotFound', + 'errorMessage' => 'vswitch not found', + ], + [ + 'errorCode' => 'ErrorTrResourceNotReady', + 'errorMessage' => 'Transit Router has not been detected by cloud firewall', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUidStatus', + 'errorMessage' => 'invalid member uid status.', + ], + [ + 'errorCode' => 'ErrorAssetSynchronizationNotCompleted', + 'errorMessage' => 'VPC firewall asset synchronization is not completed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A61A2516-0A22-5B3F-986B-3D4BF2A****\\",\\n \\"TransitRouterAttachedResources\\": [\\n {\\n \\"ResourceId\\": \\"eas-r-8k1a6jjofkp0cq****\\",\\n \\"ResourceType\\": \\"VPC\\",\\n \\"ResourceName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateTrFirewallV2' => [ + 'summary' => 'Creates a virtual private cloud (VPC) firewall for a transit router.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142851', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_test2', + ], + ], + [ + 'name' => 'RouteMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The routing mode of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **managed**: automatic mode'."\n" + .'* **manual**: manual mode'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'managed', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the transit router.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tr-m5etmb2q7e0mxcur****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the route router.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FirewallVpcCidr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR block that is allocated to the VPC created for the VPC firewall in automatic mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.0/16', + ], + ], + [ + 'name' => 'FirewallSubnetCidr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subnet CIDR block of the VPC in which the ENI of the firewall is stored in automatic mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.0.1.0/24', + ], + ], + [ + 'name' => 'TrAttachmentSlaveCidr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The secondary subnet CIDR block that the VPC uses to connect to the transit router in automatic mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.16/28', + ], + ], + [ + 'name' => 'TrAttachmentMasterCidr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The primary subnet CIDR block that the VPC uses to connect to the transit router in automatic mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.0.3.0/24', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Cloud Enterprise Network (CEN) instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cen-4xbjup276au29r****', + ], + ], + [ + 'name' => 'FirewallDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-sz', + ], + ], + [ + 'name' => 'FirewallVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC in which the ENI associated with the VPC firewall is created in manual mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9r5qvryn0lg3atb****', + ], + ], + [ + 'name' => 'FirewallVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch that is used to create the ENI in manual mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6ydz3vqj77mr5l6****', + ], + ], + [ + 'name' => 'TrAttachmentSlaveZone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The secondary zone for the vSwitch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-chengdu-b', + ], + ], + [ + 'name' => 'TrAttachmentMasterZone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The primary zone for the vSwitch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-chengdu-a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-tr-37e22bf0d9b34870****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '822B9125-6E1A-551C-8EAF-6E7AE7444B00', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorTrResourceNotReady', + 'errorMessage' => 'Transit Router has not been detected by cloud firewall', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorUserCenTrNotEnabled', + 'errorMessage' => 'This account has not enabled CEN Transit Router Enterprise Edition Cloud Firewal. Please contact Cloud Firewall Support team.', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorCenTRAssociationNotFound', + 'errorMessage' => 'CEN-TR attachment association not found.', + ], + [ + 'errorCode' => 'ErrorUserNotFound', + 'errorMessage' => 'User not found', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorCenNotSupportTREnterpriseAutoMode', + 'errorMessage' => 'VPC firewall does not support TR Enterprise Edition auto mode protection, please use manual mode protection', + ], + [ + 'errorCode' => 'ErrorVpcFirewallExist', + 'errorMessage' => 'Vpc firewall already exist.', + ], + [ + 'errorCode' => 'ErrorInvalidTrFirewallType', + 'errorMessage' => 'Firewall type is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcDoNotSupportSubnetRouting', + 'errorMessage' => 'The VPC for which the firewall is created does not support subnet routing. Create a custom route table for the VPC to enable subnet routing first.', + ], + [ + 'errorCode' => 'ErrorVpcAndTrNotInTheSameAccount', + 'errorMessage' => 'Vpc and transit router should in the account when create cloud firewall manual mode.', + ], + [ + 'errorCode' => 'ErrorCidrFormat', + 'errorMessage' => 'Network segment CIDR format error, please select again', + ], + [ + 'errorCode' => 'ErrorVswitchCidrIpNumNotEnough', + 'errorMessage' => 'No enough private proxy IP in vswitch cidr.', + ], + [ + 'errorCode' => 'ErrorTrFwVswCidrConflict', + 'errorMessage' => 'Illegal tr firewall cidr configuration.', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallZoneId', + 'errorMessage' => 'VPC firewall zone error.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUidStatus', + 'errorMessage' => 'invalid member uid status.', + ], + [ + 'errorCode' => 'ErrorGeneralInstanceSpecFull', + 'errorMessage' => 'Cloud Firewall instance specifications are full.', + ], + [ + 'errorCode' => 'ErrorBandwidthPenalty', + 'errorMessage' => 'Cloud Firewall bandwidth is being overused.', + ], + [ + 'errorCode' => 'ErrorFirewallQuotaNotEmpty', + 'errorMessage' => 'The quota for VPC firewalls is exceeded.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FirewallId\\": \\"vfw-tr-37e22bf0d9b34870****\\",\\n \\"RequestId\\": \\"822B9125-6E1A-551C-8EAF-6E7AE7444B00\\"\\n}","type":"json"}]', + 'title' => 'CreateTrFirewallV2', + ], + 'CreateTrFirewallV2RoutePolicy' => [ + 'summary' => 'Creates a routing policy for a VPC firewall of a transit router.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142852', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the traffic redirection scenario of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **fullmesh**: interconnected instances'."\n" + .'* **one_to_one**: instance to instance'."\n" + .'* **end_to_end**: instance to instances'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fullmesh', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TEST_VPC_FW'."\n", + ], + ], + [ + 'name' => 'PolicyDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test'."\n", + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-f8ce36689b224f77****', + ], + ], + [ + 'name' => 'SrcCandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The primary traffic redirection instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => 'The ID of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze9epancaw8t4sha****', + ], + 'CandidateType' => [ + 'description' => 'The type of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DestCandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The secondary traffic redirection instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => 'The ID of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze9epancaw8t4sha****', + ], + 'CandidateType' => [ + 'description' => 'The type of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TrFirewallRoutePolicyId' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'example' => 'policy-8ebed27e13e14ce2****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C91D68BA-A0BE-51BF-A0F1-1CB5C57FE58D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorPolicySrcAndDestConflict', + 'errorMessage' => 'Policy has same destination candidate as source candidtes.', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorTrFirewallEndToEndTrToAll', + 'errorMessage' => 'Parameter error, point-to-multipoint scenario, TR instance does not support configuration ALL.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorCandidateNoRouteTable', + 'errorMessage' => 'Please attach candidate with transit router before create routing template.', + ], + [ + 'errorCode' => 'ErrorTrFirewallRouteMapConflict', + 'errorMessage' => 'Cen TR firewall route table has route map conflict.', + ], + [ + 'errorCode' => 'ErrorTrFirewallCenManegedRouteMapConflict', + 'errorMessage' => 'Cen TR firewall route table has cen managed route map conflict.', + ], + [ + 'errorCode' => 'ErrorCandidateHasStaticRoute', + 'errorMessage' => 'Tr firewall don\'t support candidate which associated with transit router route table contains custom route. Please retry after deleted the route.', + ], + [ + 'errorCode' => 'ErrorFirewallUpdating', + 'errorMessage' => 'Can not modify firewall, firewall is updating. Please check if there is a routing policy updating.', + ], + [ + 'errorCode' => 'ErrorDuplicateTrFwPolicyName', + 'errorMessage' => 'Duplicate firewall policy Name.', + ], + [ + 'errorCode' => 'ErrorCandidateAlreadyInToALlPolicy', + 'errorMessage' => 'Candidate already in to aLl policy.', + ], + [ + 'errorCode' => 'ErrorFirewallCandidateReference', + 'errorMessage' => 'Firewall Candidate referrence count greater than one.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorTrFirewallOnlyContainsEcrAndTrCandidate', + 'errorMessage' => 'TR firewall cannot only contain both ECR and TR.', + ], + [ + 'errorCode' => 'ErrorTrFirewallDoNotSupportPrefixList', + 'errorMessage' => 'Cen TR firewall do not support prefix list.', + ], + [ + 'errorCode' => 'ErrorTrFirewallEcmpRoute', + 'errorMessage' => 'Cen TR ecmp next hop must add to route policy at the same time.', + ], + [ + 'errorCode' => 'ErrorTrFirewallNotExist', + 'errorMessage' => 'Cen TR firewall not exist', + ], + [ + 'errorCode' => 'ErrorCrossRegionCloudServiceStaticRoute', + 'errorMessage' => 'The CEN-TR routing table contains cross-region cloud service static routes. Please delete them and try again.', + ], + [ + 'errorCode' => 'ErrorTrRouteTableContainsRejectRoutes', + 'errorMessage' => 'There are routes conflict in transit router route table. Please resolve route conflict before create route policy.', + ], + [ + 'errorCode' => 'ErrorCandidateHasIPv6Route', + 'errorMessage' => 'Cloud Enterprise Network TR enterprise firewall don\'t support ipv6 route.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrFirewallRoutePolicyId\\": \\"policy-8ebed27e13e14ce2****\\",\\n \\"RequestId\\": \\"C91D68BA-A0BE-51BF-A0F1-1CB5C57FE58D\\"\\n}","type":"json"}]', + 'title' => 'CreateTrFirewallV2RoutePolicy', + ], + 'ModifyTrFirewallV2Configuration' => [ + 'summary' => 'Modifies the configuration of a virtual private cloud (VPC) firewall that is created for a transit router.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '143829', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-bcdf89d405ce4bd2****', + ], + ], + [ + 'name' => 'FirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test instance'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A74C8FDD-2BEF-52D5-8B01-EB6FD94606F9', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorTrFirewallNotExist', + 'errorMessage' => 'Cen TR firewall not exist.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorVpcFirewallExist', + 'errorMessage' => 'Vpc firewall already exist.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A74C8FDD-2BEF-52D5-8B01-EB6FD94606F9\\"\\n}","type":"json"}]', + 'title' => 'ModifyTrFirewallV2Configuration', + ], + 'ModifyFirewallV2RoutePolicySwitch' => [ + 'summary' => 'Modifies the status of a routing policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142877', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the virtual private cloud (VPC) firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-5b202e7f0be64611****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'policy-93684cc5caa44b2e****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicySwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the routing policy. Valid values:'."\n" + ."\n" + .'* open: enabled'."\n" + .'* close: disabled'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'ShouldRecover', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to restore the traffic redirection configurations. Valid values:'."\n" + ."\n" + .'* true: roll back'."\n" + .'* false: withdraw'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1F6D4A8D-EC01-5996-A61A-AA3B56490C00', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorIllegalRoutePolicyStatusUpdate', + 'errorMessage' => 'Can not update policy status.', + ], + [ + 'errorCode' => 'ErrorFirewallUpdating', + 'errorMessage' => 'Can not modify firewall, firewall is updating. Please check if there is a routing policy updating.', + ], + [ + 'errorCode' => 'ErrorTrFwBackUpAssocationNotExist', + 'errorMessage' => 'Tr firewall back up association not Exist.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorTrFirewallPolicyNotFound', + 'errorMessage' => 'TR firewall policy does not exist.', + ], + [ + 'errorCode' => 'ErrorBandwidthPenalty', + 'errorMessage' => 'Cloud Firewall bandwidth is being overused.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F6D4A8D-EC01-5996-A61A-AA3B56490C00\\"\\n}","type":"json"}]', + 'title' => 'ModifyFirewallV2RoutePolicySwitch', + ], + 'ModifyTrFirewallV2RoutePolicyScope' => [ + 'summary' => 'Modifies the effective scope of the routing policy created for the VPC firewall for a transit router.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142854', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'policy-4d724d0139df48f18091', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the virtual private cloud (VPC) firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-tr-6520de0253bc4669bbd9', + ], + ], + [ + 'name' => 'SrcCandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The primary traffic redirection instances.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => 'The ID of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze9epancaw8t4shajuzi'."\n", + ], + 'CandidateType' => [ + 'description' => 'The type of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VPC'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DestCandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The secondary traffic redirection instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => 'The ID of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze9epancaw8t4shajuzi'."\n", + ], + 'CandidateType' => [ + 'description' => 'The type of the traffic redirection instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ShouldRecover', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to restore the traffic redirection configurations. Valid values:'."\n" + ."\n" + .'* true: roll back'."\n" + .'* false: withdraw'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TrFirewallRoutePolicyId' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'example' => 'policy-4d724d0139df48f18091', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E7D4D635-0C70-5CEB-A609-851E94D51FBB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorPolicySrcAndDestConflict', + 'errorMessage' => 'Policy has same destination candidate as source candidtes.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorTrFirewallEndToEndTrToAll', + 'errorMessage' => 'Parameter error, point-to-multipoint scenario, TR instance does not support configuration ALL.', + ], + [ + 'errorCode' => 'ErrorCannotEditRoutePolicyWhenClose', + 'errorMessage' => 'Can not edit route policy when policy closed.', + ], + [ + 'errorCode' => 'ErrorFirewallUpdating', + 'errorMessage' => 'Can not modify firewall, firewall is updating. Please check if there is a routing policy updating.', + ], + [ + 'errorCode' => 'ErrorIllegalRoutePolicyScopeUpdate', + 'errorMessage' => 'Can not update policy scope.', + ], + [ + 'errorCode' => 'ErrorCannotEditToAllPolicy', + 'errorMessage' => 'Can not modify policy scope for policy contains All type candidate.', + ], + [ + 'errorCode' => 'ErrorCandidateNoRouteTable', + 'errorMessage' => 'Please attach candidate with transit router before create routing template.', + ], + [ + 'errorCode' => 'ErrorTrFirewallRouteMapConflict', + 'errorMessage' => 'Cen TR firewall route table has route map conflict.', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorTrFirewallDoNotSupportPrefixList', + 'errorMessage' => 'Cen TR firewall do not support prefix list.', + ], + [ + 'errorCode' => 'ErrorCandidateHasStaticRoute', + 'errorMessage' => 'Tr firewall don\'t support candidate which associated with transit router route table contains custom route. Please retry after deleted the route.', + ], + [ + 'errorCode' => 'ErrorTrRouteTableContainsRejectRoutes', + 'errorMessage' => 'There are routes conflict in transit router route table.Please resolve route conflict before create route policy.', + ], + [ + 'errorCode' => 'ErrorTrFwVswCidrConflict', + 'errorMessage' => 'Illegal tr firewall cidr configuration.', + ], + [ + 'errorCode' => 'ErrorFirewallCandidateReference', + 'errorMessage' => 'Firewall Candidate referrence count greater than one.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorTrFirewallOnlyContainsEcrAndTrCandidate', + 'errorMessage' => 'TR firewall cannot only contain both ECR and TR.', + ], + [ + 'errorCode' => 'ErrorTrFirewallPolicyNotFound', + 'errorMessage' => 'TR firewall policy does not exist.', + ], + [ + 'errorCode' => 'ErrorTrFirewallEcmpRoute', + 'errorMessage' => 'Cen TR ecmp next hop must add to route policy at the same time.', + ], + [ + 'errorCode' => 'ErrorTrFirewallCenManegedRouteMapConflict', + 'errorMessage' => 'Cen TR firewall route table has cen managed route map conflict.', + ], + [ + 'errorCode' => 'ErrorCandidateHasIPv6Route', + 'errorMessage' => 'Cloud Enterprise Network TR enterprise firewall don\'t support ipv6 route.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrFirewallRoutePolicyId\\": \\"policy-4d724d0139df48f1****\\",\\n \\"RequestId\\": \\"E7D4D635-0C70-5CEB-A609-851E94D51FBB\\"\\n}","type":"json"}]', + 'title' => 'ModifyTrFirewallV2RoutePolicyScope', + ], + 'DeleteTrFirewallV2' => [ + 'summary' => 'Deletes a virtual private cloud (VPC) firewall that is created for a transit router.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142850', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-99bc4f0fc88b4d00****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A774E66E-B170-59FC-9AAF-3068B15E991F', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorTrFirewallNotExist', + 'errorMessage' => 'Cen TR firewall not exist', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorTrFirewallNotEmpty', + 'errorMessage' => 'Can not delete firewall since firewall still attached to a firewall policy.', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorCenTRAssociationNotFound', + 'errorMessage' => 'CEN-TR attachment association not found.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorTrFirewallRouteTableInUse', + 'errorMessage' => 'Can not delete firewall. There\'s a firewall route table still associate with network instance.', + ], + [ + 'errorCode' => 'ErrorIllegalFwStatusUpdate', + 'errorMessage' => 'Can not set firewall status.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A774E66E-B170-59FC-9AAF-3068B15E991F\\"\\n}","type":"json"}]', + 'title' => 'DeleteTrFirewallV2', + ], + 'DeleteFirewallV2RoutePolicies' => [ + 'summary' => 'Deletes routing policies for a virtual private cloud (VPC) firewall of a transit router.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142855', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-d5ba592ac6c84aff****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the routing policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'policy-2d06d3568fd74d60****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '22B6B889-4E9F-56B3-AF3D-53749C477D1D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'authentication error', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorFirewallUpdating', + 'errorMessage' => 'Can not modify firewall, firewall is updating. Please check if there is a routing policy updating.', + ], + [ + 'errorCode' => 'ErrorIllegalRoutePolicyStatusUpdate', + 'errorMessage' => 'Can not update policy status.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorTrFwBackUpAssocationNotExist', + 'errorMessage' => 'Tr firewall back up association not Exist.', + ], + [ + 'errorCode' => 'ErrorTrFirewallPolicyNotFound', + 'errorMessage' => 'TR firewall policy does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22B6B889-4E9F-56B3-AF3D-53749C477D1D\\"\\n}","type":"json"}]', + 'title' => 'DeleteFirewallV2RoutePolicies', + ], + 'DescribeVpcFirewallCenSummaryList' => [ + 'summary' => '获取VPC的CEN列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68416', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'TransitRouterType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '432D6CCA-5186-5B91-A2B8-10C8994B****', + ], + 'CenList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CenName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'CenId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cen-maqfw3abcmjy56****', + ], + 'RegionNoList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' "cn-hangzhou",'."\n" + .' "cn-beijing"'."\n" + .']', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5,\\n \\"RequestId\\": \\"432D6CCA-5186-5B91-A2B8-10C8994B****\\",\\n \\"CenList\\": [\\n {\\n \\"CenName\\": \\"test\\",\\n \\"CenId\\": \\"cen-maqfw3abcmjy56****\\",\\n \\"RegionNoList\\": [\\n \\"[\\\\n \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"cn-beijing\\\\\\"\\\\n]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallCenList' => [ + 'summary' => 'Queries virtual private cloud (VPC) firewalls. Each VPC firewall protects mutual access traffic between a specified VPC and a network instance that is attached to a Cloud Enterprise Network (CEN) instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68415', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the VPC.'."\n" + ."\n" + .'> For more information about the regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the network instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'FirewallSwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: The VPC firewall is enabled.'."\n" + .'* **closed**: The VPC firewall is disabled.'."\n" + .'* **notconfigured**: The VPC firewall is not configured.'."\n" + .'* **configured**: The VPC firewall is configured but is not enabled.'."\n" + ."\n" + .'> If you do not specify this parameter, VPC firewalls in all states are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'opened', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test firewall'."\n", + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the CEN instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cen-x5jayxou71ad73****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 10. Maximum value: 50.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RouteMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The routing mode of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **auto**: automatic mode'."\n" + .'* **manual**: manual mode'."\n" + ."\n" + .'> If you do not specify this parameter, VPC firewalls in all routing modes are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'auto', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account. The member is also an Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'TransitRouterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the transit router. Valid values:'."\n" + ."\n" + .'* **Basic**: Basic Edition transit router'."\n" + .'* **Enterprise**: Enterprise Edition transit router'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of VPC firewalls.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k8g2', + ], + 'VpcFirewalls' => [ + 'description' => 'The information about the VPC firewalls.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => 'The connection type of the VPC firewall. The value is fixed as cen, which indicates a CEN instance.'."\n", + 'type' => 'string', + 'example' => 'cen', + ], + 'VpcFirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RegionStatus' => [ + 'description' => 'Indicates whether you can create a VPC firewall in a specified region. Valid values:'."\n" + ."\n" + .'* **enable**: yes'."\n" + .'* **disable**: no'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'CenId' => [ + 'description' => 'The ID of the CEN instance.'."\n", + 'type' => 'string', + 'example' => 'cen-x5jayxou71ad73****', + ], + 'VpcFirewallName' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'Test firewall'."\n", + ], + 'ResultCode' => [ + 'description' => 'The result code of the operation that creates the VPC firewall. Valid values:'."\n" + ."\n" + .'* **Unauthorized**: Cloud Firewall is not authorized to access the VPC for which the VPC firewall is created, and the VPC firewall cannot be created.'."\n" + .'* **RegionDisable**: VPC Firewall is not supported in the region of the VPC for which the VPC firewall is created, and the VPC firewall cannot be created.'."\n" + .'* **OpsDisable**: You are not allowed to create the VPC firewall.'."\n" + .'* **VbrNotSupport**: The VPC firewall cannot be created for a VBR that is attached to the CEN instance.'."\n" + .'* Empty string: You can create a VPC firewall for the network instance.'."\n", + 'type' => 'string', + 'example' => 'Unauthorized', + ], + 'CenName' => [ + 'description' => 'The name of the CEN instance.'."\n", + 'type' => 'string', + 'example' => 'Test CEN instance'."\n", + ], + 'FirewallSwitchStatus' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: The VPC firewall is enabled.'."\n" + .'* **closed**: The VPC firewall is disabled.'."\n" + .'* **notconfigured**: The VPC firewall is not configured.'."\n", + 'type' => 'string', + 'example' => 'opened', + ], + 'LocalVpc' => [ + 'description' => 'The details about the VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'TransitRouterType' => [ + 'description' => 'The edition of the CEN transit router. Valid values:'."\n" + ."\n" + .'* **Basic**: Basic Edition transit router'."\n" + .'* **Enterprise**: Enterprise Edition transit router'."\n", + 'type' => 'string', + 'example' => 'Basic', + ], + 'NetworkInstanceId' => [ + 'description' => 'The ID of the network instance.'."\n", + 'type' => 'string', + 'example' => 'vpc-2zefk9fbn8j7v585g****', + ], + 'RouteMode' => [ + 'description' => 'The routing mode of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **auto**: automatic mode'."\n" + .'* **manual**: manual mode'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AuthorizationStatus' => [ + 'description' => 'Indicates whether the VPC is granted the required permissions. The value is fixed as **authorized**, which indicates that the VPC is granted the required permissions.'."\n", + 'type' => 'string', + 'example' => 'authorized', + ], + 'ManualVSwitchId' => [ + 'description' => 'The ID of the specified vSwitch when the routing mode is manual.'."\n", + 'type' => 'string', + 'example' => 'vsw-zeq4o875u****', + ], + 'OwnerId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the VPC belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158039427902****', + ], + 'NetworkInstanceType' => [ + 'description' => 'The type of the network instance. Valid values:'."\n" + ."\n" + .'* **VPC**'."\n" + .'* **VBR**'."\n" + .'* **CCN**'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'VpcName' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'Test instance'."\n", + ], + 'SupportManualMode' => [ + 'description' => 'Indicates whether the manual routing mode is supported. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'NetworkInstanceName' => [ + 'description' => 'The name of the network instance.'."\n", + 'type' => 'string', + 'example' => 'Test VPC'."\n", + ], + 'VpcCidrTableList' => [ + 'description' => 'An array that consists of the CIDR blocks of the VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block of the VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'The route table ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vtb-1234', + ], + 'RouteEntryList' => [ + 'description' => 'An array that consists of the route entries for the VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The route entry for the VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => 'The instance ID of the next hop for the VPC.'."\n", + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => 'The destination CIDR block of the VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + 'DefendCidrList' => [ + 'description' => 'An array consisting of the CIDR blocks that are protected by the VPC firewall.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block that is protected by the VPC firewall.'."\n", + 'type' => 'string', + 'example' => '10.0.XX.XX/24', + ], + ], + ], + ], + 'IpsConfig' => [ + 'description' => 'The intrusion prevention system (IPS) configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'BasicRules' => [ + 'description' => 'Indicates whether basic protection is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableAllPatch' => [ + 'description' => 'Indicates whether virtual patching is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RunMode' => [ + 'description' => 'The mode of the IPS. Valid values:'."\n" + ."\n" + .'* **1**: block mode'."\n" + .'* **0**: monitor mode'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleClass' => [ + 'description' => 'The level of the rule group for the IPS. Valid values:'."\n" + ."\n" + .'* **1**: loose.'."\n" + .'* **2**: medium.'."\n" + .'* **3**: strict.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'MemberUid' => [ + 'description' => 'The UID of the member that is manged by your Alibaba Cloud account. The member is also an Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '258039427902****', + ], + 'PrecheckStatus' => [ + 'description' => 'Indicates whether the VPC firewall can be automatically enabled to protect VPC traffic based on route learning. Valid values:'."\n" + ."\n" + .'* **passed**: The VPC firewall can be automatically enabled.'."\n" + .'* **failed**: The VPC firewall cannot be automatically enabled.'."\n" + .'* **unknown**: The VPC firewall is in an unknown state.'."\n", + 'type' => 'string', + 'example' => 'failed', + ], + 'AclConfig' => [ + 'description' => 'ACL engine mode.', + 'type' => 'object', + 'properties' => [ + 'StrictMode' => [ + 'description' => 'Specifies whether to enable the strict mode. Valid values:'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorUserNotFound', + 'errorMessage' => 'User not found', + ], + [ + 'errorCode' => 'ErrorFirewallStatus', + 'errorMessage' => 'firewall status error.', + ], + [ + 'errorCode' => 'ErrorOwnerId', + 'errorMessage' => 'owner id invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125k8g2\\",\\n \\"VpcFirewalls\\": [\\n {\\n \\"ConnectType\\": \\"cen\\",\\n \\"VpcFirewallId\\": \\"vfw-m5e7dbc4y****\\",\\n \\"RegionStatus\\": \\"enable\\",\\n \\"CenId\\": \\"cen-x5jayxou71ad73****\\",\\n \\"VpcFirewallName\\": \\"测试防火墙\\",\\n \\"ResultCode\\": \\"Unauthorized\\",\\n \\"CenName\\": \\"测试云企业网\\",\\n \\"FirewallSwitchStatus\\": \\"opened\\",\\n \\"LocalVpc\\": {\\n \\"VpcId\\": \\"vpc-8vbwbo90rq0anm6t****\\",\\n \\"TransitRouterType\\": \\"Basic\\",\\n \\"NetworkInstanceId\\": \\"vpc-2zefk9fbn8j7v585g****\\",\\n \\"RouteMode\\": \\"auto\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"AuthorizationStatus\\": \\"authorized\\",\\n \\"ManualVSwitchId\\": \\"vsw-zeq4o875u****\\",\\n \\"OwnerId\\": 0,\\n \\"NetworkInstanceType\\": \\"VPC\\",\\n \\"VpcName\\": \\"测试用实例\\",\\n \\"SupportManualMode\\": \\"0\\",\\n \\"NetworkInstanceName\\": \\"测试业务VPC\\",\\n \\"VpcCidrTableList\\": [\\n {\\n \\"RouteTableId\\": \\"vtb-1234\\",\\n \\"RouteEntryList\\": [\\n {\\n \\"NextHopInstanceId\\": \\"vrt-m5eb5me6c3l5sezae****\\",\\n \\"DestinationCidr\\": \\"192.168.XX.XX/24\\"\\n }\\n ]\\n }\\n ],\\n \\"DefendCidrList\\": [\\n \\"10.0.XX.XX/24\\"\\n ]\\n },\\n \\"IpsConfig\\": {\\n \\"BasicRules\\": 1,\\n \\"EnableAllPatch\\": 1,\\n \\"RunMode\\": 0,\\n \\"RuleClass\\": 1\\n },\\n \\"MemberUid\\": \\"258039427902****\\",\\n \\"PrecheckStatus\\": \\"failed\\",\\n \\"AclConfig\\": {\\n \\"StrictMode\\": 1\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcFirewallCenListResponse>\\n <TotalCount>10</TotalCount>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125k8g2</RequestId>\\n <VpcFirewalls>\\n <ConnectType>cen</ConnectType>\\n <VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>\\n <RegionStatus>enable</RegionStatus>\\n <CenId>cen-x5jayxou71ad73****</CenId>\\n <VpcFirewallName>测试防火墙</VpcFirewallName>\\n <ResultCode>Unauthorized</ResultCode>\\n <CenName>测试云企业网</CenName>\\n <FirewallSwitchStatus>opened</FirewallSwitchStatus>\\n <LocalVpc>\\n <VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>\\n <TransitRouterType>Basic</TransitRouterType>\\n <NetworkInstanceId>vpc-2zefk9fbn8j7v585g****</NetworkInstanceId>\\n <RouteMode>auto</RouteMode>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <AuthorizationStatus>authorized</AuthorizationStatus>\\n <ManualVSwitchId>vsw-zeq4o875u****</ManualVSwitchId>\\n <NetworkInstanceType>VPC</NetworkInstanceType>\\n <VpcName>测试用实例</VpcName>\\n <SupportManualMode>0</SupportManualMode>\\n <NetworkInstanceName>测试业务VPC</NetworkInstanceName>\\n <VpcCidrTableList>\\n <RouteTableId>vtb-1234</RouteTableId>\\n <RouteEntryList>\\n <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>\\n <DestinationCidr>192.168.XX.XX/24</DestinationCidr>\\n </RouteEntryList>\\n </VpcCidrTableList>\\n <DefendCidrList>10.0.XX.XX/24</DefendCidrList>\\n </LocalVpc>\\n <IpsConfig>\\n <BasicRules>1</BasicRules>\\n <EnableAllPatch>1</EnableAllPatch>\\n <RunMode>0</RunMode>\\n </IpsConfig>\\n <MemberUid>258039427902****</MemberUid>\\n <PrecheckStatus>failed</PrecheckStatus>\\n </VpcFirewalls>\\n</DescribeVpcFirewallCenListResponse>","errorExample":""}]', + 'title' => 'DescribeVpcFirewallCenList', + 'description' => 'You can call the DescribeVpcFirewallCenList operation to query VPC firewalls. A VPC firewall protects mutual access traffic between a specified VPC and a network instance that is attached to a CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'translator' => 'machine', + ], + 'DescribeVpcFirewallCenDetail' => [ + 'summary' => 'Queries the details about a virtual private cloud (VPC) firewall. The VPC firewall protects access traffic between a VPC and a network instance that is attached to a Cloud Enterprise Network (CEN) instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68414', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallCenList](~~345777~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'NetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC for which the VPC firewall is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zefk9fbn8j7v585g****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => 'The connection type of the VPC firewall. The value is fixed as **cen**, which indicates CEN instances.'."\n", + 'type' => 'string', + 'example' => 'cen', + ], + 'VpcFirewallName' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'Test firewall'."\n", + ], + 'VpcFirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: enabled'."\n" + .'* **closed**: disabled'."\n" + .'* **notconfigured**: not configured'."\n", + 'type' => 'string', + 'example' => 'opened', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125g4d2', + ], + 'LocalVpc' => [ + 'description' => 'The details about the VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'TransitRouterType' => [ + 'description' => 'The edition of the CEN transit router. Valid values:'."\n" + ."\n" + .'* **Basic**: Basic Edition'."\n" + .'* **Enterprise**: Enterprise Edition'."\n", + 'type' => 'string', + 'example' => 'Basic', + ], + 'RouteMode' => [ + 'description' => 'The routing mode. Valid values:'."\n" + ."\n" + .'* auto: automatic mode'."\n" + .'* manual: manual mode'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'NetworkInstanceId' => [ + 'description' => 'The ID of the VPC for which the VPC firewall is created.'."\n", + 'type' => 'string', + 'example' => 'vpc-2zefk9fbn8j7v585g****', + ], + 'RegionNo' => [ + 'description' => 'The ID of the region in which the VPC resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ManualVSwitchId' => [ + 'description' => 'The ID of the specified vSwitch when the routing mode is manual.'."\n", + 'type' => 'string', + 'example' => 'vsw-zeq4o875u****', + ], + 'OwnerId' => [ + 'description' => 'The UID of the Alibaba Cloud account to which the VPC belongs.'."\n", + 'type' => 'string', + 'example' => '158039427902****', + ], + 'NetworkInstanceType' => [ + 'description' => 'The type of the network instance. The value is fixed as **VPC**.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'VpcName' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'Test instance'."\n", + ], + 'SupportManualMode' => [ + 'description' => 'Indicates whether the manual routing mode is supported. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'TransitRouterId' => [ + 'description' => 'The instance ID of the CEN transit router.'."\n", + 'type' => 'string', + 'example' => 'tr-2zetwxskej633l3u1****', + ], + 'AttachmentId' => [ + 'description' => 'The ID of the connection between two network instances.'."\n", + 'type' => 'string', + 'example' => 'tr-attach-sxig7bye51fid5****', + ], + 'NetworkInstanceName' => [ + 'description' => 'The name of the network instance.'."\n", + 'type' => 'string', + 'example' => 'Test VPC'."\n", + ], + 'AttachmentName' => [ + 'description' => 'The name of the connection between two network instances.'."\n", + 'type' => 'string', + 'example' => 'Local test'."\n", + ], + 'VpcCidrTableList' => [ + 'description' => 'An array that consists of the CIDR blocks of the VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'The route table ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vtb-1234', + ], + 'RouteEntryList' => [ + 'description' => 'The route entries for the VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => 'The instance ID of the next hop for the VPC.'."\n", + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => 'The destination CIDR block of the VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + 'EniList' => [ + 'description' => 'The Elastic Network Interfaces (ENIs).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EniId' => [ + 'description' => 'The ID of the ENI that belongs to the VPC.'."\n", + 'type' => 'string', + 'example' => 'eni-8vbhfosfqv2rff42****', + ], + 'EniPrivateIpAddress' => [ + 'description' => 'The private IP address of the ENI that belongs to the VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'EniVSwitchId' => [ + 'description' => 'The ID of the vSwitch to which the ENI is connected.'."\n", + 'type' => 'string', + 'example' => 'vsw-wz9viido7j436b0n1****', + ], + ], + ], + ], + 'DefendCidrList' => [ + 'description' => 'An array consisting of the CIDR blocks that are protected by the VPC firewall.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block that is protected by the VPC firewall.'."\n", + 'type' => 'string', + 'example' => '10.0.XX.XX/24', + ], + ], + ], + ], + 'FirewallVpc' => [ + 'description' => 'The firewall VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1245k5oagy2bp74****', + ], + 'VpcCidr' => [ + 'description' => 'The CIDR block of the VPC.'."\n", + 'type' => 'string', + 'example' => '10.0.0.0/8', + ], + 'VswitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1sqg9wms9wxcs1****', + ], + 'VswitchCidr' => [ + 'description' => 'The CIDR block of the vSwitch.'."\n", + 'type' => 'string', + 'example' => '10.0.0.1/24', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'AllowConfiguration' => [ + 'description' => 'Indicates whether you can specify a CIDR block when you create a VPC firewall for a Basic Edition transit router of a CEN instance. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VswitchZoneId' => [ + 'description' => 'The availability zone ID of the virtual switch.', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'StandbyZoneId' => [ + 'description' => 'Firewall backup availability zone ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallId', + 'errorMessage' => 'The VPC firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallExist', + 'errorMessage' => 'The firewall has been configured and cannot be created repeatedly.', + ], + [ + 'errorCode' => 'ErrorUnmarshalJSON', + 'errorMessage' => 'An error occurred while parsing JSON.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorVpcOpenApi', + 'errorMessage' => 'vpc open api failed', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorVpcIdPara', + 'errorMessage' => 'vpc id and firewall id parameter not exist.', + ], + [ + 'errorCode' => 'ErrorFirewallNotFound', + 'errorMessage' => 'Firewall not found', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorUserNotFound', + 'errorMessage' => 'User not found', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConnectType\\": \\"cen\\",\\n \\"VpcFirewallName\\": \\"测试防火墙\\",\\n \\"VpcFirewallId\\": \\"vfw-m5e7dbc4y****\\",\\n \\"FirewallSwitchStatus\\": \\"opened\\",\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125g4d2\\",\\n \\"LocalVpc\\": {\\n \\"VpcId\\": \\"vpc-8vbwbo90rq0anm6t****\\",\\n \\"TransitRouterType\\": \\"Basic\\",\\n \\"RouteMode\\": \\"auto\\",\\n \\"NetworkInstanceId\\": \\"vpc-2zefk9fbn8j7v585g****\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"ManualVSwitchId\\": \\"vsw-zeq4o875u****\\",\\n \\"OwnerId\\": \\"158039427902****\\",\\n \\"NetworkInstanceType\\": \\"VPC\\",\\n \\"VpcName\\": \\"测试用实例\\",\\n \\"SupportManualMode\\": \\"0\\",\\n \\"TransitRouterId\\": \\"tr-2zetwxskej633l3u1****\\",\\n \\"AttachmentId\\": \\"tr-attach-sxig7bye51fid5****\\",\\n \\"NetworkInstanceName\\": \\"测试业务vpc\\",\\n \\"AttachmentName\\": \\"本地测试\\",\\n \\"VpcCidrTableList\\": [\\n {\\n \\"RouteTableId\\": \\"vtb-1234\\",\\n \\"RouteEntryList\\": [\\n {\\n \\"NextHopInstanceId\\": \\"vrt-m5eb5me6c3l5sezae****\\",\\n \\"DestinationCidr\\": \\"192.168.XX.XX/24\\"\\n }\\n ]\\n }\\n ],\\n \\"EniList\\": [\\n {\\n \\"EniId\\": \\"eni-8vbhfosfqv2rff42****\\",\\n \\"EniPrivateIpAddress\\": \\"192.168.XX.XX\\",\\n \\"EniVSwitchId\\": \\"vsw-wz9viido7j436b0n1****\\"\\n }\\n ],\\n \\"DefendCidrList\\": [\\n \\"10.0.XX.XX/24\\"\\n ]\\n },\\n \\"FirewallVpc\\": {\\n \\"VpcId\\": \\"vpc-bp1245k5oagy2bp74****\\",\\n \\"VpcCidr\\": \\"10.0.0.0/8\\",\\n \\"VswitchId\\": \\"vsw-bp1sqg9wms9wxcs1****\\",\\n \\"VswitchCidr\\": \\"10.0.0.1/24\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"AllowConfiguration\\": 0,\\n \\"VswitchZoneId\\": \\"cn-hangzhou-i\\",\\n \\"StandbyZoneId\\": \\"cn-hangzhou-k\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcFirewallCenDetailResponse>\\n <ConnectType>cen</ConnectType>\\n <VpcFirewallName>测试防火墙</VpcFirewallName>\\n <VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>\\n <FirewallSwitchStatus>opened</FirewallSwitchStatus>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125g4d2</RequestId>\\n <LocalVpc>\\n <VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>\\n <TransitRouterType>Basic</TransitRouterType>\\n <RouteMode>auto</RouteMode>\\n <NetworkInstanceId>vpc-2zefk9fbn8j7v585g****</NetworkInstanceId>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <ManualVSwitchId>vsw-zeq4o875u****</ManualVSwitchId>\\n <OwnerId>158039427902****</OwnerId>\\n <NetworkInstanceType>VPC</NetworkInstanceType>\\n <VpcName>测试用实例</VpcName>\\n <SupportManualMode>0</SupportManualMode>\\n <TransitRouterId>tr-2zetwxskej633l3u1****</TransitRouterId>\\n <AttachmentId>tr-attach-sxig7bye51fid5****</AttachmentId>\\n <NetworkInstanceName>测试业务vpc</NetworkInstanceName>\\n <AttachmentName>本地测试</AttachmentName>\\n <VpcCidrTableList>\\n <RouteTableId>vtb-1234</RouteTableId>\\n <RouteEntryList>\\n <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>\\n <DestinationCidr>192.168.XX.XX/24</DestinationCidr>\\n </RouteEntryList>\\n </VpcCidrTableList>\\n <EniList>\\n <EniId>eni-8vbhfosfqv2rff42****</EniId>\\n <EniPrivateIpAddress>192.168.XX.XX</EniPrivateIpAddress>\\n </EniList>\\n <DefendCidrList>10.0.XX.XX/24</DefendCidrList>\\n </LocalVpc>\\n</DescribeVpcFirewallCenDetailResponse>","errorExample":""}]', + 'title' => 'DescribeVpcFirewallCenDetail', + 'description' => 'You can call the DescribeVpcFirewallCenDetail operation to query the details about a VPC firewall. The VPC firewall protects access traffic between a specified VPC and a network instance that is attached to a CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeNetworkInstanceList' => [ + 'summary' => '获取网络实例列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68310', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'ConnectType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'expressconnect' => '', + 'cen' => '', + ], + 'example' => 'expressconnect', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-x5jayxou71ad73****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D2373503-3921-59F2-93A6-3DA7FB7****', + ], + 'NetworkInstanceList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NetworkInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-m5ewlqkuf7or****', + ], + 'NetworkInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-test', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'NetworkInstanceType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'vbr' => 'vbr', + 'vpc' => 'vpc', + ], + 'example' => 'vpc', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorConnectType', + 'errorMessage' => 'Connect type invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 21,\\n \\"RequestId\\": \\"D2373503-3921-59F2-93A6-3DA7FB7****\\",\\n \\"NetworkInstanceList\\": [\\n {\\n \\"NetworkInstanceId\\": \\"vpc-m5ewlqkuf7or****\\",\\n \\"NetworkInstanceName\\": \\"vpc-test\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"NetworkInstanceType\\": \\"vpc\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcZone' => [ + 'summary' => 'Queries virtual private cloud (VPC) zones.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '179270', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member in Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1415189284827022', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => [ + 'description' => 'The environment. Valid values:'."\n" + ."\n" + .'* **VPC**'."\n" + .'* **TransitRouter**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '694DFBF3-C060-529F-92D0-7FC7E0DA1E21', + ], + 'ZoneList' => [ + 'description' => 'The zones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'LocalName' => [ + 'description' => 'The name of the zone.'."\n", + 'type' => 'string', + 'example' => 'Hangzhou Zone B', + ], + 'ZoneType' => [ + 'description' => 'The zone type. Default value: AvailabilityZone. This value indicates Alibaba Cloud zones.'."\n", + 'type' => 'string', + 'example' => 'AvailabilityZone', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'user credentials failed', + ], + [ + 'errorCode' => 'ErrorVpcOpenApi', + 'errorMessage' => 'vpc open api failed', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorCenTRAssociationNotFound', + 'errorMessage' => 'CEN-TR attachment association not found.', + ], + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'Region is error, please reselect', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"694DFBF3-C060-529F-92D0-7FC7E0DA1E21\\",\\n \\"ZoneList\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"LocalName\\": \\"华东 1 可用区 B\\",\\n \\"ZoneType\\": \\"AvailabilityZone\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeVpcZone', + ], + 'DescribeVpcFirewallZone' => [ + 'summary' => '查询VPC防火墙资源可用区', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TransitRouter' => '', + 'VPC' => '', + ], + 'example' => 'TransitRouter', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-4xbjup276au29r****', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-m5etmb2q7e0mxcur****', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '222.212.86.7XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '337A4DBA-8A01-5E9C-99CA-84293E13****', + ], + 'ZoneList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-c', + ], + 'LocalName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'Region is error, please reselect', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"337A4DBA-8A01-5E9C-99CA-84293E13****\\",\\n \\"ZoneList\\": [\\n [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-c\\",\\n \\"LocalName\\": \\"杭州 可用区C\\"\\n }\\n ]\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallManualVSwitchList' => [ + 'summary' => '获取防火墙手动交换机列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68422', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-m5ewlqkuf7orclr1****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '18820897691****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6EED3674-74E7-54DC-8FD4-6A374133****', + ], + 'VSwitchList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-uf62kq7c364sil2z2****', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-bp10d0kcp907721z****', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.0.31.0/24', + ], + 'AvailableIpAddressCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-a', + ], + 'AliUid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122167357026****', + ], + 'RouteTableId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vtb-2zet3gyk01o07so****', + ], + 'OwnerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '137578716100****', + ], + 'VSwitchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorOwnerId', + 'errorMessage' => 'owner id invalid.', + ], + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'Region invalid.', + ], + [ + 'errorCode' => 'ErrorVpcIdError', + 'errorMessage' => 'Vpc ID invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorVpcOpenApi', + 'errorMessage' => 'vpc open api failed', + ], + [ + 'errorCode' => 'ErrorVswitchNotFound', + 'errorMessage' => 'vswitch not found', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"6EED3674-74E7-54DC-8FD4-6A374133****\\",\\n \\"VSwitchList\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcId\\": \\"vpc-uf62kq7c364sil2z2****\\",\\n \\"VSwitchId\\": \\"vsw-bp10d0kcp907721z****\\",\\n \\"CidrBlock\\": \\"10.0.31.0/24\\",\\n \\"AvailableIpAddressCount\\": 10,\\n \\"RegionNo\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"AliUid\\": 0,\\n \\"RouteTableId\\": \\"vtb-2zet3gyk01o07so****\\",\\n \\"OwnerId\\": 0,\\n \\"VSwitchName\\": \\"vsw-test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateVpcFirewallCenConfigure' => [ + 'summary' => 'Creates a virtual private cloud (VPC) firewall to protect traffic between a specified VPC and a network instance that is attached to a Cloud Enterprise Network (CEN) instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68133', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Test instance'."\n", + ], + ], + [ + 'name' => 'NetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC for which you want to create the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp10zlifxh6j0232w****', + ], + ], + [ + 'name' => 'VpcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region to which the VPC belongs.'."\n" + ."\n" + .'> For more information about the regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the VPC firewall. Valid values:'."\n" + ."\n" + .'* **open**: After you create the VPC firewall, the VPC firewall is automatically enabled. This is the default value.'."\n" + .'* **close**: After you create the VPC firewall, the VPC firewall is disabled. You can call the [ModifyVpcFirewallCenSwitchStatus](~~345780~~) operation to manually enable the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the CEN instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cen-x5jayxou71ad73****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch that is used to associate with the elastic network interface (ENI) required by the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-qzeaol304m***', + ], + ], + [ + 'name' => 'FirewallVpcCidrBlock', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR block of the VPC that is automatically created for the VPC firewall. You must specify a CIDR block for the Cloud_Firewall_VPC VPC that is automatically created for the VPC firewall for traffic redirection. The subnet mask of the CIDR block must be less than or equal to 28 bits in length.'."\n" + ."\n" + .'If you do not specify a value, the CIDR block 10.0.0.0/8 is automatically allocated.'."\n" + ."\n" + .'> This parameter takes effect only when you create a VPC firewall for the first time in the current CEN instance and region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.0/8', + ], + ], + [ + 'name' => 'FirewallVpcZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone to which the vSwitch belongs. If your service is latency-sensitive, you can specify the same zone for the vSwitch of the firewall and the vSwitch of your business VPC to minimize latency.'."\n" + ."\n" + .'If you do not specify a value, a zone is automatically assigned for the vSwitch.'."\n" + ."\n" + .'> This parameter takes effect only when you create a VPC firewall for the first time in the current CEN instance and region. For more information about zones that are supported by each region, see [Query zones](~~36064~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-a', + ], + ], + [ + 'name' => 'FirewallVSwitchCidrBlock', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR block of the vSwitch that is automatically created for the VPC firewall. You must specify a CIDR block for the Cloud_Firewall_VSWITCH VPC that is automatically created for the VPC firewall for traffic redirection. The CIDR block does not conflict with your network plan. The subnet mask of the CIDR block must be less than or equal to 29 bits in length. The CIDR block of the vSwitch must be within the network segment of the VPC.'."\n" + ."\n" + .'If you do not specify a value, the CIDR block 10.219.219.216/29 is automatically allocated.'."\n" + ."\n" + .'> This parameter takes effect only when you create a VPC firewall for the first time in the current CEN instance and region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.0.*.*/28', + ], + ], + [ + 'name' => 'FirewallVpcStandbyZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup availability zone to which the firewall belongs. The firewall will automatically switch to the backup availability zone to continue running only if the primary availability zone service is unavailable.'."\n" + .'If this parameter is not filled, the backup availability zone for the firewall will be automatically assigned.'."\n" + .'> This parameter is only effective when creating a VPC firewall for the first time in this CEN region.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VpcFirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125h4j6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallExist', + 'errorMessage' => 'The firewall has been configured and cannot be created repeatedly.', + ], + [ + 'errorCode' => 'ErrorVpcId', + 'errorMessage' => 'The VPC ID is invalid.', + ], + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'The region is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'The specified VPC firewall does not exist. Please select again.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorCenVbrNotSupport', + 'errorMessage' => '云企业网vbr不支持开防火墙', + ], + [ + 'errorCode' => 'ErrorCenNotSupportCCN', + 'errorMessage' => 'VPC防火墙云企业网CCN实例, 不支持开启VPC防火墙', + ], + [ + 'errorCode' => 'ErrorCenNotSupportMultipleAccounts', + 'errorMessage' => 'The current version of Cloud Firewall does not support multiple accounts when it uses VPC Firewall to protect Cloud Enterprise Network. Upgrade the specifications and try again.', + ], + [ + 'errorCode' => 'ErrorFirewallStatus', + 'errorMessage' => 'Firewall status error, please try again later.', + ], + [ + 'errorCode' => 'ErrorFirewallQuotaNotEmpty', + 'errorMessage' => 'quota is not enough, unable to configure VPC firewall, please increase quota first.', + ], + [ + 'errorCode' => 'ErrorHubvpcCannotCreate', + 'errorMessage' => 'HUB VPC不允许创建防火墙', + ], + [ + 'errorCode' => 'ErrorCenVpcEcConflict', + 'errorMessage' => 'The VPC of the cloud enterprise network conflicts with the VPC of the high-speed channel, and the firewall cannot be opened. Please select again', + ], + [ + 'errorCode' => 'ErrorRegionNoDisable', + 'errorMessage' => 'There are unsupported regions, please reselect', + ], + [ + 'errorCode' => 'ErrorCenFirewallVpcNumInvalid', + 'errorMessage' => '云企业网vpc数量不足, 无法开启VPC边界防火墙', + ], + [ + 'errorCode' => 'ErrorDestCidrError', + 'errorMessage' => 'The target network segment is wrong. Please configure the target network segment correctly.', + ], + [ + 'errorCode' => 'ErrorVpcCustomRouteTableWithVswitch', + 'errorMessage' => 'VPC存在自定义路由表且关联了vswitch, 不允许创建VPC防火墙', + ], + [ + 'errorCode' => 'ErrorCenNotSupportTREnterpriseAutoMode', + 'errorMessage' => 'VPC firewall does not support TR Enterprise Edition auto mode protection, please use manual mode protection', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallName', + 'errorMessage' => 'Firewall name invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallSwitch', + 'errorMessage' => 'The firewall enabling parameter is incorrect. Please select again.', + ], + [ + 'errorCode' => 'ErrorNetworkInstanceIdError', + 'errorMessage' => 'Network InstanceId ID is invalid', + ], + [ + 'errorCode' => 'ErrorCenId', + 'errorMessage' => 'CEN ID is error', + ], + [ + 'errorCode' => 'ErrorCidrFormat', + 'errorMessage' => 'Cidr ip format error.', + ], + [ + 'errorCode' => 'ErrorDestCidrEmpty', + 'errorMessage' => 'The target network segment is empty and cannot be created', + ], + [ + 'errorCode' => 'ErrorOwnerId', + 'errorMessage' => 'owner id invalid.', + ], + [ + 'errorCode' => 'ErrorCenManualFirewallExist', + 'errorMessage' => 'VPC firewall in manual mode already exists in this CEN network. You are not allowed to create a VPC firewall in automatic mode.', + ], + [ + 'errorCode' => 'ErrorFirewallExistDeleting', + 'errorMessage' => 'There is a VPC firewall that is being deleted, and it is not allowed to create.', + ], + [ + 'errorCode' => 'ErrorSameCidrIp', + 'errorMessage' => 'The same network segment cannot be configured repeatedly. Please reselect the network segment.', + ], + [ + 'errorCode' => 'ErrorCenRouteMapExist', + 'errorMessage' => 'cen route map is exist.', + ], + [ + 'errorCode' => 'ErrorUserCredentials', + 'errorMessage' => 'User credentials failed.', + ], + [ + 'errorCode' => 'ErrorDBNoRow', + 'errorMessage' => 'No rows in database.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallVpcNumLimit', + 'errorMessage' => 'The number of vpcs in this region is limited to open the vpc firewall.', + ], + [ + 'errorCode' => 'ErrorCenExistPublicCidr', + 'errorMessage' => 'cen domain route exist public route.', + ], + [ + 'errorCode' => 'ErrorCenExistTrRoute', + 'errorMessage' => 'Cen VPC route exist tr route.', + ], + [ + 'errorCode' => 'ErrorCenTRAssociationCustomRouteTable', + 'errorMessage' => 'CEN-TR association custom route table.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallZoneId', + 'errorMessage' => 'VPC firewall zone error.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUidStatus', + 'errorMessage' => 'invalid member uid status.', + ], + [ + 'errorCode' => 'ErrorBandwidthPenalty', + 'errorMessage' => 'Cloud Firewall bandwidth is being overused.', + ], + [ + 'errorCode' => 'ErrorGeneralInstanceSpecFull', + 'errorMessage' => 'Cloud Firewall instance specifications are full.', + ], + [ + 'errorCode' => 'ErrorFirewallVSwitchCidrConflict', + 'errorMessage' => 'Firewall switch network segment conflicts with business network segment.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"VpcFirewallId\\": \\"vfw-m5e7dbc4y****\\",\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125h4j6\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateVpcFirewallCenConfigureResponse>\\n <VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125h4j6</RequestId>\\n</CreateVpcFirewallCenConfigureResponse>","errorExample":""}]', + 'title' => 'CreateVpcFirewallCenConfigure', + 'description' => 'You can call the CreateVpcFirewallCenConfigure operation to create a VPC firewall. The VPC firewall protects mutual access traffic between a specified VPC and a network instance that is attached to a CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance. The VPC firewall cannot protect mutual access traffic between VBRs, between CCN instances, or between VBRs and CCN instances. For more information, see [VPC firewall limits](~~172295~~).'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'translator' => 'machine', + ], + 'ModifyVpcFirewallCenConfigure' => [ + 'summary' => 'Modifies the configurations of a virtual private cloud (VPC) firewall. The VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a Cloud Enterprise Network (CEN) instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68493', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallCenList](~~345777~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Test instance'."\n", + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k6f8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallIdNotFound', + 'errorMessage' => 'The VPC firewall ID is not found.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'The region is invalid.', + ], + [ + 'errorCode' => 'ErrorUnmarshalJSON', + 'errorMessage' => 'An error occurred while parsing JSON.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallId', + 'errorMessage' => 'Firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallName', + 'errorMessage' => 'Firewall name invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallExist', + 'errorMessage' => 'Vpc firewall already exist.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'Vpc firewall not found.', + ], + [ + 'errorCode' => 'ErrorFirewallStatusCannotModify', + 'errorMessage' => 'Current firewall status, configuration not allowed', + ], + [ + 'errorCode' => 'ErrorRegionNoDisable', + 'errorMessage' => 'There are unsupported regions, please reselect', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125k6f8\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyVpcFirewallCenConfigureResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125k6f8</RequestId>\\n</ModifyVpcFirewallCenConfigureResponse>","errorExample":""}]', + 'title' => 'ModifyVpcFirewallCenConfigure', + 'description' => 'You can call the ModifyVpcFirewallCenConfigure operation to modify the configurations of a VPC firewall. The VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance. Before you call this operation, make sure that you have created a VPC firewall by calling the [CreateVpcFirewallCenConfigure](~~345772~~) operation.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ModifyVpcFirewallCenSwitchStatus' => [ + 'summary' => 'Enables or disables a virtual private cloud (VPC) firewall. The VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a Cloud Enterprise Network (CEN) instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68494', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallCenList](~~345777~~) operation to query the instance IDs of VPC firewalls.', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the VPC firewall. Valid values:'."\n" + ."\n" + .'* **open**: yes'."\n" + .'* **close**: no'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125afj2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorVpcFirewallId', + 'errorMessage' => 'The VPC firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallSwitch', + 'errorMessage' => 'The firewall enabling parameter is incorrect. Please select again.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallId', + 'errorMessage' => 'Firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'Vpc firewall not found.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorCenTRManualModifySwitchStatus', + 'errorMessage' => 'CEN-TR manual mode does not support modifying the firewall status, if you need to close it, please delete the VPC firewall.', + ], + [ + 'errorCode' => 'ErrorCenRouteMapExist', + 'errorMessage' => 'cen route map is exist.', + ], + [ + 'errorCode' => 'ErrorFirewallNotConfig', + 'errorMessage' => 'Firewall not config', + ], + [ + 'errorCode' => 'ErrorFirewallStatusClosed', + 'errorMessage' => 'firewall is already closed.', + ], + [ + 'errorCode' => 'ErrorNetworkInterfaceNotFound', + 'errorMessage' => 'The NIC of the firewall is invalid. Check its configurations.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + [ + 'errorCode' => 'ErrorBandwidthPenalty', + 'errorMessage' => 'Cloud Firewall bandwidth is being overused.', + ], + [ + 'errorCode' => 'ErrorFirewallVSwitchCidrConflict', + 'errorMessage' => 'Firewall switch network segment conflicts with business network segment.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125afj2\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyVpcFirewallCenSwitchStatusResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125afj2</RequestId>\\n</ModifyVpcFirewallCenSwitchStatusResponse>","errorExample":""}]', + 'title' => 'ModifyVpcFirewallCenSwitchStatus', + 'description' => 'You can call the ModifyVpcFirewallCenSwitchStatus operation to enable or disable a VPC firewall. A VPC firewall protects mutual access traffic between a specified VPC and a network instance that is attached to a CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance. After you enable the VPC firewall, the VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a CEN instance. After you disable the VPC firewall, the VPC firewall no longer protects mutual access traffic between a VPC and a specified network instance that is attached to a CEN instance.'."\n" + ."\n" + .'Before you call this operation, make sure that you have created a VPC firewall by calling the [CreateVpcFirewallCenConfigure](~~345772~~) operation.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DeleteVpcFirewallCenConfigure' => [ + 'summary' => 'Deletes a virtual private cloud (VPC) firewall. The VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a Cloud Enterprise Network (CEN) instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68163', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The instance IDs of VPC firewalls.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallCenList](~~345777~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k6j3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallId', + 'errorMessage' => 'The VPC firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'Vpc firewall not found.', + ], + [ + 'errorCode' => 'ErrorFirewallStatusCannotModify', + 'errorMessage' => 'Current firewall status, configuration not allowed', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125k6j3\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVpcFirewallCenConfigureResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125k6j3</RequestId>\\n</DeleteVpcFirewallCenConfigureResponse>","errorExample":""}]', + 'title' => 'DeleteVpcFirewallCenConfigure', + 'description' => 'You can call the DeleteVpcFirewallCenConfigure operation to delete a VPC firewall. The VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance. Before you call this operation, make sure that you have created a VPC firewall by calling the [CreateVpcFirewallCenConfigure](~~345772~~) operation.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeVpcFirewallList' => [ + 'summary' => 'Queries the details about virtual private cloud (VPC) firewalls by page. Each VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68420', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the VPC.'."\n" + ."\n" + .'> For more information about the regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'FirewallSwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: The VPC firewall is enabled.'."\n" + .'* **closed**: The VPC firewall is disabled.'."\n" + .'* **notconfigured**: The VPC firewall is not configured.'."\n" + .'* **configured**: The VPC firewall is configured.'."\n" + ."\n" + .'> If you do not specify this parameter, VPC firewalls in all states are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'opened', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test firewall'."\n", + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Pages start from page **1**. Default value: **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: **10**. Maximum value: **50**.', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'ConnectSubType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sub-type of the connection. Valid values:'."\n" + ."\n" + .'* **vpc2vpc**: Express Connect connection'."\n" + .'* **vpcpeer**: peer connection'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpcpeer', + ], + ], + [ + 'name' => 'PeerUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the Alibaba Cloud account to which the peer VPC belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The VPC firewalls.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of VPC firewalls.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k8g2', + ], + 'VpcFirewalls' => [ + 'description' => 'The information about the VPC firewalls.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the VPC firewall.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => 'The connection type of the VPC firewall. The value is fixed as **expressconnect**, which indicates an Express Connect connection.'."\n", + 'type' => 'string', + 'example' => 'expressconnect', + ], + 'VpcFirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RegionStatus' => [ + 'description' => 'Indicates whether you can create a VPC firewall in a specified region. Valid values:'."\n" + ."\n" + .'* **enable**: yes'."\n" + .'* **disable**: no'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'Bandwidth' => [ + 'description' => 'The bandwidth of the Express Connect circuit. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VpcFirewallName' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'Test firewall'."\n", + ], + 'FirewallSwitchStatus' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: The VPC firewall is enabled.'."\n" + .'* **closed**: The VPC firewall is disabled.'."\n" + .'* **notconfigured**: The VPC firewall is not configured.'."\n", + 'type' => 'string', + 'example' => 'opened', + ], + 'LocalVpc' => [ + 'description' => 'The details about the local VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcName' => [ + 'description' => 'The name of the local VPC.'."\n", + 'type' => 'string', + 'example' => 'Test instance'."\n", + ], + 'VpcId' => [ + 'description' => 'The ID of the local VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'AuthorizationStatus' => [ + 'description' => 'Indicates whether Cloud Firewall is authorized to access the local VPC. The value is fixed as authorized, which indicates that Cloud Firewall is authorized to access the local VPC.'."\n", + 'type' => 'string', + 'example' => 'authorized', + ], + 'OwnerId' => [ + 'description' => 'The UID of the Alibaba Cloud account to which the local VPC belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158039427902****', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the local VPC.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VpcCidrTableList' => [ + 'description' => 'An array that consists of the CIDR blocks of the local VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block of the local VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'The ID of the route table for the local VPC.'."\n", + 'type' => 'string', + 'example' => 'vtb-1234', + ], + 'RouteEntryList' => [ + 'description' => 'An array that consists of the route entries of the local VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The route entry of the local VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => 'The instance ID of the next hop for the local VPC.'."\n", + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => 'The destination CIDR block of the local VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'PeerVpc' => [ + 'description' => 'The details about the peer VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcName' => [ + 'description' => 'The name of the peer VPC.'."\n", + 'type' => 'string', + 'example' => 'Test VPC 2'."\n", + ], + 'VpcId' => [ + 'description' => 'The ID of the peer VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'AuthorizationStatus' => [ + 'description' => 'Indicates whether Cloud Firewall is authorized to access the peer VPC. The value is fixed as **authorized**, which indicates that Cloud Firewall is authorized to access the peer VPC.'."\n", + 'type' => 'string', + 'example' => 'authorized', + ], + 'OwnerId' => [ + 'description' => 'The UID of the Alibaba Cloud account to which the peer VPC belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158039427902****', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the peer VPC.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VpcCidrTableList' => [ + 'description' => 'An array that consists of the CIDR blocks of the peer VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block of the peer VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'The ID of the route table for the peer VPC.'."\n", + 'type' => 'string', + 'example' => 'vtb-1256', + ], + 'RouteEntryList' => [ + 'description' => 'An array that consists of the route entries of the peer VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The route entry of the peer VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => 'The instance ID of the next hop for the peer VPC.'."\n", + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => 'The destination CIDR block of the peer VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'IpsConfig' => [ + 'description' => 'The intrusion prevention system (IPS) configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'BasicRules' => [ + 'description' => 'Indicates whether basic protection is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableAllPatch' => [ + 'description' => 'Indicates whether virtual patching is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RunMode' => [ + 'description' => 'The mode of the IPS. Valid values:'."\n" + ."\n" + .'* **1**: block mode'."\n" + .'* **0**: monitor mode'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleClass' => [ + 'description' => 'The level of the rule group for the IPS. Valid values:'."\n" + ."\n" + .'* **1**: loose'."\n" + .'* **2**: medium'."\n" + .'* **3**: strict'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'MemberUid' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '258039427902****', + ], + 'ResultCode' => [ + 'description' => 'The result code of the operation that creates the VPC firewall. Valid values:'."\n" + ."\n" + .'* **Unauthorized**: Cloud Firewall is not authorized to access a VPC for which the VPC firewall is created, and the VPC firewall cannot be created.'."\n" + .'* **RegionDisable**: VPC Firewall is not supported in the region of a VPC for which the VPC firewall is created, and the VPC firewall cannot be created.'."\n" + .'* **Empty string**: You can create a VPC firewall for the network instance.'."\n", + 'type' => 'string', + 'example' => 'Unauthorized', + ], + 'ConnectSubType' => [ + 'description' => 'The sub-type of the connection. Valid values:'."\n" + ."\n" + .'* **vpc2vpc**: Express Connect connection'."\n" + .'* **vpcpeer**: peer connection'."\n", + 'type' => 'string', + 'example' => 'vpcpeer', + ], + 'AclConfig' => [ + 'description' => 'ACL engine mode.', + 'type' => 'object', + 'properties' => [ + 'StrictMode' => [ + 'description' => 'Specifies whether to enable the strict mode. Valid values:'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'default' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorUnmarshalJSON', + 'errorMessage' => 'An error occurred while parsing JSON.', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallStatus', + 'errorMessage' => 'Firewall status error, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125k8g2\\",\\n \\"VpcFirewalls\\": [\\n {\\n \\"ConnectType\\": \\"expressconnect\\",\\n \\"VpcFirewallId\\": \\"vfw-m5e7dbc4y****\\",\\n \\"RegionStatus\\": \\"enable\\",\\n \\"Bandwidth\\": 2,\\n \\"VpcFirewallName\\": \\"测试防火墙\\",\\n \\"FirewallSwitchStatus\\": \\"opened\\",\\n \\"LocalVpc\\": {\\n \\"VpcName\\": \\"测试用实例\\",\\n \\"VpcId\\": \\"vpc-8vbwbo90rq0anm6t****\\",\\n \\"AuthorizationStatus\\": \\"authorized\\",\\n \\"OwnerId\\": 0,\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"VpcCidrTableList\\": [\\n {\\n \\"RouteTableId\\": \\"vtb-1234\\",\\n \\"RouteEntryList\\": [\\n {\\n \\"NextHopInstanceId\\": \\"vrt-m5eb5me6c3l5sezae****\\",\\n \\"DestinationCidr\\": \\"192.168.XX.XX/24\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"PeerVpc\\": {\\n \\"VpcName\\": \\"测试vpc2\\",\\n \\"VpcId\\": \\"vpc-8vbwbo90rq0anm6t****\\",\\n \\"AuthorizationStatus\\": \\"authorized\\",\\n \\"OwnerId\\": 0,\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"VpcCidrTableList\\": [\\n {\\n \\"RouteTableId\\": \\"vtb-1256\\",\\n \\"RouteEntryList\\": [\\n {\\n \\"NextHopInstanceId\\": \\"vrt-m5eb5me6c3l5sezae****\\",\\n \\"DestinationCidr\\": \\"192.168.XX.XX/24\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"IpsConfig\\": {\\n \\"BasicRules\\": 1,\\n \\"EnableAllPatch\\": 1,\\n \\"RunMode\\": 0,\\n \\"RuleClass\\": 1\\n },\\n \\"MemberUid\\": \\"258039427902****\\",\\n \\"ResultCode\\": \\"Unauthorized\\",\\n \\"ConnectSubType\\": \\"vpcpeer\\",\\n \\"AclConfig\\": {\\n \\"StrictMode\\": 1\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcFirewallListResponse>\\n <TotalCount>10</TotalCount>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125k8g2</RequestId>\\n <VpcFirewalls>\\n <ConnectType>expressconnect</ConnectType>\\n <VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>\\n <RegionStatus>enable</RegionStatus>\\n <Bandwidth>2</Bandwidth>\\n <VpcFirewallName>测试防火墙</VpcFirewallName>\\n <FirewallSwitchStatus>opened</FirewallSwitchStatus>\\n <LocalVpc>\\n <VpcName>测试用实例</VpcName>\\n <VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>\\n <AuthorizationStatus>authorized</AuthorizationStatus>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <VpcCidrTableList>\\n <RouteTableId>vtb-1234</RouteTableId>\\n <RouteEntryList>\\n <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>\\n <DestinationCidr>192.168.XX.XX/24</DestinationCidr>\\n </RouteEntryList>\\n </VpcCidrTableList>\\n </LocalVpc>\\n <PeerVpc>\\n <VpcName>测试vpc2</VpcName>\\n <VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>\\n <AuthorizationStatus>authorized</AuthorizationStatus>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <VpcCidrTableList>\\n <RouteTableId>vtb-1256</RouteTableId>\\n <RouteEntryList>\\n <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>\\n <DestinationCidr>192.168.XX.XX/24</DestinationCidr>\\n </RouteEntryList>\\n </VpcCidrTableList>\\n </PeerVpc>\\n <IpsConfig>\\n <BasicRules>1</BasicRules>\\n <EnableAllPatch>1</EnableAllPatch>\\n <RunMode>0</RunMode>\\n </IpsConfig>\\n <MemberUid>258039427902****</MemberUid>\\n </VpcFirewalls>\\n</DescribeVpcFirewallListResponse>","errorExample":""}]', + 'title' => 'DescribeVpcFirewallList', + 'description' => 'You can call the DescribeVpcFirewallList operation to query the details about VPC firewalls by page. Each VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit.'."\n" + ."\n" + .'### Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeVpcFirewallDetail' => [ + 'summary' => 'Queries the details about a virtual private cloud (VPC) firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68419', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The natural language of the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The natural language of the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallList](~~342932~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'LocalVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the local VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'PeerVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the peer VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-90rq0anm6t8vbwbo****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => 'The connection type of the VPC firewall. The value is fixed as **expressconnect**, which indicates Express Connect circuits.'."\n", + 'type' => 'string', + 'example' => 'expressconnect', + ], + 'VpcFirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125g4d2', + ], + 'Bandwidth' => [ + 'description' => 'The bandwidth of the Express Connect circuit. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VpcFirewallName' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'tf-test', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'The status of the VPC firewall. Valid values:'."\n" + ."\n" + .'* **opened**: The VPC firewall is enabled.'."\n" + .'* **closed**: The VPC firewall is disabled.'."\n" + .'* **notconfigured**: The VPC firewall is not configured.'."\n" + .'* **configured**: The VPC firewall is configured.'."\n", + 'type' => 'string', + 'example' => 'opened', + ], + 'LocalVpc' => [ + 'description' => 'The details about the local VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the local VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'VpcName' => [ + 'description' => 'The name of the local VPC.'."\n", + 'type' => 'string', + 'example' => 'Vitasoy', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the local VPC.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'EniPrivateIpAddress' => [ + 'description' => 'The private IP address of the elastic network interface (ENI) for the local VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'RouterInterfaceId' => [ + 'description' => 'The router interface ID of the local VPC.'."\n", + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'EniId' => [ + 'description' => 'The ID of the ENI for the local VPC.'."\n", + 'type' => 'string', + 'example' => 'eni-8vbhfosfqv2rff42****', + ], + 'VpcCidrTableList' => [ + 'description' => 'The CIDR blocks of the local VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'The ID of the route table for the local VPC.'."\n", + 'type' => 'string', + 'example' => 'vtb-1234', + ], + 'RouteEntryList' => [ + 'description' => 'The route entries of the local VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => 'The instance ID of the next hop for the local VPC.'."\n", + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => 'The destination CIDR block of the local VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'PeerVpc' => [ + 'description' => 'The details about the peer VPC.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the peer VPC.', + 'type' => 'string', + 'example' => 'vpc-90rq0anm6t8vbwbo****', + ], + 'VpcName' => [ + 'description' => 'The name of the peer VPC.', + 'type' => 'string', + 'example' => 'zcy_prod', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the peer VPC.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'EniPrivateIpAddress' => [ + 'description' => 'The private IP address of the ENI for the peer VPC.', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'RouterInterfaceId' => [ + 'description' => 'The router interface ID of the peer VPC.', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'EniId' => [ + 'description' => 'The ID of the ENI for the peer VPC.', + 'type' => 'string', + 'example' => 'eni-8vbhfosfqv2rff42****', + ], + 'VpcCidrTableList' => [ + 'description' => 'The CIDR blocks of the peer VPC.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'The ID of the route table for the peer VPC.', + 'type' => 'string', + 'example' => 'vtb-1256', + ], + 'RouteEntryList' => [ + 'description' => 'The route entries of the peer VPC.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => 'The instance ID of the next hop for the peer VPC.', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => 'The destination CIDR block of the peer VPC.', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'MemberUid' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '258039427902****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallNotFound', + 'errorMessage' => 'Firewall not found', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallStatus', + 'errorMessage' => 'firewall status error.', + ], + [ + 'errorCode' => 'ErrorVpcIdPara', + 'errorMessage' => 'vpc id and firewall id parameter not exist.', + ], + [ + 'errorCode' => 'ErrorLocalVpcIdPeerVpcIdError', + 'errorMessage' => 'local vpc id and peer vpc id cannot be empty at the same time.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConnectType\\": \\"expressconnect\\",\\n \\"VpcFirewallId\\": \\"vfw-m5e7dbc4y****\\",\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125g4d2\\",\\n \\"Bandwidth\\": 2,\\n \\"VpcFirewallName\\": \\"测试防火墙\\",\\n \\"FirewallSwitchStatus\\": \\"opened\\",\\n \\"LocalVpc\\": {\\n \\"VpcId\\": \\"vpc-8vbwbo90rq0anm6t****\\",\\n \\"VpcName\\": \\"测试用实例\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"EniPrivateIpAddress\\": \\"192.168.XX.XX\\",\\n \\"RouterInterfaceId\\": \\"vrt-m5eb5me6c3l5sezae****\\",\\n \\"EniId\\": \\"eni-8vbhfosfqv2rff42****\\",\\n \\"VpcCidrTableList\\": [\\n {\\n \\"RouteTableId\\": \\"vtb-1234\\",\\n \\"RouteEntryList\\": [\\n {\\n \\"NextHopInstanceId\\": \\"vrt-m5eb5me6c3l5sezae****\\",\\n \\"DestinationCidr\\": \\"192.168.XX.XX/24\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"PeerVpc\\": {\\n \\"VpcId\\": \\"vpc-90rq0anm6t8vbwbo****\\",\\n \\"VpcName\\": \\"测试vpc2\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"EniPrivateIpAddress\\": \\"192.168.XX.XX\\",\\n \\"RouterInterfaceId\\": \\"vrt-m5eb5me6c3l5sezae****\\",\\n \\"EniId\\": \\"eni-8vbhfosfqv2rff42****\\",\\n \\"VpcCidrTableList\\": [\\n {\\n \\"RouteTableId\\": \\"vtb-1256\\",\\n \\"RouteEntryList\\": [\\n {\\n \\"NextHopInstanceId\\": \\"vrt-m5eb5me6c3l5sezae****\\",\\n \\"DestinationCidr\\": \\"192.168.XX.XX/24\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"MemberUid\\": \\"258039427902****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcFirewallDetailResponse>\\n <ConnectType>expressconnect</ConnectType>\\n <VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125g4d2</RequestId>\\n <Bandwidth>2</Bandwidth>\\n <VpcFirewallName>测试防火墙</VpcFirewallName>\\n <FirewallSwitchStatus>opened</FirewallSwitchStatus>\\n <LocalVpc>\\n <VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>\\n <VpcName>测试用实例</VpcName>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <EniPrivateIpAddress>192.168.XX.XX</EniPrivateIpAddress>\\n <RouterInterfaceId>vrt-m5eb5me6c3l5sezae****</RouterInterfaceId>\\n <EniId>eni-8vbhfosfqv2rff42****</EniId>\\n <VpcCidrTableList>\\n <RouteTableId>vtb-1234</RouteTableId>\\n <RouteEntryList>\\n <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>\\n <DestinationCidr>192.168.XX.XX/24</DestinationCidr>\\n </RouteEntryList>\\n </VpcCidrTableList>\\n </LocalVpc>\\n <PeerVpc>\\n <VpcId>vpc-90rq0anm6t8vbwbo****</VpcId>\\n <VpcName>测试vpc2</VpcName>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <EniPrivateIpAddress>192.168.XX.XX</EniPrivateIpAddress>\\n <RouterInterfaceId>vrt-m5eb5me6c3l5sezae****</RouterInterfaceId>\\n <EniId>eni-8vbhfosfqv2rff42****</EniId>\\n <VpcCidrTableList>\\n <RouteTableId>vtb-1256</RouteTableId>\\n <RouteEntryList>\\n <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>\\n <DestinationCidr>192.168.XX.XX/24</DestinationCidr>\\n </RouteEntryList>\\n </VpcCidrTableList>\\n </PeerVpc>\\n <MemberUid>258039427902****</MemberUid>\\n</DescribeVpcFirewallDetailResponse>","errorExample":""}]', + 'title' => 'DescribeVpcFirewallDetail', + 'description' => 'You can call the DescribeVpcFirewallDetail operation to query the details about a VPC firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit. '."\n" + ."\n" + .'Before you call the operation, make sure that you created a VPC firewall by calling the [CreateVpcFirewallConfigure](https://www.alibabacloud.com/help/en/cloud-firewall/latest/createvpcfirewallconfigure) operation. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'CreateVpcFirewallConfigure' => [ + 'summary' => 'Creates a Virtual Private Cloud (VPC) firewall to protect traffic between two VPCs that are connected by using an Express Connect.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68135', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'my-vpc-firewall', + ], + ], + [ + 'name' => 'LocalVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the local VPC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'LocalVpcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the local VPC.'."\n" + ."\n" + .'> For more information about the regions in which Cloud Firewall is available, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PeerVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the peer VPC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-wb8vbo90rq0anm6t****', + ], + ], + [ + 'name' => 'PeerVpcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the peer VPC.'."\n" + ."\n" + .'> For more information about Cloud Firewall supported regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the VPC firewall after you create the firewall. Valid values:'."\n" + ."\n" + .'* **open**: After you create the VPC firewall, the VPC firewall is automatically enabled. This is the default value.'."\n" + .'* **close**: After you create the VPC firewall, the VPC firewall is disabled. To enable the firewall, you can call the [ModifyVpcFirewallSwitchStatus](~~342935~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + [ + 'name' => 'LocalVpcCidrTableList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR blocks of the local VPC. The value is a JSON string that contains the following parameters:'."\n" + ."\n" + .'* **RouteTableId**: the ID of the route table for the local VPC.'."\n" + .'* **RouteEntryList**: The value is a JSON string that contains the DestinationCidr and NextHopInstanceId parameters. The DestinationCidr parameter indicates the destination CIDR block of the local VPC. The NextHopInstanceId parameter indicates the instance ID of the next hop for the local VPC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"RouteTableId":"vtb-1234","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]},{"RouteTableId":"vtb-1235","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]}]', + ], + ], + [ + 'name' => 'PeerVpcCidrTableList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR blocks of the peer VPC. The value is a JSON string that contains the following parameters:'."\n" + ."\n" + .'* **RouteTableId**: the ID of the route table for the peer VPC.'."\n" + .'* **RouteEntryList**: The value is a JSON string that contains the DestinationCidr and NextHopInstanceId parameters. The DestinationCidr parameter indicates the destination CIDR block of the peer VPC. The NextHopInstanceId parameter indicates the instance ID of the next hop for the peer VPC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"RouteTableId":"vtb-1234","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]},{"RouteTableId":"vtb-1235","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]}]', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VpcFirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125h4j6', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallName', + 'errorMessage' => 'Firewall name invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallExist', + 'errorMessage' => 'Vpc firewall already exist.', + ], + [ + 'errorCode' => 'ErrorVpcIdError', + 'errorMessage' => 'Vpc ID invalid.', + ], + [ + 'errorCode' => 'ErrorRegionNoError', + 'errorMessage' => 'Region invalid.', + ], + [ + 'errorCode' => 'ErrorDestCidrError', + 'errorMessage' => 'The destination CIDR block is invalid.', + ], + [ + 'errorCode' => 'ErrorDestCidrEmpty', + 'errorMessage' => 'The target network segment is empty and cannot be created', + ], + [ + 'errorCode' => 'ErrorSameCidrIp', + 'errorMessage' => 'The same network segment cannot be configured repeatedly. Please reselect the network segment.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorCidrFormat', + 'errorMessage' => 'Cidr ip format error.', + ], + [ + 'errorCode' => 'ErrorCidrIpAddress', + 'errorMessage' => 'cidr ip error.', + ], + [ + 'errorCode' => 'ErrorCustomRouteEntryMax', + 'errorMessage' => 'custom route exceeds maximum limit.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'Vpc firewall not found.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUidStatus', + 'errorMessage' => 'invalid member uid status.', + ], + [ + 'errorCode' => 'ErrorGeneralInstanceSpecFull', + 'errorMessage' => 'Cloud Firewall instance specifications are full.', + ], + [ + 'errorCode' => 'ErrorBandwidthPenalty', + 'errorMessage' => 'Cloud Firewall bandwidth is being overused.', + ], + [ + 'errorCode' => 'ErrorCenVpcEcConflict', + 'errorMessage' => 'The cloud enterprise network VPC conflicts with the Express Connect VPC.', + ], + [ + 'errorCode' => 'ErrorFirewallQuotaNotEmpty', + 'errorMessage' => 'The quota for VPC firewalls is exceeded.', + ], + [ + 'errorCode' => 'ErrorRouteTableIdNotFound', + 'errorMessage' => 'Route table id not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"VpcFirewallId\\": \\"vfw-m5e7dbc4y****\\",\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125h4j6\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateVpcFirewallConfigureResponse>\\n <VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125h4j6</RequestId>\\n</CreateVpcFirewallConfigureResponse>","errorExample":""}]', + 'title' => 'CreateVpcFirewallConfigure', + 'description' => 'You can call this operation to create a VPC firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit. The VPC firewall does not control the mutual access traffic between VPCs that reside in different regions or belong to different Alibaba Cloud accounts. The firewall also does not control the mutual access traffic between VPCs and virtual border routers (VBRs). For more information, see [VPC firewall limits](~~172295~~).'."\n" + ."\n" + .'### [](#qps)QPS limit'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ModifyVpcFirewallConfigure' => [ + 'summary' => 'Modifies the configurations of a virtual private cloud (VPC) firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68495', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallList](~~342932~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Test firewall'."\n", + ], + ], + [ + 'name' => 'LocalVpcCidrTableList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR blocks of the local VPC. The value is a JSON string that contains the following parameters:'."\n" + ."\n" + .'* **RouteTableId**: the ID of the route table for the local VPC.'."\n" + .'* **RouteEntryList**: The value is a JSON string that contains the DestinationCidr and NextHopInstanceId parameters. The DestinationCidr parameter indicates the destination CIDR block of the local VPC. The NextHopInstanceId parameter indicates the instance ID of the next hop for the local VPC.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallDetail](~~342892~~) operation to query the CIDR blocks of local VPCs for VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"RouteTableId":"vtb-1234","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]},{"RouteTableId":"vtb-1235","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]}]', + ], + ], + [ + 'name' => 'PeerVpcCidrTableList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR blocks of the peer VPC. The value is a JSON string that contains the following parameters:'."\n" + ."\n" + .'* **RouteTableId**: the ID of the route table for the peer VPC.'."\n" + .'* **RouteEntryList**: The value is a JSON string that contains the DestinationCidr and NextHopInstanceId parameters. The DestinationCidr parameter indicates the destination CIDR block of the peer VPC. The NextHopInstanceId parameter indicates the instance ID of the next hop for the peer VPC.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallDetail](~~342892~~) operation to query the CIDR blocks of peer VPCs for VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"RouteTableId":"vtb-1234","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]},{"RouteTableId":"vtb-1235","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]}]', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k6f8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'The specified VPC firewall does not exist. Please select again.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorUnmarshalJSON', + 'errorMessage' => 'An error occurred while parsing JSON.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallId', + 'errorMessage' => 'Firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallName', + 'errorMessage' => 'Firewall name invalid.', + ], + [ + 'errorCode' => 'ErrorDestCidrError', + 'errorMessage' => 'The destination CIDR block is invalid.', + ], + [ + 'errorCode' => 'ErrorDestCidrEmpty', + 'errorMessage' => 'The target network segment is empty and cannot be created', + ], + [ + 'errorCode' => 'ErrorVpcFirewallExist', + 'errorMessage' => 'Vpc firewall already exist.', + ], + [ + 'errorCode' => 'ErrorFirewallStatusCannotModify', + 'errorMessage' => 'Current firewall status, configuration not allowed', + ], + [ + 'errorCode' => 'ErrorSameCidrIp', + 'errorMessage' => 'The same network segment cannot be configured repeatedly. Please reselect the network segment.', + ], + [ + 'errorCode' => 'ErrorCustomRouteEntryMax', + 'errorMessage' => 'The number of target network segments exceeds the maximum limit. Please reduce the number of network segments', + ], + [ + 'errorCode' => 'ErrorCidrFormat', + 'errorMessage' => 'Cidr ip format error.', + ], + [ + 'errorCode' => 'ErrorCidrIpAddress', + 'errorMessage' => 'Target network segment error, please reselect', + ], + [ + 'errorCode' => 'ErrorRouteTableIdNotFound', + 'errorMessage' => 'Route table id not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125k6f8\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyVpcFirewallConfigureResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125k6f8</RequestId>\\n</ModifyVpcFirewallConfigureResponse>","errorExample":""}]', + 'title' => 'ModifyVpcFirewallConfigure', + 'description' => 'You can call the ModifyVpcFirewallConfigure operation to modify the configurations of a VPC firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit. Before you call the operation, make sure that you created a VPC firewall by calling the [CreateVpcFirewallConfigure](~~342893~~) operation.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'ModifyVpcFirewallSwitchStatus' => [ + 'summary' => 'Enables or disables a virtual private cloud (VPC) firewall. The VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68499', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallList](~~342932~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the VPC firewall. Valid values:'."\n" + ."\n" + .'* **open**: yes'."\n" + .'* **close**: no'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125afj2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorFirewallSwitch', + 'errorMessage' => 'The firewall enabling parameter is incorrect. Please select again.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallId', + 'errorMessage' => 'Firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'Vpc firewall not found.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorNetworkInterfaceNotFound', + 'errorMessage' => 'The NIC of the firewall is invalid. Check its configurations.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125afj2\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyVpcFirewallSwitchStatusResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125afj2</RequestId>\\n</ModifyVpcFirewallSwitchStatusResponse>","errorExample":""}]', + 'title' => 'ModifyVpcFirewallSwitchStatus', + 'description' => 'You can call the ModifyVpcFirewallSwitchStatus operation to enable or disable a VPC firewall. The VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit. After you enable the VPC firewall, the VPC firewall protects access traffic between two VPCs that are connected by using an Express Connect circuit. After you disable the VPC firewall, the VPC firewall no longer protects access traffic between two VPCs that are connected by using an Express Connect circuit.'."\n" + ."\n" + .'Before you call the operation, make sure that you created a VPC firewall by calling the [CreateVpcFirewallConfigure](~~342893~~) operation.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DeleteVpcFirewallConfigure' => [ + 'summary' => 'Deletes a virtual private cloud (VPC) firewall that controls traffic between two VPCs. The VPCs are connected by using an Express Connect circuit.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68165', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The instance IDs of VPC firewalls.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallList](~~342932~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k6j3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'The specified VPC firewall does not exist. Please select again.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallId', + 'errorMessage' => 'Firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorFirewallStatus', + 'errorMessage' => 'Firewall status error, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125k6j3\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVpcFirewallConfigureResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125k6j3</RequestId>\\n</DeleteVpcFirewallConfigureResponse>","errorExample":""}]', + 'title' => 'DeleteVpcFirewallConfigure', + 'description' => 'You can call the DeleteVpcFirewallConfigure operation to delete a VPC firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit. Before you call the operation, make sure that you created a VPC firewall by calling the [CreateVpcFirewallConfigure](~~342893~~) operation.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeInternetTimeTop' => [ + 'summary' => '获取互联网流量时间TOP', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68283', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60.179.179.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'out', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'out_pps' => 'out_pps', + 'in_bps' => 'in_bps', + 'out_bps' => 'out_bps', + 'in_pps' => 'in_pps', + ], + 'example' => 'in_bps', + ], + ], + [ + 'name' => 'TrafficTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1745222880', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8.153.18.XX', + ], + ], + [ + 'name' => 'NatIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.97.66.XXX', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1749434787', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1733796528', + ], + ], + [ + 'name' => 'TrafficType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'EIP_TRAFFIC', + ], + ], + [ + 'name' => 'IPType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Private' => '', + 'Public' => '', + ], + 'example' => 'Public', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TrafficTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1734399660', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7F2D5C04-731F-50B0-ADE1-01637B3C****', + ], + 'DataCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '19', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'InBps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '187', + ], + 'ResourceInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'lb-bp14ue2rgktunncq****', + ], + 'NewConn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'OutPps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '183.60.164.XXX', + ], + 'OutBps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'PrivateIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.21.186.XXX', + ], + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + ], + 'example' => 'EcsPublicIP', + ], + 'InPps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalPps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '88', + ], + 'TotalBps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '232', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-wz9o0uzfjuj81fx7m****', + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-wz98eedr5l5hkb8****e7', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'NatIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.97.66.XXX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorDirectionError', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorTrafficType', + 'errorMessage' => 'The traffic type is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorLimitFailed', + 'errorMessage' => 'The limit is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrafficTime\\": 1734399660,\\n \\"RequestId\\": \\"7F2D5C04-731F-50B0-ADE1-01637B3C****\\",\\n \\"DataCount\\": 19,\\n \\"DataList\\": [\\n {\\n \\"ResourceInstanceName\\": \\"test\\",\\n \\"InBps\\": 187,\\n \\"ResourceInstanceId\\": \\"lb-bp14ue2rgktunncq****\\",\\n \\"NewConn\\": 27,\\n \\"RegionNo\\": \\"cn-shenzhen\\",\\n \\"OutPps\\": 2,\\n \\"IP\\": \\"183.60.164.XXX\\",\\n \\"OutBps\\": 45,\\n \\"PrivateIP\\": \\"10.21.186.XXX\\",\\n \\"SessionCount\\": 27,\\n \\"ResourceType\\": \\"EcsPublicIP\\",\\n \\"InPps\\": 2,\\n \\"TotalPps\\": 88,\\n \\"TotalBps\\": 232,\\n \\"VpcId\\": \\"vpc-wz9o0uzfjuj81fx7m****\\",\\n \\"NatGatewayId\\": \\"ngw-wz98eedr5l5hkb8****e7\\",\\n \\"NatGatewayName\\": \\"ngw-test\\",\\n \\"NatIP\\": \\"47.97.66.XXX\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeNatFirewallTimeTop' => [ + 'summary' => '查询NAT防火墙时间点流量详情列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216506', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'SrcPublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.93.47.XXX', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-uf62zzi7000bca7zn****', + ], + ], + [ + 'name' => 'SrcPrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.134.XXX', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'total_max_bps' => 'total_max_bps', + 'out_max_bps' => 'out_max_bps', + 'in_max_bps' => 'in_max_bps', + ], + 'example' => 'total_max_bps', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'TrafficTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1749693960', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C5DDD596-1191-5F36-A504-8733045A****', + ], + 'DataCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TrafficTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1656923760', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.66.231.XXX', + ], + 'InBps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '187', + ], + 'OutBps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'TotalBps' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '232', + ], + 'SessionCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '27', + ], + 'NewConn' => [ + 'description' => '', + 'type' => 'string', + 'example' => '27', + ], + 'ResourceInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-bp130nn8h6157dir****', + ], + 'ResourceInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-uf6pnry5vpawb****', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'NatFirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-tr-7a9c8901ed394****'."\n", + ], + 'NatFirewallName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-test', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5DDD596-1191-5F36-A504-8733045A****\\",\\n \\"DataCount\\": 2,\\n \\"TrafficTime\\": \\"1656923760\\",\\n \\"DataList\\": [\\n {\\n \\"Ip\\": \\"10.66.231.XXX\\",\\n \\"InBps\\": 187,\\n \\"OutBps\\": 45,\\n \\"TotalBps\\": 232,\\n \\"SessionCount\\": \\"27\\",\\n \\"NewConn\\": \\"27\\",\\n \\"ResourceInstanceId\\": \\"i-bp130nn8h6157dir****\\",\\n \\"ResourceInstanceName\\": \\"test\\",\\n \\"RegionNo\\": \\"cn-qingdao\\",\\n \\"NatGatewayId\\": \\"ngw-uf6pnry5vpawb****\\",\\n \\"NatGatewayName\\": \\"ngw-test\\",\\n \\"NatFirewallId\\": \\"vfw-tr-7a9c8901ed394****\\\\n\\",\\n \\"NatFirewallName\\": \\"vfw-test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeNetworkTrafficTopRatio' => [ + 'summary' => '获取网络流量TOP环比', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68316', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60.12.220.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'AssetIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'AssetRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'in_src_location' => '', + 'in_src_ip' => '', + ], + 'example' => 'in_src_ip', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'in', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '39.144.124.XXX', + ], + ], + [ + 'name' => 'DstPort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8080', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1757433863', + ], + ], + [ + 'name' => 'IpProperty', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy', + ], + ], + [ + 'name' => 'Isp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'RuleResult', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'in_bytes' => 'in_bytes', + 'total_bytes' => 'total_bytes', + ], + 'example' => 'in_bytes', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.169.XXX', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1749176793', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'in_src_location' => '', + 'in_src_ip' => '', + ], + 'example' => 'in_src_ip', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C05D58A1-28A9-563A-BB59-5F7D1867****', + ], + 'DataCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DataValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12', + ], + 'DataName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataType\\": \\"in_src_ip\\",\\n \\"RequestId\\": \\"C05D58A1-28A9-563A-BB59-5F7D1867****\\",\\n \\"DataCount\\": 1,\\n \\"DataList\\": [\\n {\\n \\"DataValue\\": \\"12\\",\\n \\"DataName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOutgoingStatistic' => [ + 'summary' => '获取外联统计', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68331', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '117.32.136.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1746554400', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1734920543', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UnknownProtocolRadio' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20.13'."\n", + ], + 'SubscribeDstIPCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalProtocolCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UncoveredAclDstIP' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalDomainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SubscribeDomainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalAssetCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'TotalDstIPCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '107', + ], + 'IgnoreDstIPCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E2BD70F4-48BF-5EFD-B103-F0763E27*****', + ], + 'IgnoreDomainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'IgnoreAssetCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskDstIPCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskAssetCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'UncoveredAclDomain' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskDomainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SubscribeAssetCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PrivateTotalAssetCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'PrivateRiskAssetCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UnknownProtocolRadio\\": \\"20.13\\\\n\\",\\n \\"SubscribeDstIPCount\\": 10,\\n \\"TotalProtocolCount\\": 10,\\n \\"UncoveredAclDstIP\\": 10,\\n \\"TotalDomainCount\\": 10,\\n \\"SubscribeDomainCount\\": 10,\\n \\"TotalAssetCount\\": 13,\\n \\"TotalDstIPCount\\": 107,\\n \\"IgnoreDstIPCount\\": 0,\\n \\"RequestId\\": \\"E2BD70F4-48BF-5EFD-B103-F0763E27*****\\",\\n \\"IgnoreDomainCount\\": 10,\\n \\"IgnoreAssetCount\\": 0,\\n \\"RiskDstIPCount\\": 1,\\n \\"RiskAssetCount\\": 0,\\n \\"UncoveredAclDomain\\": 0,\\n \\"RiskDomainCount\\": 1,\\n \\"SubscribeAssetCount\\": 0,\\n \\"PrivateTotalAssetCount\\": 0,\\n \\"PrivateRiskAssetCount\\": 0\\n}","type":"json"}]', + ], + 'DescribeOutgoingAssetList' => [ + 'summary' => '获取外联资产列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68322', + 'abilityTreeNodes' => [ + 'FEATUREcfwE8FJHT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1743647114', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1736438400', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + ], + 'example' => 'NatEIP', + ], + ], + [ + 'name' => 'AssetsRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'subscribe' => 'subscribe', + 'ignore' => 'ignore', + ], + 'example' => 'subscribe', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.116.70.XXX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.200.33.XXX', + ], + ], + [ + 'name' => 'SecurityRisk', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '', + 'risk' => '', + ], + 'example' => 'risk', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'InBytes' => '', + 'SessionCount' => '', + 'OutBytes' => '', + ], + 'example' => 'InBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'IPType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'NatPrivate', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-bp123456g******', + ], + ], + [ + 'name' => 'NatGatewayName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7A515672-FAAE-584F-B51C-B2586E****', + ], + 'AssetList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + 'EIP' => 'EIP', + ], + 'example' => 'EcsPublicIP', + ], + 'AssetInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-8vbcmllue4d94nto****', + ], + 'GroupName' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'subscribe' => '', + 'ignore' => '', + ], + 'example' => 'subscribe', + ], + 'AssetsRegion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'SecurityRisk' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => '', + 'risk' => '', + ], + 'example' => 'risk', + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '244438.0', + ], + 'PublicIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.96.181.XXX', + ], + 'AssetInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PrivateIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.21.242XXX', + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-bp1utx6wj4x9qu9tl****', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'OutgoingDomainCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OutgoingDstIPCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12498767', + ], + 'PrivateIPList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '["47.256.35.XXX"]', + ], + ], + 'IpsHitCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorSecurityRisk', + 'errorMessage' => 'The security risk is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorSecuritySuggest', + 'errorMessage' => 'The security suggest is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"7A515672-FAAE-584F-B51C-B2586E****\\",\\n \\"AssetList\\": [\\n {\\n \\"SessionCount\\": 2,\\n \\"ResourceType\\": \\"EcsPublicIP\\",\\n \\"AssetInstanceId\\": \\"i-8vbcmllue4d94nto****\\",\\n \\"GroupName\\": \\"subscribe\\",\\n \\"AssetsRegion\\": \\"cn-hangzhou\\",\\n \\"OutBytes\\": 100,\\n \\"SecurityRisk\\": \\"risk\\",\\n \\"InBytes\\": 244438,\\n \\"PublicIP\\": \\"47.96.181.XXX\\",\\n \\"AssetInstanceName\\": \\"test\\",\\n \\"PrivateIP\\": \\"10.21.242XXX\\",\\n \\"NatGatewayId\\": \\"ngw-bp1utx6wj4x9qu9tl****\\",\\n \\"NatGatewayName\\": \\"ngw-test\\",\\n \\"OutgoingDomainCnt\\": 10,\\n \\"OutgoingDstIPCnt\\": 12,\\n \\"TotalBytes\\": 12498767,\\n \\"PrivateIPList\\": [\\n \\"[\\\\\\"47.256.35.XXX\\\\\\"]\\"\\n ],\\n \\"IpsHitCnt\\": 12\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeConfiguredDomainNames' => [ + 'summary' => '获取已配置的域名', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68237', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.202.149.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ignore', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'out', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg_server', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '09A2D6F1-EA1B-56D9-977D-74878405****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'DomainNames' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IsMalicious' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => '0', + ], + 'OperationTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1534408189', + ], + 'DomainName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Comment' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorObjectOperation', + 'errorMessage' => 'The objectOperation is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Module\\": \\"sg_server\\",\\n \\"RequestId\\": \\"09A2D6F1-EA1B-56D9-977D-74878405****\\",\\n \\"TotalCount\\": 16,\\n \\"DomainNames\\": [\\n {\\n \\"IsMalicious\\": true,\\n \\"OperationTime\\": 1534408189,\\n \\"DomainName\\": \\"example.com\\",\\n \\"Comment\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeConfiguredDestinationIP' => [ + 'summary' => '获取已配置的目的IP', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68235', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123.113.99.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'DestinationIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1'."\n", + ], + ], + [ + 'name' => 'DestinationRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'DestinationISP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'subscribe' => 'subscribe', + 'ignore' => 'ignore', + ], + 'example' => 'ignore', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'out', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0AE91F8-E6C5-50D4-983F-FC53672****', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'Destinations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DestinationIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'DestinationRegion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'OperationTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1534408189', + ], + 'DestinationISP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Comment' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorObjectOperation', + 'errorMessage' => 'The objectOperation is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNo\\": 1,\\n \\"RequestId\\": \\"F0AE91F8-E6C5-50D4-983F-FC53672****\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 32,\\n \\"Destinations\\": [\\n {\\n \\"DestinationIP\\": \\"1.1.1.1\\",\\n \\"DestinationRegion\\": \\"cn-shenzhen\\",\\n \\"OperationTime\\": 1534408189,\\n \\"DestinationISP\\": \\"电信\\",\\n \\"Comment\\": \\"测试\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOutgoingDestinationCategory' => [ + 'summary' => '获取外联目的分类', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68325', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '59.82.45.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1749657600', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1750818370', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'All' => '', + 'RiskDomain' => '', + 'AliYun' => '', + 'NotAliYun' => '', + ], + 'example' => 'All', + ], + ], + [ + 'name' => 'TypeId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'All' => '', + 'AliYun' => '', + 'NotAliYun' => '', + ], + 'example' => 'All', + ], + ], + [ + 'name' => 'DstType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DstIP' => '', + 'Domain' => '', + ], + 'example' => 'domain', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C1ED80BC-FFC8-57DB-8151-705DC31****', + ], + 'TypeList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TypeName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TypeId' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => '', + 'AliYun' => '', + 'NotAliYun' => '', + ], + 'example' => 'All', + ], + 'TypeDescribe' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AliYun', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryDescribe' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ClassId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Trusted', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDstType', + 'errorMessage' => 'The dst type is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorObjectOperation', + 'errorMessage' => 'The objectOperation is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"C1ED80BC-FFC8-57DB-8151-705DC31****\\",\\n \\"TypeList\\": [\\n {\\n \\"TypeName\\": \\"阿里云云产品\\",\\n \\"TypeId\\": \\"All\\",\\n \\"TypeDescribe\\": \\"阿里云产品\\",\\n \\"CategoryList\\": [\\n {\\n \\"CategoryId\\": \\"AliYun\\",\\n \\"CategoryName\\": \\"阿里云产品\\",\\n \\"CategoryDescribe\\": \\"阿里云产品\\",\\n \\"ClassId\\": \\"Trusted\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOutgoingTag' => [ + 'summary' => '获取外联标签', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68332', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60.179.226.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1743646544', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1749003483', + ], + ], + [ + 'name' => 'DstType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Domain ', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '103208', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B532203E-813B-5BEB-B75B-315E1D08****', + ], + 'TagList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test tag', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tag-6833388d18cc****', + ], + 'TagDescribe' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test describe', + ], + 'ClassId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Trusted', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"B532203E-813B-5BEB-B75B-315E1D08****\\",\\n \\"TagList\\": [\\n {\\n \\"RiskLevel\\": 0,\\n \\"TagName\\": \\"test tag\\",\\n \\"TagId\\": \\"tag-6833388d18cc****\\",\\n \\"TagDescribe\\": \\"test describe\\",\\n \\"ClassId\\": \\"Trusted\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOutgoingDomain' => [ + 'summary' => 'Queries the information about the domain names in outbound connections.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68328', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => 'The language of the content within the request. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间,Unix timestamp, 精确到秒', + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间,Unix timestamp, 精确到秒', + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1656750960', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数, 不得超过100, 超过100会设置为100', + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 6. Maximum value: 100.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'title' => '分类, 枚举值.'."\n" + .'默认值: 空'."\n" + .'可选值: '."\n" + .'All (全部分类)'."\n" + .'RiskDomain (风险域名分类)'."\n" + .'RiskIP (风险IP分类)'."\n" + .'AliYun (云产品分类)'."\n" + .'NotAliYun (非云产品分类)', + 'description' => 'The type of the service. This parameter is empty by default. Valid values:'."\n" + ."\n" + .'* **All**: all services'."\n" + .'* **RiskDomain**: risky domain names'."\n" + .'* **RiskIP**: risky IP addresses'."\n" + .'* **AliYun**: Alibaba Cloud services'."\n" + .'* **NotAliYun**: third-party services'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'title' => '域名', + 'description' => 'The domain name in outbound connections.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'title' => '公网IP', + 'description' => 'The public IP address of the Elastic Compute Service (ECS) instance that initiates outbound connections.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序, 枚举值, 可选:asc, desc', + 'description' => 'The field based on which you want to sort the query results. Valid values:'."\n" + ."\n" + .'* **SessionCount** (default): the number of requests.'."\n" + .'* **TotalBytes**: the total volume of traffic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SessionCount', + 'enum' => [], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段, 枚举值.'."\n" + .'默认值: SessionCount'."\n" + .'可选值: InBytes, OutBytes,TotalBytes,SessionCount', + 'description' => 'The method that you want to use to sort the query results. Valid values:'."\n" + ."\n" + .'* **asc**'."\n" + .'* **desc** (default)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [], + ], + ], + [ + 'name' => 'TagIdNew', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the tag. Valid values:'."\n" + ."\n" + .'* **AliYun**: Alibaba Cloud service'."\n" + .'* **RiskDomain**: risky domain name'."\n" + .'* **RiskIP**: risky IP address'."\n" + .'* **TrustedDomain**: trusted website'."\n" + .'* **AliPay**: Alipay'."\n" + .'* **DingDing**: DingTalk'."\n" + .'* **WeChat**: WeChat'."\n" + .'* **QQ**: Tencent QQ'."\n" + .'* **SecurityService**: security service'."\n" + .'* **Microsoft**: Microsoft'."\n" + .'* **Amazon**: Amazon Web Services (AWS)'."\n" + .'* **Pan**: cloud disk'."\n" + .'* **Map**: map'."\n" + .'* **Code**: code hosting'."\n" + .'* **SystemService**: system service'."\n" + .'* **Taobao**: Taobao'."\n" + .'* **Google**: Google'."\n" + .'* **ThirdPartyService**: third-party service'."\n" + .'* **FirstFlow**: the first time when an outbound connection is initiated'."\n" + .'* **Downloader**: malicious download'."\n" + .'* **Alexa Top1M**: popular website'."\n" + .'* **Miner**: mining pool'."\n" + .'* **Intelligence**: threat intelligence'."\n" + .'* **DDoS**: DDoS trojan'."\n" + .'* **Ransomware**: ransomware'."\n" + .'* **Spyware**: spyware'."\n" + .'* **Rogue**: rogue software'."\n" + .'* **Botnet**: botnet'."\n" + .'* **Suspicious**: suspicious website'."\n" + .'* **C\\&C**: command and control (C\\&C)'."\n" + .'* **Gang**: gang'."\n" + .'* **CVE**: Common Vulnerabilities and Exposures (CVE)'."\n" + .'* **Backdoor**: webshell'."\n" + .'* **Phishing**: phishing website'."\n" + .'* **APT**: advanced persistent threat (APT) attack'."\n" + .'* **Supply Chain Attack**: supply chain attack'."\n" + .'* **Malicious software**: malware'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliYun', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of traffic for statistics. Valid values:'."\n" + ."\n" + .'* **internet** (default): the Internet firewall.'."\n" + .'* **nat**: NAT firewalls.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nat', + ], + ], + [ + 'name' => 'IsAITraffic', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to collect statistics only on AI service access traffic. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of the domain names in outbound connections.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'DomainList' => [ + 'description' => 'The domain names in outbound connections.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The domain name in the outbound connection.'."\n", + 'type' => 'object', + 'properties' => [ + 'AclCoverage' => [ + 'title' => 'ACL覆盖', + 'description' => 'Indicates whether an access control policy is configured. Valid values:'."\n" + ."\n" + .'* **Uncovered**: no'."\n" + .'* **FullCoverage**: yes'."\n", + 'type' => 'string', + 'example' => 'Uncovered', + ], + 'Domain' => [ + 'title' => '域名', + 'description' => 'The domain name in outbound connections.'."\n", + 'type' => 'string', + 'example' => 'www.aliyundoc.com', + ], + 'AclRecommendDetail' => [ + 'title' => 'ACL推荐内容', + 'description' => 'The suggestion in an access control policy.'."\n", + 'type' => 'string', + 'example' => 'Allows the traffic.'."\n", + ], + 'HasAclRecommend' => [ + 'title' => '是否有ACL推荐规则', + 'description' => 'Indicates whether an access control policy is recommended. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'InBytes' => [ + 'title' => '入流量', + 'description' => 'The volume of inbound traffic.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3214', + ], + 'CategoryName' => [ + 'title' => '分类名称', + 'description' => 'The type of the service to which the domain name belongs. Valid values:'."\n" + ."\n" + .'* **Alibaba Cloud services**'."\n" + .'* **Third-party services**'."\n", + 'type' => 'string', + 'example' => 'Alibaba Cloud services'."\n", + ], + 'RuleName' => [ + 'title' => '规则名称', + 'description' => 'The name of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'Default rule'."\n", + ], + 'RuleId' => [ + 'title' => 'ACL规则ID', + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'add-dfadf-f****', + ], + 'SessionCount' => [ + 'title' => '会话数', + 'description' => 'The number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'GroupName' => [ + 'title' => '规则中的组名称', + 'description' => 'The name of the group to which the access control policy belongs.'."\n", + 'type' => 'string', + 'example' => 'Group of addresses in outbound connections'."\n", + ], + 'SecuritySuggest' => [ + 'title' => '安全建议', + 'description' => 'The suggestion to handle the traffic of the domain name in outbound connections. Valid values:'."\n" + ."\n" + .'* **pass**: allow'."\n" + .'* **alert**: monitor'."\n" + .'* **drop**: deny'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'OutBytes' => [ + 'title' => '出流量', + 'description' => 'The volume of outbound traffic.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4582', + ], + 'AclStatus' => [ + 'title' => 'ACL状态', + 'description' => 'The state of the access control policy. Valid values:'."\n" + ."\n" + .'* **normal**: healthy'."\n" + .'* **abnormal**: unhealthy'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'IsMarkNormal' => [ + 'title' => '是否正常', + 'description' => 'Indicates whether the domain name is marked as normal. Valid values:'."\n" + ."\n" + .'* **true**: normal'."\n" + .'* **false**: abnormal'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CategoryId' => [ + 'title' => '分类ID', + 'description' => 'The type ID of the service to which the domain name belongs. Valid values:'."\n" + ."\n" + .'* **Aliyun**: Alibaba Cloud services'."\n" + .'* **NotAliyun**: third-party services'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'AddressGroupUUID' => [ + 'title' => '地址簿UUID', + 'description' => 'The UUID of the address book.'."\n", + 'type' => 'string', + 'example' => 'fdad-fdafa-dafa-dfa****', + ], + 'AddressGroupName' => [ + 'title' => '地址簿名称', + 'description' => 'The name of the address book.'."\n", + 'type' => 'string', + 'example' => 'The address book for outbound connections'."\n", + ], + 'CategoryClassId' => [ + 'description' => 'The type of the tag. Valid values:'."\n" + ."\n" + .'* **Suspicious**'."\n" + .'* **Malicious**'."\n" + .'* **Trusted**'."\n", + 'type' => 'string', + 'example' => 'Trusted', + ], + 'Business' => [ + 'description' => 'The website service.'."\n", + 'type' => 'string', + 'example' => 'Alibaba Cloud'."\n", + ], + 'HasAcl' => [ + 'description' => 'Indicates whether an `access control policy` is configured for the domain name. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false**: no'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'Organization' => [ + 'description' => 'The name of the organization.'."\n", + 'type' => 'string', + 'example' => 'Alibaba Cloud Computing Co., Ltd.'."\n", + ], + 'SecurityReason' => [ + 'description' => 'The reason why the domain name is secure.'."\n", + 'type' => 'string', + 'example' => 'Intelligent policy: The destination domain name belongs to Alibaba Cloud Computing Co., Ltd. The domain name mainly provides services for Alibaba Cloud. No security risks are found, and you can add the domain name to the whitelist.'."\n", + ], + 'TotalBytes' => [ + 'description' => 'The total volume of traffic. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '800', + ], + 'TagList' => [ + 'description' => 'An array that consists of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Tag list object.', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'title' => '风险等级', + 'description' => 'The risk level. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TagName' => [ + 'title' => '标签名称', + 'description' => 'The name of the tag.'."\n", + 'type' => 'string', + 'example' => 'Tag indicating that the domain name is added to the whitelist'."\n", + ], + 'TagId' => [ + 'title' => '标签ID', + 'description' => 'The ID of the tag.'."\n", + 'type' => 'string', + 'example' => 'AliYun', + ], + 'TagDescribe' => [ + 'title' => '标签描述', + 'description' => 'The description of the tag.'."\n", + 'type' => 'string', + 'example' => 'Tag indicating that the domain name is added to the whitelist'."\n", + ], + 'ClassId' => [ + 'description' => 'The type of the tag. Valid values:'."\n" + ."\n" + .'* **Suspicious**'."\n" + .'* **Malicious**'."\n" + .'* **Trusted**'."\n", + 'type' => 'string', + 'example' => 'Trusted', + ], + ], + ], + ], + 'ApplicationNameList' => [ + 'description' => 'The application names.', + 'type' => 'array', + 'items' => [ + 'description' => 'The application names.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + 'AssetCount' => [ + 'description' => 'The outbound asset count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PrivateAssetCount' => [ + 'description' => 'The outbound private asset count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorSecuritySuggest', + 'errorMessage' => 'The security suggest is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainName', + 'errorMessage' => 'The domain name is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 132,\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"DomainList\\": [\\n {\\n \\"AclCoverage\\": \\"Uncovered\\",\\n \\"Domain\\": \\"www.aliyundoc.com\\",\\n \\"AclRecommendDetail\\": \\"建议放行\\",\\n \\"HasAclRecommend\\": true,\\n \\"InBytes\\": 3214,\\n \\"CategoryName\\": \\"阿里云产品\\",\\n \\"RuleName\\": \\"默认规则\\",\\n \\"RuleId\\": \\"add-dfadf-f****\\",\\n \\"SessionCount\\": 12,\\n \\"GroupName\\": \\"外量地址组\\",\\n \\"SecuritySuggest\\": \\"pass\\",\\n \\"OutBytes\\": 4582,\\n \\"AclStatus\\": \\"Normal\\",\\n \\"IsMarkNormal\\": true,\\n \\"CategoryId\\": \\"Aliyun\\",\\n \\"AddressGroupUUID\\": \\"fdad-fdafa-dafa-dfa****\\",\\n \\"AddressGroupName\\": \\"外联地址簿\\",\\n \\"CategoryClassId\\": \\"Trusted\\",\\n \\"Business\\": \\"阿里云\\",\\n \\"HasAcl\\": \\"true\\",\\n \\"Organization\\": \\"阿里云计算有限公司\\",\\n \\"SecurityReason\\": \\"智能策略：该目的域名所属组织为阿里云计算有限公司，主要业务为阿里云，未发现安全风险，可用于配置外联白名单。\\",\\n \\"TotalBytes\\": \\"800\\",\\n \\"TagList\\": [\\n {\\n \\"RiskLevel\\": 3,\\n \\"TagName\\": \\"加白标签\\",\\n \\"TagId\\": \\"AliYun\\",\\n \\"TagDescribe\\": \\"加白标签\\",\\n \\"ClassId\\": \\"Trusted\\"\\n }\\n ],\\n \\"ApplicationNameList\\": [\\n \\"HTTP\\"\\n ],\\n \\"AssetCount\\": 20,\\n \\"PrivateAssetCount\\": 20\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeOutgoingDomainResponse>\\n <TotalCount>132</TotalCount>\\n <RequestId>F0F82705-CFC7-5F83-86C8-A063892F****</RequestId>\\n <DomainList>\\n <AclCoverage>Uncovered</AclCoverage>\\n <Domain>www.aliyundoc.com</Domain>\\n <AclRecommendDetail>建议放行</AclRecommendDetail>\\n <HasAclRecommend>true</HasAclRecommend>\\n <InBytes>3214</InBytes>\\n <CategoryName>阿里云产品</CategoryName>\\n <RuleName>默认规则</RuleName>\\n <RuleId>add-dfadf-f****</RuleId>\\n <SessionCount>12</SessionCount>\\n <GroupName>外量地址组</GroupName>\\n <SecuritySuggest>pass</SecuritySuggest>\\n <OutBytes>4582</OutBytes>\\n <AclStatus>Normal</AclStatus>\\n <IsMarkNormal>true</IsMarkNormal>\\n <CategoryId>Aliyun</CategoryId>\\n <AddressGroupUUID>fdad-fdafa-dafa-dfa****</AddressGroupUUID>\\n <AddressGroupName>外联地址簿</AddressGroupName>\\n <CategoryClassId>Trusted</CategoryClassId>\\n <Business>阿里云</Business>\\n <HasAcl>true</HasAcl>\\n <Organization>阿里云计算有限公司</Organization>\\n <SecurityReason>智能策略：该目的域名所属组织为阿里云计算有限公司，主要业务为阿里云，未发现安全风险，可用于配置外联白名单。</SecurityReason>\\n <TotalBytes>800</TotalBytes>\\n <TagList>\\n <RiskLevel>3</RiskLevel>\\n <TagName>加白标签</TagName>\\n <TagId>AliYun</TagId>\\n <TagDescribe>加白标签</TagDescribe>\\n <ClassId>Trusted</ClassId>\\n </TagList>\\n </DomainList>\\n</DescribeOutgoingDomainResponse>","errorExample":""}]', + 'title' => 'DescribeOutgoingDomain', + 'translator' => 'machine', + ], + 'DescribeOutgoingDomainDetail' => [ + 'summary' => '获取外联域名详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68329', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '121.15.137.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh（默认）' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh（默认）' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1753617600', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1733450528', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'FirstFlow' => '', + 'Period' => '', + ], + 'example' => 'FirstFlow', + ], + ], + [ + 'name' => 'AclCoverage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'All' => '', + 'FullCoverage' => '', + 'Uncovered' => '', + 'PartialCoverage' => '', + ], + 'example' => 'FullCoverage', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com'."\n", + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.96.181.XXX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.210.0.XXX', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'InBytes' => '', + 'SessionCount' => '', + 'OutBytes' => '', + ], + 'example' => 'OutBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'IPType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'NatPrivate', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-uf62zzi7000bca7zn****', + ], + ], + [ + 'name' => 'DomainList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[\'example.com\']'."\n", + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98AF5888-9606-59CF-888F-032A9ED0****', + ], + 'ApplicationNameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[\'HTTP\', \'HTTPS\']', + ], + ], + 'AssetList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AclCoverage' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => '', + 'FullCoverage' => '', + 'Uncovered' => '', + 'PartialCoverage' => '', + ], + 'example' => 'FullCoverage', + ], + 'ResourceInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-uf63wjhyoohc1g4z****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '244438.0', + ], + 'FirstTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1738548990', + ], + 'PrivateIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.21.242XXX', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '08a58465-ff4d-4c47-8782-eb008301****', + ], + 'RuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'LastTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1739326614', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + 'EIP' => 'EIP', + ], + 'example' => 'NatEIP', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PublicIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.96.181.XXX', + ], + 'TagList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + '', + '', + ], + 'example' => '0', + ], + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'FirstFlow' => '', + 'Period' => '', + ], + 'example' => 'FirstFlow', + ], + 'TagDescribe' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ClassId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + ], + ], + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'string', + 'example' => '321120825843', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-9dp16jgwgyvn****', + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-bp1utx6wj4x9qu9tl****', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'IpsHitCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'Domain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainName', + 'errorMessage' => 'The domain name is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 8,\\n \\"RequestId\\": \\"98AF5888-9606-59CF-888F-032A9ED0****\\",\\n \\"ApplicationNameList\\": [\\n \\"[\'HTTP\', \'HTTPS\']\\"\\n ],\\n \\"AssetList\\": [\\n {\\n \\"AclCoverage\\": \\"FullCoverage\\",\\n \\"ResourceInstanceName\\": \\"test\\",\\n \\"ResourceInstanceId\\": \\"i-uf63wjhyoohc1g4z****\\",\\n \\"RegionNo\\": \\"cn-beijing\\",\\n \\"InBytes\\": 244438,\\n \\"FirstTime\\": 1738548990,\\n \\"PrivateIP\\": \\"10.21.242XXX\\",\\n \\"RuleId\\": \\"08a58465-ff4d-4c47-8782-eb008301****\\",\\n \\"RuleName\\": \\"test\\",\\n \\"SessionCount\\": 10,\\n \\"LastTime\\": 1739326614,\\n \\"ResourceType\\": \\"NatEIP\\",\\n \\"OutBytes\\": 100,\\n \\"PublicIP\\": \\"47.96.181.XXX\\",\\n \\"TagList\\": [\\n {\\n \\"RiskLevel\\": 0,\\n \\"TagName\\": \\"test\\",\\n \\"TagId\\": \\"FirstFlow\\",\\n \\"TagDescribe\\": \\"test\\",\\n \\"ClassId\\": \\"3\\"\\n }\\n ],\\n \\"TotalBytes\\": \\"321120825843\\",\\n \\"VpcId\\": \\"vpc-9dp16jgwgyvn****\\",\\n \\"NatGatewayId\\": \\"ngw-bp1utx6wj4x9qu9tl****\\",\\n \\"NatGatewayName\\": \\"ngw-test\\",\\n \\"IpsHitCnt\\": 32,\\n \\"Domain\\": \\"example.com\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOutgoingDestination' => [ + 'summary' => '获取外联目的', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68324', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '106.3.198.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1749657600', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1749089441', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RiskDomain' => '', + 'AliYun' => '', + 'NotAliYun' => '', + ], + 'example' => 'AliYun', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'FirstFlow', + ], + ], + [ + 'name' => 'SecuritySuggest', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'drop' => '', + 'pass' => '', + 'alert' => '', + ], + 'example' => 'pass', + ], + ], + [ + 'name' => 'AclCoverage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'FullCoverage', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.111XXX', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.96.74.XXX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.111.53XXX', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'InBytes' => 'InBytes', + 'TotalBytes' => 'TotalBytes', + 'SessionCount' => 'SessionCount', + 'OutBytes' => 'OutBytes', + ], + 'example' => 'InBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'IsAITraffic', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '42', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A2845BA9-1642-5B27-9F04-8014DD94****', + ], + 'DstList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DstIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '101.6.15.XXX', + ], + 'AclRecommendDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'HasAclRecommend' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'false' => '', + 'true' => '', + ], + 'example' => 'false', + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'DstType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'domain', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'categor_test', + ], + 'DstDomain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example.com', + ], + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'GroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'AclStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'Normal' => '', + 'Abnormal' => '', + ], + 'example' => 'Normal', + ], + 'CategoryId' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'RiskDomain' => '', + 'AliYun' => '', + 'NotAliYun' => '', + ], + 'example' => 'AliYun', + ], + 'IsMarkNormal' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'false', + ], + 'TagList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + '', + '', + ], + 'example' => '1', + ], + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'verify', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FirstFlow', + ], + 'TagDescribe' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'Business' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 42,\\n \\"RequestId\\": \\"A2845BA9-1642-5B27-9F04-8014DD94****\\",\\n \\"DstList\\": [\\n {\\n \\"DstIP\\": \\"101.6.15.XXX\\",\\n \\"AclRecommendDetail\\": \\"test\\",\\n \\"HasAclRecommend\\": false,\\n \\"InBytes\\": 0,\\n \\"DstType\\": \\"domain\\",\\n \\"CategoryName\\": \\"categor_test\\",\\n \\"DstDomain\\": \\"example.com\\",\\n \\"SessionCount\\": 10,\\n \\"GroupName\\": \\"test\\",\\n \\"OutBytes\\": 0,\\n \\"AclStatus\\": \\"Normal\\",\\n \\"CategoryId\\": \\"AliYun\\",\\n \\"IsMarkNormal\\": false,\\n \\"TagList\\": [\\n {\\n \\"RiskLevel\\": 1,\\n \\"TagName\\": \\"verify\\",\\n \\"TagId\\": \\"FirstFlow\\",\\n \\"TagDescribe\\": \\"test\\"\\n }\\n ],\\n \\"Business\\": \\"example.com\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOutgoingDestinationIP' => [ + 'summary' => 'Get details of outgoing destination IPs', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68326', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言', + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间,Unix timestamp, 精确到秒', + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1656837360', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1656923760', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 6. Maximum value: 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'title' => '分类, 枚举值.'."\n" + .'默认值: 空'."\n" + .'可选值: '."\n" + .'All (全部分类)'."\n" + .'RiskDomain (风险域名分类)'."\n" + .'RiskIP (风险IP分类)'."\n" + .'AliYun (云产品分类)'."\n" + .'NotAliYun (非云产品分类)', + 'description' => 'The ID of the service to which the destination IP address belongs. This parameter is left empty by default. Valid values:'."\n" + ."\n" + .'* **All**: all services'."\n" + .'* **RiskDomain**: risky domain names'."\n" + .'* **RiskIP**: risky IP addresses'."\n" + .'* **AliYun**: Alibaba Cloud services'."\n" + .'* **NotAliYun**: third-party services'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'title' => '目的IP', + 'description' => 'The destination IP address in the outbound connection that is initiated to access a domain name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'title' => '公网IP', + 'description' => 'The public IP address of the Elastic Compute Service (ECS) instance that initiates the outbound connection.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'title' => '私网IP', + 'description' => 'The private IP address of the ECS instance that initiates the outbound connection.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'title' => '端口号', + 'description' => 'The port number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序, 枚举值, 可选:asc, desc', + 'description' => 'The field based on which you want to sort the query results. Valid values:'."\n" + ."\n" + .'* **SessionCount** (default): the number of requests.'."\n" + .'* **TotalBytes**: the total volume of traffic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SessionCount', + 'enum' => [], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段, 枚举值.'."\n" + .'默认值: SessionCount'."\n" + .'可选值: InBytes, OutBytes,TotalBytes,SessionCount', + 'description' => 'The method that you want to use to sort the query results. Valid values:'."\n" + ."\n" + .'* **asc**'."\n" + .'* **desc** (default)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [], + ], + ], + [ + 'name' => 'TagIdNew', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the tag. Valid values:'."\n" + ."\n" + .'* **AliYun**: Alibaba Cloud service'."\n" + .'* **RiskDomain**: risky domain name'."\n" + .'* **RiskIP**: risky IP address'."\n" + .'* **TrustedDomain**: trusted website'."\n" + .'* **AliPay**: Alipay'."\n" + .'* **DingDing**: DingTalk'."\n" + .'* **WeChat**: WeChat'."\n" + .'* **QQ**: Tencent QQ'."\n" + .'* **SecurityService**: security service'."\n" + .'* **Microsoft**: Microsoft'."\n" + .'* **Amazon**: Amazon Web Services (AWS)'."\n" + .'* **Pan**: cloud disk'."\n" + .'* **Map**: map'."\n" + .'* **Code**: code hosting'."\n" + .'* **SystemService**: system service'."\n" + .'* **Taobao**: Taobao'."\n" + .'* **Google**: Google'."\n" + .'* **ThirdPartyService**: third-party service'."\n" + .'* **FirstFlow**: the first time'."\n" + .'* **Downloader**: malicious download'."\n" + .'* **Alexa Top1M**: popular website'."\n" + .'* **Miner**: mining pool'."\n" + .'* **Intelligence**: threat intelligence'."\n" + .'* **DDoS**: DDoS trojan'."\n" + .'* **Ransomware**: ransomware'."\n" + .'* **Spyware**: spyware'."\n" + .'* **Rogue**: rogue software'."\n" + .'* **Botnet**: botnet'."\n" + .'* **Suspicious**: suspicious website'."\n" + .'* **C\\&C**: command and control (C\\&C)'."\n" + .'* **Gang**: gang'."\n" + .'* **CVE**: Common Vulnerabilities and Exposures (CVE)'."\n" + .'* **Backdoor**: webshell'."\n" + .'* **Phishing**: phishing website'."\n" + .'* **APT**: advanced persistent threat (APT) attack'."\n" + .'* **Supply Chain Attack**: supply chain attack'."\n" + .'* **Malicious software**: malware'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliYun', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application type in the access control policy. Valid values:'."\n" + ."\n" + .'* **FTP**'."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **Memcache**'."\n" + .'* **MongoDB**'."\n" + .'* **MQTT**'."\n" + .'* **MySQL**'."\n" + .'* **RDP**'."\n" + .'* **Redis**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **SSH**'."\n" + .'* **SSL_No_Cert**'."\n" + .'* **SSL**'."\n" + .'* **VNC**'."\n" + ."\n" + .'> The value of this parameter depends on the value of Proto. If you set Proto to TCP, you can set ApplicationNameList to any valid value. If you specify both ApplicationNameList and ApplicationName, only the value of ApplicationNameList is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FTP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of destination IP addresses in outbound connections.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'DstIPList' => [ + 'title' => '外联IP列表', + 'description' => 'The IP addresses in outbound connections.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'object', + 'properties' => [ + 'AclCoverage' => [ + 'title' => 'ACL覆盖', + 'description' => 'Indicates whether an access control policy is configured. Valid values:'."\n" + ."\n" + .'* **Uncovered**: no'."\n" + .'* **FullCoverage**: yes'."\n", + 'type' => 'string', + 'example' => 'Uncovered', + ], + 'DstIP' => [ + 'title' => '目的IP', + 'description' => 'The destination IP addresses in outbound connections.'."\n", + 'type' => 'string', + 'example' => '10.0.XX.XX', + ], + 'AclRecommendDetail' => [ + 'title' => 'ACL推荐内容', + 'description' => 'The suggestion to configure an access control policy.'."\n", + 'type' => 'string', + 'example' => 'Allows the traffic.'."\n", + ], + 'HasAclRecommend' => [ + 'title' => '是否有推荐ACL', + 'description' => 'Indicates whether an access control policy is recommended. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'InBytes' => [ + 'title' => '入方向流量', + 'description' => 'The inbound traffic. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '472', + ], + 'CategoryName' => [ + 'title' => '分类名称', + 'description' => 'The type of the service to which the destination IP address belongs. Valid values:'."\n" + ."\n" + .'* **Alibaba Cloud services**'."\n" + .'* **Third-party services**'."\n", + 'type' => 'string', + 'example' => 'Alibaba Cloud services'."\n", + ], + 'RuleName' => [ + 'title' => '规则名称', + 'description' => 'The name of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'Default rule'."\n", + ], + 'RuleId' => [ + 'title' => '规则UUID', + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'fadsfd-dfadf-df****', + ], + 'SessionCount' => [ + 'title' => '会话数', + 'description' => 'The number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'GroupName' => [ + 'title' => '规则中的组名称', + 'description' => 'The name of the group to which the access control policy belongs.'."\n", + 'type' => 'string', + 'example' => 'Rule_test'."\n", + ], + 'SecuritySuggest' => [ + 'title' => '安全建议', + 'description' => 'The suggestion to handle the traffic of the domain name in outbound connections. Valid values:'."\n" + ."\n" + .'* **pass**: allow'."\n" + .'* **alert**: deny'."\n" + .'* **drop**: monitor'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'OutBytes' => [ + 'title' => '出流量', + 'description' => 'The outbound traffic. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '965', + ], + 'AclStatus' => [ + 'title' => 'ACL状态', + 'description' => 'The status of the access control policy. Valid values:'."\n" + ."\n" + .'* **normal**: healthy'."\n" + .'* **Abnormal**: unhealthy'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'IsMarkNormal' => [ + 'title' => '是否正常', + 'description' => 'Indicates whether the destination IP address is added to a whitelist. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'CategoryId' => [ + 'title' => '分类ID', + 'description' => 'The ID of the service type. Valid values:'."\n" + ."\n" + .'* **Aliyun**: Alibaba Cloud services'."\n" + .'* **NotAliyun**: third-party services'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'TagList' => [ + 'title' => '标签列表', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'title' => '风险等级', + 'description' => 'The risk level. Valid values:'."\n" + ."\n" + .'* **1**: low.'."\n" + .'* **2**: medium.'."\n" + .'* **3**: high.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [], + ], + 'TagName' => [ + 'title' => '标签名', + 'description' => 'The name of the tag.'."\n", + 'type' => 'string', + 'example' => 'Tag that indicates traffic is allowed'."\n", + ], + 'TagId' => [ + 'title' => '标签ID', + 'description' => 'The ID of the tag.'."\n", + 'type' => 'string', + 'example' => 'AliYun', + ], + 'TagDescribe' => [ + 'title' => '标签描述', + 'description' => 'The description of the tag.'."\n", + 'type' => 'string', + 'example' => 'Tag that indicates traffic is allowed'."\n", + ], + 'ClassId' => [ + 'description' => 'The type of the tag. Valid values:'."\n" + ."\n" + .'* **Suspicious**'."\n" + .'* **Malicious**'."\n" + .'* **Trusted**'."\n", + 'type' => 'string', + 'example' => 'Trusted', + ], + ], + ], + ], + 'ApplicationPortList' => [ + 'description' => 'The application ports.'."\n" + ."\n" + .'> Only the first 100 application ports are displayed.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '端口列表', + 'description' => 'The ports.'."\n", + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'title' => '端口', + 'description' => 'The application port.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ApplicationName' => [ + 'title' => '应用名', + 'description' => 'The application type used in the access control policy. Valid values:'."\n" + ."\n" + .'* **FTP**'."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **Memcache**'."\n" + .'* **MongoDB**'."\n" + .'* **MQTT**'."\n" + .'* **MySQL**'."\n" + .'* **RDP**'."\n" + .'* **Redis**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **SSH**'."\n" + .'* **SSL_No_Cert**'."\n" + .'* **SSL**'."\n" + .'* **VNC**'."\n" + ."\n" + .'> The value of this parameter depends on the value of the Proto parameter. If you set Proto to TCP, you can set ApplicationNameList to any valid value. If you configure both ApplicationNameList and ApplicationName, only the value of ApplicationNameList is used.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'UnknownReason' => [ + 'description' => 'List of reasons for failing to analyze the protocol when it is identified as Unknown.', + 'type' => 'array', + 'items' => [ + 'description' => 'Reasons for protocol analysis failure.', + 'type' => 'string', + 'example' => 'tcp_not_establish', + ], + ], + ], + ], + ], + 'CategoryClassId' => [ + 'description' => 'The type of the tag. Valid values:'."\n" + ."\n" + .'* **Suspicious**'."\n" + .'* **Malicious**'."\n" + .'* **Trusted**'."\n", + 'type' => 'string', + 'example' => 'Trusted', + ], + 'SecurityReason' => [ + 'description' => 'The reason why the domain name is secure.'."\n", + 'type' => 'string', + 'example' => 'Intelligent policy: The destination domain name belongs to Alibaba Cloud Computing Co., Ltd. The domain name mainly provides services for Alibaba Cloud. No security risks are found, and you can add the domain name to the whitelist.'."\n", + ], + 'TotalBytes' => [ + 'description' => 'The total traffic. Unit: bytes'."\n", + 'type' => 'string', + 'example' => '800', + ], + 'HasAcl' => [ + 'description' => 'Indicates whether an access control policy is configured. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'AddressGroupList' => [ + 'description' => 'The information about the address book.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressGroupUUID' => [ + 'description' => 'The UUID of the address book.'."\n", + 'type' => 'string', + 'example' => 'f04ac7ce-628b-4cb7-be61-310222b7****', + ], + 'AddressGroupName' => [ + 'description' => 'The name of the address book.'."\n", + 'type' => 'string', + 'example' => 'IP address book'."\n", + ], + ], + ], + ], + 'AssetCount' => [ + 'description' => 'The outbound asset count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PrivateAssetCount' => [ + 'description' => 'The outbound private asset count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'LocationName' => [ + 'description' => 'Location name.', + 'type' => 'string', + 'example' => 'Qingdao, Shandong', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorPortError', + 'errorMessage' => 'The port is invalid.', + ], + [ + 'errorCode' => 'ErrorSecuritySuggest', + 'errorMessage' => 'The security suggest is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 50,\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"DstIPList\\": [\\n {\\n \\"AclCoverage\\": \\"Uncovered\\",\\n \\"DstIP\\": \\"10.0.XX.XX\\",\\n \\"AclRecommendDetail\\": \\"建议放行\\",\\n \\"HasAclRecommend\\": true,\\n \\"InBytes\\": 472,\\n \\"CategoryName\\": \\"阿里云产品\\",\\n \\"RuleName\\": \\"默认规则\\",\\n \\"RuleId\\": \\"fadsfd-dfadf-df****\\",\\n \\"SessionCount\\": 4,\\n \\"GroupName\\": \\"规则_test\\",\\n \\"SecuritySuggest\\": \\"pass\\",\\n \\"OutBytes\\": 965,\\n \\"AclStatus\\": \\"Normal\\",\\n \\"IsMarkNormal\\": true,\\n \\"CategoryId\\": \\"Aliyun\\",\\n \\"TagList\\": [\\n {\\n \\"RiskLevel\\": 1,\\n \\"TagName\\": \\"放行标签\\",\\n \\"TagId\\": \\"AliYun\\",\\n \\"TagDescribe\\": \\"放行标签\\",\\n \\"ClassId\\": \\"Trusted\\"\\n }\\n ],\\n \\"ApplicationPortList\\": [\\n {\\n \\"Port\\": 80,\\n \\"ApplicationName\\": \\"HTTP\\",\\n \\"UnknownReason\\": [\\n \\"tcp_not_establish\\"\\n ]\\n }\\n ],\\n \\"CategoryClassId\\": \\"Trusted\\",\\n \\"SecurityReason\\": \\"智能策略：该目的域名所属组织为阿里云计算有限公司，主要业务为阿里云，未发现安全风险，可用于配置外联白名单。\\",\\n \\"TotalBytes\\": \\"800\\",\\n \\"HasAcl\\": \\"true\\",\\n \\"AddressGroupList\\": [\\n {\\n \\"AddressGroupUUID\\": \\"f04ac7ce-628b-4cb7-be61-310222b7****\\",\\n \\"AddressGroupName\\": \\"IP地址簿\\"\\n }\\n ],\\n \\"AssetCount\\": 20,\\n \\"PrivateAssetCount\\": 20,\\n \\"LocationName\\": \\"山东省青岛市\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeOutgoingDestinationIPResponse>\\n <TotalCount>50</TotalCount>\\n <RequestId>F0F82705-CFC7-5F83-86C8-A063892F****</RequestId>\\n <DstIPList>\\n <AclCoverage>Uncovered</AclCoverage>\\n <DstIP>10.0.XX.XX</DstIP>\\n <AclRecommendDetail>建议放行</AclRecommendDetail>\\n <HasAclRecommend>true</HasAclRecommend>\\n <InBytes>472</InBytes>\\n <CategoryName>阿里云产品</CategoryName>\\n <RuleName>默认规则</RuleName>\\n <RuleId>fadsfd-dfadf-df****</RuleId>\\n <SessionCount>4</SessionCount>\\n <GroupName>规则_test</GroupName>\\n <SecuritySuggest>pass</SecuritySuggest>\\n <OutBytes>965</OutBytes>\\n <AclStatus>Normal</AclStatus>\\n <IsMarkNormal>true</IsMarkNormal>\\n <CategoryId>Aliyun</CategoryId>\\n <TagList>\\n <RiskLevel>1</RiskLevel>\\n <TagName>放行标签</TagName>\\n <TagId>AliYun</TagId>\\n <TagDescribe>放行标签</TagDescribe>\\n <ClassId>Trusted</ClassId>\\n </TagList>\\n <ApplicationPortList>\\n <Port>80</Port>\\n <ApplicationName>HTTP</ApplicationName>\\n </ApplicationPortList>\\n <CategoryClassId>Trusted</CategoryClassId>\\n <SecurityReason>智能策略：该目的域名所属组织为阿里云计算有限公司，主要业务为阿里云，未发现安全风险，可用于配置外联白名单。</SecurityReason>\\n <TotalBytes>800</TotalBytes>\\n <HasAcl>true</HasAcl>\\n <AddressGroupList>\\n <AddressGroupUUID>f04ac7ce-628b-4cb7-be61-310222b7****</AddressGroupUUID>\\n <AddressGroupName>IP地址簿</AddressGroupName>\\n </AddressGroupList>\\n </DstIPList>\\n</DescribeOutgoingDestinationIPResponse>","errorExample":""}]', + 'title' => 'DescribeOutgoingDestinationIP', + 'translator' => 'machine', + ], + 'DescribeOutgoingDestinationIPDetail' => [ + 'summary' => '获取外联目的IP详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68327', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.202.193.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1749434787', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1733710383', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'FirstFlow' => '', + 'Period' => '', + ], + 'example' => 'FirstFlow', + ], + ], + [ + 'name' => 'AclCoverage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'All' => '', + 'FullCoverage' => '', + 'Uncovered' => '', + 'PartialCoverage' => '', + ], + 'example' => 'FullCoverage', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '34.136.111.XXX', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.210.0.XXX', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'InBytes' => '', + 'SessionCount' => '', + 'OutBytes' => '', + ], + 'example' => 'InBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'IPType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'NatPrivate', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-2zed6z6qkd7ogc****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LocationName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'IspName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'AssetList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AclCoverage' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => '', + 'FullCoverage' => '', + 'Uncovered' => '', + 'PartialCoverage' => '', + ], + 'example' => 'FullCoverage', + ], + 'ResourceInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-uf63wjhyoohc1g4z****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'LocationName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FirstTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1744682438', + ], + 'PrivateIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.21.242XXX', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '08a58465-ff4d-4c47-8782-eb008301****', + ], + 'RuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'LastTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1739326614', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + 'EIP' => 'EIP', + ], + 'example' => 'EcsPublicIP', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'IspName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PublicIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.96.181.XXX', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'string', + 'example' => '458681', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-9dp16jgwgyvn****', + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-bp1utx6wj4x9qu9tl****', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'TagList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + '', + '', + ], + 'example' => '0', + ], + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FirstFlow', + ], + 'TagDescribe' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ClassId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorPortError', + 'errorMessage' => 'The port is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LocationName\\": \\"杭州\\",\\n \\"IspName\\": \\"电信\\",\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"TotalCount\\": 25,\\n \\"AssetList\\": [\\n {\\n \\"AclCoverage\\": \\"FullCoverage\\",\\n \\"ResourceInstanceName\\": \\"test\\",\\n \\"ResourceInstanceId\\": \\"i-uf63wjhyoohc1g4z****\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"InBytes\\": 0,\\n \\"LocationName\\": \\"杭州\\",\\n \\"FirstTime\\": 1744682438,\\n \\"PrivateIP\\": \\"10.21.242XXX\\",\\n \\"RuleId\\": \\"08a58465-ff4d-4c47-8782-eb008301****\\",\\n \\"RuleName\\": \\"test\\",\\n \\"SessionCount\\": 2,\\n \\"LastTime\\": 1739326614,\\n \\"ResourceType\\": \\"EcsPublicIP\\",\\n \\"OutBytes\\": 0,\\n \\"IspName\\": \\"电信\\",\\n \\"PublicIP\\": \\"47.96.181.XXX\\",\\n \\"TotalBytes\\": \\"458681\\",\\n \\"VpcId\\": \\"vpc-9dp16jgwgyvn****\\",\\n \\"NatGatewayId\\": \\"ngw-bp1utx6wj4x9qu9tl****\\",\\n \\"NatGatewayName\\": \\"ngw-test\\",\\n \\"TagList\\": [\\n {\\n \\"RiskLevel\\": 0,\\n \\"TagName\\": \\"test\\",\\n \\"TagId\\": \\"FirstFlow\\",\\n \\"TagDescribe\\": \\"test\\",\\n \\"ClassId\\": \\"1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInternetTrafficTop' => [ + 'summary' => '获取互联网流量TOP趋势图', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68285', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '117.82.14.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'in', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1734055824', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'in_src_location' => '', + 'in_src_ip' => '', + ], + 'example' => 'in_src_ip', + ], + ], + [ + 'name' => 'RuleResult', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'RuleSource', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'in_bytes' => 'in_bytes', + 'session_count' => 'session_count', + 'out_bytes' => 'out_bytes', + 'total_bytes' => 'total_bytes', + 'out_packets' => 'out_packets', + 'in_packets' => 'in_packets', + ], + 'example' => 'in_bytes', + ], + ], + [ + 'name' => 'ShowCountryName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'China', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '50', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'in_src_location' => '', + 'in_src_ip' => '', + ], + 'example' => 'in_src_ip', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******', + ], + 'DataCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DataValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.12', + ], + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DataName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'US', + ], + 'IsSubscribed' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'LabelList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NA', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorDirectionError', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorRuleSourceError', + 'errorMessage' => 'The rule source is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorLimitCountFailed', + 'errorMessage' => 'The limit count is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataType\\": \\"in_src_ip\\",\\n \\"RequestId\\": \\"15FCCC52-1E23-57AE-B5EF-3E00A3******\\",\\n \\"DataCount\\": 10,\\n \\"DataList\\": [\\n {\\n \\"DataValue\\": \\"47.12\\",\\n \\"SessionCount\\": 27,\\n \\"TotalBytes\\": 0,\\n \\"DataName\\": \\"US\\",\\n \\"IsSubscribed\\": false,\\n \\"LabelList\\": [\\n \\"NA\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInternetTrafficTrend' => [ + 'summary' => 'Queries the trends of Internet traffic.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68287', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the access source.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '101.80.171.196', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content in the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content in the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the internet traffic.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **in**: inbound traffic'."\n" + .'* **out**: outbound traffic', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.', + 'type' => 'string', + 'required' => true, + 'example' => '1670307484', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.', + 'type' => 'string', + 'required' => true, + 'example' => '1674958929', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source code.', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + [ + 'name' => 'SrcPublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The public IP address of the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '47.112.210.136', + ], + ], + [ + 'name' => 'SrcPrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private IP address of the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.100.134.60', + ], + ], + [ + 'name' => 'TrafficType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the traffic that is captured. Valid values:'."\n" + ."\n" + .'* **max** (default): peak traffic'."\n" + .'* **avg**: average traffic'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'max', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxTotalBps' => [ + 'description' => 'The total maximum inbound and outbound network throughput, which indicates the maximum number of bits that are sent inbound and outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89783147', + ], + 'MaxBandwidthTime' => [ + 'description' => 'The timestamp generated when the bandwidth reaches the peak value. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672736400', + ], + 'AvgInBps' => [ + 'description' => 'The average inbound network throughput, which indicates the average number of bits that are sent inbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6114152', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C7E837BE-0379-565E-B7B4-DE595C8D337C', + ], + 'MaxInBps' => [ + 'description' => 'The maximum inbound network throughput, which indicates the maximum number of bits that are sent inbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10275643', + ], + 'MaxOutBps' => [ + 'description' => 'The maximum outbound network throughput, which indicates the maximum number of bits that are sent outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395188', + ], + 'AvgSession' => [ + 'description' => 'The average number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '79013', + ], + 'MaxSession' => [ + 'description' => 'The number of requests during the peak hour of the network throughout.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '931641', + ], + 'AvgTotalBps' => [ + 'description' => 'The total average inbound and outbound network throughput, which indicates the average number of bits that are sent inbound and outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2306', + ], + 'AvgOutBps' => [ + 'description' => 'The average outbound network throughput, which indicates the average number of bits that are sent outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70148993', + ], + 'TotalInBytes' => [ + 'description' => 'The inbound network throughput, which indicates the total number of bytes that are sent inbound. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41536824243873', + ], + 'TotalOutBytes' => [ + 'description' => 'The outbound network throughput, which indicates the total number of bytes that are sent outbound. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2660894567178', + ], + 'TotalBytes' => [ + 'description' => 'The total inbound and outbound network throughput, which indicates the total number of bytes that are sent inbound and outbound. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '963227674958', + ], + 'TotalSession' => [ + 'description' => 'The total number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1061449', + ], + 'TotalExceedBytes' => [ + 'description' => 'The total volume of excess traffic.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4243873', + ], + 'MaxDayExceedBytes' => [ + 'description' => 'The maximum volume of excess traffic allowed per day.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '873', + ], + 'DataList' => [ + 'description' => 'The statistics on traffic.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SessionCount' => [ + 'description' => 'The number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'Time' => [ + 'description' => 'The time when traffic is generated. The value is a UNIX timestamp. Unit: seconds.'."\n" + ."\n" + .'If processing is not complete at this point in time, -1 is returned for all other fields.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1659405600', + ], + 'InBps' => [ + 'description' => 'The inbound network throughput, which indicates the number of bits that are sent inbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '187', + ], + 'InPps' => [ + 'description' => 'The inbound network throughput, which indicates the number of packets that are sent inbound per second. Unit: packets per second (pps).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NewConn' => [ + 'description' => 'The number of new connections.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'OutBytes' => [ + 'description' => 'The outbound network throughput, which indicates the total number of bytes that are sent outbound. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'OutPps' => [ + 'description' => 'The outbound network throughput, which indicates the number of packets that are sent outbound per second. Unit: pps.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'InBytes' => [ + 'description' => 'The inbound network throughput, which indicates the total number of bytes that are sent inbound. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'OutBps' => [ + 'description' => 'The outbound network throughput, which indicates the number of bits that are sent outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'TotalBps' => [ + 'description' => 'The total outbound and inbound network throughput, which indicates the total number of bits that are sent inbound and outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '323', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorDirectionError', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorSrcDstIPError', + 'errorMessage' => 'SrcPublicIP and DstPublicIP cannot be specified at the same time.', + ], + [ + 'errorCode' => 'ErrorTrafficType', + 'errorMessage' => 'The traffic type is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MaxTotalBps\\": 89783147,\\n \\"MaxBandwidthTime\\": 1672736400,\\n \\"AvgInBps\\": 6114152,\\n \\"RequestId\\": \\"C7E837BE-0379-565E-B7B4-DE595C8D337C\\",\\n \\"MaxInBps\\": 10275643,\\n \\"MaxOutBps\\": 395188,\\n \\"AvgSession\\": 79013,\\n \\"MaxSession\\": 931641,\\n \\"AvgTotalBps\\": 2306,\\n \\"AvgOutBps\\": 70148993,\\n \\"TotalInBytes\\": 41536824243873,\\n \\"TotalOutBytes\\": 2660894567178,\\n \\"TotalBytes\\": 963227674958,\\n \\"TotalSession\\": 1061449,\\n \\"TotalExceedBytes\\": 4243873,\\n \\"MaxDayExceedBytes\\": 873,\\n \\"DataList\\": [\\n {\\n \\"SessionCount\\": 27,\\n \\"Time\\": 1659405600,\\n \\"InBps\\": 187,\\n \\"InPps\\": 2,\\n \\"NewConn\\": 27,\\n \\"OutBytes\\": 1123,\\n \\"OutPps\\": 2,\\n \\"InBytes\\": 235,\\n \\"OutBps\\": 45,\\n \\"TotalBps\\": 232\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeInternetTrafficTrend', + ], + 'DescribeNatFirewallTrafficTrend' => [ + 'summary' => 'Queries the traffic trend of NAT gateways.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203560', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1739326980', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value is a UNIX timestamp that is accurate to seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1739330580', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'SrcPublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The public IP address of the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '47.112.210.136', + ], + ], + [ + 'name' => 'SrcPrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private IP address of the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.100.134.60', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time interval between the data entries to return. Unit: seconds. Valid values:'."\n" + ."\n" + .'* **60**: 1 minute'."\n" + .'* **1800**: 30 minutes', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '87F23A3A-6F57-59C3-8237-A090D0613D71', + ], + 'MaxTotalBps' => [ + 'description' => 'The total maximum inbound and outbound network throughput, which indicates the maximum number of bits that are sent inbound and outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '66953194', + ], + 'MaxOutBps' => [ + 'description' => 'The maximum outbound network throughput, which indicates the maximum number of bits that are sent outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122596487', + ], + 'MaxInBps' => [ + 'description' => 'The maximum inbound network throughput, which indicates the maximum number of bits that are sent inbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18038632', + ], + 'DataList' => [ + 'description' => 'The statistics on traffic.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The statistics on traffic.'."\n", + 'type' => 'object', + 'properties' => [ + 'TrafficTime' => [ + 'description' => 'The time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1734418980', + ], + 'MaxTotalBps' => [ + 'description' => 'The total maximum inbound and outbound network throughput, which indicates the maximum number of bits that are sent inbound and outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '66953194', + ], + 'MaxInBps' => [ + 'description' => 'The maximum inbound network throughput, which indicates the maximum number of bits that are sent inbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18038632', + ], + 'MaxOutBps' => [ + 'description' => 'The maximum outbound network throughput, which indicates the maximum number of bits that are sent outbound per second. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122596487', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"87F23A3A-6F57-59C3-8237-A090D0613D71\\",\\n \\"MaxTotalBps\\": 66953194,\\n \\"MaxOutBps\\": 122596487,\\n \\"MaxInBps\\": 18038632,\\n \\"DataList\\": [\\n {\\n \\"TrafficTime\\": 1734418980,\\n \\"MaxTotalBps\\": 66953194,\\n \\"MaxInBps\\": 18038632,\\n \\"MaxOutBps\\": 122596487\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeNatFirewallTrafficTrend', + ], + 'DescribeInternetServiceNameList' => [ + 'summary' => '获取互联网服务名称列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68281', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '140.240.17.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '91B01BCD-DFB0-5CA8-9191-5B38C62****', + ], + 'ServiceNameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' "SMB",'."\n" + .' "MySQL"'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"91B01BCD-DFB0-5CA8-9191-5B38C62****\\",\\n \\"ServiceNameList\\": [\\n \\"[\\\\n \\\\\\"SMB\\\\\\",\\\\n \\\\\\"MySQL\\\\\\"\\\\n]\\"\\n ]\\n}","type":"json"}]', + ], + 'DescribeInternetOpenIp' => [ + 'summary' => 'Queries the IP addresses that are open to the Internet.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68277', + 'abilityTreeNodes' => [ + 'FEATUREcfwVWCDEU', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SSH', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The risk level. If you leave this parameter empty, all risk levels are queried. Valid values:'."\n" + ."\n" + .'* **3**: high risk'."\n" + .'* **2**: medium risk'."\n" + .'* **1**: low risk'."\n" + .'* **0**: no risk'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'AssetsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6faknmuby7ezht****', + ], + ], + [ + 'name' => 'AssetsInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'launch-advisor-2023****', + ], + ], + [ + 'name' => 'PublicIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The public IP address of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.1', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'AssetsType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The asset type of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EcsEIP', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1681957629', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1663640336', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6B780BD6-282C-51A9-A8E6-59F636BAFA54', + ], + 'PageInfo' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + ], + 'DataList' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => 'The risk level. Valid values:'."\n" + ."\n" + .'* **3**: high risk'."\n" + .'* **2**: medium risk'."\n" + .'* **1**: low risk'."\n" + .'* **0**: no risk'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TrafficPercent1Day' => [ + 'description' => 'For detailed traffic information, see the TotalBytes field.', + 'type' => 'string', + 'example' => '0', + ], + 'AclRecommendDetail' => [ + 'description' => 'The reason why recommended intelligent policies are unavailable. Valid values:'."\n" + ."\n" + .'* No recommended intelligent policies are available.'."\n" + .'* This feature is available only to some users.'."\n" + .'* The policy configuration has been modified. No recommended intelligent policies are available.'."\n" + .'* The recommended intelligent policies have been configured. No new recommended intelligent policies are available.'."\n", + 'type' => 'string', + 'example' => 'No recommended intelligent policies are available.', + ], + 'AssetsName' => [ + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'example' => 'launch-advisor-2023****', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'AssetsType' => [ + 'description' => 'The asset type of the instance.'."\n", + 'type' => 'string', + 'example' => 'EcsEIP', + ], + 'HasAclRecommend' => [ + 'description' => 'Specifies whether an access control policy is recommended. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DetailNum' => [ + 'description' => 'The total number of ports.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TrafficPercent7Day' => [ + 'description' => 'For detailed traffic information, see the TotalBytes field.', + 'type' => 'string', + 'example' => '0', + ], + 'TrafficPercent30Day' => [ + 'description' => 'For detailed traffic information, see the TotalBytes field.', + 'type' => 'string', + 'example' => '0', + ], + 'PublicIp' => [ + 'description' => 'The public IP address of the instance.'."\n", + 'type' => 'string', + 'example' => '203.0.113.1', + ], + 'RiskReason' => [ + 'description' => 'The reason for the risk.'."\n", + 'type' => 'string', + 'example' => 'Previous traffic is all malicious traffic.', + ], + 'AssetsInstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'i-bp1ix9w22kv6aew9****', + ], + 'PortList' => [ + 'description' => 'The list of ports.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ports.'."\n", + 'type' => 'string', + 'example' => '["3000","5601","8886,"8887","8889"]', + ], + ], + 'ServiceNameList' => [ + 'description' => 'The list of applications.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The applications.'."\n", + 'type' => 'string', + 'example' => '[\'HTTPS\', \'RDP\', \'SSL\', \'Unknown\']', + ], + ], + 'TotalReplyBytes' => [ + 'description' => 'Outbound traffic in the last 7 days.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'SrcIpCnt' => [ + 'description' => 'Number of source IPs.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'MemberUid' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14151892****7022', + ], + 'InBytes' => [ + 'description' => 'The inbound network throughput, which indicates the total number of bytes that are sent inbound. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'OutBytes' => [ + 'description' => 'The outbound network throughput, which indicates the total number of bytes that are sent outbound. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'TotalBytes' => [ + 'description' => 'The total inbound and outbound network throughput, which indicates the total number of bytes that are sent inbound and outbound. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '253023143', + ], + 'UnknownReason' => [ + 'description' => 'Reasons for not analyzing the protocol when the protocol is identified as Unknown.', + 'type' => 'array', + 'items' => [ + 'description' => 'Reasons for not analyzing the protocol when the protocol is identified as Unknown.', + 'type' => 'string', + 'example' => 'no_payload', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B780BD6-282C-51A9-A8E6-59F636BAFA54\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 40\\n },\\n \\"DataList\\": [\\n {\\n \\"RiskLevel\\": 3,\\n \\"TrafficPercent1Day\\": \\"0\\",\\n \\"AclRecommendDetail\\": \\"当前无智能策略推荐\\",\\n \\"AssetsName\\": \\"launch-advisor-2023****\\",\\n \\"RegionNo\\": \\"cn-shenzhen\\",\\n \\"AssetsType\\": \\"EcsEIP\\",\\n \\"HasAclRecommend\\": true,\\n \\"DetailNum\\": 5,\\n \\"TrafficPercent7Day\\": \\"0\\",\\n \\"TrafficPercent30Day\\": \\" 0\\",\\n \\"PublicIp\\": \\"203.0.113.1\\",\\n \\"RiskReason\\": \\"历史流量均为黑流量\\",\\n \\"AssetsInstanceId\\": \\"i-bp1ix9w22kv6aew9****\\",\\n \\"PortList\\": [\\n \\"[\\\\\\"3000\\\\\\",\\\\\\"5601\\\\\\",\\\\\\"8886,\\\\\\"8887\\\\\\",\\\\\\"8889\\\\\\"]\\"\\n ],\\n \\"ServiceNameList\\": [\\n \\"[\'HTTPS\', \'RDP\', \'SSL\', \'Unknown\']\\"\\n ],\\n \\"TotalReplyBytes\\": 100000,\\n \\"SrcIpCnt\\": 22,\\n \\"MemberUid\\": 0,\\n \\"InBytes\\": 235,\\n \\"OutBytes\\": 1123,\\n \\"TotalBytes\\": 253023143,\\n \\"UnknownReason\\": [\\n \\"no_payload\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeInternetOpenIp', + ], + 'DescribeInternetOpenPort' => [ + 'summary' => '获取互联网开放端口', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68278', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '114.242.33.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SMB', + ], + ], + [ + 'name' => 'ServiceNameFuzzy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SMB', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + '', + -1 => '', + ], + 'example' => '3', + ], + ], + [ + 'name' => 'SuggestLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + 10 => '', + 30 => '', + -1 => '', + ' 20' => '', + ], + 'example' => '10', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1735264800', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1748358644', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F3637663-991B-547F-9163-1A5AC367****', + ], + 'PageInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '39', + ], + ], + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 1 => '', + '', + '', + -1 => '', + ], + 'example' => '3', + ], + 'ProbRiskDesc' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'desc', + ], + 'TrafficPercent1Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'Protocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tcp', + ], + 'PublicIpNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SuggestLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + 10 => '', + 20 => '', + 30 => '', + ' -1' => '', + ], + 'example' => '20', + ], + 'DetailNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'TrafficPercent7Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'TrafficPercent30Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => '48', + ], + 'ProbRisk' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'RiskReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ServiceNameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[\'HTTPS\', \'RDP\', \'SSL\', \'Unknown\']', + ], + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1456536639.0', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '117200.0', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '621404', + ], + 'UnknownReason' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'no_payload', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F3637663-991B-547F-9163-1A5AC367****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 39\\n },\\n \\"DataList\\": [\\n {\\n \\"RiskLevel\\": 3,\\n \\"ProbRiskDesc\\": \\"desc\\",\\n \\"TrafficPercent1Day\\": \\"10\\",\\n \\"Protocol\\": \\"tcp\\",\\n \\"PublicIpNum\\": 10,\\n \\"SuggestLevel\\": 20,\\n \\"DetailNum\\": 5,\\n \\"Port\\": 80,\\n \\"TrafficPercent7Day\\": \\"30\\",\\n \\"TrafficPercent30Day\\": \\"48\\",\\n \\"ProbRisk\\": \\"test\\",\\n \\"RiskReason\\": \\"test\\",\\n \\"ServiceNameList\\": [\\n \\"[\'HTTPS\', \'RDP\', \'SSL\', \'Unknown\']\\"\\n ],\\n \\"InBytes\\": 1456536639,\\n \\"OutBytes\\": 117200,\\n \\"TotalBytes\\": 621404,\\n \\"UnknownReason\\": [\\n \\"no_payload\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInternetOpenService' => [ + 'summary' => '获取互联网开放服务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68279', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '122.200.64.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SMB', + ], + ], + [ + 'name' => 'ServiceNameFuzzy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SMB', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + '', + -1 => '', + ], + 'example' => '2', + ], + ], + [ + 'name' => 'SuggestLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + 10 => '', + 20 => '', + 30 => '', + ' -1' => '', + ], + 'example' => '10', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3389', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1755742107', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1753804800', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '99A65AA0-C5B5-5092-BFCF-8111B436****', + ], + 'PageInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + '', + '', + ' -1' => '', + ], + 'example' => '3', + ], + 'ProbRiskDesc' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'TrafficPercent1Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Protocol' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'tcp' => 'tcp', + 'udp' => 'udp', + ], + 'example' => 'tcp', + ], + 'PublicIpNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SuggestLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + 10 => '', + 20 => '', + 30 => '', + -1 => '', + ], + 'example' => '20', + ], + 'DetailNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TrafficPercent7Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => '77', + ], + 'TrafficPercent30Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' 0', + ], + 'ProbRisk' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ServiceName' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'SMB', + ], + 'RiskReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PortList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' 80,'."\n" + .' 8080,'."\n" + .' 80,'."\n" + .' 21'."\n" + .']', + ], + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '447458.0', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '621404', + ], + 'UnknownReason' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'no_payload', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99A65AA0-C5B5-5092-BFCF-8111B436****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 10\\n },\\n \\"DataList\\": [\\n {\\n \\"RiskLevel\\": 3,\\n \\"ProbRiskDesc\\": \\"test\\",\\n \\"TrafficPercent1Day\\": \\"0\\",\\n \\"Protocol\\": \\"tcp\\",\\n \\"PublicIpNum\\": 3,\\n \\"SuggestLevel\\": 20,\\n \\"DetailNum\\": 5,\\n \\"TrafficPercent7Day\\": \\"77\\",\\n \\"TrafficPercent30Day\\": \\" 0\\",\\n \\"ProbRisk\\": \\"test\\",\\n \\"ServiceName\\": 0,\\n \\"RiskReason\\": \\"test\\",\\n \\"PortList\\": [\\n \\"[\\\\n 80,\\\\n 8080,\\\\n 80,\\\\n 21\\\\n]\\"\\n ],\\n \\"InBytes\\": 447458,\\n \\"OutBytes\\": 1123,\\n \\"TotalBytes\\": 621404,\\n \\"UnknownReason\\": [\\n \\"no_payload\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInternetOpenDetail' => [ + 'summary' => '获取互联网开放详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68276', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '222.212.86.7XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SMB', + ], + ], + [ + 'name' => 'ServiceNameFuzzy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SMB', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + '', + -1 => '', + ], + 'example' => '3', + ], + ], + [ + 'name' => 'SuggestLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + 10 => '', + 20 => '', + 30 => '', + -1 => '', + ], + 'example' => '10', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '9100', + ], + ], + [ + 'name' => 'AssetsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6faknmuby7ezht****', + ], + ], + [ + 'name' => 'AssetsInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'instance_test', + ], + ], + [ + 'name' => 'PublicIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '203.0.13.XX', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'AssetsType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'EcsPublicIP', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1656837360', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1745251200', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Dir' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'asc', + ], + 'SortKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ServiceName' => '', + 'PublicIp' => '', + 'Port' => '', + ], + 'example' => 'ServiceName', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3495E758-BB4B-5F5C-8AE0-897489F****', + ], + 'PageInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + '', + ' 3' => '', + -1 => '', + ], + 'example' => '3', + ], + 'ProbRiskDesc' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'TrafficPercent1Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'SuggestLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + 10 => '', + 20 => '', + 30 => '', + -1 => '', + ], + 'example' => '20', + ], + 'Protocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tcp', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'AssetsName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'launch-advisor-2023****', + ], + 'AssetsType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EcsEIP', + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3389', + ], + 'TrafficPercent7Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'TrafficPercent30Day' => [ + 'description' => '', + 'type' => 'string', + 'example' => '48', + ], + 'ProbRisk' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PublicIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39.101.167.XX', + ], + 'ServiceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Redis', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1123', + ], + 'AssetsInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-bp1ix9w22kv6aew9****', + ], + 'RiskReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UnknownReason' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' "no_payload",'."\n" + .' "tcp_not_establish"'."\n" + .']', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorUnMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3495E758-BB4B-5F5C-8AE0-897489F****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 5\\n },\\n \\"DataList\\": [\\n {\\n \\"RiskLevel\\": 3,\\n \\"ProbRiskDesc\\": \\"test\\",\\n \\"TrafficPercent1Day\\": \\"10\\",\\n \\"SuggestLevel\\": 20,\\n \\"Protocol\\": \\"tcp\\",\\n \\"RegionNo\\": \\"cn-shenzhen\\",\\n \\"AssetsName\\": \\"launch-advisor-2023****\\",\\n \\"AssetsType\\": \\"EcsEIP\\",\\n \\"Port\\": 3389,\\n \\"TrafficPercent7Day\\": \\"30\\",\\n \\"TrafficPercent30Day\\": \\"48\\",\\n \\"ProbRisk\\": \\"test\\",\\n \\"PublicIp\\": \\"39.101.167.XX\\",\\n \\"ServiceName\\": \\"Redis\\",\\n \\"Id\\": \\"1123\\",\\n \\"AssetsInstanceId\\": \\"i-bp1ix9w22kv6aew9****\\",\\n \\"RiskReason\\": \\"test\\",\\n \\"InBytes\\": 0,\\n \\"OutBytes\\": 0,\\n \\"TotalBytes\\": 0,\\n \\"UnknownReason\\": [\\n \\"[\\\\n \\\\\\"no_payload\\\\\\",\\\\n \\\\\\"tcp_not_establish\\\\\\"\\\\n]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInternetSlb' => [ + 'summary' => '获取互联网SLB', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68282', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '112.64.233.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PublicIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.108.60.XXX', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'lb-2ze8v2x5kd9qyvp2****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'tcp' => 'tcp', + 'udp' => 'udp', + 'http' => 'http', + 'https' => 'https', + ], + 'example' => 'tcp', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '63389', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '135BF83A-0416-5A11-96BB-FA7604D4****', + ], + 'PageInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AclType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'white' => '', + 'black' => '', + ], + 'example' => 'white', + ], + 'AclId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'acl-uf66n6l9mf3fgq8xs****', + ], + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'buyerpro1', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'AclStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => '', + 'on' => '', + ], + 'example' => 'on', + ], + 'PublicIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39.108.57.XXX', + ], + 'IpProtocol' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'tcp' => 'tcp', + 'udp' => 'udp', + 'http' => 'http', + 'https' => 'https', + ], + 'example' => 'tcp', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'lb-2ze8v2x5kd9qyvp2****', + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1883', + ], + 'HealthStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => '', + 'abnormal' => '', + 'unavailable' => '', + 'close ' => '', + ], + 'example' => 'normal', + ], + 'Tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorSlbOpenApi', + 'errorMessage' => 'An SLB OpenAPI error occurred.', + ], + [ + 'errorCode' => 'ErrorUnMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"135BF83A-0416-5A11-96BB-FA7604D4****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 0\\n },\\n \\"DataList\\": [\\n {\\n \\"AclType\\": \\"white\\",\\n \\"AclId\\": \\"acl-uf66n6l9mf3fgq8xs****\\",\\n \\"InstanceName\\": \\"buyerpro1\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"AclStatus\\": \\"on\\",\\n \\"PublicIp\\": \\"39.108.57.XXX\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"InstanceId\\": \\"lb-2ze8v2x5kd9qyvp2****\\",\\n \\"Port\\": 1883,\\n \\"HealthStatus\\": \\"normal\\",\\n \\"Tags\\": [\\n \\"[]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOpenIpAccessSrcStat' => [ + 'summary' => '获取公网IP通过的源状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68321', + 'abilityTreeNodes' => [ + 'FEATUREcfwVWCDEU', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'DstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.102.XXX', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0DC783F1-B3A7-578D-8A63-*****', + ], + 'StatList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AbnormalSrcIp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'NormalSrcIp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'Port' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6163', + ], + 'App' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"0DC783F1-B3A7-578D-8A63-*****\\",\\n \\"StatList\\": [\\n {\\n \\"AbnormalSrcIp\\": 12,\\n \\"NormalSrcIp\\": 21,\\n \\"Port\\": \\"6163\\",\\n \\"App\\": \\"HTTP\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeNetworkInstanceRelationList' => [ + 'summary' => '获取网络实例关系列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68311', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'ConnectType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'expressconnect' => '', + 'cen' => '', + ], + 'example' => 'cen', + ], + ], + [ + 'name' => 'FirewallConfigureStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'configured' => '', + 'notconfigured' => '', + ], + 'example' => 'notconfigured', + ], + ], + [ + 'name' => 'NetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PeerNetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '284FF89D-4F70-546F-8EF6-77E0A530****', + ], + 'NetworkInstanceList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'expressconnect' => '', + 'cen' => '', + ], + 'example' => 'cen', + ], + 'NetworkInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-test', + ], + 'NetworkInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-2vcwfqbrh4kr****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'NetworkInstanceType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'vbr' => 'vbr', + 'vpc' => 'vpc', + ], + 'example' => 'VPC', + ], + 'PeerNetworkInstanceList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NetworkInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-dsf232d****', + ], + 'NetworkInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-test', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'NetworkInstanceType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'vbr' => 'vbr', + 'vpc' => 'vpc', + ], + 'example' => 'vpc', + ], + 'AssociatedCen' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CenId' => [ + 'type' => 'string', + ], + 'CenName' => [ + 'type' => 'string', + ], + 'TransitRouterType' => [ + 'type' => 'string', + ], + 'AttachmentId' => [ + 'type' => 'string', + ], + 'AttachmentName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'AssociatedCen' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CenId' => [ + 'type' => 'string', + ], + 'CenName' => [ + 'type' => 'string', + ], + 'TransitRouterType' => [ + 'type' => 'string', + ], + 'AttachmentId' => [ + 'type' => 'string', + ], + 'AttachmentName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorConfigureStatus', + 'errorMessage' => 'firewall configure status invalid.', + ], + [ + 'errorCode' => 'ErrorConnectType', + 'errorMessage' => 'Connect type invalid.', + ], + [ + 'errorCode' => 'ErrorNetworkInstanceIdBothEmpty', + 'errorMessage' => 'The parameters NetworkInstanceId and PeerNetworkInstanceId must be both empty or neither empty.', + ], + [ + 'errorCode' => 'ErrorNetworkInstanceIdSame', + 'errorMessage' => 'The NetworkInstanceId and PeerNetworkInstanceId parameters cannot be the same.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 12,\\n \\"RequestId\\": \\"284FF89D-4F70-546F-8EF6-77E0A530****\\",\\n \\"NetworkInstanceList\\": [\\n {\\n \\"ConnectType\\": \\"cen\\",\\n \\"NetworkInstanceName\\": \\"vpc-test\\",\\n \\"NetworkInstanceId\\": \\"vpc-2vcwfqbrh4kr****\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"NetworkInstanceType\\": \\"VPC\\",\\n \\"PeerNetworkInstanceList\\": [\\n {\\n \\"NetworkInstanceId\\": \\"vpc-dsf232d****\\",\\n \\"NetworkInstanceName\\": \\"vpc-test\\",\\n \\"RegionNo\\": \\"cn-shenzhen\\",\\n \\"NetworkInstanceType\\": \\"vpc\\",\\n \\"AssociatedCen\\": [\\n {\\n \\"CenId\\": \\"cen-sdij1***\\",\\n \\"CenName\\": \\"test\\",\\n \\"TransitRouterType\\": \\"Enterprise\\",\\n \\"AttachmentId\\": \\"tr-attach-b9dyqn***\\",\\n \\"AttachmentName\\": \\"att-test2\\"\\n }\\n ]\\n }\\n ],\\n \\"AssociatedCen\\": [\\n {\\n \\"CenId\\": \\"cen-sdij1***\\",\\n \\"CenName\\": \\"test\\",\\n \\"TransitRouterType\\": \\"Enterprise\\",\\n \\"AttachmentId\\": \\"tr-attach-b92yqn***\\",\\n \\"AttachmentName\\": \\"att-test1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallAssetList' => [ + 'summary' => '获取VPC防火墙资产列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68413', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + 'FEATUREcfwE8FJHT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1534408189', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1756952150', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-wz9ulqcvly23w31zkh8sm****', + ], + ], + [ + 'name' => 'PeerVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-90rq0anm6t8vbwbo****', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5234', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'in', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IPProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'tcp' => 'tcp', + 'udp' => 'udp', + ], + 'example' => 'tcp', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + '', + ], + 'example' => '3', + ], + ], + [ + 'name' => 'EcsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' i-hp3ez3rs9bxwt034****', + ], + ], + [ + 'name' => 'EcsInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test-ecs', + ], + ], + [ + 'name' => 'AssetIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'InBytes' => 'InBytes', + 'SessionCount' => 'SessionCount', + 'OutBytes' => 'OutBytes', + ], + 'example' => 'SessionCount', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'IsAITraffic', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '924A6CCC-4EAD-5554-8AD0-45F5ED56****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + '', + '', + ], + 'example' => '3', + ], + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'AssetInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' i-hp3ez3rs9bxwt034****', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'AssetIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'AssetInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs-test', + ], + 'RiskReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PortList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' 80,'."\n" + .' 8080,'."\n" + .' 80,'."\n" + .' 21'."\n" + .']', + ], + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IpsHitCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 30,\\n \\"RequestId\\": \\"924A6CCC-4EAD-5554-8AD0-45F5ED56****\\",\\n \\"DataList\\": [\\n {\\n \\"RiskLevel\\": 3,\\n \\"SessionCount\\": 27,\\n \\"AssetInstanceId\\": \\" i-hp3ez3rs9bxwt034****\\",\\n \\"OutBytes\\": 0,\\n \\"RegionNo\\": \\"cn-beijing\\",\\n \\"AssetIP\\": \\"192.0.XX.XX\\",\\n \\"InBytes\\": 0,\\n \\"AssetInstanceName\\": \\"ecs-test\\",\\n \\"RiskReason\\": \\"test\\",\\n \\"PortList\\": [\\n \\"[\\\\n 80,\\\\n 8080,\\\\n 80,\\\\n 21\\\\n]\\"\\n ],\\n \\"TotalBytes\\": 0,\\n \\"IpsHitCnt\\": 10\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAITrafficAnalysisStatus' => [ + 'summary' => '查询AI流量分析开启状态', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '4E7F94C7-781F-5192-86CF-DB085****', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'open', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E7F94C7-781F-5192-86CF-DB085****\\",\\n \\"Status\\": \\"open\\"\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallDomainList' => [ + 'summary' => '查询VPC互访的域名信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68328', + 'abilityTreeNodes' => [ + 'FEATUREcfwG6EEQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间,Unix timestamp, 精确到秒', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间,Unix timestamp, 精确到秒', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656750960', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数, 不得超过100, 超过100会设置为100', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'title' => '域名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com'."\n", + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'title' => '公网IP', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.92.x.x', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序, 枚举值, 可选:asc, desc', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段, 枚举值.'."\n" + .'默认值: SessionCount'."\n" + .'可选值: InBytes, OutBytes,TotalBytes,SessionCount', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SessionCount', + 'enum' => [], + ], + ], + [ + 'name' => 'SrcVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-t4nlt09olhpazpoeg****', + ], + ], + [ + 'name' => 'IsAITraffic', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '133173B9-8010-5DF5-8B93-********', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'title' => '域名', + 'description' => '', + 'type' => 'string', + 'example' => 'www.a.com', + ], + 'RequestBytes' => [ + 'title' => '入流量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3214', + ], + 'SessionCount' => [ + 'title' => '会话数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'GroupName' => [ + 'title' => '规则中的组名称', + 'description' => '', + 'type' => 'string', + 'example' => 'Google', + ], + 'ResponseBytes' => [ + 'title' => '出流量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4582', + ], + 'Business' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Google', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8111126106', + ], + 'ApplicationNameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + 'SrcIpCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SrcVpcCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorSecuritySuggest', + 'errorMessage' => 'The security suggest is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainName', + 'errorMessage' => 'The domain name is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 132,\\n \\"RequestId\\": \\"133173B9-8010-5DF5-8B93-********\\",\\n \\"DataList\\": [\\n {\\n \\"Domain\\": \\"www.a.com\\",\\n \\"RequestBytes\\": 3214,\\n \\"SessionCount\\": 12,\\n \\"GroupName\\": \\"Google\\",\\n \\"ResponseBytes\\": 4582,\\n \\"Business\\": \\"Google\\",\\n \\"TotalBytes\\": 8111126106,\\n \\"ApplicationNameList\\": [\\n \\"HTTP\\"\\n ],\\n \\"SrcIpCount\\": 2,\\n \\"SrcVpcCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallDomainRelationList' => [ + 'summary' => '查询VPC互访的域名信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68328', + 'abilityTreeNodes' => [ + 'FEATUREcfwG6EEQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间,Unix timestamp, 精确到秒', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间,Unix timestamp, 精确到秒', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656750960', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数, 不得超过100, 超过100会设置为100', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DomainList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com'."\n", + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'title' => '公网IP', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.92.x.x', + ], + ], + [ + 'name' => 'SrcVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-t4nlt09olhpazpoeg****', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '34.136.111.XXX', + ], + ], + [ + 'name' => 'DstVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp10w5nb30r4jzfyc****', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TotalBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C5DDD596-1191-5F36-A504-8733045A****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'SrcIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'DstIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'SrcVpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-t4nlt09olhpazpoeg****', + ], + 'DstVpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-bp10w5nb30r4jzfyc****', + ], + 'SrcVpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-****', + ], + 'DstVpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-****', + ], + 'SrcRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DstRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16287823', + ], + 'SessionCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'Business' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Google', + ], + 'GroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Google', + ], + 'IpsHitCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'FirstTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1767147003', + ], + 'LastTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1767147003', + ], + 'RequestBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ResponseBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + ], + ], + ], + 'DstVpcList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-bp10w5nb30r4jzfyc****', + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorSecuritySuggest', + 'errorMessage' => 'The security suggest is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainName', + 'errorMessage' => 'The domain name is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 132,\\n \\"RequestId\\": \\"C5DDD596-1191-5F36-A504-8733045A****\\",\\n \\"DataList\\": [\\n {\\n \\"Domain\\": \\"www.example.com\\",\\n \\"SrcIP\\": \\"192.0.XX.XX\\",\\n \\"DstIP\\": \\"192.0.XX.XX\\",\\n \\"SrcVpcId\\": \\"vpc-t4nlt09olhpazpoeg****\\",\\n \\"DstVpcId\\": \\"vpc-bp10w5nb30r4jzfyc****\\",\\n \\"SrcVpcName\\": \\"vpc-****\\",\\n \\"DstVpcName\\": \\"vpc-****\\",\\n \\"SrcRegionId\\": \\"cn-hangzhou\\",\\n \\"DstRegionId\\": \\"cn-beijing\\",\\n \\"TotalBytes\\": 16287823,\\n \\"SessionCount\\": 27,\\n \\"Business\\": \\"Google\\",\\n \\"GroupName\\": \\"Google\\",\\n \\"IpsHitCnt\\": 10,\\n \\"FirstTime\\": 1767147003,\\n \\"LastTime\\": 1767147003,\\n \\"RequestBytes\\": 10000,\\n \\"ResponseBytes\\": 10000\\n }\\n ],\\n \\"DstVpcList\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp10w5nb30r4jzfyc****\\",\\n \\"VpcName\\": \\"vpc-****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'UpdateAITrafficAnalysisStatus' => [ + 'summary' => '修改AI流量分析开启状态', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4E7F94C7-781F-5192-86CF-DB085013C810', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E7F94C7-781F-5192-86CF-DB085013C810\\"\\n}","type":"json"}]', + ], + 'ModifyObjectGroupOperation' => [ + 'summary' => 'Modifies information about an operation on an object group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68478', + 'abilityTreeNodes' => [ + 'FEATUREcfwY8M1K1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123.xxx.251.60', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ObjectOperation', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation. Valid values:'."\n" + ."\n" + .'* **ignore**: adds the operation object to the whitelist.'."\n" + .'* **cancelIgnore**: removes the operation object from the whitelist.'."\n" + .'* **subscribe**: follows the operation object.'."\n" + .'* **unsubscribe**: unfollows the operation object.', + 'type' => 'string', + 'required' => true, + 'example' => 'ignore', + ], + ], + [ + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the operation object.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **assetsIp**: the asset IP address.'."\n" + .'* **destinationIp**: the destination IP address.'."\n" + .'* **destinationPort**: the destination port.'."\n" + .'* **destinationDomain**: the destination domain name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'destinationDomain', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **in**: inbound.'."\n" + .'* **out**: outbound.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'ObjectList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The operation objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The operation object.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8.25.xxx.55', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The remarks of the operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CB32593D************775F41D6ED84', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorOutgoingIgnoredReachLimit', + 'errorMessage' => 'outgoing ignored list reach limit', + ], + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorObjectOperation', + 'errorMessage' => 'The objectOperation is invalid.', + ], + [ + 'errorCode' => 'ErrorDirectionError', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorObjectType', + 'errorMessage' => 'The objectType is invalid.', + ], + [ + 'errorCode' => 'ErrorObjectList', + 'errorMessage' => 'The objectList is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + [ + 'errorCode' => 'ErrorDBDeleteError', + 'errorMessage' => 'A database delete error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB32593D************775F41D6ED84\\"\\n}","type":"json"}]', + 'title' => 'ModifyObjectGroupOperation', + ], + 'DescribeRiskEventTopAttackApp' => [ + 'summary' => '获取Top风险事件攻击APP', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68351', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '182.150.22.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1735784888', + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + 3 => '', + '', + ], + 'example' => '3', + ], + ], + [ + 'name' => 'AttackApp', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "MySQL",'."\n" + .' "Redis",'."\n" + .' "MemCached"'."\n" + .']', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BuyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 2 => '', + '', + '', + 10 => '', + ], + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C9DDAD29-C6B3-5997-B757-FFB3F1C3****', + ], + 'AttackApps' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AttackCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'DropCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'App' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'live', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9DDAD29-C6B3-5997-B757-FFB3F1C3****\\",\\n \\"AttackApps\\": [\\n {\\n \\"AttackCnt\\": 20,\\n \\"DropCnt\\": 15,\\n \\"App\\": \\"live\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRiskEventTopAttackType' => [ + 'summary' => '获取Top风险事件类型', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68353', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '140.210.153.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1670307484', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1743387943', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'out', + ], + ], + [ + 'name' => 'BuyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 2 => '', + '', + '', + 10 => '', + ], + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalProtectCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '65', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BECDBF66-91DA-5B40-8B05-0D26541A****', + ], + 'TotalAttackCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '47', + ], + 'TopAttackTypeList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AttackType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'AttackCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '38', + ], + 'ProtectCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalProtectCnt\\": 65,\\n \\"RequestId\\": \\"BECDBF66-91DA-5B40-8B05-0D26541A****\\",\\n \\"TotalAttackCnt\\": 47,\\n \\"TopAttackTypeList\\": [\\n {\\n \\"AttackType\\": 2,\\n \\"AttackCnt\\": 38,\\n \\"ProtectCnt\\": 42\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRiskEventStatistic' => [ + 'summary' => '获取风险事件统计', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68350', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '218.76.30.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1534408267', + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + 3 => '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'AttackApp', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "MySQL",'."\n" + .' "Redis",'."\n" + .' "MemCached"'."\n" + .']', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BuyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 2 => '', + '', + '', + 10 => '', + ], + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F93A490D-9E92-5AA4-BA79-600FFC09****', + ], + 'AttackIpCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AttackAppCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DropCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AttackCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F93A490D-9E92-5AA4-BA79-600FFC09****\\",\\n \\"AttackIpCnt\\": 10,\\n \\"AttackAppCnt\\": 10,\\n \\"DropCnt\\": 20,\\n \\"AttackCnt\\": 5\\n}","type":"json"}]', + ], + 'DescribeRiskEventPayload' => [ + 'summary' => 'Queries the attack payloads of intrusion events.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68349', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value is a timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1669533617', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value is a timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1681288980', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address to query. If you specify this parameter, all intrusion events from the specified source IP address are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.1', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination IP address to query. If you specify this parameter, all intrusion events with the specified destination IP address are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.2', + ], + ], + [ + 'name' => 'UUID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the intrusion event.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'e62c25e0-1073-46bd-9567-b8f12b3d****', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the firewall. Valid values:'."\n" + ."\n" + .'* **VpcFirewall**: virtual private cloud (VPC) firewall'."\n" + .'* **InternetFirewall** (default): Internet firewall'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewall', + ], + ], + [ + 'name' => 'SrcVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source VPC to query. If you specify this parameter, all intrusion events that contain the specified ID of the source VPC are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9j2lqyo15udw5nt****', + ], + ], + [ + 'name' => 'DstVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination VPC to query. If you specify this parameter, all intrusion events that contain the specified ID of the destination VPC are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6jr1klwqb60dyn2****', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The public IP address. If you specify this parameter, all intrusion events that contain the specified public IP address are queried.', + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DstIP' => [ + 'description' => 'The destination IP address of the intrusion event.'."\n", + 'type' => 'string', + 'example' => '203.0.113.1', + ], + 'DstPort' => [ + 'description' => 'The destination port of the intrusion event.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8080', + ], + 'DstVpcId' => [ + 'description' => 'The destination VPC ID of the intrusion event.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp10w5nb30r4jzfyc****', + ], + 'HitContentType' => [ + 'description' => 'Type of the hit.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HitTo' => [ + 'description' => 'The position where the hit ends.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '67', + ], + 'ParsedContent' => [ + 'description' => 'Hit payload.', + 'type' => 'string', + 'example' => '2f636f6d706f7365722f73656e645f656d61696c3f746f3d6d61667740776f66736f7961792675726c3d687474703a2f2f302e302e302e303a31323334352f692f6431366530312f313664622f673670772f', + ], + 'Payload' => [ + 'description' => 'The attack payload of the intrusion event.'."\n", + 'type' => 'string', + 'example' => '302902010004067075626c6963a01c0204036a5f43020100020100300e300c06082b060102010101000500', + ], + 'PayloadLen' => [ + 'description' => 'The length of the attack payload of the intrusion event.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '457', + ], + 'Proto' => [ + 'description' => 'The protocol type of intrusion event. Valid values:'."\n" + ."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + 'RealIp' => [ + 'description' => 'The HTTP X-Real-IP field.'."\n", + 'type' => 'string', + 'example' => '203.0.113.3', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '68055BA4-D8BD-5611-AC49-C651E619A12E', + ], + 'SrcIP' => [ + 'description' => 'The source IP address of the intrusion event.'."\n", + 'type' => 'string', + 'example' => '203.0.113.2', + ], + 'SrcPort' => [ + 'description' => 'The source port of the intrusion event.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '54360', + ], + 'SrcVpcId' => [ + 'description' => 'The source VPC ID of the intrusion event.'."\n", + 'type' => 'string', + 'example' => 'vpc-t4nlt09olhpazpoeg****', + ], + 'XForwardFor' => [ + 'description' => 'The HTTP X-Forwarded-For field.'."\n", + 'type' => 'string', + 'example' => '203.0.113.4', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallType', + 'errorMessage' => 'The specified firewall type is invalid.', + ], + [ + 'errorCode' => 'ErrorSLSLogStore', + 'errorMessage' => 'Failed to get SLS logstore.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DstIP\\": \\"203.0.113.1\\",\\n \\"DstPort\\": 8080,\\n \\"DstVpcId\\": \\"vpc-bp10w5nb30r4jzfyc****\\",\\n \\"HitContentType\\": 1,\\n \\"HitTo\\": 67,\\n \\"ParsedContent\\": \\"2f636f6d706f7365722f73656e645f656d61696c3f746f3d6d61667740776f66736f7961792675726c3d687474703a2f2f302e302e302e303a31323334352f692f6431366530312f313664622f673670772f\\",\\n \\"Payload\\": \\"302902010004067075626c6963a01c0204036a5f43020100020100300e300c06082b060102010101000500\\",\\n \\"PayloadLen\\": 457,\\n \\"Proto\\": \\"TCP\\",\\n \\"RealIp\\": \\"203.0.113.3\\",\\n \\"RequestId\\": \\"68055BA4-D8BD-5611-AC49-C651E619A12E\\",\\n \\"SrcIP\\": \\"203.0.113.2\\",\\n \\"SrcPort\\": 54360,\\n \\"SrcVpcId\\": \\"vpc-t4nlt09olhpazpoeg****\\",\\n \\"XForwardFor\\": \\"203.0.113.4\\"\\n}","type":"json"}]', + 'title' => 'DescribeRiskEventPayload', + ], + 'DescribeRiskEventGroup' => [ + 'summary' => 'Queries the details of intrusion events.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68348', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1534408189', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1534408267', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic for the intrusion events. Valid values:'."\n" + ."\n" + .'* **in**: inbound'."\n" + .'* **out**: outbound'."\n" + ."\n" + .'> If you do not specify this parameter, the intrusion events that are recorded for both inbound and outbound traffic are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: **6**. Maximum value: **10**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the risk events.\\'."\n" + .'Set the value to **session**, which indicates intrusion events.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'session', + ], + ], + [ + 'name' => 'RuleSource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The module of the rule that is used to detect the intrusion events. Valid values:'."\n" + ."\n" + .'* **1**: basic protection'."\n" + .'* **2**: virtual patching'."\n" + .'* **4**: threat intelligence'."\n" + ."\n" + .'> If you do not specify this parameter, the intrusion events that are detected by all rules are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the firewall. Valid values:'."\n" + ."\n" + .'* **1**: alerting'."\n" + .'* **2**: blocking'."\n" + ."\n" + .'> If you do not specify this parameter, all intrusion events that are detected by the firewall are queried, regardless of the firewall status.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address to query. If you specify this parameter, all intrusion events with the specified source IP address are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination IP address to query. If you specify this parameter, all intrusion events with the specified destination IP address are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'VulLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The risk level of the intrusion events. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n" + ."\n" + .'> If you do not specify this parameter, the intrusion events that are at all risk levels are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the firewall. Valid values:'."\n" + ."\n" + .'* **VpcFirewall**: virtual private cloud (VPC) firewall'."\n" + .'* **InternetFirewall**: Internet firewall (default)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewall', + ], + ], + [ + 'name' => 'SrcNetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source VPC.'."\n" + ."\n" + .'> If the FirewallType parameter is set to VpcFirewall, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6e9a9zyokj2ywuo****', + ], + ], + [ + 'name' => 'DstNetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination VPC.'."\n" + ."\n" + .'> If the FirewallType parameter is set to VpcFirewall, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6e9a9zyokj2ywuo****', + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The attack type of the intrusion events. Valid values:'."\n" + ."\n" + .'* **1**: suspicious connection'."\n" + .'* **2**: command execution'."\n" + .'* **3**: brute-force attack'."\n" + .'* **4**: scanning'."\n" + .'* **5**: others'."\n" + .'* **6**: information leak'."\n" + .'* **7**: DoS attack'."\n" + .'* **8**: buffer overflow attack'."\n" + .'* **9**: web attack'."\n" + .'* **10**: trojan backdoor'."\n" + .'* **11**: computer worm'."\n" + .'* **12**: mining'."\n" + .'* **13**: reverse shell'."\n" + ."\n" + .'> If you do not specify this parameter, the intrusion events of all attack types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NoLocation', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the information about the geographical locations of IP addresses.'."\n" + ."\n" + .'* **true**: does not query the information about the geographical locations of IP addresses.'."\n" + .'* **false**: queries the information about the geographical locations of IP addresses. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AttackApp', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The names of the attacked applications. Set the value in the `["AttackApp1","AttackApp2"]` format.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the attacked application. Set the value in the `["AttackApp1","AttackApp2"]` format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + ], + 'required' => false, + 'example' => '["MySql","DNS"]', + 'maxItems' => 50, + 'minItems' => 0, + ], + ], + [ + 'name' => 'BuyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of Cloud Firewall that you purchase. Valid values:'."\n" + ."\n" + .'* **2**: Premium Edition'."\n" + .'* **3**: Enterprise Edition'."\n" + .'* **4**: Ultimate Edition'."\n" + .'* **10**: Cloud Firewall that uses the pay-as-you-go billing method'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field based on which you want to sort the results. Valid values:'."\n" + ."\n" + .'* **VulLevel**: The results are sorted based on the risk level field. This is the default value.'."\n" + .'* **LastTime**: The results are sorted based on the most recent occurrence time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LastTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which you want to sort the results. Valid values:'."\n" + ."\n" + .'* **asc**: the ascending order.'."\n" + .'* **desc**: the descending order. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the intrusion event.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Webshell communication'."\n", + ], + ], + [ + 'name' => 'IsOnlyPrivateAssoc', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to query only the data that has completed private network tracing.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AttackAppCategory', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'A list of categories of attacked applications, expressed in the format ["AttackAppCategory1","AttackAppCategory2"].', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of categories of attacked applications, expressed in the format ["AttackAppCategory1","AttackAppCategory2"].', + 'type' => 'string', + 'required' => false, + 'example' => 'AI Components', + ], + 'required' => false, + 'maxItems' => 50, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of risk events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B14757D0-4640-4B44-AC67-7F558FE7E6EF', + ], + 'DataList' => [ + 'description' => 'An array that consists of the details of the intrusion events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the intrusion event.'."\n", + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => 'The direction of the traffic for the intrusion event. Valid values:'."\n" + ."\n" + .'* **in**: inbound'."\n" + .'* **out**: outbound'."\n", + 'type' => 'string', + 'example' => 'in', + ], + 'EventName' => [ + 'description' => 'The name of the intrusion event.'."\n", + 'type' => 'string', + 'example' => 'Path traversal attack'."\n", + ], + 'DstIP' => [ + 'description' => 'The destination IP address that is included in the intrusion event.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'AttackType' => [ + 'description' => 'The attack type of the intrusion event. Valid values:'."\n" + ."\n" + .'* **1**: suspicious connection'."\n" + .'* **2**: command execution'."\n" + .'* **3**: brute-force attack'."\n" + .'* **4**: scanning'."\n" + .'* **5**: others'."\n" + .'* **6**: information leak'."\n" + .'* **7**: DoS attack'."\n" + .'* **8**: buffer overflow attack'."\n" + .'* **9**: web attack'."\n" + .'* **10**: trojan backdoor'."\n" + .'* **11**: computer worm'."\n" + .'* **12**: mining'."\n" + .'* **13**: reverse shell'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tag' => [ + 'description' => 'The tag added to the threat intelligence that is provided for major events.'."\n", + 'type' => 'string', + 'example' => 'Threat intelligence provided for major events'."\n", + ], + 'RuleId' => [ + 'description' => 'The ID of the rule that is used to detect the intrusion event.'."\n", + 'type' => 'string', + 'example' => '1000****', + ], + 'EventId' => [ + 'description' => 'The ID of the intrusion event.'."\n", + 'type' => 'string', + 'example' => '2b58efae-4c4b-4d96-9544-a586fb1f****', + ], + 'ResourceType' => [ + 'description' => 'The type of the public IP address in the intrusion event. Valid values:'."\n" + ."\n" + .'* **EIP**: the elastic IP address (EIP)'."\n" + .'* **EcsPublicIP**: the public IP address of an Elastic Compute Service (ECS) instance'."\n" + .'* **EcsEIP**: the EIP of an ECS instance'."\n" + .'* **NatPublicIP**: the public IP address of a NAT gateway'."\n" + .'* **NatEIP**: the EIP of a NAT gateway'."\n", + 'type' => 'string', + 'example' => 'EcsPublicIP', + ], + 'FirstEventTime' => [ + 'description' => 'The time when the intrusion event was first detected. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1534408189', + ], + 'Description' => [ + 'description' => 'The description of the intrusion event.'."\n", + 'type' => 'string', + 'example' => 'Path traversal attacks are detected in the web access requests over HTTP.'."\n", + ], + 'EventCount' => [ + 'description' => 'The number of intrusion events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'VulLevel' => [ + 'description' => 'The risk level of the intrusion event. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AttackApp' => [ + 'description' => 'The name of the attacked application.'."\n", + 'type' => 'string', + 'example' => 'MySql', + ], + 'RuleSource' => [ + 'description' => 'The module of the rule that is used to detect the intrusion event. Valid values:'."\n" + ."\n" + .'* **1**: basic protection'."\n" + .'* **2**: virtual patching'."\n" + .'* **4**: threat intelligence'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleResult' => [ + 'description' => 'The status of the firewall. Valid values:'."\n" + ."\n" + .'* **1**: alerting'."\n" + .'* **2**: blocking'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SrcIP' => [ + 'description' => 'The source IP address that is included in the intrusion event.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'LastEventTime' => [ + 'description' => 'The time when the intrusion event was last detected. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1534408267', + ], + 'ResourcePrivateIPList' => [ + 'description' => 'The information about the private IP address in the intrusion event. The value is an array that contains the following parameters: **RegionNo**, **ResourceInstanceId**, **ResourceInstanceName**, and **ResourcePrivateIP**.\\'."\n" + .'****************'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the private IP address in the intrusion event. The value is an array that contains the following parameters: **RegionNo**, **ResourceInstanceId**, **ResourceInstanceName**, and **ResourcePrivateIP**.\\'."\n" + .'****************'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceInstanceName' => [ + 'description' => 'The name of the instance that uses the private IP address.'."\n", + 'type' => 'string', + 'example' => 'LD-shenzhen-zy****', + ], + 'ResourcePrivateIP' => [ + 'description' => 'The private IP address.'."\n", + 'type' => 'string', + 'example' => '10.255.XX.XX', + ], + 'ResourceInstanceId' => [ + 'description' => 'The ID of the instance that uses the private IP address.'."\n", + 'type' => 'string', + 'example' => 'i-wz92jf4scg2zb74p****', + ], + 'RegionNo' => [ + 'description' => 'The ID of the region to which the private IP address belongs.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'SrcPrivateIPList' => [ + 'description' => 'An array that consists of the source private IP addresses in the intrusion event.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The source private IP address in the intrusion event.'."\n" + ."\n" + .'> The value of this parameter is returned only when the value of Direction is out.'."\n", + 'type' => 'string', + 'example' => '["192.168.XX.XX","192.168.XX.XX"]', + ], + ], + 'VpcSrcInfo' => [ + 'description' => 'The information about the source VPC of the intrusion event. The value is a struct that contains the following parameters: **EcsInstanceId**, **EcsInstanceName**, **NetworkInstanceId**, **NetworkInstanceName**, and **RegionNo**.\\'."\n" + .'********************'."\n", + 'type' => 'object', + 'properties' => [ + 'EcsInstanceName' => [ + 'description' => 'The name of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'LD-shenzhen-zy****', + ], + 'NetworkInstanceName' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'VPC-SH-TX****', + ], + 'NetworkInstanceId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6e9a9zyokj2ywuo****', + ], + 'EcsInstanceId' => [ + 'description' => 'The ID of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'i-wz92jf4scg2zb74p****', + ], + 'RegionNo' => [ + 'description' => 'The ID of the region in which the source VPC resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'VpcDstInfo' => [ + 'description' => 'The information about the destination VPC of the intrusion event. The value is a struct that contains the following parameters: **EcsInstanceId**, **EcsInstanceName**, **NetworkInstanceId**, **NetworkInstanceName**, and **RegionNo**.\\'."\n" + .'********************'."\n", + 'type' => 'object', + 'properties' => [ + 'EcsInstanceName' => [ + 'description' => 'The name of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'LD-shenzhen-zy****', + ], + 'NetworkInstanceName' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'VPC-SH-TX****', + ], + 'NetworkInstanceId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6e9a9zyokj2ywuo****', + ], + 'EcsInstanceId' => [ + 'description' => 'The ID of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'i-wz92jf4scg2zb74p****', + ], + 'RegionNo' => [ + 'description' => 'The ID of the region in which the destination VPC resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'IPLocationInfo' => [ + 'description' => 'The geographical information about the IP address. The value is a struct that contains the following parameters: **CityId**, **CityName**, **CountryId**, and **CountryName**.\\'."\n" + .'****************'."\n", + 'type' => 'object', + 'properties' => [ + 'CityId' => [ + 'description' => 'The ID of the city to which the IP address belongs.'."\n", + 'type' => 'string', + 'example' => '510100', + ], + 'CountryName' => [ + 'description' => 'The name of the country to which the IP address belongs.'."\n", + 'type' => 'string', + 'example' => 'China'."\n", + ], + 'CityName' => [ + 'description' => 'The name of the city to which the IP address belongs.'."\n", + 'type' => 'string', + 'example' => 'Chengdu, Sichuan Province'."\n", + ], + 'CountryId' => [ + 'description' => 'The ID of the country to which the IP address belongs.'."\n", + 'type' => 'string', + 'example' => 'CN', + ], + ], + ], + 'SrcIPTag' => [ + 'description' => 'The tag added to the source IP address. The tag helps identify whether the source IP address is a back-to-origin IP address for a cloud service.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'example' => 'WAF Back-to-origin Address', + ], + 'SrcIPTags' => [ + 'title' => 'IP标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'IP标签。', + 'type' => 'string', + 'example' => 'Anti-DDoS Back-to-origin Address', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallType', + 'errorMessage' => 'The specified firewall type is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDirectionError', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorRuleSourceError', + 'errorMessage' => 'The rule source is invalid.', + ], + [ + 'errorCode' => 'ErrorRuleResultError', + 'errorMessage' => 'The rule result is invalid.', + ], + [ + 'errorCode' => 'ErrorVulLevelFailed', + 'errorMessage' => 'VulLevel has failed.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'time range invalid.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"B14757D0-4640-4B44-AC67-7F558FE7E6EF\\",\\n \\"DataList\\": [\\n {\\n \\"Direction\\": \\"in\\",\\n \\"EventName\\": \\"Web目录穿越攻击\\",\\n \\"DstIP\\": \\"192.0.XX.XX\\",\\n \\"AttackType\\": 1,\\n \\"Tag\\": \\"重保情报\\",\\n \\"RuleId\\": \\"1000****\\",\\n \\"EventId\\": \\"2b58efae-4c4b-4d96-9544-a586fb1f****\\",\\n \\"ResourceType\\": \\"EcsPublicIP\\",\\n \\"FirstEventTime\\": 1534408189,\\n \\"Description\\": \\"检测到HTTP请求的Web访问中使用了目录穿越攻击。\\",\\n \\"EventCount\\": 100,\\n \\"VulLevel\\": 1,\\n \\"AttackApp\\": \\"MySql\\",\\n \\"RuleSource\\": 1,\\n \\"RuleResult\\": 2,\\n \\"SrcIP\\": \\"192.0.XX.XX\\",\\n \\"LastEventTime\\": 1534408267,\\n \\"ResourcePrivateIPList\\": [\\n {\\n \\"ResourceInstanceName\\": \\"LD-shenzhen-zy****\\",\\n \\"ResourcePrivateIP\\": \\"10.255.XX.XX\\",\\n \\"ResourceInstanceId\\": \\"i-wz92jf4scg2zb74p****\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"SrcPrivateIPList\\": [\\n \\"[\\\\\\"192.168.XX.XX\\\\\\",\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"VpcSrcInfo\\": {\\n \\"EcsInstanceName\\": \\"LD-shenzhen-zy****\\",\\n \\"NetworkInstanceName\\": \\"VPC-SH-TX****\\",\\n \\"NetworkInstanceId\\": \\"vpc-uf6e9a9zyokj2ywuo****\\",\\n \\"EcsInstanceId\\": \\"i-wz92jf4scg2zb74p****\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\"\\n },\\n \\"VpcDstInfo\\": {\\n \\"EcsInstanceName\\": \\"LD-shenzhen-zy****\\",\\n \\"NetworkInstanceName\\": \\"VPC-SH-TX****\\",\\n \\"NetworkInstanceId\\": \\"vpc-uf6e9a9zyokj2ywuo****\\",\\n \\"EcsInstanceId\\": \\"i-wz92jf4scg2zb74p****\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\"\\n },\\n \\"IPLocationInfo\\": {\\n \\"CityId\\": \\"510100\\",\\n \\"CountryName\\": \\"中国\\",\\n \\"CityName\\": \\"四川省成都\\",\\n \\"CountryId\\": \\"CN\\"\\n },\\n \\"SrcIPTag\\": \\"WAF Back-to-origin Address\\",\\n \\"SrcIPTags\\": [\\n \\"Anti-DDoS Back-to-origin Address\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeRiskEventGroupResponse>\\n <TotalCount>20</TotalCount>\\n <RequestId>B14757D0-4640-4B44-AC67-7F558FE7E6EF</RequestId>\\n <DataList>\\n <Direction>in</Direction>\\n <EventName>WEB目录穿越攻击</EventName>\\n <DstIP>192.0.XX.XX</DstIP>\\n <AttackType>1</AttackType>\\n <Tag>重保情报</Tag>\\n <RuleId>1000****</RuleId>\\n <EventId>2b58efae-4c4b-4d96-9544-a586fb1f****</EventId>\\n <ResourceType>EcsPublicIP</ResourceType>\\n <FirstEventTime>1534408189</FirstEventTime>\\n <Description>检测到HTTP请求的WEB访问中使用了目录穿越攻击。</Description>\\n <EventCount>100</EventCount>\\n <VulLevel>1</VulLevel>\\n <AttackApp>MySql</AttackApp>\\n <RuleSource>1</RuleSource>\\n <RuleResult>2</RuleResult>\\n <SrcIP>192.0.XX.XX</SrcIP>\\n <LastEventTime>1534408267</LastEventTime>\\n <ResourcePrivateIPList>\\n <ResourceInstanceName>LD-shenzhen-zy****</ResourceInstanceName>\\n <ResourcePrivateIP>10.255.XX.XX</ResourcePrivateIP>\\n <ResourceInstanceId>i-wz92jf4scg2zb74p****</ResourceInstanceId>\\n <RegionNo>cn-hangzhou</RegionNo>\\n </ResourcePrivateIPList>\\n <SrcPrivateIPList>[\\"192.168.XX.XX\\",\\"192.168.XX.XX\\"]</SrcPrivateIPList>\\n <VpcSrcInfo>\\n <EcsInstanceName>LD-shenzhen-zy****</EcsInstanceName>\\n <NetworkInstanceName>VPC-SH-TX****</NetworkInstanceName>\\n <NetworkInstanceId>vpc-uf6e9a9zyokj2ywuo****</NetworkInstanceId>\\n <EcsInstanceId>i-wz92jf4scg2zb74p****</EcsInstanceId>\\n <RegionNo>cn-hangzhou</RegionNo>\\n </VpcSrcInfo>\\n <VpcDstInfo>\\n <EcsInstanceName>LD-shenzhen-zy****</EcsInstanceName>\\n <NetworkInstanceName>VPC-SH-TX****</NetworkInstanceName>\\n <NetworkInstanceId>vpc-uf6e9a9zyokj2ywuo****</NetworkInstanceId>\\n <EcsInstanceId>i-wz92jf4scg2zb74p****</EcsInstanceId>\\n <RegionNo>cn-hangzhou</RegionNo>\\n </VpcDstInfo>\\n <IPLocationInfo>\\n <CityId>510100</CityId>\\n <CountryName>中国</CountryName>\\n <CityName>四川省成都</CityName>\\n <CountryId>CN</CountryId>\\n </IPLocationInfo>\\n </DataList>\\n</DescribeRiskEventGroupResponse>","errorExample":""}]', + 'title' => 'DescribeRiskEventGroup', + 'description' => 'You can call the DescribeRiskEventGroup operation to query and download the details of intrusion events. We recommend that you query the details of 5 to 10 intrusion events at a time. If you do not need to query the geographical information about IP addresses, you can set the NoLocation parameter to true to prevent query timeout.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see [Common parameters](~~94763~~). For more information about sample requests, see the "**Examples**" section of this topic.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVulnerabilityProtectedList' => [ + 'summary' => 'Queries the vulnerabilities that are supported by Cloud Firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68447', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + 'FEATUREcfwIT6TRR', + 'FEATUREcfwQROEEE', + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the access source.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '112.239.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1655778046', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1646063922', + ], + ], + [ + 'name' => 'VulnStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of vulnerability protection. Valid values:'."\n" + ."\n" + .'* **partProtected**: partially protected'."\n" + .'* **protected**: protected'."\n" + .'* **unProtected**: unprotected'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'protected' => 'protected', + 'unProtected' => 'unProtected', + 'partProtected' => 'partProtected', + ], + 'example' => 'protected', + ], + ], + [ + 'name' => 'VulnCveName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Common Vulnerabilities and Exposures (CVE) ID of the vulnerability.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CVE-2022-2992', + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The attack type of the vulnerability prevention event. Valid values:'."\n" + ."\n" + .'* **1**: suspicious connection'."\n" + .'* **2**: command execution'."\n" + .'* **3**: brute-force attack'."\n" + .'* **4**: scanning'."\n" + .'* **5**: others'."\n" + .'* **6**: information leakage'."\n" + .'* **7**: DoS attack'."\n" + .'* **8**: buffer overflow attack'."\n" + .'* **9**: web attack'."\n" + .'* **10**: webshell'."\n" + .'* **11**: computer worm'."\n" + .'* **12**: mining'."\n" + .'* **13**: reverse shell'."\n" + ."\n" + .'> If you do not specify this parameter, the intrusion events of all attack types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '13', + ], + ], + [ + 'name' => 'VulnType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the vulnerability. Valid values:'."\n" + ."\n" + .'* **App**: application vulnerability'."\n" + .'* **emg**: urgent vulnerability'."\n" + .'* **cms**: Web-CMS vulnerability'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'emg', + ], + ], + [ + 'name' => 'VulnLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The risk level of the vulnerability. Valid values:'."\n" + ."\n" + .'* **high**'."\n" + .'* **medium**'."\n" + .'* **low**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting basis. Set the value to **attackCnt**, which indicates the number of attacks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'attackCnt', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which you want to sort the queried information. Valid values:'."\n" + ."\n" + .'* **asc**: the ascending order.'."\n" + .'* **desc**: the descending order. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'VulnResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of assets that are affected by the vulnerability.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the user. Set the value to **buy**, which indicates user of a paid edition of Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'buy', + ], + ], + [ + 'name' => 'BuyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of Cloud Firewall. If you use Cloud Firewall that uses the pay-as-you-go billing method, set the value to 10. You do not need to specify this parameter for other editions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'RuleTag', + 'in' => 'query', + 'schema' => [ + 'title' => '规则标签：AI', + 'description' => '漏洞标签，取值：'."\n" + ."\n" + .' - **AI**： AI组件相关漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D355C631-1537-59C5-A56E-F6C5037B99E5', + ], + 'TotalCount' => [ + 'description' => 'The total number of vulnerabilities that are detected by Cloud Firewall.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ZeroResourceCount' => [ + 'description' => 'The number of assets on which no vulnerabilities are detected.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VulnList' => [ + 'description' => 'The vulnerabilities.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the vulnerability.'."\n", + 'type' => 'object', + 'properties' => [ + 'VulnName' => [ + 'description' => 'The name of the vulnerability.'."\n", + 'type' => 'string', + 'example' => 'Deserialization vulnerability of arbitrary code execution in Fastjson 1.2.80 and earlier versions'."\n", + ], + 'AttackType' => [ + 'description' => 'The attack type of the vulnerability prevention event. Valid values:'."\n" + ."\n" + .'* **1**: suspicious connection'."\n" + .'* **2**: command execution'."\n" + .'* **3**: brute-force attack'."\n" + .'* **4**: scanning'."\n" + .'* **5**: others'."\n" + .'* **6**: information leakage'."\n" + .'* **7**: DoS attack'."\n" + .'* **8**: buffer overflow attack'."\n" + .'* **9**: web attack'."\n" + .'* **10**: webshell'."\n" + .'* **11**: computer worm'."\n" + .'* **12**: mining'."\n" + .'* **13**: reverse shell'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'NeedRuleClass' => [ + 'description' => 'The type of the rule group. Valid values:'."\n" + ."\n" + .'* **1** (default): loose'."\n" + .'* **2**: medium'."\n" + .'* **3**: strict'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VulnType' => [ + 'description' => 'The type of the vulnerability. Valid values:'."\n" + ."\n" + .'* **emg**: urgent vulnerability'."\n" + .'* **webcms**: Web-CMS vulnerability'."\n" + .'* **app**: application vulnerability'."\n", + 'type' => 'string', + 'example' => 'emg', + ], + 'VulnKey' => [ + 'description' => 'The code of the vulnerability.'."\n", + 'type' => 'string', + 'example' => 'dedecms-archive.helper.php-vul', + ], + 'VulnLevel' => [ + 'description' => 'The risk level of the vulnerability. Valid values:'."\n" + ."\n" + .'* **high**'."\n" + .'* **medium**'."\n" + .'* **low**'."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'NeedOpenBasicRule' => [ + 'description' => 'Indicates whether the basic protection policy that related to the vulnerability is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> If the value of this parameter is true, you must set the action of the basic protection policy related to the vulnerability to Block.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'CveId' => [ + 'description' => 'The CVE IDs.'."\n", + 'type' => 'string', + 'example' => '12112131123, 1231123112', + ], + 'FirstTime' => [ + 'description' => 'The time when the first attack was launched.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1608687364', + ], + 'BasicRuleIds' => [ + 'description' => 'The IDs of associated basic protection policies.'."\n", + 'type' => 'string', + 'example' => '12,12', + ], + 'LastTime' => [ + 'description' => 'The time when the last attack was launched.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1608687364', + ], + 'NeedOpenVirtualPatcheUuids' => [ + 'description' => 'The UUIDs of the virtual patching policies for which the action needs to be changed to Block.'."\n", + 'type' => 'string', + 'example' => 'UUID-1231231234', + ], + 'NeedOpenBasicRuleUuids' => [ + 'description' => 'The UUIDs of the basic protection policies for which the action needs to be changed to Block.'."\n", + 'type' => 'string', + 'example' => 'UUID-1231231', + ], + 'NeedOpenVirtualPatche' => [ + 'description' => 'Indicates whether the virtual patching policy that related to the vulnerability is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> If the value of this parameter is true, you must set the action of the virtual patching policy that related to the vulnerability to Block.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'VirtualPatcheIds' => [ + 'description' => 'The IDs of associated virtual patching policies.'."\n", + 'type' => 'string', + 'example' => '13,13', + ], + 'HighlightTag' => [ + 'description' => 'Indicates whether you need to pay special attention to the vulnerability. Valid values:'."\n" + ."\n" + .'* **0**: no'."\n" + .'* **1**: yes'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NeedOpenRunMode' => [ + 'description' => 'Indicates whether Threat Engine Mode needs to be configured when you enable protection. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'VulnStatus' => [ + 'description' => 'The status of the vulnerability prevention feature. Valid values:'."\n" + ."\n" + .'* **partProtected**: enabled for partial assets'."\n" + .'* **protected**: enabled'."\n" + .'* **unProtected**: disabled'."\n", + 'type' => 'string', + 'example' => 'protected', + ], + 'AttackCnt' => [ + 'description' => 'The number of vulnerability attacks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceCnt' => [ + 'description' => 'The number of assets on which vulnerabilities are detected.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MemberUid' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '119384235299****', + ], + 'ResourceList' => [ + 'description' => 'The assets on which the vulnerability is detected.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the asset.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The type of the asset. Valid values:'."\n" + ."\n" + .'* **SLB**'."\n" + .'* **EIP**'."\n" + .'* **ECS**'."\n", + 'type' => 'string', + 'example' => 'EIP', + ], + 'Eip' => [ + 'description' => 'The elastic IP address (EIP) that is associated with the instance.'."\n", + 'type' => 'string', + 'example' => '203.107.XX.XX', + ], + 'InternetIp' => [ + 'description' => 'The public IP address of the instance.'."\n", + 'type' => 'string', + 'example' => '47.96.XX.XX', + ], + 'VulnStatus' => [ + 'description' => 'The status of the vulnerability prevention feature. Valid values:'."\n" + ."\n" + .'* **partProtected**: enabled for partial assets'."\n" + .'* **protected**: enabled'."\n" + .'* **unProtected**: disabled'."\n", + 'type' => 'string', + 'example' => 'protected', + ], + 'ResourceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'ResourceName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'ECS', + ], + 'IntranetIp' => [ + 'description' => 'The private IP address of the instance.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'RegionId' => [ + 'description' => 'The region ID of your Cloud Firewall.'."\n" + ."\n" + .'> For more information about Cloud Firewall supported regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + 'RuleTag' => [ + 'description' => '漏洞标签，取值：'."\n" + ."\n" + .'- **AI**： AI相关漏洞', + 'type' => 'string', + 'enumValueTitles' => [ + 'AI' => 'AI相关漏洞', + ], + 'example' => 'AI', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorAttackTypeError', + 'errorMessage' => 'attack type invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D355C631-1537-59C5-A56E-F6C5037B99E5\\",\\n \\"TotalCount\\": 5,\\n \\"ZeroResourceCount\\": 1,\\n \\"VulnList\\": [\\n {\\n \\"VulnName\\": \\"fastjson <= 1.2.80 反序列化任意代码执行漏洞\\",\\n \\"AttackType\\": 13,\\n \\"NeedRuleClass\\": 1,\\n \\"VulnType\\": \\"emg\\",\\n \\"VulnKey\\": \\"dedecms-archive.helper.php-vul\\",\\n \\"VulnLevel\\": \\"high\\",\\n \\"NeedOpenBasicRule\\": false,\\n \\"CveId\\": \\"12112131123, 1231123112\\",\\n \\"FirstTime\\": 1608687364,\\n \\"BasicRuleIds\\": \\"12,12\\",\\n \\"LastTime\\": 1608687364,\\n \\"NeedOpenVirtualPatcheUuids\\": \\"UUID-1231231234\\",\\n \\"NeedOpenBasicRuleUuids\\": \\"UUID-1231231\\",\\n \\"NeedOpenVirtualPatche\\": true,\\n \\"VirtualPatcheIds\\": \\"13,13\\",\\n \\"HighlightTag\\": 0,\\n \\"NeedOpenRunMode\\": true,\\n \\"VulnStatus\\": \\"protected\\",\\n \\"AttackCnt\\": 0,\\n \\"ResourceCnt\\": 0,\\n \\"MemberUid\\": \\"119384235299****\\",\\n \\"ResourceList\\": [\\n {\\n \\"ResourceType\\": \\"EIP\\",\\n \\"Eip\\": \\"203.107.XX.XX\\",\\n \\"InternetIp\\": \\"47.96.XX.XX\\",\\n \\"VulnStatus\\": \\"protected\\",\\n \\"ResourceId\\": \\"vfw-m5e7dbc4y****\\",\\n \\"ResourceName\\": \\"ECS\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"RuleTag\\": \\"AI\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeVulnerabilityProtectedListResponse>\\n <RequestId>D355C631-1537-59C5-A56E-F6C5037B99E5</RequestId>\\n <TotalCount>5</TotalCount>\\n <ZeroResourceCount>1</ZeroResourceCount>\\n <VulnList>\\n <VulnName>fastjson <= 1.2.80 反序列化任意代码执行漏洞</VulnName>\\n <AttackType>13</AttackType>\\n <NeedRuleClass>1</NeedRuleClass>\\n <VulnType>emg</VulnType>\\n <VulnKey>dedecms-archive.helper.php-vul</VulnKey>\\n <VulnLevel>high</VulnLevel>\\n <NeedOpenBasicRule>false</NeedOpenBasicRule>\\n <CveId>12112131123, 1231123112</CveId>\\n <FirstTime>1608687364</FirstTime>\\n <BasicRuleIds>12,12</BasicRuleIds>\\n <LastTime>1608687364</LastTime>\\n <NeedOpenVirtualPatcheUuids>UUID-1231231234</NeedOpenVirtualPatcheUuids>\\n <NeedOpenBasicRuleUuids>UUID-1231231</NeedOpenBasicRuleUuids>\\n <NeedOpenVirtualPatche>true</NeedOpenVirtualPatche>\\n <VirtualPatcheIds>13,13</VirtualPatcheIds>\\n <HighlightTag>0</HighlightTag>\\n <NeedOpenRunMode>true</NeedOpenRunMode>\\n <VulnStatus>protected</VulnStatus>\\n <AttackCnt>0</AttackCnt>\\n <ResourceCnt>0</ResourceCnt>\\n <ResourceList>\\n <ResourceType>EIP</ResourceType>\\n <Eip>203.107.XX.XX</Eip>\\n <InternetIp>47.96.XX.XX</InternetIp>\\n <VulnStatus>protected</VulnStatus>\\n <ResourceId>vfw-m5e7dbc4y****</ResourceId>\\n <ResourceName>ECS</ResourceName>\\n <IntranetIp>192.168.XX.XX</IntranetIp>\\n <RegionId>cn-beijing</RegionId>\\n </ResourceList>\\n </VulnList>\\n</DescribeVulnerabilityProtectedListResponse>","errorExample":""}]', + 'title' => 'DescribeVulnerabilityProtectedList', + ], + 'DescribeUnprotectedVulnTrend' => [ + 'summary' => '获取未保护漏洞趋势', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68394', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + 'FEATUREcfwIT6TRR', + 'FEATUREcfwQROEEE', + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '112.15.190.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1740623016', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1754878752', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1731551104', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1749434787', + ], + 'CurProtectedCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '05BEF2B5-EAAA-509D-9824-E3C7DC17****', + ], + 'Interval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'CurUnprotectedCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1525833105', + ], + 'ProtectedVulnCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'UnprotectedVulnCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": 1731551104,\\n \\"StartTime\\": 1749434787,\\n \\"CurProtectedCnt\\": 7,\\n \\"RequestId\\": \\"05BEF2B5-EAAA-509D-9824-E3C7DC17****\\",\\n \\"Interval\\": 60,\\n \\"CurUnprotectedCnt\\": 8,\\n \\"DataList\\": [\\n {\\n \\"Time\\": 1525833105,\\n \\"ProtectedVulnCnt\\": 3,\\n \\"UnprotectedVulnCnt\\": 2\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInvadeEventList' => [ + 'summary' => 'Queries the information about the breach awareness events of a firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68290', + 'abilityTreeNodes' => [ + 'FEATUREcfwIT6TRR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'title' => '源IP', + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言', + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the query starts from 30 days before the current time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1656750960', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the query ends at the current time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1656837360', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页多少条', + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 6. Maximum value: 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AssetsInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ins_1321_asedb_****', + ], + ], + [ + 'name' => 'AssetsInstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_test', + ], + ], + [ + 'name' => 'IsIgnore', + 'in' => 'query', + 'schema' => [ + 'title' => '是否忽略', + 'description' => 'Specifies whether the breach awareness event is ignored. Valid values:'."\n" + ."\n" + .'* **true**: The breach awareness event is ignored.'."\n" + .'* **false**: The breach awareness event is not ignored.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AssetsIP', + 'in' => 'query', + 'schema' => [ + 'title' => '资产IP', + 'description' => 'The IP address of the affected asset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + ], + [ + 'name' => 'EventKey', + 'in' => 'query', + 'schema' => [ + 'title' => '事件key', + 'description' => 'The ID of the breach awareness event.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '69d189e2-ec17-4676-a2fe-02969234****', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'title' => '事件名称', + 'description' => 'The name of the breach awareness event.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'event_test', + ], + ], + [ + 'name' => 'EventUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '事件UUID', + 'description' => 'The UUID of the breach awareness event.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fadd-dfdd-****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'title' => '成员账号UID', + 'description' => 'The ID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'ProcessStatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '处理状态列表', + 'description' => 'The handling status of breach awareness events.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '处理状态', + 'description' => 'The handling status of the breach awareness event. Valid values:'."\n" + ."\n" + .'* **0**: unhandled'."\n" + .'* **20**: handled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [], + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '风险等级', + 'description' => 'The risk levels.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '风险等级值', + 'description' => 'The risk level. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'enum' => [], + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LowLevelPercent' => [ + 'title' => '低风险等级比例', + 'description' => 'The percentage of low-risk events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'MiddleLevelPercent' => [ + 'title' => '中风险等级比例', + 'description' => 'The percentage of medium-risk events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'HighLevelPercent' => [ + 'title' => '高风险等级比例', + 'description' => 'The percentage of high-risk events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'PageInfo' => [ + 'title' => '分页信息', + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页', + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of breach awareness events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + ], + 'EventList' => [ + 'title' => '事件列表', + 'description' => 'An array that consists of breach awareness events.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'title' => '风险等级', + 'description' => 'The risk level. Valid values:'."\n" + ."\n" + .'* **1**: low'."\n" + .'* **2**: medium'."\n" + .'* **3**: high'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [], + ], + 'EventName' => [ + 'title' => '事件名称', + 'description' => 'The name of the breach awareness event.'."\n", + 'type' => 'string', + 'example' => 'event_test', + ], + 'EventKey' => [ + 'title' => 'CVE编号', + 'description' => 'The ID of the breach awareness event.'."\n", + 'type' => 'string', + 'example' => '69d189e2-ec17-4676-a2fe-02969234****', + ], + 'EventUuid' => [ + 'title' => '事件UUID', + 'description' => 'The UUID of the breach awareness event.'."\n", + 'type' => 'string', + 'example' => 'fadd-dfdd-****', + ], + 'MemberUid' => [ + 'title' => '成员账号UID', + 'description' => 'The ID of the member.'."\n", + 'type' => 'string', + 'example' => '135809047715****', + ], + 'AssetsType' => [ + 'title' => '资产类型', + 'description' => 'The type of the affected asset. Valid values:'."\n" + ."\n" + .'* **BastionHostIP**: the egress IP address of a bastion host'."\n" + .'* **BastionHostIngressIP**: the ingress IP address of a bastion host'."\n" + .'* **EcsEIP**: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance'."\n" + .'* **EcsPublicIP**: the public IP address of an ECS instance'."\n" + .'* **EIP**: the EIP'."\n" + .'* **EniEIP**: the EIP of an elastic network interface (ENI)'."\n" + .'* **NatEIP**: the EIP of a NAT gateway'."\n" + .'* **SlbEIP**: the EIP of a Server Load Balancer (SLB) instance'."\n" + .'* **SlbPublicIP**: the public IP address of an SLB instance'."\n" + .'* **NatPublicIP**: the public IP address of a NAT gateway'."\n" + .'* **HAVIP**: the high-availability virtual IP address (HAVIP)'."\n", + 'type' => 'string', + 'example' => 'EcsPublicIp', + ], + 'FirstTime' => [ + 'title' => '首次出现时间', + 'description' => 'The time when the breach awareness event first occurred. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1656750960', + ], + 'EventSrc' => [ + 'title' => '事件来源', + 'description' => 'The type of the breach awareness event. Valid values:'."\n" + ."\n" + .'* **IPS**: intrusion prevention event'."\n" + .'* **offline**: disconnection event'."\n", + 'type' => 'string', + 'example' => 'IPS', + ], + 'PrivateIP' => [ + 'title' => '私网IP', + 'description' => 'The private IP address of the affected asset.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AssetsInstanceName' => [ + 'title' => '资产名称', + 'description' => 'The name of the affected asset.'."\n", + 'type' => 'string', + 'example' => 'ECS_test', + ], + 'LastTime' => [ + 'title' => '最近一次时间', + 'description' => 'The time when the breach awareness event last occurred. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1656837360', + ], + 'PublicIpType' => [ + 'title' => '公开类型', + 'description' => 'The type of the affected asset. Valid values:'."\n" + ."\n" + .'* **BastionHostIP**: the egress IP address of a bastion host'."\n" + .'* **BastionHostIngressIP**: the ingress IP address of a bastion host'."\n" + .'* **EcsEIP**: the EIP of an ECS instance'."\n" + .'* **EcsPublicIP**: the public IP address of an ECS instance'."\n" + .'* **EIP**: the EIP'."\n" + .'* **EniEIP**: the EIP of an ENI'."\n" + .'* **NatEIP**: the EIP of a NAT gateway'."\n" + .'* **SlbEIP**: the EIP of an SLB instance'."\n" + .'* **SlbPublicIP**: the public IP address of an SLB instance'."\n" + .'* **NatPublicIP**: the public IP address of a NAT gateway'."\n" + .'* **HAVIP**: the HAVIP'."\n", + 'type' => 'string', + 'example' => 'EcsPublicIp', + ], + 'IsIgnore' => [ + 'title' => '是否忽略', + 'description' => 'Indicates whether the breach awareness event is ignored. Valid values:'."\n" + ."\n" + .'* **true**: The breach awareness event is ignored.'."\n" + .'* **false**: The breach awareness event is not ignored.'."\n", + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'false', + ], + 'PublicIP' => [ + 'title' => '公网IP', + 'description' => 'The public IP address of the affected asset.'."\n", + 'type' => 'string', + 'example' => '198.51.XX.XX', + ], + 'ProcessStatus' => [ + 'title' => '处理状态', + 'description' => 'The handling status of the breach awareness event. Valid values:'."\n" + ."\n" + .'* **0**: unhandled'."\n" + .'* **20**: handled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AssetsInstanceId' => [ + 'title' => '资产实例ID', + 'description' => 'The ID of the affected asset.'."\n", + 'type' => 'string', + 'example' => 'i-ECS****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorUnMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LowLevelPercent\\": 20,\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"MiddleLevelPercent\\": 40,\\n \\"HighLevelPercent\\": 40,\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 40\\n },\\n \\"EventList\\": [\\n {\\n \\"RiskLevel\\": 1,\\n \\"EventName\\": \\"event_test\\",\\n \\"EventKey\\": \\"69d189e2-ec17-4676-a2fe-02969234****\\",\\n \\"EventUuid\\": \\"fadd-dfdd-****\\",\\n \\"MemberUid\\": \\"135809047715****\\",\\n \\"AssetsType\\": \\"EcsPublicIp\\",\\n \\"FirstTime\\": 1656750960,\\n \\"EventSrc\\": \\"IPS\\",\\n \\"PrivateIP\\": \\"192.168.XX.XX\\",\\n \\"AssetsInstanceName\\": \\"ECS_test\\",\\n \\"LastTime\\": 1656837360,\\n \\"PublicIpType\\": \\"EcsPublicIp\\",\\n \\"IsIgnore\\": true,\\n \\"PublicIP\\": \\"198.51.XX.XX\\",\\n \\"ProcessStatus\\": 20,\\n \\"AssetsInstanceId\\": \\"i-ECS****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeInvadeEventListResponse>\\n <LowLevelPercent>20</LowLevelPercent>\\n <RequestId>F0F82705-CFC7-5F83-86C8-A063892F****</RequestId>\\n <MiddleLevelPercent>40</MiddleLevelPercent>\\n <HighLevelPercent>40</HighLevelPercent>\\n <PageInfo>\\n <CurrentPage>1</CurrentPage>\\n <PageSize>10</PageSize>\\n <TotalCount>40</TotalCount>\\n </PageInfo>\\n <EventList>\\n <RiskLevel>1</RiskLevel>\\n <EventName>event_test</EventName>\\n <EventKey>69d189e2-ec17-4676-a2fe-02969234****</EventKey>\\n <EventUuid>fadd-dfdd-****</EventUuid>\\n <MemberUid>135809047715****</MemberUid>\\n <AssetsType>EcsPublicIp</AssetsType>\\n <FirstTime>1656750960</FirstTime>\\n <EventSrc>IPS</EventSrc>\\n <PrivateIP>192.168.XX.XX</PrivateIP>\\n <AssetsInstanceName>ECS_test</AssetsInstanceName>\\n <LastTime>1656837360</LastTime>\\n <PublicIpType>EcsPublicIp</PublicIpType>\\n <IsIgnore>true</IsIgnore>\\n <PublicIP>198.51.XX.XX</PublicIP>\\n <ProcessStatus>20</ProcessStatus>\\n <AssetsInstanceId>i-ECS****</AssetsInstanceId>\\n </EventList>\\n</DescribeInvadeEventListResponse>","errorExample":""}]', + 'title' => 'DescribeInvadeEventList', + ], + 'DescribeInvadeEventNameList' => [ + 'summary' => '获取漏洞名称列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68291', + 'abilityTreeNodes' => [ + 'FEATUREcfwIT6TRR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '36.112.73.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1757620800', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1738780437', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6ABAA264-E7B5-5D66-8FC3-9253100****', + ], + 'NameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[]', + ], + ], + 'EventNameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EventKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CActivity', + ], + 'EventName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6ABAA264-E7B5-5D66-8FC3-9253100****\\",\\n \\"NameList\\": [\\n \\"[]\\"\\n ],\\n \\"EventNameList\\": [\\n {\\n \\"EventKey\\": \\"CActivity\\",\\n \\"EventName\\": \\"可疑中控通信\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInvadeEventStatistic' => [ + 'summary' => '获取漏洞事件统计', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68293', + 'abilityTreeNodes' => [ + 'FEATUREcfwIT6TRR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '52.130.200.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1746151757', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1774713600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LowOpenEventCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalOpenEventCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1530A01A-6901-5B72-AB88-28B6E96B****', + ], + 'MiddleOpenEventCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HighOpenEventCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LowOpenEventCnt\\": 1,\\n \\"TotalOpenEventCnt\\": 2,\\n \\"RequestId\\": \\"1530A01A-6901-5B72-AB88-28B6E96B****\\",\\n \\"MiddleOpenEventCnt\\": 0,\\n \\"HighOpenEventCnt\\": 1\\n}","type":"json"}]', + ], + 'DescribeInvadeEventDetail' => [ + 'summary' => '获取漏洞事件详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68289', + 'abilityTreeNodes' => [ + 'FEATUREcfwIT6TRR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '218.76.30.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'AssetsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp135d2rmbwpt****', + ], + ], + [ + 'name' => 'EventUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '92498578-7c42-4845-8c73-7e824782****', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '182.92.103.XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 1 => '', + '', + '', + ], + 'example' => '2', + ], + 'EventKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C&CActivity', + ], + 'EventName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'event_test', + ], + 'EventDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'EventUuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aa6e786c-5034-457a-8e05-1c63fab****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FirstTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1735006706', + ], + 'Reference' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PrivateIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.21.186.XXX', + ], + 'LastTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1740104108', + ], + 'AssetsInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ECS_test', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8022D695-4A35-50BC-8697-EA9C233A****', + ], + 'EventDesc' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'IsIgnore' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'PublicIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '106.15.185.XXX', + ], + 'ProcessStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + 10 => '', + 20 => '', + ], + 'example' => '1', + ], + 'AssetsInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-8vb2nmm070m****', + ], + 'OperationList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Operate' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RunMode', + ], + 'Args' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'UnhandleOperationList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Operate' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RunMode', + ], + 'Args' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RiskLevel\\": 2,\\n \\"EventKey\\": \\"C&CActivity\\",\\n \\"EventName\\": \\"event_test\\",\\n \\"EventDetail\\": \\"test\\",\\n \\"EventUuid\\": \\"aa6e786c-5034-457a-8e05-1c63fab****\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"FirstTime\\": 1735006706,\\n \\"Reference\\": \\"test\\",\\n \\"PrivateIP\\": \\"10.21.186.XXX\\",\\n \\"LastTime\\": 1740104108,\\n \\"AssetsInstanceName\\": \\"ECS_test\\",\\n \\"RequestId\\": \\"8022D695-4A35-50BC-8697-EA9C233A****\\",\\n \\"EventDesc\\": \\"test\\",\\n \\"IsIgnore\\": false,\\n \\"PublicIP\\": \\"106.15.185.XXX\\",\\n \\"ProcessStatus\\": 1,\\n \\"AssetsInstanceId\\": \\"i-8vb2nmm070m****\\",\\n \\"OperationList\\": [\\n {\\n \\"Operate\\": \\"RunMode\\",\\n \\"Args\\": \\"test\\"\\n }\\n ],\\n \\"UnhandleOperationList\\": [\\n {\\n \\"Operate\\": \\"RunMode\\",\\n \\"Args\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSdlEventList' => [ + 'summary' => '获取数据泄露事件列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246035', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1759198702', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1756433077', + ], + ], + [ + 'name' => 'CurrentPage', + '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' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.0.XXX', + ], + ], + [ + 'name' => 'DstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.102.XXX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aa58cdf6-6cf8-493c-912d-97619a24****', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TotalBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'OnlyAiEvt', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SensitiveLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'S3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F06DE24D-6EB9-5F55-B588-7BB946DF****', + ], + 'SdlEventDetailList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AssetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'AssetPrivateIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.100.102.XXX', + ], + 'AssetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EIP', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Trusted', + ], + 'CategoryClassId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Trusted', + ], + 'CityId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '000', + ], + 'CountryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn', + ], + 'DstIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '106.14.74.XXX', + ], + 'DstPortList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '22', + ], + 'EventCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'EventLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'high', + ], + 'EventName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FirstTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1735697768', + ], + 'LastTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1738636157', + ], + 'LocationName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Payload' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3082002f02010004067075626c6963a082002002044c33a756020100020100308200103082000c06082b060102010105000500', + ], + 'ProtoList' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'TCP', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SensitiveDataCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SensitiveDataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hege***********.com', + ], + ], + 'SensitiveLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'S3', + ], + 'SensitiveType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SrcIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '104.28.226.XX', + ], + 'SrcPortList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '443', + ], + 'TrafficBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Uuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'b91035dc-8be4-411d-bec5-e6320af9****', + ], + 'ResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ce347a98f41e849188aa51c56b02a****', + ], + 'ResourceIdType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F06DE24D-6EB9-5F55-B588-7BB946DF****\\",\\n \\"SdlEventDetailList\\": [\\n {\\n \\"AssetName\\": \\"test\\",\\n \\"AssetPrivateIp\\": \\"47.100.102.XXX\\",\\n \\"AssetType\\": \\"EIP\\",\\n \\"CategoryName\\": \\"Trusted\\",\\n \\"CategoryClassId\\": \\"Trusted\\",\\n \\"CityId\\": \\"000\\",\\n \\"CountryId\\": \\"cn\\",\\n \\"DstIp\\": \\"106.14.74.XXX\\",\\n \\"DstPortList\\": \\"22\\",\\n \\"EventCnt\\": 1,\\n \\"EventLevel\\": \\"high\\",\\n \\"EventName\\": \\"身份证敏感数据泄漏\\",\\n \\"FirstTime\\": 1735697768,\\n \\"LastTime\\": 1738636157,\\n \\"LocationName\\": \\"浙江省杭州市余杭区\\",\\n \\"Payload\\": \\"3082002f02010004067075626c6963a082002002044c33a756020100020100308200103082000c06082b060102010105000500\\",\\n \\"ProtoList\\": \\"TCP\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SensitiveDataCnt\\": 10,\\n \\"SensitiveDataList\\": [\\n \\"hege***********.com\\"\\n ],\\n \\"SensitiveLevel\\": \\"S3\\",\\n \\"SensitiveType\\": \\"身份证\\",\\n \\"SrcIp\\": \\"104.28.226.XX\\",\\n \\"SrcPortList\\": \\"443\\",\\n \\"TrafficBytes\\": 0,\\n \\"Uuid\\": \\"b91035dc-8be4-411d-bec5-e6320af9****\\",\\n \\"ResourceId\\": \\"ce347a98f41e849188aa51c56b02a****\\",\\n \\"ResourceIdType\\": 0\\n }\\n ],\\n \\"TotalCount\\": 6\\n}","type":"json"}]', + ], + 'DescribeSdlEventSdList' => [ + 'summary' => '获取数据泄露的敏感数据列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246374', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1761185080', + ], + ], + [ + 'name' => 'CurrentPage', + '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' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.0.XXX', + ], + ], + [ + 'name' => 'DstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.102.XXX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'aa58cdf6-6cf8-493c-912d-97619a24****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******', + ], + 'SdlEventSensitiveDataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SensitiveData' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sk-N***************************SxiJ', + ], + 'SensitiveDataCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'SensitiveLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'S3', + ], + 'SensitiveType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SrcIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '172.23.191.XXX', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1753928907', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15FCCC52-1E23-57AE-B5EF-3E00A3******\\",\\n \\"SdlEventSensitiveDataList\\": [\\n {\\n \\"SensitiveData\\": \\"sk-N***************************SxiJ\\",\\n \\"SensitiveDataCnt\\": 6,\\n \\"SensitiveLevel\\": \\"S3\\",\\n \\"SensitiveType\\": \\"身份证\\",\\n \\"SrcIp\\": \\"172.23.191.XXX\\",\\n \\"StartTime\\": 1753928907\\n }\\n ],\\n \\"TotalCount\\": 6\\n}","type":"json"}]', + ], + 'DescribeSdlEventDetail' => [ + 'summary' => '获取数据泄露的敏感数据事件列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247466', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1753755251', + ], + ], + [ + 'name' => 'CurrentPage', + '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' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '121.40.84.XXX', + ], + ], + [ + 'name' => 'DstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.102.XXX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '326ce10e-5e17-4235-879a-6f2502cd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'D19D8F70-D64B-5A95-905A-6073BF4A****', + ], + 'SdlEventDetailList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EventName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'event-test', + ], + 'SensitiveDataCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SensitiveLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'S3', + ], + 'SensitiveType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1753928907', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D19D8F70-D64B-5A95-905A-6073BF4A****\\",\\n \\"SdlEventDetailList\\": [\\n {\\n \\"EventName\\": \\"event-test\\",\\n \\"SensitiveDataCnt\\": 10,\\n \\"SensitiveLevel\\": \\"S3\\",\\n \\"SensitiveType\\": \\"身份证\\",\\n \\"StartTime\\": 1753928907\\n }\\n ],\\n \\"TotalCount\\": 8\\n}","type":"json"}]', + ], + 'DescribeSdlEventStatistic' => [ + 'summary' => '获取数据泄露事件统计数据', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245978', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1656750960', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1732586712', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'AssetCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'C5DDD596-1191-5F36-A504-8733045A****', + ], + 'SensitiveDataCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalTraffic' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AiSensitiveDataCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AssetCount\\": 32,\\n \\"RequestId\\": \\"C5DDD596-1191-5F36-A504-8733045A****\\",\\n \\"SensitiveDataCount\\": 2,\\n \\"TotalCount\\": 2,\\n \\"TotalTraffic\\": 0,\\n \\"AiSensitiveDataCount\\": 1\\n}","type":"json"}]', + ], + 'DescribeSdlStatistic' => [ + 'summary' => '获取数据泄露事件类型分布/资产TOP/目的TOP', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246011', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1748916368', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '337A4DBA-8A01-5E9C-99CA-84293E13****', + ], + 'SdlStatisticResp' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SdlEventTypeCountList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Count' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9', + ], + ], + ], + ], + 'SdlDstTopList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PublicIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.101.68.XXX', + ], + 'TrafficBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + 'SdlAssetTopList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PublicIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '116.62.66.XXX', + ], + 'AssetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EIP', + ], + 'TrafficBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"337A4DBA-8A01-5E9C-99CA-84293E13****\\",\\n \\"SdlStatisticResp\\": {\\n \\"SdlEventTypeCountList\\": [\\n {\\n \\"EventType\\": \\"身份证\\",\\n \\"Count\\": \\"9\\"\\n }\\n ],\\n \\"SdlDstTopList\\": [\\n {\\n \\"PublicIp\\": \\"47.101.68.XXX\\",\\n \\"TrafficBytes\\": 0\\n }\\n ],\\n \\"SdlAssetTopList\\": [\\n {\\n \\"PublicIp\\": \\"116.62.66.XXX\\",\\n \\"AssetType\\": \\"EIP\\",\\n \\"TrafficBytes\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSensitiveSwitch' => [ + 'summary' => '获取敏感数据类别开关', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247466', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'ParentCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'universal_industry_template', + ], + ], + [ + 'name' => 'SensitiveCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id_card', + ], + ], + [ + 'name' => 'CurrentPage', + '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' => 'CategoryName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'SensitiveLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'S3', + ], + ], + [ + 'name' => 'SwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'A7F3ED45-5556-5AF3-ADE3-EE48FFF0****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UserSensitiveDataSwitchList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SensitiveCategory' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'id_card', + ], + 'SensitiveLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'S3', + ], + 'SwitchStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '1', + ], + ], + ], + ], + 'OpenCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7F3ED45-5556-5AF3-ADE3-EE48FFF0****\\",\\n \\"TotalCount\\": 10,\\n \\"UserSensitiveDataSwitchList\\": [\\n {\\n \\"CategoryName\\": \\"身份证\\",\\n \\"Description\\": \\"身份证敏感数据泄漏\\",\\n \\"SensitiveCategory\\": \\"id_card\\",\\n \\"SensitiveLevel\\": \\"S3\\",\\n \\"SwitchStatus\\": 1\\n }\\n ],\\n \\"OpenCount\\": 80\\n}","type":"json"}]', + ], + 'ModifySensitiveSwitch' => [ + 'summary' => '修改敏感数据开关', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247466', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SensitiveCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'id_card', + ], + ], + [ + 'name' => 'SwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6169C0A4-B91A-5D48-AE4D-B9432D15****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6169C0A4-B91A-5D48-AE4D-B9432D15****\\"\\n}","type":"json"}]', + ], + 'EnableSdlProtectedAsset' => [ + 'summary' => '开启资产数据泄露保护', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240055', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.99.108.XX', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15FCCC52-1E23-57AE-B5EF-3E00A3******\\\\n\\"\\n}","type":"json"}]', + ], + 'DisableSdlProtectedAsset' => [ + 'summary' => '关闭资产数据泄漏保护', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247433', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "47.99.108.XXX",'."\n" + .' "47.99.109.XXX"'."\n" + .']', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'F93A490D-9E92-5AA4-BA79-600FFC09****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F93A490D-9E92-5AA4-BA79-600FFC09****\\"\\n}","type":"json"}]', + ], + 'DescribeAclApps' => [ + 'summary' => '批量查询访问控制应用', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'AclType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'VPC', + 'enum' => [ + 'Internet', + 'NAT', + 'VPC', + 'All', + ], + ], + ], + [ + 'name' => 'Popular', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '1', + ], + 'example' => '1', + 'enum' => [ + '1', + ], + ], + ], + [ + 'name' => 'Protocols', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "TCP",'."\n" + .' "UDP"'."\n" + .']', + 'enum' => [ + 'TCP', + 'UDP', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '9063AB86-6FFA-5B2D-A16D-697C966D****', + ], + 'AclApps' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1.0', + ], + 'AppName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'RiskLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Popular' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Protocols' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' "TCP",'."\n" + .' "UDP"'."\n" + .']', + ], + ], + 'SupportFqdn' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9063AB86-6FFA-5B2D-A16D-697C966D****\\",\\n \\"AclApps\\": [\\n {\\n \\"AppId\\": 1,\\n \\"AppName\\": \\"test\\",\\n \\"RiskLevel\\": 1,\\n \\"Popular\\": 1,\\n \\"Protocols\\": [\\n \\"[\\\\n \\\\\\"TCP\\\\\\",\\\\n \\\\\\"UDP\\\\\\"\\\\n]\\"\\n ],\\n \\"SupportFqdn\\": 1\\n }\\n ],\\n \\"TotalCount\\": 20\\n}","type":"json"}]', + ], + 'DescribeAclWhitelist' => [ + 'summary' => '获取ACL白名单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68174', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + 'FEATUREcfwO822TD', + 'FEATUREcfwFIV6PB', + 'FEATUREcfwTW8EA1', + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '101.36.65.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainGroupUseDns' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SupportMessageType' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7D45133B-DBC0-506B-9DF9-AB0735D3****', + ], + 'NatDomainGroupUseDns' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VpcDomainGroupUseDns' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainGroupUseDns\\": true,\\n \\"SupportMessageType\\": true,\\n \\"RequestId\\": \\"7D45133B-DBC0-506B-9DF9-AB0735D3****\\",\\n \\"NatDomainGroupUseDns\\": false,\\n \\"VpcDomainGroupUseDns\\": false\\n}","type":"json"}]', + ], + 'DescribeAclRuleCount' => [ + 'summary' => '获取总ACL配置数', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68172', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + 'FEATUREcfwO822TD', + 'FEATUREcfwFIV6PB', + 'FEATUREcfwTW8EA1', + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '27.151.85.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InternetInAclCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalAclCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '27936D6C-1B7A-5A5A-B9E4-FBEBBDAA****', + ], + 'InternetOutAclCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'VpcAclCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NatInAclCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NatOutAclCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InternetInAclCount\\": 2,\\n \\"TotalAclCount\\": 8,\\n \\"RequestId\\": \\"27936D6C-1B7A-5A5A-B9E4-FBEBBDAA****\\",\\n \\"InternetOutAclCount\\": 3,\\n \\"VpcAclCount\\": 3,\\n \\"NatInAclCount\\": 0,\\n \\"NatOutAclCount\\": 2\\n}","type":"json"}]', + ], + 'DescribeControlPolicy' => [ + 'summary' => 'Queries the details about all access control policies.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68239', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policies apply. Valid values:'."\n" + ."\n" + .'* **in**: inbound.'."\n" + .'* **out**: outbound.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'in', + 'enum' => [ + 'out', + 'in', + ], + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy. Fuzzy match is supported. The value of this parameter depends on the value of the SourceType parameter.'."\n" + ."\n" + .'* If SourceType is set to `net`, the value of Source must be a CIDR block. Example: 192.0.XX.XX/24.'."\n" + .'* If SourceType is set to `group`, the value of Source must be the name of an address book. Example: db_group. If the db_group address book does not contain addresses, all source addresses are queried.'."\n" + .'* If SourceType is set to `location`, the value of Source must be a location. Example: beijing.'."\n" + ."\n" + .'> If you do not specify this parameter, access control policies of all source address types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy. Fuzzy match is supported. The value of this parameter varies based on the value of the DestinationType parameter.'."\n" + ."\n" + .'* If you set DestinationType to `net`, the value of Destination is a CIDR block. Example: 10.0.3.0/24.'."\n" + .'* If you set DestinationType to `domain`, the value of Destination is a domain name. Example: aliyun.'."\n" + .'* If you set DestinationType to `group`, the value of Destination is the name of an address book. Example: db_group.'."\n" + .'* If you set DestinationType to `location`, the value of Destination is the name of a location. For more information about location codes, see AddControlPolicy. Example: \\["BJ11", "ZB"].'."\n" + ."\n" + .'> If you do not specify this parameter, access control policies of all destination address types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy. Fuzzy match is supported.'."\n" + ."\n" + .'> If you do not specify this parameter, access control policies that have descriptions are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the protocol in the access control policy. Valid values:'."\n" + ."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n" + .'* **ANY**: all types of protocols'."\n" + ."\n" + .'> If you do not specify this parameter, access control policies of all protocol types are queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n" + ."\n" + .'> If you do not specify this parameter, access control policies of all action types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the access control policy is enabled. By default, an access control policy is enabled after it is created. Valid values:'."\n" + ."\n" + .'* **true**: The access control policy is enabled.'."\n" + .'* **false**: The access control policy is disabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The IP version of the address in the access control policy. Valid values:'."\n" + ."\n" + .'* **4**: IPv4 (default)'."\n" + .'* **6**: IPv6'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6', + 'enum' => [ + '4', + '6', + ], + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****', + ], + 'TotalCount' => [ + 'description' => 'The total number of the returned access control policies.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Policys' => [ + 'description' => 'The information about the access control policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'None.'."\n", + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => 'The direction of the traffic to which the access control policy applies. Valid values:'."\n" + ."\n" + .'* **in**: inbound traffic'."\n" + .'* **out**: outbound traffic'."\n", + 'type' => 'string', + 'example' => 'in', + ], + 'Order' => [ + 'description' => 'The priority of the access control policy.'."\n" + ."\n" + .'The priority value starts from 1. A smaller priority value indicates a higher priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SourceType' => [ + 'description' => 'The type of the source address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **location**: location'."\n", + 'type' => 'string', + 'example' => 'net', + ], + 'ApplicationName' => [ + 'description' => 'The application type supported by the access control policy. We recommend that you specify ApplicationNameList. Valid values:'."\n" + ."\n" + .'* **FTP**'."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **Memcache**'."\n" + .'* **MongoDB**'."\n" + .'* **MQTT**'."\n" + .'* **MySQL**'."\n" + .'* **RDP**'."\n" + .'* **Redis**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **SSH**'."\n" + .'* **SSL**'."\n" + .'* **VNC**'."\n" + .'* **ANY**: all types of applications'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'HitTimes' => [ + 'description' => 'The number of hits for the access control policy.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Description' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SourceGroupType' => [ + 'description' => 'The type of the source address book in the access control policy. Valid values:'."\n" + ."\n" + .'* **ip**: an address book that includes one or more IP addresses'."\n" + .'* **tag**: an Elastic Compute Service (ECS) tag-based address book that includes the IP addresses of the ECS instances with one or more specific tags'."\n" + .'* **domain**: an address book that includes one or more domain names'."\n" + .'* **threat**: an address book that includes one or more malicious IP addresses or domain names'."\n" + .'* **backsrc**: an address book that includes one or more back-to-origin addresses of Anti-DDoS Pro or Anti-DDoS Premium instances or Web Application Firewall (WAF) instances'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'DnsResultTime' => [ + 'description' => 'The time when the Domain Name System (DNS) resolution was performed. The value is a timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DnsResult' => [ + 'description' => 'The DNS resolution results.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'example' => '192.0.XX.XX,192.0.XX.XX', + ], + 'Proto' => [ + 'description' => 'The protocol type in the access control policy. Valid values:'."\n" + ."\n" + .'* **ANY**'."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + 'DestinationGroupType' => [ + 'description' => 'The type of the destination address book in the access control policy. Valid values:'."\n" + ."\n" + .'* **ip**: an address book that includes one or more IP addresses'."\n" + .'* **tag**: an ECS tag-based address book that includes the IP addresses of the ECS instances with one or more specific tags'."\n" + .'* **domain**: an address book that includes one or more domain names'."\n" + .'* **threat**: an address book that includes one or more malicious IP addresses or domain names'."\n" + .'* **backsrc**: an address book that includes one or more back-to-origin addresses of Anti-DDoS Pro or Anti-DDoS Premium instances or WAF instances'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'Destination' => [ + 'description' => 'The destination address in the access control policy. The value of this parameter varies based on the value of DestinationType.'."\n" + ."\n" + .'* If the value of **DestinationType** is **net**, the value of Destination is a CIDR block. Example: 192.0.XX.XX/24.'."\n" + .'* If the value of **DestinationType** is **domain**, the value of Destination is a domain name. Example: aliyuncs.com.'."\n" + .'* If the value of **DestinationType** is **group**, the value of Destination is the name of an address book. Example: db_group.'."\n" + .'* If the value of **DestinationType** is **location**, the value of Destination is the name of a location. For more information about location codes, see AddControlPolicy. Example: \\["BJ11", "ZB"].'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'HitLastTime' => [ + 'description' => 'The time when the access control policy was last hit. The value is a timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DestPortGroup' => [ + 'description' => 'The name of the destination port address book in the access control policy.'."\n", + 'type' => 'string', + 'example' => 'my_port_group', + ], + 'AclUuid' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + 'DestPortType' => [ + 'description' => 'The type of the destination port in the access control policy. Valid values:'."\n" + ."\n" + .'* **port**: port'."\n" + .'* **group**: port address book'."\n", + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => 'The source address in the access control policy. Valid values:'."\n" + ."\n" + .'* If **SourceType** is set to `net`, the value of Source is a CIDR block. Example: 192.0.XX.XX/24.'."\n" + .'* If **SourceType** is set to `group`, the value of Source is the name of an address book. Example: db_group.'."\n" + .'* If **SourceType** is set to `location`, the value of Source is a location. For more information about location codes, see [AddControlPolicy](~~138867~~). Example: \\["BJ11", "ZB"].'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'DestinationType' => [ + 'description' => 'The type of the destination address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **domain**: domain name'."\n" + .'* **location**: location'."\n", + 'type' => 'string', + 'example' => 'net', + ], + 'DestPort' => [ + 'description' => 'The destination port in the access control policy.'."\n", + 'type' => 'string', + 'example' => '80', + ], + 'IpVersion' => [ + 'description' => 'The IP version used in the access control policy. Valid values:'."\n" + ."\n" + .'* **4**: IPv4'."\n" + .'* **6**: IPv6'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'AclAction' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'example' => 'accept', + ], + 'Release' => [ + 'description' => 'The status of the access control policy. By default, an access control policy is enabled after it is created. Valid values:'."\n" + ."\n" + .'* **true**: enabled'."\n" + .'* **false**: disabled'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ApplicationId' => [ + 'description' => 'The application ID in the access control policy.'."\n", + 'type' => 'string', + 'example' => '10***', + ], + 'DestinationGroupCidrs' => [ + 'description' => 'The CIDR blocks in the destination address book.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block in the destination address book.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + ], + 'DestPortGroupPorts' => [ + 'description' => 'The ports in the destination port address book.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The port in the destination port address book.'."\n", + 'type' => 'string', + 'example' => '443/443', + ], + ], + 'SourceGroupCidrs' => [ + 'description' => 'The CIDR blocks in the source address book.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block in the source address book.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + ], + 'ApplicationNameList' => [ + 'description' => 'The application names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application type used in the access control policy. Valid values:'."\n" + ."\n" + .'* **FTP**'."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **Memcache**'."\n" + .'* **MongoDB**'."\n" + .'* **MQTT**'."\n" + .'* **MySQL**'."\n" + .'* **RDP**'."\n" + .'* **Redis**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **SSH**'."\n" + .'* **SSL**'."\n" + .'* **VNC**'."\n" + .'* **ANY**: all types of applications'."\n", + 'type' => 'string', + 'example' => 'HTTPS', + ], + ], + 'SpreadCnt' => [ + 'description' => 'The total quota consumed by the returned access control policies, which is the sum of the quota consumed by each policy. The quota that is consumed by an access control policy is calculated by using the following formula: Quota that is consumed by an access control policy = Number of source addresses (number of CIDR blocks or regions) × Number of destination addresses (number of CIDR blocks, regions, or domain names) × Number of port ranges × Number of applications.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10,000', + ], + 'CreateTime' => [ + 'description' => 'The time when the access control policy was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ModifyTime' => [ + 'description' => 'The time when the access control policy was modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'RepeatType' => [ + 'description' => 'The recurrence type based on which the access control policy takes effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + 'RepeatDays' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If RepeatType is set to `Permanent`, `None`, or `Daily`, this parameter is left empty. Example: \\[].'."\n" + .'* If RepeatType is set to Weekly, this parameter must be specified. Example: \\[0, 6].'."\n" + ."\n" + .'> If RepeatType is set to Weekly, the fields in the value of RepeatDays cannot be repeated.'."\n" + ."\n" + .'* If RepeatType is set to `Monthly`, this parameter must be specified. Example: \\[1, 31].'."\n" + ."\n" + .'> If RepeatType is set to Monthly, the fields in the value of RepeatDays cannot be repeated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If RepeatType is set to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If RepeatType is set to Monthly, valid values of this parameter are 1 to 31.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'RepeatStartTime' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the end time.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, this parameter is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'string', + 'example' => '08:00', + ], + 'RepeatEndTime' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the start time.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, this parameter is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a timestamp. Unit: seconds. The start time must be on the hour or on the half hour, and at least 30 minutes earlier than the end time.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, this parameter is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694761200', + ], + 'EndTime' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a timestamp. Unit: seconds. The end time must be on the hour or on the half hour, and at least 30 minutes later than the start time.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, this parameter is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694764800', + ], + 'DomainResolveType' => [ + 'description' => 'The domain name resolution method of the access control policy. By default, an access control policy is enabled after the policy is created. Valid values:'."\n" + ."\n" + .'* **FQDN**: fully qualified domain name (FQDN)-based resolution'."\n" + .'* **DNS**: DNS-based dynamic resolution'."\n" + .'* **FQDN_AND_DNS**: FQDN and DNS-based dynamic resolution', + 'type' => 'string', + 'example' => 'FQDN', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorUnmarshalJSON', + 'errorMessage' => 'An error occurred while parsing JSON.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Policys\\": [\\n {\\n \\"Direction\\": \\"in\\",\\n \\"Order\\": 1,\\n \\"SourceType\\": \\"net\\",\\n \\"ApplicationName\\": \\"HTTP\\",\\n \\"HitTimes\\": 100,\\n \\"Description\\": \\"test\\",\\n \\"SourceGroupType\\": \\"ip\\",\\n \\"DnsResultTime\\": 1579261141,\\n \\"DnsResult\\": \\"192.0.XX.XX,192.0.XX.XX\\",\\n \\"Proto\\": \\"TCP\\",\\n \\"DestinationGroupType\\": \\"ip\\",\\n \\"Destination\\": \\"192.0.XX.XX/24\\",\\n \\"HitLastTime\\": 1579261141,\\n \\"DestPortGroup\\": \\"my_port_group\\",\\n \\"AclUuid\\": \\"00281255-d220-4db1-8f4f-c4df221a****\\",\\n \\"DestPortType\\": \\"port\\",\\n \\"Source\\": \\"192.0.XX.XX/24\\",\\n \\"DestinationType\\": \\"net\\",\\n \\"DestPort\\": \\"80\\",\\n \\"IpVersion\\": 6,\\n \\"AclAction\\": \\"accept\\",\\n \\"Release\\": \\"true\\",\\n \\"ApplicationId\\": \\"10***\\",\\n \\"DestinationGroupCidrs\\": [\\n \\"192.0.XX.XX/24\\"\\n ],\\n \\"DestPortGroupPorts\\": [\\n \\"80/80\\"\\n ],\\n \\"SourceGroupCidrs\\": [\\n \\"192.0.XX.XX/24\\"\\n ],\\n \\"ApplicationNameList\\": [\\n \\"HTTP\\"\\n ],\\n \\"SpreadCnt\\": 10000,\\n \\"CreateTime\\": 1761062400,\\n \\"ModifyTime\\": 1761062400,\\n \\"RepeatType\\": \\"Permanent\\",\\n \\"RepeatDays\\": [\\n 1\\n ],\\n \\"RepeatStartTime\\": \\"08:00\\",\\n \\"RepeatEndTime\\": \\"23:30\\",\\n \\"StartTime\\": 1694761200,\\n \\"EndTime\\": 1694764800,\\n \\"DomainResolveType\\": \\"FQDN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeControlPolicyResponse>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****</RequestId>\\n <TotalCount>100</TotalCount>\\n <Policys>\\n <Direction>in</Direction>\\n <Order>1</Order>\\n <SourceType>net</SourceType>\\n <ApplicationName>HTTP</ApplicationName>\\n <HitTimes>100</HitTimes>\\n <Description>test</Description>\\n <SourceGroupType>ip</SourceGroupType>\\n <DnsResultTime>1579261141</DnsResultTime>\\n <DnsResult>192.0.XX.XX,192.0.XX.XX</DnsResult>\\n <Proto>TCP</Proto>\\n <DestinationGroupType>ip</DestinationGroupType>\\n <Destination>192.0.XX.XX/24</Destination>\\n <HitLastTime>1579261141</HitLastTime>\\n <DestPortGroup>my_port_group</DestPortGroup>\\n <AclUuid>00281255-d220-4db1-8f4f-c4df221a****</AclUuid>\\n <DestPortType>port</DestPortType>\\n <Source>192.0.XX.XX/24</Source>\\n <DestinationType>net</DestinationType>\\n <DestPort>80</DestPort>\\n <IpVersion>6</IpVersion>\\n <AclAction>accept</AclAction>\\n <Release>true</Release>\\n <ApplicationId>10***</ApplicationId>\\n <DestinationGroupCidrs>192.0.XX.XX/24</DestinationGroupCidrs>\\n <DestPortGroupPorts>80/80</DestPortGroupPorts>\\n <SourceGroupCidrs>192.0.XX.XX/24</SourceGroupCidrs>\\n <ApplicationNameList>HTTP</ApplicationNameList>\\n <SpreadCnt>10000</SpreadCnt>\\n <CreateTime>1761062400</CreateTime>\\n <ModifyTime>1761062400</ModifyTime>\\n </Policys>\\n</DescribeControlPolicyResponse>","errorExample":""}]', + 'title' => 'DescribeControlPolicy', + 'description' => 'You can call the DescribeControlPolicy operation to query the details about access control policies by page.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeACLProtectTrend' => [ + 'summary' => 'Queries the statistics on the requests that are blocked by the access control list (ACL) feature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68171', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + 'FEATUREcfwO822TD', + 'FEATUREcfwFIV6PB', + 'FEATUREcfwTW8EA1', + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '223.95.87.130', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp that is accurate to seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1677050306', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The value is a UNIX timestamp that is accurate to seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1670397599', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9063AB86-6FFA-5B2D-A16D-697C966DECA3', + ], + 'Interval' => [ + 'description' => 'The interval for returning data. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '86400', + ], + 'TotalProtectCnt' => [ + 'description' => 'The total number of requests that are blocked by the ACL feature.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'InProtectCnt' => [ + 'description' => 'The number of internal requests that are blocked by the ACL feature.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'InterVPCProtectCnt' => [ + 'description' => 'This parameter is deprecated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OutProtectCnt' => [ + 'description' => 'The number of external requests that are blocked by the ACL feature.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'TrendList' => [ + 'description' => 'The statistics on the requests that are blocked by the ACL feature.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => 'The UNIX timestamp at midnight (00:00:00) of each day, which indicates the date of the current day. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1697299200', + ], + 'ProtectCnt' => [ + 'description' => 'The number of requests that are blocked by ACL on the current day.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9063AB86-6FFA-5B2D-A16D-697C966DECA3\\",\\n \\"Interval\\": 86400,\\n \\"TotalProtectCnt\\": 300,\\n \\"InProtectCnt\\": 100,\\n \\"InterVPCProtectCnt\\": 0,\\n \\"OutProtectCnt\\": 200,\\n \\"TrendList\\": [\\n {\\n \\"Time\\": 1697299200,\\n \\"ProtectCnt\\": 100\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeACLProtectTrend', + ], + 'DescribePolicyAdvancedConfig' => [ + 'summary' => 'Queries whether the strict mode is enabled for an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68336', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + 'FEATUREcfwO822TD', + 'FEATUREcfwFIV6PB', + 'FEATUREcfwTW8EA1', + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The natural language of the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The natural language of the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InternetSwitch' => [ + 'description' => 'Indicates whether the strict mode is enabled for the access control policy. Valid values:'."\n" + ."\n" + .'* **on**: The strict mode is enabled.'."\n" + .'* **off**: The strict mode is disabled.'."\n", + 'type' => 'string', + 'example' => 'off', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125EEB1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"InternetSwitch\\": \\"off\\",\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125EEB1\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribePolicyAdvancedConfigResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125EEB1</RequestId>\\n <InternetSwitch>off</InternetSwitch>\\n</DescribePolicyAdvancedConfigResponse>","errorExample":""}]', + 'title' => 'DescribePolicyAdvancedConfig', + 'description' => 'You can call the DescribePolicyAdvancedConfig operation to query whether the strict mode is enabled for an access control policy. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePolicyPriorUsed' => [ + 'summary' => 'Queries the priority range of access control policies.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68337', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + 'FEATUREcfwO822TD', + 'FEATUREcfwFIV6PB', + 'FEATUREcfwTW8EA1', + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **in**: inbound.'."\n" + .'* **out**: outbound.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version of the asset that is protected by Cloud Firewall.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **4** (default): IPv4.'."\n" + .'* **6**: IPv6.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6', + 'enum' => [ + '4', + '6', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => 'The lowest priority of existing access control policies.'."\n" + ."\n" + .'> The value -1 indicates the lowest priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'Start' => [ + 'description' => 'The highest priority of existing access control policies.'."\n" + ."\n" + .'> The value 0 indicates the highest priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'A domain resolution error occurred.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The destination is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"End\\": 150,\\n \\"Start\\": -1,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribePolicyPriorUsedResponse>\\n <End>150</End>\\n <Start>-1</Start>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n</DescribePolicyPriorUsedResponse>","errorExample":""}]', + 'title' => 'DescribePolicyPriorUsed', + 'description' => 'You can call this operation to query the priority range of the access control policies that match specific query conditions.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeControlPolicyDomainResolve' => [ + 'summary' => '查询访问控制策略的域名解析结果', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221221', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + 'enum' => [ + '4', + '6', + ], + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'nat' => 'nat', + 'vpc' => 'vpc', + 'internet' => 'internet', + ], + 'example' => 'internet', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResolveResult' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example.com', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579091739', + ], + 'IpVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 4 => '4', + 6 => '6', + ], + 'example' => '4', + ], + 'IpAddrList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' "10.10.10.1"'."\n" + .']', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResolveResult\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"UpdateTime\\": 1579091739,\\n \\"IpVersion\\": 4,\\n \\"IpAddrList\\": [\\n \\"[\\\\n \\\\\\"10.10.10.1\\\\\\"\\\\n]\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\"\\n}","type":"json"}]', + ], + 'AddControlPolicy' => [ + 'summary' => 'Creates an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '68094', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'accept', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application type supported by the access control policy. Valid values:'."\n" + ."\n" + .'* **FTP**'."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **Memcache**'."\n" + .'* **MongoDB**'."\n" + .'* **MQTT**'."\n" + .'* **MySQL**'."\n" + .'* **RDP**'."\n" + .'* **Redis**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **SSH**'."\n" + .'* **SSL_No_Cert**'."\n" + .'* **SSL**'."\n" + .'* **VNC**'."\n" + .'* **ANY**'."\n" + ."\n" + .'> The value of this parameter is based on the value of Proto. If Proto is set to TCP, you can set ApplicationName to any valid value. If Proto is set to UDP, ICMP, or ANY, you can set ApplicationName only to ANY. You must specify at least one of the ApplicationNameList and ApplicationName parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ANY', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Allows traffic'."\n", + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination port in the access control policy. Valid values:'."\n" + ."\n" + .'* If Proto is set to ICMP, DestPort is automatically left empty.'."\n" + ."\n" + .'> If Proto is set to ICMP, access control does not take effect on the destination port.'."\n" + ."\n" + .'* If Proto is set to TCP, UDP, or ANY and DestPortType is set to group, DestPort is empty.'."\n" + ."\n" + .'> If DestPortType is set to group, you do not need to specify the destination port number. All ports on which the access control policy takes effect are included in the destination port address book.'."\n" + ."\n" + .'* If Proto is set to TCP, UDP, or ANY and DestPortType is set to port, the value of DestPort is the destination port number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* If DestinationType is set to net, the value of this parameter is a CIDR block.'."\n" + ."\n" + .' Example: 1.2.XX.XX/24'."\n" + ."\n" + .'* If DestinationType is set to group, the value of this parameter is an address book name.'."\n" + ."\n" + .' Example: db_group'."\n" + ."\n" + .'* If DestinationType is set to domain, the value of this parameter is a domain name.'."\n" + ."\n" + .' Example: \\*.aliyuncs.com'."\n" + ."\n" + .'* If DestinationType is set to location, the value of this parameter is a location.'."\n" + ."\n" + .' Example: \\["BJ11", "ZB"]'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **domain**: domain name'."\n" + .'* **location**: location'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies. Valid values:'."\n" + ."\n" + .'* **in**: inbound traffic'."\n" + .'* **out**: outbound traffic'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type supported by the access control policy. Valid values:'."\n" + ."\n" + .'* **ANY**'."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ANY', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy. Valid values:'."\n" + ."\n" + .'* If SourceType is set to net, the value of this parameter is a CIDR block.'."\n" + ."\n" + .' Example: 1.1.XX.XX/24'."\n" + ."\n" + .'* If SourceType is set to group, the value of this parameter is an address book name.'."\n" + ."\n" + .' Example: db_group'."\n" + ."\n" + .'* If SourceType is set to location, the value of this parameter is a location.'."\n" + ."\n" + .' Example: \\["BJ11", "ZB"]'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the source address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **location**: location'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the access control policy. The priority value starts from 1. A smaller priority value indicates a higher priority.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination port in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **port**: port'."\n" + .'* **group**: port address book'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination port address book in the access control policy.'."\n" + ."\n" + .'> If DestPortType is set to group, you must specify the name of the destination port address book.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the access control policy. By default, an access control policy is enabled after the policy is created. Valid values:'."\n" + ."\n" + .'* **true**: enables the access control policy.'."\n" + .'* **false**: disables the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version supported by the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **4**: IPv4'."\n" + .'* **6**: IPv6'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The application types supported by the access control policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application type supported by the access control policy. Valid values:'."\n" + ."\n" + .'* **FTP**'."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **Memcache**'."\n" + .'* **MongoDB**'."\n" + .'* **MQTT**'."\n" + .'* **MySQL**'."\n" + .'* **RDP**'."\n" + .'* **Redis**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **SSH**'."\n" + .'* **SSL_No_Cert**'."\n" + .'* **SSL**'."\n" + .'* **VNC**'."\n" + .'* **ANY**'."\n" + ."\n" + .'> The value of this parameter is based on the value of Proto. If Proto is set to TCP, you can set ApplicationNameList to any valid value in the `["HTTP","HTTPS",……]` format. If Proto is set to UDP, ICMP, or ANY, you can set ApplicationNameList only to ANY. You must specify at least one of the ApplicationNameList and ApplicationName parameters. If you specify both ApplicationNameList and ApplicationName, only the value of ApplicationNameList takes effect.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["ANY"]', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If you set RepeatType to `Permanent`, `None`, or `Daily`, leave this parameter empty. Example: \\[].'."\n" + .'* If you set RepeatType to Weekly, you must specify this parameter. Example: \\[0, 6].'."\n" + ."\n" + .'> If you set RepeatType to Weekly, the fields in the value of this parameter cannot be repeated.'."\n" + ."\n" + .'* If you set RepeatType to `Monthly`, you must specify this parameter. Example: \\[1, 31].'."\n" + ."\n" + .'> If you set RepeatType to Monthly, the fields in the value of this parameter cannot be repeated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If you set RepeatType to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If you set RepeatType to Monthly, valid values of this parameter are 1 to 31.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The start time must be on the hour or on the half hour, and at least 30 minutes earlier than the end time.'."\n" + ."\n" + .'> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The end time must be on the hour or on the half hour, and at least 30 minutes later than the start time.'."\n" + ."\n" + .'> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the end time.'."\n" + ."\n" + .'> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the start time.'."\n" + ."\n" + .'> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name resolution method of the access control policy. Valid values:'."\n" + ."\n" + .'* **FQDN**: fully qualified domain name (FQDN)-based resolution'."\n" + .'* **DNS**: DNS-based dynamic resolution'."\n" + .'* **FQDN_AND_DNS**: FQDN and DNS-based dynamic resolution', + 'type' => 'string', + 'required' => false, + 'example' => 'FQDN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AclUuid' => [ + 'description' => 'The ID of the access control policy that is created on the Internet firewall.'."\n", + 'type' => 'string', + 'example' => '00281255-d220-4db1-8f4f-c4df221ad84c', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorAclDomainAnyCountExceed', + 'errorMessage' => 'The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.', + ], + [ + 'errorCode' => 'ErrorParametersGroupPort', + 'errorMessage' => 'The group port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersFtpNotSupport', + 'errorMessage' => 'domain destination not support ftp.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorParametersDestinationCount', + 'errorMessage' => 'Exceeding the number of countries in a single ACL.', + ], + [ + 'errorCode' => 'ErrorSrcMand', + 'errorMessage' => 'Source is mandatory for this action.', + ], + [ + 'errorCode' => 'ErrorEmptyDomainResolveType', + 'errorMessage' => 'Empty DomainResolveType only support HTTP/HTTPS/SSL/SMTP/SMTPS apps.', + ], + [ + 'errorCode' => 'ErrorAddressGroupNotExist', + 'errorMessage' => 'The address group does not exist.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationNameList', + 'errorMessage' => 'Specified parameter ApplicationNameList is not valid.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationName', + 'errorMessage' => 'Specified parameter ApplicationName is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AclUuid\\": \\"00281255-d220-4db1-8f4f-c4df221ad84c\\",\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<AddControlPolicyResponse>\\n <AclUuid>00281255-d220-4db1-8f4f-c4df221ad84c</AclUuid>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n</AddControlPolicyResponse>","errorExample":""}]', + 'title' => 'AddControlPolicy', + 'description' => 'You can call the AddControlPolicy operation to create an access control policy to allow, block, or monitor traffic that reaches Cloud Firewall.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => 'Location codes:'."\n" + ."\n" + .'* China: ZD'."\n" + .'* Beijing: BJ11'."\n" + .'* Tianjin: TJ12'."\n" + .'* Hebei: HB13'."\n" + .'* Shanxi: SX14'."\n" + .'* Liaoning: LN21'."\n" + .'* Jilin: JL22'."\n" + .'* Shanghai: SH31'."\n" + .'* Jiangsu: JS32'."\n" + .'* Zhejiang: ZJ33'."\n" + .'* Anhui: AH34'."\n" + .'* Fujian: FJ35'."\n" + .'* Jiangxi: JX36'."\n" + .'* Shandong: SD37'."\n" + .'* Henan: HN41'."\n" + .'* Hubei: HB42'."\n" + .'* Hunan: HN43'."\n" + .'* Guangdong: GD44'."\n" + .'* Hainan: HN46'."\n" + .'* Chongqing: CQ50'."\n" + .'* Sichuan: SC51'."\n" + .'* Guizhou: GZ52'."\n" + .'* Yunnan: YN53'."\n" + .'* Shaanxi: SX61'."\n" + .'* Gansu: GS62'."\n" + .'* Qinghai: QH63'."\n" + .'* Heilongjiang: HLJ23'."\n" + .'* Xizang: XZ54'."\n" + .'* Guangxi: GX45'."\n" + .'* Nei Mongol: NMG15'."\n" + .'* Ningxia: NX64'."\n" + .'* Xinjiang: XJ65'."\n" + .'* Taiwan (China): TW'."\n" + .'* Hong Kong (China): HK'."\n" + .'* Macao (China): MO'."\n" + .'* Locations outside China: ZB'."\n" + .'* Asia (except the Chinese mainland): ZC'."\n" + .'* Europe: EU'."\n" + .'* Africa: AF'."\n" + .'* North America: NA'."\n" + .'* South America: LA'."\n" + .'* Oceania: OA'."\n" + .'* Antarctica: AQ'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddDomainResolveRealtimeTask' => [ + 'summary' => '新增域名解析实时任务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228230', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'nat' => 'nat', + 'vpc' => 'vpc', + 'internet' => 'internet', + ], + 'example' => 'internet', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '337A4DBA-8A01-5E9C-99CA-84293E13****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorFirewallTypeDuplicates', + 'errorMessage' => 'firewallType duplicates.', + ], + [ + 'errorCode' => 'ErrorDomainName', + 'errorMessage' => 'The domain name is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorRegionNo', + 'errorMessage' => 'regionNo error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"337A4DBA-8A01-5E9C-99CA-84293E13****\\"\\n}","type":"json"}]', + ], + 'ModifyControlPolicy' => [ + 'summary' => 'Modifies the configurations of an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '68467', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the application that the access control policy supports. Valid values:'."\n" + ."\n" + .'* **ANY**'."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **MySQL**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **RDP**'."\n" + .'* **VNC**'."\n" + .'* **SSH**'."\n" + .'* **Redis**'."\n" + .'* **MQTT**'."\n" + .'* **MongoDB**'."\n" + .'* **Memcache**'."\n" + .'* **SSL**'."\n" + ."\n" + .'> The value **ANY** indicates all types of applications.'."\n" + ."\n" + .'> You must specify one of the ApplicationNameList and ApplicationName parameters. If you configure both ApplicationNameList and ApplicationName, only the value of ApplicationNameList is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination port in the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy.'."\n" + ."\n" + .'* If **DestinationType** is set to net, the value of **Destination** is a CIDR block. Example: 1.2.XX.XX/24.'."\n" + .'* If **DestinationType** is set to group, the value of **Destination** is an address book. Example: db_group.'."\n" + .'* If **DestinationType** is set to domain, the value of **Destination** is a domain name. Example: \\*.aliyuncs.com.'."\n" + .'* If **DestinationType** is set to location, the value of **Destination** is a location. For more information about the location codes, see the "AddControlPolicy" topic. Example: \\["BJ11", "ZB"].'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **domain**: domain name'."\n" + .'* **location**: location'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies. Valid values:'."\n" + ."\n" + .'* **in**: inbound traffic'."\n" + .'* **out**: outbound traffic'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type that the access control policy supports. Valid values:'."\n" + ."\n" + .'* **ANY**'."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n" + ."\n" + .'> The value **ANY** indicates all types of applications.'."\n" + ."\n" + .'> If the traffic direction is outbound and the destination address is a threat intelligence address book of the domain name type or a cloud service address book, you can set Proto to TCP or ANY. If you set Proto to TCP, you can set ApplicationName to HTTP, HTTPS, SMTP, SMTPS, and SSL. If you set Proto to ANY, you can set ApplicationName to ANY.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy.'."\n" + ."\n" + .'* If **SourceType** is set to net, the value of **Source** is a CIDR block. Example: 1.2.XX.XX/24.'."\n" + .'* If **SourceType** is set to group, the value of **Source** is an address book. Example: db_group.'."\n" + .'* If **SourceType** is set to location, the value of **Source** is a location. For more information about the location codes, see the "AddControlPolicy" topic. Example: \\["BJ11", "ZB"]'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n" + ."\n" + .'> To modify an access control policy, you must specify the UUID of the policy. You can call the [DescribeControlPolicy](~~138866~~) interface to query the UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df221ad84c', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the source address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **location**: location'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination port in the access control policy. Valid values:'."\n" + ."\n" + .'* **port**: port'."\n" + .'* **group**: port address book'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination port address book in the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the access control policy. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The application names.'."\n" + ."\n" + .'> You must specify one of the ApplicationNameList and ApplicationName parameters. If you configure both ApplicationNameList and ApplicationName, only the value of ApplicationNameList is used.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If you set RepeatType to `Permanent`, `None`, or `Daily`, the value of this parameter is an empty array. Example: \\[]'."\n" + .'* If you set RepeatType to Weekly, you must specify this parameter. Example: \\[0, 6]'."\n" + ."\n" + .'> If you set RepeatType to Weekly, the fields in the value of this parameter cannot be repeated.'."\n" + ."\n" + .'* If you set RepeatType to `Monthly`, you must specify this parameter. Example: \\[1, 31]'."\n" + ."\n" + .'> If you set RepeatType to Monthly, the fields in the value of this parameter cannot be repeated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If you set RepeatType to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If you set RepeatType to Monthly, valid values of this parameter are 1 to 31.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime.'."\n" + ."\n" + .'> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime.'."\n" + ."\n" + .'> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime.'."\n" + ."\n" + .'> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime.'."\n" + ."\n" + .'> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name resolution method of the access control policy. By default, an access control policy is enabled after the policy is created. Valid values:'."\n" + ."\n" + .'* **FQDN**: fully qualified domain name (FQDN)-based resolution'."\n" + .'* **DNS**: DNS-based dynamic resolution'."\n" + .'* **FQDN_AND_DNS**: FQDN and DNS-based dynamic resolution', + 'type' => 'string', + 'required' => false, + 'example' => 'FQDN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Error Parameters', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersFtpNotSupport', + 'errorMessage' => 'domain destination not support ftp.', + ], + [ + 'errorCode' => 'ErrorAclDomainAnyCountExceed', + 'errorMessage' => 'The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + [ + 'errorCode' => 'ErrorAclEffectiveTimeNonPermanent', + 'errorMessage' => 'ACL rule is not allowed to update status when effective is not permanent.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersDestinationCount', + 'errorMessage' => 'Exceeding the number of countries in a single ACL.', + ], + [ + 'errorCode' => 'ErrorEmptyDomainResolveType', + 'errorMessage' => 'Empty DomainResolveType only support HTTP/HTTPS/SSL/SMTP/SMTPS apps.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationName', + 'errorMessage' => 'Specified parameter ApplicationName is not valid.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationNameList', + 'errorMessage' => 'Specified parameter ApplicationNameList is not valid.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + [ + 'errorCode' => 'ErrorAddressGroupNotExist', + 'errorMessage' => 'The address group does not exist.', + ], + [ + 'errorCode' => 'ErrorParametersProtoAppsMismatch', + 'errorMessage' => 'The protocol and applicationName mismatch.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyControlPolicyResponse>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n</ModifyControlPolicyResponse>","errorExample":""}]', + 'title' => 'ModifyControlPolicy', + 'description' => 'You can call this operation to modify the configurations of an access control policy. The policy allows Cloud Firewall to allow, deny, or monitor the traffic that passes through Cloud Firewall.'."\n" + ."\n" + .'## [](#qps)Limit'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyControlPolicyPriority' => [ + 'summary' => 'Modifies the priority of an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68469', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + 'FEATUREcfwO822TD', + 'FEATUREcfwFIV6PB', + 'FEATUREcfwTW8EA1', + 'FEATUREcfwC140SS', + ], + ], + 'parameters' => [ + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3770d603-3534-4878-b845-f00095ee5048', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '586F34E8-3F16-4C08-9FFC-8FFDC64B9D0D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'A domain resolution error occurred.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorParametersNewOrder', + 'errorMessage' => 'The newOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersOldOrder', + 'errorMessage' => 'The oldOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred. Try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"586F34E8-3F16-4C08-9FFC-8FFDC64B****\\"\\n}","type":"json"}]', + 'title' => 'ModifyControlPolicyPriority', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyPolicyAdvancedConfig' => [ + 'summary' => 'Enables or disables the strict mode for an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68479', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The natural language of the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'InternetSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the strict mode for the access control policy. Valid values:'."\n" + ."\n" + .'* **on**: enables the strict mode.'."\n" + .'* **off**: disables the strict mode.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'off', + ], + ], + [ + 'name' => 'Eips', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The IP addresses. The versions of the IP addresses must be the same. You can specify a maximum of 100 IP addresses.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyPolicyAdvancedConfigResponse>\\r\\n <RequestId>B2841452-CB8D-4F7D-B247-38E1CF7334F8</RequestId>\\r\\n</ModifyPolicyAdvancedConfigResponse>","errorExample":""}]', + 'title' => 'ModifyPolicyAdvancedConfig', + 'description' => 'You can call the ModifyPolicyAdvancedConfig operation to enable or disable the strict mode for an access control policy. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteControlPolicy' => [ + 'summary' => 'Deletes an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'delete', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68146', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the traffic.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n" + ."\n" + .'To delete an access control policy, you must specify the UUID of the policy. You can call the [DescribeControlPolicy](~~138866~~) operation to query the UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df221ad84c', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **in**: inbound.'."\n" + .'* **out**: outbound.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteControlPolicyResponse>\\r\\n<RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\r\\n</DeleteControlPolicyResponse>","errorExample":""}]', + 'title' => 'DeleteControlPolicy', + 'description' => 'You can call the DeleteControlPolicy operation to delete an access control policy that applies to inbound or outbound traffic.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteControlPolicyTemplate' => [ + 'summary' => 'Deletes an access control policy template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140699', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '61.178.12.52', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '719ce620-ae23-4e42-9f93-9191b4400b55', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4E7F94C7-781F-5192-86CF-DB085013C810', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorUnmarshalJSON', + 'errorMessage' => 'An error occurred while parsing JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E7F94C7-781F-5192-86CF-DB085013C810\\"\\n}","type":"json"}]', + 'title' => 'DeleteControlPolicyTemplate', + ], + 'ResetRuleHitCount' => [ + 'summary' => '重置规则命中数', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68520', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '112.64.126.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '211fd804-30f5-470f-ab26-c465a4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg_server', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '706B2093-CBA0-51B2-BEBF-58903FC6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Module\\": \\"sg_server\\",\\n \\"RequestId\\": \\"706B2093-CBA0-51B2-BEBF-58903FC6****\\"\\n}","type":"json"}]', + ], + 'DescribeNatAclPageStatus' => [ + 'summary' => 'Queries the pagination status of NAT firewalls.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180434', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NatAclPageEnable' => [ + 'description' => 'Indicates whether pagination for access control policies for NAT firewalls is supported.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B97F9AD7-A2DB-5F8F-9206-DF89DE0AC9E8', + ], + 'Detail' => [ + 'description' => 'Extra error information.', + 'type' => 'string', + 'example' => 'proxy_not_exist', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorUnmarshalJSON', + 'errorMessage' => 'An error occurred while parsing JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NatAclPageEnable\\": true,\\n \\"RequestId\\": \\"B97F9AD7-A2DB-5F8F-9206-DF89DE0AC9E8\\",\\n \\"Detail\\": \\"proxy_not_exist\\"\\n}","type":"json"}]', + 'title' => 'DescribeNatAclPageStatus', + ], + 'DescribeNatFirewallAclGroupList' => [ + 'summary' => '查询Nat防火墙分组列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201928', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F06DE24D-6EB9-5F55-B588-7BB946DF****', + ], + 'NatFirewalls' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-2zed6z6qkd7ogc****', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'IsDefault' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'AclRuleCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F06DE24D-6EB9-5F55-B588-7BB946DF****\\",\\n \\"NatFirewalls\\": [\\n {\\n \\"NatGatewayId\\": \\"ngw-2zed6z6qkd7ogc****\\",\\n \\"NatGatewayName\\": \\"ngw-test\\",\\n \\"IsDefault\\": true,\\n \\"AclRuleCount\\": 32,\\n \\"RegionNo\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeNatFirewallControlPolicy' => [ + 'summary' => 'Queries the information about all access control policies that are created for NAT firewalls.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171421', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy. Fuzzy match is supported. The value of this parameter varies based on the value of the SourceType parameter.'."\n" + ."\n" + .'* If SourceType is set to `net`, the value of Source must be a CIDR block. Example: 192.0.XX.XX/24.'."\n" + .'* If SourceType is set to `group`, the value of Source must be the name of an address book. Example: db_group. If the db_group address book does not contain addresses, all source addresses are queried.'."\n" + .'* If SourceType is set to `location`, the value of Source must be a location. Example: beijing.'."\n" + ."\n" + .'> If you do not specify this parameter, all types of source addresses are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1/32', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy. Fuzzy match is supported. The value of this parameter varies based on the value of the DestinationType parameter.'."\n" + ."\n" + .'* If DestinationType is set to `net`, the value of Destination must be a CIDR block. Example: 10.0.3.0/24.'."\n" + .'* If DestinationType is set to `domain`, the value of Destination must be a domain name. Example: aliyun.'."\n" + .'* If DestinationType is set to `group`, the value of Destination must be the name of an address book. Example: db_group.'."\n" + .'* If DestinationType is set to `location`, the value of Destination is a location. For more information about location codes, see [AddControlPolicy](~~474128~~). Example: \\["BJ11", "ZB"].'."\n" + ."\n" + .'> If you do not specify this parameter, all types of destination addresses are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'x.x.x.x/32', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy. Fuzzy match is supported.'."\n" + ."\n" + .'> If you do not specify this parameter, the descriptions of all policies are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the protocol in the access control policy. Valid values:'."\n" + ."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n" + .'* **ANY**: all types of protocols'."\n" + ."\n" + .'> If you do not specify this parameter, access control policies of all protocol types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ANY', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '303f0697-2a21-4e43-b142-4a77adf7b358', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the access control policy is enabled. By default, an access control policy is enabled after it is created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies. Valid values:'."\n" + ."\n" + .'* **out**: outbound traffic'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '28', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F183567D-8A52-5BAE-9472-F1C427378C28', + ], + 'Policys' => [ + 'description' => 'The information about the access control policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Destination' => [ + 'description' => 'The destination address in the access control policy. The value of this parameter varies based on the value of DestinationType. Valid values:'."\n" + ."\n" + .'* If the value of **DestinationType** is **net**, the value of this parameter is a CIDR block. Example: 192.0.XX.XX/24.'."\n" + .'* If the value of **DestinationType** is **domain**, the value of this parameter is a domain name. Example: aliyuncs.com.'."\n" + .'* If the value of **DestinationType** is **group**, the value of this parameter is the name of an address book. Example: db_group.'."\n" + .'* If the value of **DestinationType** is **location**, the value of this parameter is a location. For more information about location codes, see [AddControlPolicy](~~138867~~). Example: \\["BJ11", "ZB"].'."\n", + 'type' => 'string', + 'example' => 'x.x.x.x/32', + ], + 'Order' => [ + 'description' => 'The priority of the access control policy.'."\n" + ."\n" + .'The priority value starts from 1. A smaller priority value indicates a higher priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DestPortGroup' => [ + 'description' => 'The name of the destination port address book in the access control policy.'."\n", + 'type' => 'string', + 'example' => 'my_port_group', + ], + 'SourceType' => [ + 'description' => 'The type of the source address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **location**: location'."\n", + 'type' => 'string', + 'example' => 'net', + ], + 'DnsResultTime' => [ + 'description' => 'The time when the Domain Name System (DNS) resolution was performed. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DnsResult' => [ + 'description' => 'The DNS resolution result.'."\n", + 'type' => 'string', + 'example' => '111.0.XX.XX,112.0.XX.XX', + ], + 'ApplicationNameList' => [ + 'description' => 'The application names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'example' => '[\'HTTP\', \'HTTPS\']', + ], + ], + 'AclUuid' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + 'DestPortType' => [ + 'description' => 'The type of the destination port in the access control policy. Valid values:'."\n" + ."\n" + .'* **port**: port'."\n" + .'* **group**: port address book'."\n", + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => 'The source address in the access control policy. Valid values:'."\n" + ."\n" + .'* If the value of **SourceType** is `net`, the value of this parameter is a CIDR block. Example: 192.0.XX.XX/24.'."\n" + .'* If the value of **SourceType** is `group`, the value of this parameter is the name of an address book. Example: db_group.'."\n" + .'* If the value of **SourceType** is `location`, the value of this parameter is a location. For more information about location codes, see [AddControlPolicy](~~138867~~). Example: \\["BJ11", "ZB"].'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'DestinationType' => [ + 'description' => 'The type of the destination address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **domain**: domain name'."\n" + .'* **location**: location'."\n", + 'type' => 'string', + 'example' => 'net', + ], + 'HitTimes' => [ + 'description' => 'The number of hits for the access control policy.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'HitLastTime' => [ + 'description' => 'The time when the access control policy was last hit. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DestPort' => [ + 'description' => 'The destination port in the access control policy.'."\n", + 'type' => 'string', + 'example' => '80', + ], + 'Description' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AclAction' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'example' => 'accept', + ], + 'Proto' => [ + 'description' => 'The protocol type in the access control policy. Valid values:'."\n" + ."\n" + .'* **ANY**'."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + 'DestinationGroupCidrs' => [ + 'description' => 'The CIDR blocks in the destination address book.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block in the destination address book.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "112.0.XX.XX/24",'."\n" + .' "112.0.XX.XX/32"'."\n" + .']', + ], + ], + 'DestPortGroupPorts' => [ + 'description' => 'The ports in the destination port address book.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The port in the destination port address book.'."\n", + 'type' => 'string', + 'example' => '[80,443]', + ], + ], + 'SourceGroupCidrs' => [ + 'description' => 'The CIDR blocks in the source address book.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block in the source address book.'."\n", + 'type' => 'string', + 'example' => '[\'192.0.XX.XX/24\', \'192.0.XX.XX/32\']', + ], + ], + 'Release' => [ + 'description' => 'The status of the access control policy. By default, an access control policy is enabled after it is created. Valid values:'."\n" + ."\n" + .'* **true**: enabled'."\n" + .'* **false**: disabled'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'SourceGroupType' => [ + 'description' => 'The type of the source address book in the access control policy. The value is fixed as **ip**. The value indicates an address book that includes one or more CIDR blocks.'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'DestinationGroupType' => [ + 'description' => 'The type of the destination address book in the access control policy. Valid values:'."\n" + ."\n" + .'* **ip**: an address book that includes one or more CIDR blocks'."\n" + .'* **domain**: an address book that includes one or more domain names'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'NatGatewayId' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'example' => 'ngw-xxxxxx', + ], + 'DomainResolveType' => [ + 'description' => 'The domain name resolution method of the access control policy. By default, an access control policy is enabled after the policy is created. Valid values:'."\n" + ."\n" + .'* **0**: fully qualified domain name (FQDN)-based resolution'."\n" + .'* **1**: DNS-based dynamic resolution'."\n" + .'* **2**: FQDN and DNS-based dynamic resolution'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SpreadCnt' => [ + 'description' => 'The total quota consumed by the returned access control policies, which is the sum of the quota consumed by each policy. The quota that is consumed by an access control policy is calculated by using the following formula: Quota that is consumed by an access control policy = Number of source addresses (number of CIDR blocks or regions) × Number of destination addresses (number of CIDR blocks, regions, or domain names) × Number of port ranges × Number of applications.'."\n", + 'type' => 'string', + 'example' => '10,000', + ], + 'CreateTime' => [ + 'description' => 'The time when the access control policy was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ModifyTime' => [ + 'description' => 'The time when the access control policy was modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'RepeatType' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + 'RepeatDays' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If RepeatType is set to `Permanent`, `None`, or `Daily`, the value of this parameter is an empty array. Example: \\[].'."\n" + .'* If RepeatType is set to Weekly, this parameter must be specified. Example: \\[0, 6].'."\n" + ."\n" + .'> If RepeatType is set to Weekly, the fields in the value of this parameter cannot be repeated.'."\n" + ."\n" + .'* If RepeatType is set to `Monthly`, this parameter must be specified. Example: \\[1, 31].'."\n" + ."\n" + .'> If RepeatType is set to Monthly, the fields in the value of this parameter cannot be repeated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If RepeatType is set to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If RepeatType is set to Monthly, valid values of this parameter are 1 to 31.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'RepeatStartTime' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The start time must be on the hour or on the half hour, and at least 30 minutes earlier than the end time.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, this parameter is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'string', + 'example' => '08:00', + ], + 'RepeatEndTime' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The end time must be on the hour or on the half hour, and at least 30 minutes later than the start time.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, this parameter is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The start time must be on the hour or on the half hour, and at least 30 minutes earlier than the end time.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, this parameter is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694761200', + ], + 'EndTime' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The end time must be on the hour or on the half hour, and at least 30 minutes later than the start time.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, this parameter is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694764800', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorUnmarshalJSON', + 'errorMessage' => 'An error occurred while parsing JSON.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParametersNatGatewayId', + 'errorMessage' => 'Invalid parameters NatGatewayId.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"28\\",\\n \\"RequestId\\": \\"F283567D-8A52-5BAE-9472-*****\\",\\n \\"Policys\\": [\\n {\\n \\"Destination\\": \\"x.x.x.x/32\\",\\n \\"Order\\": 1,\\n \\"DestPortGroup\\": \\"my_port_group\\",\\n \\"SourceType\\": \\"net\\",\\n \\"DnsResultTime\\": 1579261141,\\n \\"DnsResult\\": \\"111.0.XX.XX,112.0.XX.XX\\",\\n \\"ApplicationNameList\\": [\\n \\"[\'HTTP\', \'HTTPS\']\\"\\n ],\\n \\"AclUuid\\": \\"01281255-d220-4db1-8f4f-c4df221a****\\",\\n \\"DestPortType\\": \\"port\\",\\n \\"Source\\": \\"192.0.XX.XX/24\\",\\n \\"DestinationType\\": \\"net\\",\\n \\"HitTimes\\": 100,\\n \\"HitLastTime\\": 1579261141,\\n \\"DestPort\\": \\"80\\",\\n \\"Description\\": \\"描述信息\\",\\n \\"AclAction\\": \\"accept\\",\\n \\"Proto\\": \\"TCP\\",\\n \\"DestinationGroupCidrs\\": [\\n \\"[\\\\n \\\\\\"112.0.XX.XX/24\\\\\\",\\\\n \\\\\\"112.0.XX.XX/32\\\\\\"\\\\n]\\"\\n ],\\n \\"DestPortGroupPorts\\": [\\n \\"[80,443]\\"\\n ],\\n \\"SourceGroupCidrs\\": [\\n \\"[\'192.0.XX.XX/24\', \'192.0.XX.XX/32\']\\"\\n ],\\n \\"Release\\": \\"true\\",\\n \\"SourceGroupType\\": \\"ip\\",\\n \\"DestinationGroupType\\": \\"ip\\",\\n \\"NatGatewayId\\": \\"ngw-xxxxxx\\",\\n \\"DomainResolveType\\": 0,\\n \\"SpreadCnt\\": \\"10,000\\",\\n \\"CreateTime\\": 1761062400,\\n \\"ModifyTime\\": 1761062400,\\n \\"RepeatType\\": \\"Permanent\\",\\n \\"RepeatDays\\": [\\n 1\\n ],\\n \\"RepeatStartTime\\": \\"08:00\\",\\n \\"RepeatEndTime\\": \\"23:30\\",\\n \\"StartTime\\": 1694761200,\\n \\"EndTime\\": 1694764800\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeNatFirewallControlPolicy', + 'description' => 'You can use this operation to query the information about all access control policies that are created for NAT firewalls by page.'."\n", + ], + 'DescribeNatFirewallPolicyPriorUsed' => [ + 'summary' => 'Queries the priority range of access control policies that are created for a NAT firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171493', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **out**: outbound traffic'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version supported by the access control policy. Valid values:'."\n" + ."\n" + .'* **4**: IPv4 (default)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => 'The lowest priority for the access control policy.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + 'Start' => [ + 'description' => 'The highest priority for the access control policy.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BCDF3907-1011-5504-B015-CC7603C0E6B6', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParametersNatGatewayId', + 'errorMessage' => 'Invalid parameters NatGatewayId.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"End\\": 28,\\n \\"Start\\": 1,\\n \\"RequestId\\": \\"BCDF3907-1011-5504-B015-CC7603C0E6B6\\"\\n}","type":"json"}]', + 'title' => 'DescribeNatFirewallPolicyPriorUsed', + 'description' => 'You can use this operation to query the priority range of access control policies that are created for a NAT firewall.'."\n", + ], + 'CreateNatFirewallControlPolicy' => [ + 'summary' => 'Creates an access control policy for a NAT firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '170916', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'log', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The application types supported by the access control policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application type supported by the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ANY', + ], + 'required' => true, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'allow', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination port in the access control policy. Valid values:'."\n" + ."\n" + .'* If Proto is set to ICMP, DestPort is automatically left empty.'."\n" + ."\n" + .'> If Proto is set to ICMP, access control does not take effect on the destination port.'."\n" + ."\n" + .'* If Proto is set to TCP, UDP, or ANY and DestPortType is set to group, DestPort is empty.'."\n" + ."\n" + .'> If DestPortType is set to group, you do not need to specify the destination port number. All ports on which the access control policy takes effect are included in the destination port address book.'."\n" + ."\n" + .'* If Proto is set to TCP, UDP, or ANY and DestPortType is set to port, the value of DestPort is the destination port number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* If DestinationType is set to net, the value of this parameter is a CIDR block.'."\n" + ."\n" + .' Example: 1.2.XX.XX/24'."\n" + ."\n" + .'* If DestinationType is set to group, the value of this parameter is an address book.'."\n" + ."\n" + .' Example: db_group'."\n" + ."\n" + .'* If DestinationType is set to domain, the value of this parameter is a domain name.'."\n" + ."\n" + .' Example: \\*.aliyuncs.com'."\n" + ."\n" + .'* If DestinationType is set to location, the value of this parameter is a location.'."\n" + ."\n" + .' Example: \\["BJ11", "ZB"]'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'XX.XX.XX.XX/24', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination address in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **domain**: domain name'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngx-xxxxxxx', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ANY: all types of protocols.'."\n" + .'* TCP'."\n" + .'* UDP'."\n" + .'* ICMP'."\n" + ."\n" + .'> If the destination address is a threat intelligence address book of the domain name type or a cloud service address book, you can set Proto only to TCP and set ApplicationNameList to HTTP, HTTPS, SMTP, SMTPS, or SSL.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'ANY', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* If **SourceType** is set to `net`, the value of Source is a CIDR block.'."\n" + ."\n" + .' Example: 10.2.4.0/24'."\n" + ."\n" + .'* If **SourceType** is set to `group`, the value of this parameter must be an address book name.'."\n" + ."\n" + .' Example: db_group'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.25/32', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the source address in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **net**: source CIDR block'."\n" + .'* **group**: source address book'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the access control policy. The priority value starts from 1. A small priority value indicates a high priority.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination port in the access control policy. Valid values:'."\n" + ."\n" + .'* **port**: port'."\n" + .'* **group**: port address book'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination port address book in the access control policy.'."\n" + ."\n" + .'> If DestPortType is set to group, you must specify the name of the destination port address book.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the access control policy. By default, an access control policy is enabled after it is created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name resolution method of the access control policy. Valid values:'."\n" + ."\n" + .'* **0**: fully qualified domain name (FQDN)-based resolution'."\n" + .'* **1**: Domain Name System (DNS)-based dynamic resolution'."\n" + .'* **2**: FQDN and DNS-based dynamic resolution'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version supported by the access control policy. Valid values:'."\n" + ."\n" + .'* **4**: IPv4 (default)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies. Valid value:'."\n" + ."\n" + .'* **out**: outbound.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If RepeatType is set to `Permanent`, `None`, or `Daily`, RepeatDays is left empty. Example: \\[].'."\n" + .'* If RepeatType is set to Weekly, RepeatDays must be specified. Example: \\[0, 6].'."\n" + ."\n" + .'> If RepeatType is set to Weekly, the fields in the value of RepeatDays cannot be repeated.'."\n" + ."\n" + .'* If RepeatType is set to `Monthly`, RepeatDays must be specified. Example: \\[1, 31].'."\n" + ."\n" + .'> If RepeatType is set to Monthly, the fields in the value of RepeatDays cannot be repeated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If RepeatType is set to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If RepeatType is set to Monthly, valid values of this parameter are 1 to 31.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, RepeatStartTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, RepeatEndTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, StartTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, EndTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AclUuid' => [ + 'description' => 'The unique ID of the access control policy.'."\n" + ."\n" + .'> To modify an access control policy, you must specify the unique ID of the policy. You can call the DescribeNatFirewallControlPolicy operation to obtain the ID.'."\n", + 'type' => 'string', + 'example' => '6504d2fb-ab36-49c3-92a6-822a56549783', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0DC783F1-B3A7-578D-8A63-687CC9B82C0A', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorParametersNewOrder', + 'errorMessage' => 'The newOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorAclDomainAnyCountExceed', + 'errorMessage' => 'The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.', + ], + [ + 'errorCode' => 'ErrorParametersNatGatewayId', + 'errorMessage' => 'Invalid parameters NatGatewayId.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersDestinationCount', + 'errorMessage' => 'Exceeding the number of countries in a single ACL.', + ], + [ + 'errorCode' => 'ErrorStartTimeOrEndTime', + 'errorMessage' => 'The start time or end time is invalid. The time must be the hour or half hour, and the start time must be 30 minutes earlier than the end time.', + ], + [ + 'errorCode' => 'ErrorParametersFtpNotSupport', + 'errorMessage' => 'domain destination not support ftp.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorAddressGroupNotExist', + 'errorMessage' => 'The address group does not exist.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationNameList', + 'errorMessage' => 'Specified parameter ApplicationNameList is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AclUuid\\": \\"6504d2fb-ab36-49c3-92a6-*****\\",\\n \\"RequestId\\": \\"0DC783F1-B3A7-578D-8A63-*****\\"\\n}","type":"json"}]', + 'title' => 'CreateNatFirewallControlPolicy', + 'description' => 'You can call this operation to create a policy that allows, denies, or monitors the traffic that passes through the NAT firewall.'."\n", + ], + 'ModifyNatFirewallControlPolicy' => [ + 'summary' => 'Modifies the configurations of an access control policy that is created for a NAT firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171412', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'log', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy. Fuzzy match is supported.'."\n" + ."\n" + .'> If you do not specify this parameter, the descriptions of all policies are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination port in the access control policy.'."\n" + ."\n" + .'> If **DestPortType** is set to `port`, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy.'."\n" + ."\n" + .'* If **DestinationType** is set to net, the value of **Destination** is a CIDR block. Example: 1.2.3.4/24'."\n" + .'* If **DestinationType** is set to group, the value of **Destination** is an address book. Example: db_group'."\n" + .'* If **DestinationType** is set to domain, the value of **Destination** is a domain name. Example: \\*.aliyuncs.com'."\n" + .'* If **DestinationType** is set to location, the value of **Destination** is a location. For more information about the location codes, see the "AddControlPolicy" topic. Example: \\["BJ11", "ZB"]'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'x.x.x.x/32', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **domain**: domain name'."\n" + .'* **location**: destination location', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type in the access control policy. Valid values:'."\n" + ."\n" + .'* **ANY**'."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n" + ."\n" + .'> The value **ANY** indicates all types of applications.'."\n" + ."\n" + .'> If the destination address type is a threat intelligence address book of the domain name type or a cloud service address book, you can set Proto to TCP. If you set Proto to TCP, you can set application types to HTTP, HTTPS, SMTP, SMTPS, and SSL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy. Valid values:'."\n" + ."\n" + .'* If **SourceType** is set to `net`, the value of this parameter is a CIDR block. Example: 10.2.XX.XX/24.'."\n" + .'* If **SourceType** is set to `group`, the value of this parameter is an address book name. Example: db_group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.25/32', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n" + ."\n" + .'To modify the configurations of an access control policy, you must provide the UUID of the policy. You can call the DescribeNatFirewallControlPolicy operation to query the UUIDs of access control policies.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '61ab1c02-926a-4d1b-9ef7-595eed8c4226', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies. Valid value:'."\n" + ."\n" + .'* **out**: outbound.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'out', + 'default' => 'out', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the source address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination port in the access control policy. Valid values:'."\n" + ."\n" + .'* **port**: port'."\n" + .'* **group**: port address book'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination port address book in the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my_dest_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the access control policy. Valid values:'."\n" + ."\n" + .'* **true**: enabled'."\n" + .'* **false**: disabled'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The name of the application.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application types supported by the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ANY', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name resolution method of the access control policy. Valid values:'."\n" + ."\n" + .'* **0**: Fully qualified domain name (FQDN)-based resolution'."\n" + .'* **1**: Domain Name System (DNS)-based dynamic resolution'."\n" + .'* **2**: FQDN and DNS-based dynamic resolution'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If RepeatType is set to `Permanent`, `None`, or `Daily`, RepeatDays is left empty. Example: \\[].'."\n" + .'* If RepeatType is set to Weekly, RepeatDays must be specified. Example: \\[0, 6].'."\n" + ."\n" + .'> If RepeatType is set to Weekly, the fields in the value of RepeatDays cannot be repeated.'."\n" + ."\n" + .'* If RepeatType is set to `Monthly`, RepeatDays must be specified. Example: \\[1, 31].'."\n" + ."\n" + .'> If RepeatType is set to Monthly, the fields in the value of RepeatDays cannot be repeated.', + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If RepeatType is set to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If RepeatType is set to Monthly, valid values of this parameter are 1 to 31.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, RepeatStartTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, RepeatEndTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, RepeatEndTime must be specified.', + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, StartTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, StartTime must be specified.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, EndTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, EndTime must be specified.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3868197C-E6E8-52CD-8358-05E3308430E2', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorParametersDestinationCount', + 'errorMessage' => 'Exceeding the number of countries in a single ACL.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorAclEffectiveTimeNonPermanent', + 'errorMessage' => 'ACL rule is not allowed to update status when effective is not permanent.', + ], + [ + 'errorCode' => 'ErrorParametersNatGatewayId', + 'errorMessage' => 'Invalid parameters NatGatewayId.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorParametersFtpNotSupport', + 'errorMessage' => 'domain destination not support ftp.', + ], + [ + 'errorCode' => 'ErrorAddressGroupNotExist', + 'errorMessage' => 'The address group does not exist.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationNameList', + 'errorMessage' => 'Specified parameter ApplicationNameList is not valid.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3768197C-E6E8-52CD-8358-*****\\"\\n}","type":"json"}]', + 'title' => 'ModifyNatFirewallControlPolicy', + 'description' => 'You can use this operation to modify the configurations of an access control policy. The policy is used to allow, deny, or monitor traffic that reaches a NAT firewall.'."\n", + ], + 'ModifyNatFirewallControlPolicyPosition' => [ + 'summary' => 'Modifies the priority of an access control policy that is created for a NAT firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171422', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies.'."\n" + ."\n" + .'* Set the value to **out**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'out', + 'default' => 'out', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new priority of the IPv4 access control policy. You must specify a numeric value for this parameter. The value 1 indicates the highest priority. A larger value indicates a lower priority.'."\n" + ."\n" + .'> Make sure that the value of this parameter is within the priority range of existing IPv4 access control policies. Otherwise, an error occurs when you call this operation.'."\n" + ."\n" + .'Before you call this operation, we recommend that you call the DescribeNatFirewallPolicyPriorUsed operation to query the priority range of the IPv4 access control policies in the specified traffic direction.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '66961eea-e659-4225-84c9-9b6da76ec401', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '60617208-F5F7-5B44-BB1E-3AC1B6FCD627', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParametersNatGatewayId', + 'errorMessage' => 'Invalid parameters NatGatewayId.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68617208-F5F7-5B44-BB1E-*****\\"\\n}","type":"json"}]', + 'title' => 'ModifyNatFirewallControlPolicyPosition', + ], + 'ResetNatFirewallRuleHitCount' => [ + 'summary' => 'Resets the number of NAT firewall hits.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171494', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3de3aed5-6de7-4ecd-9106-cfe994b9c49f', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-zm0h3c1exm5bifuorg8c5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5CAA0FFD-4B94-5BB9-8B0A-ECFC86A0E666', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CAA0FFD-4B94-5BB9-8B0A-ECFC86A0E666\\"\\n}","type":"json"}]', + 'title' => 'ResetNatFirewallRuleHitCount', + ], + 'DeleteNatFirewallControlPolicy' => [ + 'summary' => 'Deletes an access control policy that is created for a NAT firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171413', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n" + ."\n" + .'To delete an access control policy, you must provide the ID of the policy. You can call the DescribeNatFirewallControlPolicy operation to query the UUIDs of access control policies.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'b6c8f905-2eb6-442a-ba35-9416e9dbb2c5', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **out**: outbound traffic'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '31306869-C4BC-56F3-BBE6-C377CF9C8E1C', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParametersNatGatewayId', + 'errorMessage' => 'Invalid parameters NatGatewayId.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31306819-C4BC-56F3-BBE6-*****\\"\\n}","type":"json"}]', + 'title' => 'DeleteNatFirewallControlPolicy', + 'description' => 'You can use this operation to delete an outbound access control policy that is created for a NAT firewall.'."\n", + ], + 'DeleteNatFirewallControlPolicyBatch' => [ + 'summary' => 'Deletes access control policies that are created for a NAT firewall at a time.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173710', + 'abilityTreeNodes' => [ + 'FEATUREcfw7YI1ZZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The UUIDs of access control policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '6fb052a4-baad-4d86-8e2e-b79cc060535c', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAT gateway.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-uf6j0426ap74vd6vrb676', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the access control policy applies. Valid values:'."\n" + ."\n" + .'* **out**: outbound traffic'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'out', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '450D47F5-956E-543E-8502-2F71C8C54E72', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorParamUuidOrOrderMiss', + 'errorMessage' => 'Either uuid or oldOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"450D47F5-956E-543E-8502-2F71C8C54E72\\"\\n}","type":"json"}]', + 'title' => 'DeleteNatFirewallControlPolicyBatch', + ], + 'DescribeVpcFirewallAssetRegionList' => [ + 'summary' => '查询VPC防火墙资产地域', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231484', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '00933CCB-65A4-5E51-B180-3D154281****', + ], + 'RegionNoList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[\'cn-hangzhou\', \'cn-shenzhen\']', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"00933CCB-65A4-5E51-B180-3D154281****\\",\\n \\"RegionNoList\\": [\\n \\"[\'cn-hangzhou\', \'cn-shenzhen\']\\"\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallAclGroupList' => [ + 'summary' => 'Queries the information about all policy groups of access control policies that are created for virtual private cloud (VPC) firewalls.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68412', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallConfigureStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether VPC firewalls are configured. Valid values:'."\n" + ."\n" + .'* **notconfigured**: VPC firewalls are not configured.'."\n" + .'* **configured**: VPC firewalls are configured.'."\n" + .'* If you do not specify this parameter, the access control policies of all VPC firewalls are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'configured', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-5b202e7f0be64611****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of the policy groups that are returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + 'AclGroupList' => [ + 'description' => 'The information about the access control policy groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'None.'."\n", + 'type' => 'object', + 'properties' => [ + 'AclGroupId' => [ + 'description' => 'The ID of the policy group.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* If the VPC firewall is used to protect a Cloud Enterprise Network (CEN) instance, the value of this parameter is the ID of the CEN instance.'."\n" + ."\n" + .' Example: cen-ervw0g12b5jbw\\*\\*\\*\\*'."\n" + ."\n" + .'* If the VPC firewall is used to protect an Express Connect circuit, the value of this parameter is the instance ID of the VPC firewall.'."\n" + ."\n" + .' Example: vfw-a42bbb7b887148c9\\*\\*\\*\\*'."\n", + 'type' => 'string', + 'example' => 'vfw-a42bbb7b887148c9****', + ], + 'AclGroupName' => [ + 'description' => 'The name of the policy group. Valid values:'."\n" + ."\n" + .'* If the VPC firewall is used to protect a CEN instance, the value of this parameter is the name of the CEN instance.'."\n" + .'* If the VPC firewall is used to protect an Express Connect circuit, the value of this parameter is the instance name of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'group_test', + ], + 'MemberUid' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '258039427902****', + ], + 'AclRuleCount' => [ + 'description' => 'The number of access control policies in the policy group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'IsDefault' => [ + 'description' => 'Whether it is the default firewall. Values:'."\n" + ."\n" + .'* **true**: It is the default firewall.'."\n" + .'* **false**: It is not the default firewall.', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'AclConfig' => [ + 'description' => 'ACL engine mode.', + 'type' => 'object', + 'properties' => [ + 'StrictMode' => [ + 'description' => 'Specifies Whether strict mode is enabled. Valid values:'."\n" + .'* 1: yes'."\n" + .'* 0: no', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'The aliuid is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorConfigureStatus', + 'errorMessage' => 'firewall configure status invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"AclGroupList\\": [\\n {\\n \\"AclGroupId\\": \\"vfw-a42bbb7b887148c9****\\",\\n \\"AclGroupName\\": \\"group_test\\",\\n \\"MemberUid\\": \\"258039427902****\\",\\n \\"AclRuleCount\\": 9,\\n \\"IsDefault\\": true,\\n \\"AclConfig\\": {\\n \\"StrictMode\\": 1\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcFirewallAclGroupListResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n <AclGroupList>\\n <AclGroupId>vfw-a42bbb7b887148c9****</AclGroupId>\\n <AclGroupName>group_test</AclGroupName>\\n <MemberUid>258039427902****</MemberUid>\\n </AclGroupList>\\n</DescribeVpcFirewallAclGroupListResponse>","errorExample":""}]', + 'title' => 'DescribeVpcFirewallAclGroupList', + 'description' => 'You can call the DescribeVpcFirewallAclGroupList operation to query the information about all policy groups of access control policies that are created for VPC firewalls.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVpcFirewallControlPolicy' => [ + 'summary' => 'Queries the information about the access control policies for a specified virtual private cloud (VPC) firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68417', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall. Valid values:'."\n" + ."\n" + .'* If the VPC firewall protects the traffic between two VPCs that are connected by using a CEN instance, the value of this parameter must be the ID of the CEN instance.'."\n" + .'* If the VPC firewall protects the traffic between two VPCs that are connected by using an Express Connect circuit, the value of this parameter must be the instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallAclGroupList](~~159760~~) operation to query the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Maximum value: 50.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy. Fuzzy match is supported.'."\n" + ."\n" + .'> The value of this parameter can be a CIDR block or an address book name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy. Fuzzy match is supported.'."\n" + ."\n" + .'> The value of this parameter can be a CIDR block or an address book name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type in the access control policy. Valid values:'."\n" + ."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n" + .'* **ANY**: all protocol types'."\n" + ."\n" + .'> If you do not specify this parameter, access control policies of all protocol types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: blocks the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n" + ."\n" + .'> If you do not specify this parameter, access control policies are queried based on all actions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4037fbf7-3e39-4634-92a4-d0155247****', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the access control policy. Valid values:'."\n" + ."\n" + .'* **true**: enabled'."\n" + .'* **false**: disabled'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of access control policies returned.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + 'Policys' => [ + 'description' => 'The details of the access control policies.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Destination' => [ + 'description' => 'The destination address in the access control policy. Valid values:'."\n" + ."\n" + .'* If **DestinationType** is set to `net`, the value of this parameter is a CIDR block.'."\n" + .'* If **DestinationType** is set to `domain`, the value of this parameter is a domain name.'."\n" + .'* If **DestinationType** is set to `group`, the value of this parameter is an address book name.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'Order' => [ + 'description' => 'The priority of the access control policy.'."\n" + ."\n" + .'The priority value starts from 1. A smaller priority value indicates a higher priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DestPortGroup' => [ + 'description' => 'The name of the destination port address book in the access control policy.'."\n", + 'type' => 'string', + 'example' => 'my_port_group', + ], + 'SourceType' => [ + 'description' => 'The type of the source address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n", + 'type' => 'string', + 'example' => 'net', + ], + 'ApplicationName' => [ + 'description' => 'The application types supported by the access control policy. We recommend that you specify ApplicationNameList. Valid values:'."\n" + ."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **MySQL**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **RDP**'."\n" + .'* **VNC**'."\n" + .'* **SSH**'."\n" + .'* **Redis**'."\n" + .'* **MQTT**'."\n" + .'* **MongoDB**'."\n" + .'* **Memcache**'."\n" + .'* **SSL**'."\n" + .'* **ANY**: all application types'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'AclUuid' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'example' => '4037fbf7-3e39-4634-92a4-d0155247****', + ], + 'DestPortType' => [ + 'description' => 'The type of the destination port in the access control policy. Valid values:'."\n" + ."\n" + .'* **port**: port'."\n" + .'* **group**: port address book'."\n", + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => 'The source address in the access control policy. Valid values:'."\n" + ."\n" + .'* If **SourceType** is set to `net`, the value of this parameter is a CIDR block.'."\n" + .'* If **SourceType** is set to `group`, the value of this parameter is an address book name.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'DestinationType' => [ + 'description' => 'The type of the destination address in the access control policy. Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **domain**: domain name'."\n", + 'type' => 'string', + 'example' => 'net', + ], + 'HitTimes' => [ + 'description' => 'The number of hits for the access control policy.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DestPort' => [ + 'description' => 'The destination port in the access control policy.'."\n", + 'type' => 'string', + 'example' => '80', + ], + 'Description' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AclAction' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: denies the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'example' => 'accept', + ], + 'ApplicationId' => [ + 'description' => 'The application ID in the access control policy.'."\n", + 'type' => 'string', + 'example' => '10**', + ], + 'Proto' => [ + 'description' => 'The protocol type in the access control policy. Valid values:'."\n" + ."\n" + .'* **TCP**'."\n" + .'* **UDP**'."\n" + .'* **ICMP**'."\n" + .'* **ANY**: all protocol types'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + 'DestinationGroupCidrs' => [ + 'description' => 'The CIDR blocks in the destination address book of the access control policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block in the destination address book of the access control policy.'."\n", + 'type' => 'string', + 'example' => '["192.0.XX.XX/24", "192.0.XX.XX/32"]', + ], + ], + 'DestPortGroupPorts' => [ + 'description' => 'The ports in the destination port address book of the access control policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The port in the destination port address book of the access control policy.'."\n", + 'type' => 'string', + 'example' => '[80,443]', + ], + ], + 'SourceGroupCidrs' => [ + 'description' => 'The CIDR blocks in the source address book of the access control policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The CIDR block in the source address book of the access control policy.'."\n", + 'type' => 'string', + 'example' => '["192.0.XX.XX/24", "198.51.XX.XX/32"]', + ], + ], + 'MemberUid' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '258039427902****', + ], + 'Release' => [ + 'description' => 'Indicates whether the access control policy is enabled. By default, an access control policy is enabled after it is created. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'SourceGroupType' => [ + 'description' => 'The type of the source address book in the access control policy. The value is fixed as **ip**. The value indicates an address book that includes one or more CIDR blocks.'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'DestinationGroupType' => [ + 'description' => 'The type of the destination address book in the access control policy. Valid values:'."\n" + ."\n" + .'* **ip**: an address book that includes one or more CIDR blocks'."\n" + .'* **domain**: an address book that includes one or more domain names'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'HitLastTime' => [ + 'description' => 'The time when the access control policy was last hit. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'ModifyTime' => [ + 'description' => 'The time when the access control policy was modified. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'SpreadCnt' => [ + 'description' => 'The total quota consumed by the returned access control policies, which is the sum of the quota consumed by each policy. The quota that is consumed by an access control policy is calculated by using the following formula: Quota that is consumed by an access control policy = Number of source addresses × Number of destination addresses (number of CIDR blocks or domain names) × Number of applications × Number of port ranges.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10,000', + ], + 'CreateTime' => [ + 'description' => 'The time when the access control policy was created. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ApplicationNameList' => [ + 'description' => 'The application types supported by the access control policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application type supported by the access control policy. Valid values:'."\n" + ."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **MySQL**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **RDP**'."\n" + .'* **VNC**'."\n" + .'* **SSH**'."\n" + .'* **Redis**'."\n" + .'* **MQTT**'."\n" + .'* **MongoDB**'."\n" + .'* **Memcache**'."\n" + .'* **SSL**'."\n" + .'* **ANY**: all application types'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "HTTPS", '."\n" + .' "SMTPS", '."\n" + .' "SSL"'."\n" + .']', + ], + ], + 'RepeatType' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + 'RepeatDays' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If RepeatType is set to `Permanent`, `None`, or `Daily`, RepeatDays is left empty. Example: \\[].'."\n" + .'* If RepeatType is set to Weekly, RepeatDays must be specified. Example: \\[0, 6].'."\n" + ."\n" + .'> If RepeatType is set to Weekly, the fields in the value of RepeatDays cannot be repeated.'."\n" + ."\n" + .'* If RepeatType is set to `Monthly`, RepeatDays must be specified. Example: \\[1, 31].'."\n" + ."\n" + .'> If RepeatType is set to Monthly, the fields in the value of RepeatDays cannot be repeated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If RepeatType is set to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If RepeatType is set to Monthly, valid values of this parameter are 1 to 31.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'RepeatStartTime' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, RepeatStartTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.'."\n", + 'type' => 'string', + 'example' => '08:00', + ], + 'RepeatEndTime' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent or None, RepeatEndTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, RepeatEndTime must be specified.'."\n", + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, StartTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, StartTime must be specified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694761200', + ], + 'EndTime' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime.'."\n" + ."\n" + .'> If RepeatType is set to Permanent, EndTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, EndTime must be specified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694764800', + ], + 'DomainResolveType' => [ + 'description' => 'The domain name resolution method of the access control policy. By default, an access control policy is enabled after the policy is created. Valid values:'."\n" + ."\n" + .'* **FQDN**: fully qualified domain name (FQDN)-based resolution'."\n" + .'* **DNS**: DNS-based dynamic resolution'."\n" + .'* **FQDN_AND_DNS**: FQDN and DNS-based dynamic resolution', + 'type' => 'string', + 'example' => 'FQDN', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The appId is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'A domain resolution error occurred.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"20\\",\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"Policys\\": [\\n {\\n \\"Destination\\": \\"192.0.XX.XX/24\\",\\n \\"Order\\": 1,\\n \\"DestPortGroup\\": \\"my_port_group\\",\\n \\"SourceType\\": \\"net\\",\\n \\"ApplicationName\\": \\"HTTP\\",\\n \\"AclUuid\\": \\"4037fbf7-3e39-4634-92a4-d0155247****\\",\\n \\"DestPortType\\": \\"port\\",\\n \\"Source\\": \\"192.0.XX.XX/24\\",\\n \\"DestinationType\\": \\"net\\",\\n \\"HitTimes\\": 100,\\n \\"DestPort\\": \\"80\\",\\n \\"Description\\": \\"test\\",\\n \\"AclAction\\": \\"accept\\",\\n \\"ApplicationId\\": \\"10**\\",\\n \\"Proto\\": \\"TCP\\",\\n \\"DestinationGroupCidrs\\": [\\n \\"[\\\\\\"192.0.XX.XX/24\\\\\\", \\\\\\"192.0.XX.XX/32\\\\\\"]\\"\\n ],\\n \\"DestPortGroupPorts\\": [\\n \\"[80,443]\\"\\n ],\\n \\"SourceGroupCidrs\\": [\\n \\"[\\\\\\"192.0.XX.XX/24\\\\\\", \\\\\\"198.51.XX.XX/32\\\\\\"]\\"\\n ],\\n \\"MemberUid\\": \\"258039427902****\\",\\n \\"Release\\": \\"true\\",\\n \\"SourceGroupType\\": \\"ip\\",\\n \\"DestinationGroupType\\": \\"ip\\",\\n \\"HitLastTime\\": 1579261141,\\n \\"ModifyTime\\": 1761062400,\\n \\"SpreadCnt\\": 0,\\n \\"CreateTime\\": 1761062400,\\n \\"ApplicationNameList\\": [\\n \\"[\\\\n \\\\\\"HTTPS\\\\\\", \\\\n \\\\\\"SMTPS\\\\\\", \\\\n \\\\\\"SSL\\\\\\"\\\\n]\\"\\n ],\\n \\"RepeatType\\": \\"Permanent\\",\\n \\"RepeatDays\\": [\\n 1\\n ],\\n \\"RepeatStartTime\\": \\"08:00\\",\\n \\"RepeatEndTime\\": \\"23:30\\",\\n \\"StartTime\\": 1694761200,\\n \\"EndTime\\": 1694764800,\\n \\"DomainResolveType\\": \\"FQDN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcFirewallControlPolicyResponse>\\n <TotalCount>20</TotalCount>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n <Policys>\\n <Destination>192.0.XX.XX/24</Destination>\\n <Order>1</Order>\\n <DestPortGroup>my_port_group</DestPortGroup>\\n <SourceType>net</SourceType>\\n <ApplicationName>HTTP</ApplicationName>\\n <AclUuid>4037fbf7-3e39-4634-92a4-d0155247****</AclUuid>\\n <DestPortType>port</DestPortType>\\n <Source>192.0.XX.XX/24</Source>\\n <DestinationType>net</DestinationType>\\n <HitTimes>100</HitTimes>\\n <DestPort>80</DestPort>\\n <Description>test</Description>\\n <AclAction>accept</AclAction>\\n <ApplicationId>10**</ApplicationId>\\n <Proto>TCP</Proto>\\n <DestinationGroupCidrs>[\\"192.0.XX.XX/24\\", \\"192.0.XX.XX/32\\"]</DestinationGroupCidrs>\\n <DestPortGroupPorts>[80,443]</DestPortGroupPorts>\\n <SourceGroupCidrs>[\\"192.0.XX.XX/24\\", \\"198.51.XX.XX/32\\"]</SourceGroupCidrs>\\n <MemberUid>258039427902****</MemberUid>\\n <Release>true</Release>\\n <SourceGroupType>ip</SourceGroupType>\\n <DestinationGroupType>ip</DestinationGroupType>\\n </Policys>\\n</DescribeVpcFirewallControlPolicyResponse>","errorExample":""}]', + 'title' => 'DescribeVpcFirewallControlPolicy', + 'description' => 'You can call the DescribeVpcFirewallControlPolicy operation to query the information about all access control policies that are created for a specified VPC firewall. Different access control policies are used when a VPC firewall is used to protect traffic between two VPCs that are connected by using a Cloud Enterprise Network (CEN) instance or an Express Connect circuit.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVpcFirewallPolicyPriorUsed' => [ + 'summary' => 'Queries the priority range of access control policies that are created for a virtual private cloud (VPC) firewall in a specific policy group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68424', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy group. You can call the [DescribeVpcFirewallAclGroupList](~~159760~~) operation to query the ID.'."\n" + ."\n" + .'* If the VPC firewall is used to protect a Cloud Enterprise Network (CEN) instance, the value of this parameter is the ID of the CEN instance.'."\n" + ."\n" + .' Example: cen-ervw0g12b5jbw\\*\\*\\*\\*.'."\n" + ."\n" + .'* If the VPC firewall is used to protect an Express Connect circuit, the value of this parameter is the ID of the VPC firewall.'."\n" + ."\n" + .' Example: vfw-a42bbb7b887148c9\\*\\*\\*\\*.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => 'The lowest priority for the access control policies.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'Start' => [ + 'description' => 'The highest priority for the access control policies.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'invalid aliUid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'A domain resolution error occurred.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"End\\": 150,\\n \\"Start\\": 1,\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcFirewallPolicyPriorUsedResponse>\\n<RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n<Start>1</Start>\\n<End>150</End>\\n</DescribeVpcFirewallPolicyPriorUsedResponse>","errorExample":""}]', + 'title' => 'DescribeVpcFirewallPolicyPriorUsed', + 'description' => 'You can call this operation to query the priority range of access control policies that are created for a VPC firewall in a specific policy group.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateVpcFirewallControlPolicy' => [ + 'summary' => 'Creates an access control policy in a specified policy group for a virtual private cloud (VPC) firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68136', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese (default)'."\n" + .'- **en**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic. Valid values:'."\n" + ."\n" + .'- **accept**: allows the traffic.'."\n" + .'- **drop**: blocks the traffic.'."\n" + .'- **log**: monitors the traffic.', + 'type' => 'string', + 'required' => true, + 'example' => 'accept', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the applications that the access control policy supports. Valid values:'."\n" + ."\n" + .'- **FTP**'."\n" + .'- **HTTP**'."\n" + .'- **HTTPS**'."\n" + .'- **MySQL**'."\n" + .'- **SMTP**'."\n" + .'- **SMTPS**'."\n" + .'- **RDP**'."\n" + .'- **VNC**'."\n" + .'- **SSH**'."\n" + .'- **Redis**'."\n" + .'- **MQTT**'."\n" + .'- **MongoDB**'."\n" + .'- **Memcache**'."\n" + .'- **SSL**'."\n" + .'- **ANY**: all types of applications', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy.', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination port in the access control policy. '."\n" + ."\n" + .'> If **DestPortType** is set to `port`, you must specify this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy. Valid values:'."\n" + ."\n" + .'- If **DestinationType** is set to `net`, the value of **Destination** must be a CIDR block.'."\n" + .'- If **DestinationType** is set to `group`, the value of **Destination** must be an address book.'."\n" + .'- If **DestinationType** is set to `domain`, the value of **Destination** must be a domain name.', + 'type' => 'string', + 'required' => true, + 'example' => '10.2.XX.XX/24', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination address in the access control policy. Valid values:'."\n" + ."\n" + .'- **net**: CIDR block'."\n" + .'- **group**: address book'."\n" + .'- **domain**: domain name', + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the policy group in which you want to create the access control policy. '."\n" + ."\n" + .'- If a VPC firewall protects the traffic between two VPCs that are connected by using a CEN instance, the value of this parameter must be the ID of the CEN instance.'."\n" + .'- If a VPC firewall protects the traffic between two VPCs that are connected by using an Express Connect circuit, the value of this parameter must be the instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallAclGroupList](https://www.alibabacloud.com/help/en/cloud-firewall/latest/describevpcfirewallaclgrouplist) operation to query the IDs.', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the protocol in the access control policy. Valid values:'."\n" + ."\n" + .'- **ANY** (If you are not sure about the protocol type, you can set this parameter to ANY.)'."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**', + 'type' => 'string', + 'required' => true, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy. '."\n" + ."\n" + .'- If SourceType is set to `net`, the value of Source must be a CIDR block.'."\n" + .'- If SourceType is set to `group`, the value of Source must be an address book.', + 'type' => 'string', + 'required' => true, + 'example' => '10.2.XX.XX/24', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the source address in the access control policy. Valid values:'."\n" + ."\n" + .'- **net**: CIDR block'."\n" + .'- **group**: address book', + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the access control policy. '."\n" + ."\n" + .'The priority value starts from 1. A smaller priority value indicates a higher priority.', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination port in the access control policy. Valid values:'."\n" + ."\n" + .'- **port**: port'."\n" + .'- **group**: port address book', + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination port address book in the access control policy. '."\n" + ."\n" + .'> If **DestPortType** is set to `group`, you must specify this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the access control policy. By default, an access control policy is enabled after the policy is created. Valid values: '."\n" + ."\n" + .'- **true**: enables the access control policy.'."\n" + .'- **false**: disables the access control policy.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The application types supported by the access control policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application type supported by the access control policy. Valid values:'."\n" + ."\n" + .'* **FTP**'."\n" + .'* **HTTP**'."\n" + .'* **HTTPS**'."\n" + .'* **Memcache**'."\n" + .'* **MongoDB**'."\n" + .'* **MQTT**'."\n" + .'* **MySQL**'."\n" + .'* **RDP**'."\n" + .'* **Redis**'."\n" + .'* **SMTP**'."\n" + .'* **SMTPS**'."\n" + .'* **SSH**'."\n" + .'* **SSL_No_Cert**'."\n" + .'* **SSL**'."\n" + .'* **VNC**'."\n" + .'* **ANY**: all types of applications'."\n" + ."\n" + .'> The value of this parameter depends on the value of the Proto parameter. If Proto is set to TCP, you can set ApplicationNameList to any valid value in the `["HTTP","HTTPS",……]` format. If Proto is set to UDP, ICMP, or ANY, you can set ApplicationNameList only to ANY. You must specify at least one of ApplicationNameList and ApplicationName. If you specify both ApplicationNameList and ApplicationName, only the value of ApplicationNameList takes effect.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "ANY"'."\n" + .']', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If you set RepeatType to `Permanent`, `None`, or `Daily`, leave this parameter empty. Example: \\[].'."\n" + .'* If you set RepeatType to Weekly, you must specify this parameter. Example: \\[0, 6].'."\n" + ."\n" + .'> If you set RepeatType to Weekly, the fields in the value of this parameter cannot be repeated.'."\n" + ."\n" + .'* If you set RepeatType to `Monthly`, you must specify this parameter. Example: \\[1, 31].'."\n" + ."\n" + .'> If you set RepeatType to Monthly, the fields in the value of this parameter cannot be repeated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If you set RepeatType to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If you set RepeatType to Monthly, valid values of this parameter are 1 to 31.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the end time.'."\n" + ."\n" + .'> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the start time.'."\n" + ."\n" + .'> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the end time.'."\n" + ."\n" + .'> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the start time.'."\n" + ."\n" + .'> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name resolution method of the access control policy. Valid values:'."\n" + ."\n" + .'* **FQDN**: fully qualified domain name (FQDN)-based resolution'."\n" + .'* **DNS**: DNS-based dynamic resolution'."\n" + .'* **FQDN_AND_DNS**: FQDN and DNS-based dynamic resolution', + 'type' => 'string', + 'required' => false, + 'example' => 'DNS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AclUuid' => [ + 'description' => 'The ID of the access control policy.', + 'type' => 'string', + 'example' => '00281255-d220-4db1-8f4f-c4df221ad84c', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorParametersNewOrder', + 'errorMessage' => 'The newOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorAclDomainAnyCountExceed', + 'errorMessage' => 'The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred. Try again later.', + ], + [ + 'errorCode' => 'ErrorParametersFtpNotSupport', + 'errorMessage' => 'domain destination not support ftp.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationName', + 'errorMessage' => 'Specified parameter ApplicationName is not valid.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationNameList', + 'errorMessage' => 'Specified parameter ApplicationNameList is not valid.', + ], + [ + 'errorCode' => 'ErrorAddressGroupNotExist', + 'errorMessage' => 'The address group does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AclUuid\\": \\"00281255-d220-4db1-8f4f-c4df221ad84c\\",\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateVpcFirewallControlPolicyResponse>\\n <AclUuid>00281255-d220-4db1-8f4f-c4df221ad84c</AclUuid>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n</CreateVpcFirewallControlPolicyResponse>","errorExample":""}]', + 'title' => 'CreateVpcFirewallControlPolicy', + 'description' => 'You can call the CreateVpcFirewallControlPolicy operation to create an access control policy in a specified policy group for a VPC firewall. Different access control policies are used when a VPC firewall is used to protect traffic between two VPCs that are connected by using a Cloud Enterprise Network (CEN) instance or an Express Connect circuit. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyVpcFirewallControlPolicy' => [ + 'summary' => 'Modifies the configurations of an access control policy that is created for a virtual private cloud (VPC) firewall in a specified policy group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'update', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68496', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Cloud Firewall performs on the traffic.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **accept**: allows the traffic.'."\n" + .'* **drop**: blocks the traffic.'."\n" + .'* **log**: monitors the traffic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the application that the access control policy supports.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ANY: all application types'."\n" + .'* FTP'."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n" + .'* MySQL'."\n" + .'* SMTP'."\n" + .'* SMTPS'."\n" + .'* RDP'."\n" + .'* VNC'."\n" + .'* SSH'."\n" + .'* Redis'."\n" + .'* MQTT'."\n" + .'* MongoDB'."\n" + .'* Memcache'."\n" + .'* SSL'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination port in the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination address in the access control policy.'."\n" + ."\n" + .'* If **DestinationType** is set to `net`, the value of this parameter must be a CIDR block.'."\n" + ."\n" + .' Example: 10.2.3.0/24'."\n" + ."\n" + .'* If **DestinationType** is set to `group`, the value of this parameter must be an address book name.'."\n" + ."\n" + .' Example: db_group'."\n" + ."\n" + .'* If **DestinationType** is set to `domain`, the value of this parameter must be a domain name.'."\n" + ."\n" + .' Example: \\*.aliyuncs.com'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.2.X.X/XX', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination address in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n" + .'* **domain**: domain name'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall. You can call the [DescribeVpcFirewallAclGroupList](~~159760~~) operation to query the ID.'."\n" + ."\n" + .'* If the VPC firewall is used to protect a CEN instance, the value of this parameter must be the ID of the CEN instance.'."\n" + ."\n" + .' Example: cen-ervw0g12b5jbw\\*\\*\\*\\*'."\n" + ."\n" + .'* If the VPC firewall is used to protect an Express Connect circuit, the value of this parameter must be the instance ID of the VPC firewall.'."\n" + ."\n" + .' Example: vfw-a42bbb7b887148c9\\*\\*\\*\\*'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ANY: all protocol types'."\n" + .'* TCP'."\n" + .'* UDP'."\n" + .'* ICMP'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source address in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* If **SourceType** is set to `net`, the value of this parameter must be a CIDR block.'."\n" + ."\n" + .' Example: 10.2.4.0/24'."\n" + ."\n" + .'* If **SourceType** is set to `group`, the value of this parameter must be an address book name.'."\n" + ."\n" + .' Example: db_group'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.2.X.X/XX', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the access control policy.'."\n" + ."\n" + .'If you want to modify the configurations of an access control policy, you must provide the unique ID of the policy. You can call the [DescribeVpcFirewallControlPolicy](~~159758~~) operation to query the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the source address in the access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **net**: CIDR block'."\n" + .'* **group**: address book'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the destination port in the access control policy.'."\n" + ."\n" + .'* **port**: port'."\n" + .'* **group**: port address book'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination port address book in the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the access control policy. By default, an access control policy is enabled after the policy is created. Valid values:'."\n" + ."\n" + .'* **true**: enables the access control policy.'."\n" + .'* **false**: disables the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The application names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["ANY"]', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The recurrence type for the access control policy to take effect. Valid values:'."\n" + ."\n" + .'* **Permanent** (default): The policy always takes effect.'."\n" + .'* **None**: The policy takes effect for only once.'."\n" + .'* **Daily**: The policy takes effect on a daily basis.'."\n" + .'* **Weekly**: The policy takes effect on a weekly basis.'."\n" + .'* **Monthly**: The policy takes effect on a monthly basis.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '', + 'Monthly' => '', + 'Permanent' => '', + 'Weekly' => '', + 'None' => '', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The days of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'* If you set RepeatType to `Permanent`, `None`, or `Daily`, the value of this parameter is an empty array. Example: \\[].'."\n" + .'* If you set RepeatType to Weekly, you must specify this parameter. Example: \\[0, 6].'."\n" + ."\n" + .'> If you set RepeatType to Weekly, the fields in the value of this parameter cannot be repeated.'."\n" + ."\n" + .'* If you set RepeatType to `Monthly`, you must specify this parameter. Example: \\[1, 31].'."\n" + ."\n" + .'> If you set RepeatType to Monthly, the fields in the value of this parameter cannot be repeated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The day of a week or of a month on which the access control policy takes effect.'."\n" + ."\n" + .'> If you set RepeatType to Weekly, valid values of this parameter are 0 to 6. Each week starts from Sunday. If you set RepeatType to Monthly, valid values of this parameter are 1 to 31.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime.'."\n" + ."\n" + .'> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime.'."\n" + ."\n" + .'> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime.'."\n" + ."\n" + .'> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime.'."\n" + ."\n" + .'> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The domain name resolution method of the access control policy. By default, an access control policy is enabled after the policy is created. Valid values:'."\n" + ."\n" + .'* **FQDN**: fully qualified domain name (FQDN)-based resolution'."\n" + .'* **DNS**: DNS-based dynamic resolution'."\n" + .'* **FQDN_AND_DNS**: FQDN and DNS-based dynamic resolution', + 'example' => 'FQDN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorAclEffectiveTimeNonPermanent', + 'errorMessage' => 'ACL rule is not allowed to update status when effective is not permanent.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'A domain resolution error occurred.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorAclDomainAnyCountExceed', + 'errorMessage' => 'The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorParametersFtpNotSupport', + 'errorMessage' => 'domain destination not support ftp.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationName', + 'errorMessage' => 'Specified parameter ApplicationName is not valid.', + ], + [ + 'errorCode' => 'ErrorParametersApplicationNameList', + 'errorMessage' => 'Specified parameter ApplicationNameList is not valid.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + [ + 'errorCode' => 'ErrorAddressGroupNotExist', + 'errorMessage' => 'The address group does not exist.', + ], + [ + 'errorCode' => 'ErrorParametersVpcFirewallId', + 'errorMessage' => 'Specified parameter VpcFirewallId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyVpcFirewallControlPolicyResponse>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n</ModifyVpcFirewallControlPolicyResponse>","errorExample":""}]', + 'title' => 'ModifyVpcFirewallControlPolicy', + 'description' => 'You can call the ModifyVpcFirewallControlPolicy operation to modify the configurations of an access control policy that is created for a VPC firewall in a specified policy group. Different access control policies are used for the VPC firewalls that are used to protect each Cloud Enterprise Network (CEN) instance and the VPC firewalls that are used to protect each Express Connect circuit.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyVpcFirewallControlPolicyPosition' => [ + 'summary' => 'Modifies the priority of an access control policy that is created for a virtual private cloud (VPC) firewall in a specific policy group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68497', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the group to which the access control policy belongs. You can call the [DescribeVpcFirewallAclGroupList](~~159760~~) operation to query the ID.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* If the VPC firewall is used to protect a CEN instance, the value of this parameter must be the ID of the CEN instance.'."\n" + ."\n" + .' Example: cen-ervw0g12b5jbw\\*\\*\\*\\*'."\n" + ."\n" + .'* If the VPC firewall is used to protect an Express Connect circuit, the value of this parameter must be the instance ID of the VPC firewall.'."\n" + ."\n" + .' Example: vfw-a42bbb7b887148c9\\*\\*\\*\\*'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new priority of the access control policy.'."\n" + ."\n" + .'> For more information about the valid values of the new priority, see [DescribeVpcFirewallPolicyPriorUsed](~~474145~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'OldOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The original priority of the access control policy.'."\n" + ."\n" + .'> This parameter is not recommended. We recommend that you use the AclUuid parameter to specify the policy that you want to modify.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the access control policy.'."\n" + ."\n" + .'If you want to modify the configurations of an access control policy, you must provide the UUID of the policy. You can call the [DescribeVpcFirewallControlPolicy](~~159758~~) operation to query the UUID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2746d9ff-5d7c-449d-a2a9-ccaa15fe****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125EEB1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + [ + 'errorCode' => 'ErrorAclEffectiveTimeNonPermanent', + 'errorMessage' => 'ACL rule is not allowed to update status when effective is not permanent.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorAclDomainAnyCountExceed', + 'errorMessage' => 'The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125EEB1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyVpcFirewallControlPolicyPositionResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125EEB1</RequestId>\\n</ModifyVpcFirewallControlPolicyPositionResponse>","errorExample":""}]', + 'title' => 'ModifyVpcFirewallControlPolicyPosition', + 'description' => 'You can use this operation to modify the priority of an access control policy that is created for a VPC firewall in a specific policy group.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyVpcFirewallAclEngineMode' => [ + 'summary' => '修改VPC防火墙ACL引擎模式', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'StrictMode', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'B14757D0-4640-4B44-AC67-7F558F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B14757D0-4640-4B44-AC67-7F558F****\\"\\n}","type":"json"}]', + ], + 'ResetVpcFirewallRuleHitCount' => [ + 'summary' => 'Clears the count on hits of an access control policy that is created for a virtual private cloud (VPC) firewall in a specific policy group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68521', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The natural language of the request and response. '."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- **zh**: Chinese (default)'."\n" + .'- **en**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy.', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'A918B4F6-482F-5A91-8F65-AFFFF1FC04EA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetVpcFirewallRuleHitCountResponse>\\r\\n<RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\r\\n</ResetVpcFirewallRuleHitCountResponse>","errorExample":""}]', + 'title' => 'ResetVpcFirewallRuleHitCount', + 'description' => 'You can call the ResetVpcFirewallRuleHitCount operation to clear the count on hits of an access control policy that is created for a VPC firewall in a specific policy group. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVpcFirewallControlPolicy' => [ + 'summary' => 'Deletes an access control policy from a specific policy group for a virtual private cloud (VPC) firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68166', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The natural language of the request and response. Valid values: '."\n" + ."\n" + .'- **zh**: Chinese'."\n" + .'- **en**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy. '."\n" + ."\n" + .'To delete an access control policy, you must provide the ID of the policy. You can call the **DescribeVpcFirewallControlPolicy** operation to query the ID.', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df2214****', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the group to which the access control policy belongs. You can call the **DescribeVpcFirewallAclGroupList** operation to query the ID. '."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- If the VPC firewall is used to protect a CEN instance, the value of this parameter is the ID of the CEN instance. '."\n" + ."\n" + .'Example: cen-ervw0g12b5jbw****'."\n" + .'- If the VPC firewall is used to protect an Express Connect circuit, the value of this parameter is the ID of the VPC firewall. '."\n" + ."\n" + .'Example: vfw-a42bbb7b887148c9****', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c91****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAppId', + 'errorMessage' => 'The AppId parameter is incorrect.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersProto', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestPort', + 'errorMessage' => 'The dst_port is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'An error occurred while resolving the domain.', + ], + [ + 'errorCode' => 'ErrorParametersAclUuid', + 'errorMessage' => 'Specified parameter AclUuid is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVpcFirewallControlPolicyResponse>\\r\\n<RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\r\\n</DeleteVpcFirewallControlPolicyResponse>","errorExample":""}]', + 'title' => 'DeleteVpcFirewallControlPolicy', + 'description' => 'You can call the DeleteVpcFirewallControlPolicy operation to delete an access control policy from a specific policy group for a VPC firewall. Different access control policies are used for the VPC firewall that is used to protect each Cloud Enterprise Network (CEN) instance and the VPC firewall that is used to protect each Express Connect circuit. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchDeleteVpcFirewallControlPolicy' => [ + 'summary' => 'Deletes multiple access control policies for a virtual private cloud (VPC) firewall at a time.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195162', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'AclUuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The UUIDs of access control policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The UUID of the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6fb052a4-baad-4d86-8e2e-b79cc060535c', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorParamUuidOrOrderMiss', + 'errorMessage' => 'Either uuid or oldOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\"\\n}","type":"json"}]', + 'title' => 'BatchDeleteVpcFirewallControlPolicy', + ], + 'DescribeVpcListLite' => [ + 'summary' => 'Queries virtual private clouds (VPCs).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68434', + 'abilityTreeNodes' => [ + 'FEATUREcfwE8FJHT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '58.34.174.194', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-shanghai', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the VPC.'."\n" + ."\n" + .'> For more information about Cloud Firewall supported regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '55E56A55-D93A-5614-AE00-BE2F8077F891', + ], + 'VpcList' => [ + 'description' => 'The information about the VPCs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-wz9dqhljd10fk0b4eh885', + ], + 'VpcName' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'Cloud_Firewall_VPC', + ], + 'RegionNo' => [ + 'description' => 'The region ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + [ + 'errorCode' => 'ErrorJsonDecode', + 'errorMessage' => 'decoding json failed', + ], + [ + 'errorCode' => 'ErrorNoInstanceInDb', + 'errorMessage' => 'no instance for process in db.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"55E56A55-D93A-5614-AE00-BE2F8077F891\\",\\n \\"VpcList\\": [\\n {\\n \\"VpcId\\": \\"vpc-wz9dqhljd10fk0b4eh885\\",\\n \\"VpcName\\": \\"Cloud_Firewall_VPC\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeVpcListLite', + ], + 'DescribeDnsFirewallPolicy' => [ + 'summary' => '获取DNS防火墙ACL列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68243', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '140.205.118.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.2.XX.XX/24', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'b6c8f905-2eb6-442a-ba35-9416e****', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4', + 'enum' => [ + '4', + '6', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0A4ACDE9-9F9F-56C1-B3B7-60971BA1****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + 'Policys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'in', + ], + 'DestinationGroupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ip', + ], + 'HitLastTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'Destination' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'x.x.x.x/32', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'net', + ], + 'AclUuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '01281255-d220-4db1-8f4f-c4df221a****', + ], + 'Priority' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '110', + ], + 'Source' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'DestinationType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'net', + ], + 'HitTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'IpVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'SourceGroupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ip', + ], + 'AclAction' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'accept', + ], + 'Release' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'DestinationAddrs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.0.XX.XX/24'."\n", + ], + ], + 'SourceAddrs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.2.XX.XX/24'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersNewOrder', + 'errorMessage' => 'The newOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"RequestId\\": \\"0A4ACDE9-9F9F-56C1-B3B7-60971BA1****\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"Policys\\": [\\n {\\n \\"Direction\\": \\"in\\",\\n \\"DestinationGroupType\\": \\"ip\\",\\n \\"HitLastTime\\": 1579261141,\\n \\"Destination\\": \\"x.x.x.x/32\\",\\n \\"SourceType\\": \\"net\\",\\n \\"AclUuid\\": \\"01281255-d220-4db1-8f4f-c4df221a****\\",\\n \\"Priority\\": 110,\\n \\"Source\\": \\"192.0.XX.XX/24\\",\\n \\"DestinationType\\": \\"net\\",\\n \\"HitTimes\\": 100,\\n \\"IpVersion\\": 6,\\n \\"Description\\": \\"test\\",\\n \\"SourceGroupType\\": \\"ip\\",\\n \\"AclAction\\": \\"accept\\",\\n \\"Release\\": \\"true\\",\\n \\"DestinationAddrs\\": [\\n \\"192.0.XX.XX/24\\\\n\\"\\n ],\\n \\"SourceAddrs\\": [\\n \\"10.2.XX.XX/24\\\\n\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribePrefixLists' => [ + 'summary' => 'Queries prefix lists.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157353', + 'abilityTreeNodes' => [ + 'FEATUREcfw4TUC5U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '47.100.XX.XX', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shenzhen', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '67FD76C2-C493-5815-8107-643FD7AB77C7', + ], + 'PrefixList' => [ + 'description' => 'Details about the prefix lists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PrefixListId' => [ + 'description' => 'The ID of the prefix list.'."\n", + 'type' => 'string', + 'example' => 'pl-uf64nco3ujjqchx6aaji', + ], + 'PrefixListName' => [ + 'description' => 'The name of the prefix list.'."\n", + 'type' => 'string', + 'example' => 'participant-name', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'TCP_14900-14911', + ], + 'CreationTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2023-10-16T08:31:06Z', + ], + 'AssociationCount' => [ + 'description' => 'The number of associated resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'MaxEntries' => [ + 'description' => 'The maximum number of entries in the prefix list.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AddressFamily' => [ + 'description' => 'The IP address family of the prefix list. Valid values:'."\n" + ."\n" + .'* IPv4'."\n" + .'* IPv6'."\n", + 'type' => 'string', + 'example' => 'IPv4', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'parameters invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67FD76C2-C493-5815-8107-643FD7AB77C7\\",\\n \\"PrefixList\\": [\\n {\\n \\"PrefixListId\\": \\"pl-uf64nco3ujjqchx6aaji\\",\\n \\"PrefixListName\\": \\"participant-name\\",\\n \\"Description\\": \\"TCP_14900-14911\\",\\n \\"CreationTime\\": \\"2023-10-16T08:31:06Z\\",\\n \\"AssociationCount\\": 2,\\n \\"MaxEntries\\": 20,\\n \\"AddressFamily\\": \\"IPv4\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribePrefixLists', + ], + 'AddDnsFirewallPolicy' => [ + 'summary' => '添加DNS防火墙ACL', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68096', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '140.205.118.97', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'log', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'db_group', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'domain', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'out', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.223/32', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4', + 'enum' => [ + '4', + '6', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AclUuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'f88dae6f-XXX-XXX-613de9ab2be8', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '71209DFE-XXX-XXX-52B4A4E9DA3B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersNewOrder', + 'errorMessage' => 'The newOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorAclRuleDuplicate', + 'errorMessage' => 'acl rule duplicate.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AclUuid\\": \\"f88dae6f-XXX-XXX-613de9ab2be8\\",\\n \\"RequestId\\": \\"71209DFE-XXX-XXX-52B4A4E9DA3B\\"\\n}","type":"json"}]', + ], + 'ModifyDnsFirewallPolicy' => [ + 'summary' => '修改DNS防火墙规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68471', + 'abilityTreeNodes' => [ + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'log', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'db_group', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.21.**/24', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df22****', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9C50C2A9-4BBB-5504-8ADA-C41A79****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAclNotExist', + 'errorMessage' => 'The ACL does not exist.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDestination', + 'errorMessage' => 'The Destination parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAction', + 'errorMessage' => 'The action is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersNewOrder', + 'errorMessage' => 'The newOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + [ + 'errorCode' => 'ErrorAclRuleDuplicate', + 'errorMessage' => 'acl rule duplicate.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C50C2A9-4BBB-5504-8ADA-C41A79****\\"\\n}","type":"json"}]', + ], + 'DeleteDnsFirewallPolicy' => [ + 'summary' => '删除DNS防火墙规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68148', + 'abilityTreeNodes' => [ + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '140.210.39.***', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '498946f4-c98a-45c0-9038-635c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '32314C1E-82CF-582C-853A-B1773F******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32314C1E-82CF-582C-853A-B1773F******\\"\\n}","type":"json"}]', + ], + 'DescribeThreatIntelligenceSwitch' => [ + 'summary' => '查询威胁情报配置的信息', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'CategoryList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3000037', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryDescribe' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryParentId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Action' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'alert', + ], + 'EnableStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6B8E0379-2629-59A1-B811-96F3E****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 24,\\n \\"CategoryList\\": [\\n {\\n \\"CategoryId\\": \\"3000037\\",\\n \\"CategoryName\\": \\"Tor出口恶意IP\\\\n\\",\\n \\"CategoryDescribe\\": \\"Tor出口恶意IP\\\\n\\",\\n \\"CategoryParentId\\": \\"123\\",\\n \\"Action\\": \\"alert\\",\\n \\"EnableStatus\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"6B8E0379-2629-59A1-B811-96F3E****\\"\\n}","type":"json"}]', + ], + 'ModifyThreatIntelligenceSwitch' => [ + 'summary' => '修改威胁情报配置的信息', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CategoryList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'IpOutThreatTorExit', + ], + 'Action' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'alert', + ], + 'EnableStatus' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-0009012****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-0009012****\\"\\n}","type":"json"}]', + ], + 'ModifyIpsRulesToDefault' => [ + 'summary' => '修改IPS规则为默认', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68476', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '140.205.118.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'customize', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "uuid_1",'."\n" + .' "uuid_2"'."\n" + .']', + ], + ], + [ + 'name' => 'AttackApp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PHP', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewall', + 'default' => 'InternetFirewall', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B713361D-62E2-5FF0-9D29-BBFAAF40****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'invalid aliUid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error: marshal json.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'update operation log error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B713361D-62E2-5FF0-9D29-BBFAAF40****\\"\\n}","type":"json"}]', + ], + 'DescribeSignatureLibVersion' => [ + 'summary' => 'Queries the information about signature library versions.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185095', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9C50C2A9-4BBB-5504-8ADA-C41A79B8C946', + ], + 'Version' => [ + 'description' => 'The version information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The version number.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => 'The type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ips'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' Basic Rules and Virtual Patching'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* intelligence'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' Threat Intelligence'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'ips' => '', + 'intelligence' => '', + ], + 'example' => 'ips', + ], + 'Version' => [ + 'title' => '版本', + 'description' => 'The version number.'."\n", + 'type' => 'string', + 'example' => 'IPS-2307-02', + ], + 'UpdateTime' => [ + 'description' => 'Update time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741067915', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 132,\\n \\"RequestId\\": \\"9C50C2A9-4BBB-5504-8ADA-C41A79B8C946\\",\\n \\"Version\\": [\\n {\\n \\"Type\\": \\"ips\\",\\n \\"Version\\": \\"IPS-2307-02\\",\\n \\"UpdateTime\\": 1741067915\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSignatureLibVersion', + 'translator' => 'machine', + ], + 'DescribeDefaultIPSConfig' => [ + 'summary' => 'Queries the default intrusion prevention system (IPS) configurations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68241', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '133173B9-8010-5DF5-8B93-********', + ], + 'RuleClass' => [ + 'description' => 'The level of the rule group for the IPS. Valid values:'."\n" + ."\n" + .'* **1**: loose'."\n" + .'* **2**: medium'."\n" + .'* **3**: strict'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CtiRules' => [ + 'description' => 'Indicates whether threat intelligence is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PatchRules' => [ + 'description' => 'Indicates whether virtual patching is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RunMode' => [ + 'description' => 'The mode of the IPS. Valid values:'."\n" + ."\n" + .'* **1**: block mode'."\n" + .'* **0**: monitor mode'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BasicRules' => [ + 'description' => 'Indicates whether basic protection is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxSdl' => [ + 'description' => 'The maximum amount of traffic that can be processed by the sensitive data leak detection feature each day.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"133173B9-8010-5DF5-8B93-********\\",\\n \\"RuleClass\\": 3,\\n \\"CtiRules\\": 0,\\n \\"PatchRules\\": 0,\\n \\"RunMode\\": 0,\\n \\"BasicRules\\": 0,\\n \\"MaxSdl\\": 10\\n}","type":"json"}]', + 'title' => 'DescribeDefaultIPSConfig', + ], + 'DescribeUserIPSWhitelist' => [ + 'summary' => '获取用户IPS白名单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68405', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '47.100.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '04F788A5-6A47-5EA9-AC30-CA4DB98AD520', + ], + 'Whitelists' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 1 => '', + '', + ], + 'example' => '1', + ], + 'WhiteType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 1 => '', + '', + ], + 'example' => '1', + ], + 'ListValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.10.200.4/32,10.10.200.25/32', + ], + 'ListType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '', + '', + '', + ], + 'example' => '1', + ], + 'WhiteListValue' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.10.200.4/32', + ], + ], + ], + ], + ], + 'Ipv6Whitelists' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 1 => '', + '', + ], + 'example' => '1', + ], + 'WhiteType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 1 => '', + '', + ], + 'example' => '2', + ], + 'ListValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2408:400a:81a:7900:a77d:ea36:fcbf:de40/128', + ], + 'ListType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '', + '', + '', + ], + 'example' => '0', + ], + 'WhiteListValue' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2408:400a:81a:7900:a77d:ea36:fcbf:de40/128'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'invalid aliUid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error: marshal json.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F788A5-6A47-5EA9-AC30-CA4DB98AD520\\",\\n \\"Whitelists\\": [\\n {\\n \\"Direction\\": 1,\\n \\"WhiteType\\": 1,\\n \\"ListValue\\": \\"10.10.200.4/32,10.10.200.25/32\\",\\n \\"ListType\\": 1,\\n \\"WhiteListValue\\": [\\n \\"10.10.200.4/32\\"\\n ]\\n }\\n ],\\n \\"Ipv6Whitelists\\": [\\n {\\n \\"Direction\\": 1,\\n \\"WhiteType\\": 2,\\n \\"ListValue\\": \\"2408:400a:81a:7900:a77d:ea36:fcbf:de40/128\\",\\n \\"ListType\\": 0,\\n \\"WhiteListValue\\": [\\n \\"2408:400a:81a:7900:a77d:ea36:fcbf:de40/128\\\\n\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ModifyIpsRules' => [ + 'summary' => '修改IPS规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68475', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '218.1.147.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'patchRule' => 'patchRule', + 'basicRule' => 'basicRule', + ], + 'example' => 'basicRule', + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'drop' => 'drop', + 'alert' => 'alert', + 'close' => 'close', + ], + 'example' => 'alert', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '[\\"4664138c-4f81-4650-9c8d-2230ea0d****\\"]', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VpcFirewall' => '', + 'InternetFirewall' => '', + ], + 'example' => 'VpcFirewall', + 'default' => 'InternetFirewall', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30FB7F84-1FC5-5A3D-BBBE-5779FC74****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'invalid aliUid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error: marshal json.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'update operation log error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30FB7F84-1FC5-5A3D-BBBE-5779FC74****\\"\\n}","type":"json"}]', + ], + 'ModifyDefaultIPSConfig' => [ + 'summary' => 'Modifies the default configuration of the intrusion prevention system (IPS).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68470', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CtiRules', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable threat intelligence. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'required' => true, + 'example' => '0', + 'format' => 'int32', + ], + ], + [ + 'name' => 'BasicRules', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable basic protection. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'required' => true, + 'example' => '1', + 'format' => 'int32', + ], + ], + [ + 'name' => 'PatchRules', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable virtual patching. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'required' => false, + 'example' => '1', + 'format' => 'int32', + ], + ], + [ + 'name' => 'RunMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the IPS. Valid values:'."\n" + ."\n" + .'* **1**: block mode'."\n" + .'* **0**: monitor mode'."\n", + 'type' => 'integer', + 'required' => true, + 'example' => '0', + 'format' => 'int32', + ], + ], + [ + 'name' => 'RuleClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the rule group for the IPS. Valid values:'."\n" + ."\n" + .'* **1**: loose'."\n" + .'* **2**: medium'."\n" + .'* **3**: strict'."\n", + 'type' => 'integer', + 'required' => false, + 'example' => '1', + 'format' => 'int32', + ], + ], + [ + 'name' => 'MaxSdl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum amount of traffic that can be processed by the sensitive data leak detection feature each day.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '65885B52-00EC-5728-96******', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65885B52-00EC-5728-96******\\"\\n}","type":"json"}]', + 'title' => 'ModifyDefaultIPSConfig', + ], + 'ModifyUserIPSWhitelist' => [ + 'summary' => '修改用户IPS白名单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68490', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'WhiteType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + ], + 'example' => '2', + ], + ], + [ + 'name' => 'ListType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + ], + 'example' => '2', + ], + ], + [ + 'name' => 'ListValue', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '115.236.36.114/32', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ipv4' => 'IPv4', + 'ipv6' => 'IPv6', + ], + 'example' => 'ipv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '36E89955-1E5D-5810-970C-74646F378085', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'invalid aliUid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'Internal error: sql delete.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorParametersWhitelistIP', + 'errorMessage' => 'Invalid whitelistIp.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'update operation log error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error: marshal json.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36E89955-1E5D-5810-970C-74646F378085\\"\\n}","type":"json"}]', + ], + 'DescribeIpsPrivateAssoc' => [ + 'summary' => '查询IPS私网关联信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240655', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-c5vhmjdfp5t****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PublicIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'close', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IpsPrivateAssoc' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AssocInfoStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'close', + ], + 'ErrorMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aliuid:1096080848305847 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole', + ], + 'ProtectedIpList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123.56.18.XX', + ], + ], + 'ResourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cba48ec510bb640559c6f5161cde58014', + ], + 'ResourceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'job-0000000061279FB000001BBB31F9D673', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'closed', + ], + 'UnprotectedIpList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60.205.197.X', + ], + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-wz92dxepli2pgnut796tf', + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-uf62vdtifj7kffpxrydqd', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1507956024994407', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'TotalOpenCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpsPrivateAssoc\\": [\\n {\\n \\"AssocInfoStatus\\": \\"close\\",\\n \\"ErrorMsg\\": \\"aliuid:1096080848305847 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole\\",\\n \\"ProtectedIpList\\": [\\n \\"123.56.18.XX\\"\\n ],\\n \\"ResourceId\\": \\"cba48ec510bb640559c6f5161cde58014\\",\\n \\"ResourceName\\": \\"job-0000000061279FB000001BBB31F9D673\\",\\n \\"Status\\": \\"closed\\",\\n \\"UnprotectedIpList\\": [\\n \\"60.205.197.X\\"\\n ],\\n \\"VpcId\\": \\"vpc-wz92dxepli2pgnut796tf\\",\\n \\"VpcName\\": \\"vpc-uf62vdtifj7kffpxrydqd\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"MemberUid\\": 1507956024994407\\n }\\n ],\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\",\\n \\"TotalCount\\": 6,\\n \\"TotalOpenCount\\": 0\\n}","type":"json"}]', + ], + 'CreateIpsPrivateAssoc' => [ + 'summary' => '创建IPS私网关联信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240771', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-c5vhmjdfp5t****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '99A65AA0-C5B5-5092-BFCF-8111B436****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99A65AA0-C5B5-5092-BFCF-8111B436****\\"\\n}","type":"json"}]', + ], + 'DeleteIpsPrivateAssoc' => [ + 'summary' => '创建IPS私网关联信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240774', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-c5vhmjdfp5t****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '133173B9-8010-5DF5*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"133173B9-8010-5DF5*****\\"\\n}","type":"json"}]', + ], + 'DescribeVfwIPSConfigList' => [ + 'summary' => 'VPC防火墙IP配置列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230059', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageNo' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******', + ], + 'VfwIpsSwitchConfigList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '134646920647****', + ], + 'VpcFirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cen-h678sl4wv3yd5v****', + ], + 'VpcFirewallName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-test', + ], + 'RunMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '1', + ], + 'BasicRules' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '1', + ], + 'PatchRules' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '1', + ], + 'RuleClass' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 1 => '', + '', + '', + ], + 'example' => '1', + ], + 'VpcFirewallIdList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-9f39c248f9f447c****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"15FCCC52-1E23-57AE-B5EF-3E00A3******\\",\\n \\"VfwIpsSwitchConfigList\\": [\\n {\\n \\"MemberUid\\": \\"134646920647****\\",\\n \\"VpcFirewallId\\": \\"cen-h678sl4wv3yd5v****\\",\\n \\"VpcFirewallName\\": \\"vpc-test\\",\\n \\"RunMode\\": 1,\\n \\"BasicRules\\": 1,\\n \\"PatchRules\\": 1,\\n \\"RuleClass\\": 1,\\n \\"VpcFirewallIdList\\": [\\n \\"vfw-9f39c248f9f447c****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeVpcFirewallDefaultIPSConfig' => [ + 'summary' => 'Queries the intrusion prevention configurations of a virtual private cloud (VPC) firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68418', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall. Valid values:'."\n" + ."\n" + .'* If the VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a Cloud Enterprise Network (CEN) instance, the value of this parameter is the ID of the CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance. You can call the [DescribeVpcFirewallCenList](~~345777~~) operation to query the IDs of CEN instances.'."\n" + .'* If the VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit, the value of this parameter is the instance ID of the VPC firewall. You can call the [DescribeVpcFirewallList](~~342932~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125adf1', + ], + 'RunMode' => [ + 'description' => 'The mode of the intrusion prevention system (IPS). Valid values:'."\n" + ."\n" + .'* **1**: block mode'."\n" + .'* **0**: monitor mode'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EnableAllPatch' => [ + 'description' => 'Indicates whether virtual patching is enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BasicRules' => [ + 'description' => 'Indicates whether basic policies are enabled. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleClass' => [ + 'description' => 'The level of the rule group for the IPS. Valid values:'."\n" + ."\n" + .'* **1**: loose.'."\n" + .'* **2**: medium.'."\n" + .'* **3**: strict.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallId', + 'errorMessage' => 'The VPC firewall ID is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorParametersFirewallId', + 'errorMessage' => 'Invalid VPC firewall ID.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-****-00090125adf1\\",\\n \\"RunMode\\": 0,\\n \\"EnableAllPatch\\": 1,\\n \\"BasicRules\\": 1,\\n \\"RuleClass\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcFirewallDefaultIPSConfigResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125adf1</RequestId>\\n <RunMode>0</RunMode>\\n <EnableAllPatch>1</EnableAllPatch>\\n <BasicRules>1</BasicRules>\\n</DescribeVpcFirewallDefaultIPSConfigResponse>","errorExample":""}]', + 'title' => 'DescribeVpcFirewallDefaultIPSConfig', + 'description' => 'You can call the DescribeVpcFirewallDefaultIPSConfig operation to query the intrusion prevention configurations of a VPC firewall.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + ], + 'DescribeVpcFirewallIPSWhitelist' => [ + 'summary' => 'Queries the IPS whitelist of a virtual private cloud (VPC) firewall.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '138368', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwIT6TRR', + 'FEATUREcfwQROEEE', + 'FEATUREcfw1FTUMS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member in Cloud Firewall.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1766185894104675', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-3547deab1c9b4190a53f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B5EE02F9-4F21-56CA-AA49-F9F8D69483C1', + ], + 'Whitelists' => [ + 'description' => 'The details of the IPS whitelist of the VPC firewall.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcFirewallId' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'example' => 'vfw-57431e9abe424852a578', + ], + 'WhiteType' => [ + 'description' => 'The type of the whitelist. Valid values:'."\n" + ."\n" + .'* **1**: destination'."\n" + .'* **2**: source'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ListValue' => [ + 'description' => 'The entries in the list.'."\n", + 'type' => 'string', + 'example' => '10.10.200.4/32,10.10.200.25/32', + ], + 'ListType' => [ + 'description' => 'The type of the list. Valid values:'."\n" + ."\n" + .'* **1**: user-defined'."\n" + .'* **2**: address book'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'WhiteListValue' => [ + 'description' => 'An array of entries in the list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The entry in the list.'."\n", + 'type' => 'string', + 'example' => '10.10.200.4/32', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid is invalid.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorParametersFirewallId', + 'errorMessage' => 'Invalid VPC firewall ID.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error: marshal json.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B5EE02F9****AA49****F9F8D69483C1\\",\\n \\"Whitelists\\": [\\n {\\n \\"VpcFirewallId\\": \\"cen-l6t5yj5fi762******\\",\\n \\"WhiteType\\": 1,\\n \\"ListValue\\": \\"10.10.200.4/32,10.10.200.25/32\\",\\n \\"ListType\\": 1,\\n \\"WhiteListValue\\": [\\n \\"10.10.200.4/32\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeVpcFirewallIPSWhitelist', + ], + 'ModifyVpcFirewallDefaultIPSConfig' => [ + 'summary' => 'Modifies the intrusion prevention configurations of a virtual private cloud (VPC) firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68498', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n" + ."\n" + .'* If the VPC firewall protects traffic between a VPC and a network instance that is attached to a Cloud Enterprise Network (CEN) instance, the value of this parameter is the ID of the CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance. You can call the [DescribeVpcFirewallCenList](~~345777~~) operation to query the IDs of CEN instances.'."\n" + .'* If the VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit, the value of this parameter is the instance ID of the VPC firewall. You can call the [DescribeVpcFirewallList](~~342932~~) operation to query the instance IDs of VPC firewalls.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'BasicRules', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable basic protection. Valid values:'."\n" + ."\n" + .'* **1**: yes.'."\n" + .'* **0**: no.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'EnableAllPatch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable virtual patching. Valid values:'."\n" + ."\n" + .'* **1**: yes.'."\n" + .'* **0**: no.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'RunMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the intrusion prevention system (IPS). Valid values:'."\n" + ."\n" + .'* **1**: block mode.'."\n" + .'* **0**: monitor mode.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'RuleClass', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The level of the rule group for the IPS. Valid values:'."\n" + ."\n" + .'* **1**: loose'."\n" + .'* **2**: medium'."\n" + .'* **3**: strict'."\n", + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3B51B5BF-3C26-5009-ADAB-190E58DE4D6E', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorParametersFirewallId', + 'errorMessage' => 'Invalid VPC firewall ID.', + ], + [ + 'errorCode' => 'ErrorParametersMemberUid', + 'errorMessage' => 'invalid memberUid.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'update operation log error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3B51B5BF-3C26-5009-ADAB-190E58DE4D6E\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyVpcFirewallDefaultIPSConfigResponse>\\n <RequestId>3B51B5BF-3C26-5009-ADAB-190E58DE4D6E</RequestId>\\n</ModifyVpcFirewallDefaultIPSConfigResponse>","errorExample":""}]', + 'title' => 'ModifyVpcFirewallDefaultIPSConfig', + 'description' => 'You can call this operation to modify the intrusion prevention configurations of a VPC firewall.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ModifyVpcFirewallIPSWhitelist' => [ + 'summary' => 'Modifies the IPS whitelist of a virtual private cloud (VPC) firewall.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '138370', + 'abilityTreeNodes' => [ + 'FEATUREcfw1FTUMS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member that is managed by your Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1415189284827022', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID of the VPC firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-d7b8ce273791475b9b0b', + ], + ], + [ + 'name' => 'WhiteType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the whitelist. Valid values:'."\n" + ."\n" + .'* **1**: destination'."\n" + .'* **2**: source'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ListType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the list. Valid values:'."\n" + ."\n" + .'* **1**: user-defined'."\n" + .'* **2**: address book'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ListValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The entry in the list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.130.0.0/20,10.130.17.11/32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F2E8D49A-E5AA-5FF8-8822-25282DCF4BE8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersFirewallId', + 'errorMessage' => 'Invalid VPC firewall ID.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorParametersWhitelistIP', + 'errorMessage' => 'Invalid whitelistIp.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'update operation log error.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error: marshal json.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2E8D49A-E5AA-5FF8-8822-25282DCF4BE8\\"\\n}","type":"json"}]', + 'title' => 'ModifyVpcFirewallIPSWhitelist', + ], + 'ListTlsInspectCACertificates' => [ + 'summary' => '查询TLS检查证书', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfwCM05W3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CaCertId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'C3E91391-16CD-1BFC-A133-******D429', + ], + ], + [ + 'name' => 'CurrentPage', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-******837D', + ], + 'Certificates' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CaCertId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2732BB48-2969-5716-B5D9-******CA85', + ], + 'ExpirationTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1934***149', + ], + 'CaCertType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ROOT', + ], + 'AliasName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rsa_ml_***_root', + ], + 'Algorithm' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RSA', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ISSUE', + ], + 'KeySize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2048', + ], + 'SignAlgorithm' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + ], + 'ParentCaCertId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '340BB48-2969-5716-B5D9-****ACA85', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrCasOpenApiFailed', + 'errorMessage' => 'Error querying certificate, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-******837D\\",\\n \\"Certificates\\": [\\n {\\n \\"CaCertId\\": \\"2732BB48-2969-5716-B5D9-******CA85\\",\\n \\"ExpirationTime\\": 0,\\n \\"CaCertType\\": \\"ROOT\\",\\n \\"AliasName\\": \\"rsa_ml_***_root\\",\\n \\"Algorithm\\": \\"RSA\\",\\n \\"Status\\": \\"ISSUE\\",\\n \\"KeySize\\": 2048,\\n \\"SignAlgorithm\\": \\"SHA256WITHRSA\\",\\n \\"ParentCaCertId\\": \\"340BB48-2969-5716-B5D9-****ACA85\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + ], + 'GetTlsInspectCertificateDownloadUrl' => [ + 'summary' => '下载TLS证书', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfwCM05W3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CaCertId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'C3E91391-16CD-1BFC-A133-******D429', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-******h4j6', + ], + 'DownloadUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://cfw-tls-inspect-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/tls_cert%2F2025-08-13%2F1850****', + ], + 'CaCertId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorCasInnerApiFailed', + 'errorMessage' => 'API call failed, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-******h4j6\\",\\n \\"DownloadUrl\\": \\"https://cfw-tls-inspect-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/tls_cert%2F2025-08-13%2F1850****\\",\\n \\"CaCertId\\": \\"1f07c104-99ed-6b9a-b0bb-2938c9b8****\\"\\n}","type":"json"}]', + ], + 'DescribeAclCheckQuota' => [ + 'summary' => '查询NAT防火墙预检查结果', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219328', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '7D5483BF-2262-586D-8706-BDDB8B42****', + ], + 'Quota' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AvailableQuota' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'ConsumedQuota' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1500', + ], + 'TotalQuota' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1724982259', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D5483BF-2262-586D-8706-BDDB8B42****\\",\\n \\"Quota\\": {\\n \\"AvailableQuota\\": 500,\\n \\"ConsumedQuota\\": 1500,\\n \\"TotalQuota\\": 2000,\\n \\"UpdateTime\\": \\"1724982259\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeAclChecks' => [ + 'summary' => '批量查询ACL检查条目', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219331', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'VPC', + 'enum' => [ + 'Internet', + 'NAT', + 'VPC', + 'AddressBook', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '9AABB1B7-C81F-5158-9EF9-B2DD5D3D****', + ], + 'CheckRecords' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AclType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'NAT' => '', + 'AddressBook' => '', + 'VPC' => '', + 'Internet' => '', + ], + 'example' => 'Internet', + ], + 'Records' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CheckName' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'PolicyDuplicate' => '', + 'PolicyConflict' => '', + 'AddressBookIpSeparated' => '', + 'DefaultPolicyNotDeny' => '', + 'PolicySourceDestinationSame' => '', + 'PolicyPortHighRisk' => '', + 'PolicyTooLoose' => '', + 'PolicyHitCountZero' => '', + 'AddressBookPortSeparated' => '', + 'AddressBookDomainValid' => '', + ], + 'example' => 'AddressBookDomainValid', + ], + 'CheckStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'Checked' => '', + 'Unchecked' => '', + 'Checking' => '', + ], + 'example' => 'Checked', + ], + 'CheckType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'InvalidPolicy' => '', + 'AddressBookGather' => '', + 'HighRisk' => '', + ], + 'example' => 'AddressBookGather', + ], + 'LastCheckTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1724982259', + ], + 'Level' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'High' => '', + 'Low' => '', + 'Medium' => '', + ], + 'example' => 'Medium', + ], + 'AclPendingCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AclTotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'task-c92d4544ef7b6a42', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9AABB1B7-C81F-5158-9EF9-B2DD5D3D****\\",\\n \\"CheckRecords\\": {\\n \\"AclType\\": \\"Internet\\",\\n \\"Records\\": [\\n {\\n \\"CheckName\\": \\"AddressBookDomainValid\\",\\n \\"CheckStatus\\": \\"Checked\\",\\n \\"CheckType\\": \\"AddressBookGather\\",\\n \\"LastCheckTime\\": \\"1724982259\\",\\n \\"Level\\": \\"Medium\\",\\n \\"AclPendingCount\\": 1,\\n \\"AclTotalCount\\": 10,\\n \\"TaskId\\": \\"task-c92d4544ef7b6a42\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAclCheck' => [ + 'summary' => '查询ACL检查详情', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219336', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '132', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '25E655B0-CAED-53D4-8054-F983126****', + ], + 'CheckRecord' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AclTotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RecordAssessmentDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CheckName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PolicyHitCountZero', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'LastCheckTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1724982259', + ], + 'Level' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'High', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'task-c92d4544ef7b6a42', + ], + 'Acls' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Acl' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'out', + ], + 'Order' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'group', + ], + 'ApplicationName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ANY', + ], + 'HitTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_policy', + ], + 'SourceGroupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ip', + ], + 'DnsResultTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DnsResult' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'Proto' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'TCP', + ], + 'DestinationGroupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'domain', + ], + 'Destination' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'kms.cn-shanghai.aliyuncs.com', + ], + 'HitLastTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DestPortGroup' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'my_port_group'."\n", + ], + 'AclUuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '997b38e0-01fa-4db7-8d30-02ebf6fdb747', + ], + 'DestPortType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => '', + 'type' => 'string', + 'example' => '172.28.7.167', + ], + 'DestinationType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'domain', + ], + 'DestPort' => [ + 'description' => '', + 'type' => 'string', + 'example' => '80/80', + ], + 'IpVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'AclAction' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'log', + ], + 'Release' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'plugin_idp4_ciam', + ], + 'DestinationGroupCidrs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.0.XX.XX/32', + ], + ], + 'DestPortGroupPorts' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '80/80', + ], + ], + 'SourceGroupCidrs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '111.48.54.39/32', + ], + ], + 'ApplicationNameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ANY', + ], + ], + 'SpreadCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'RepeatType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Permanent', + ], + 'RepeatDays' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + ], + 'RepeatStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '08:00'."\n", + ], + 'RepeatEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730318400', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1758334822', + ], + 'AddressListCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupUuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'b91d86c3-2b52-4534-aae9-8d0339b12a48', + ], + 'AutoAddTagEcs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ReferenceCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ip', + ], + 'TagRelation' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'or', + ], + 'TagList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tfTestAcc0', + ], + 'TagKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ss', + ], + ], + ], + ], + 'AddressList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '183.2.201.71/32,60.28.235.22/32,210.51.58.107/32,60.28.235.81/32,210.51.58.51/32,60.28.235.52/32,1.1.1.1/32,154.212.141.143/32,167.94.146.55/32,185.226.197.47/32,101.251.238.174/32', + ], + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-2ze4w62zbdkwjmoqeokgl', + ], + 'DomainResolveType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'FQDN', + ], + 'VpcFirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-925514970c2c4bcab222', + ], + 'Addresses' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.0.XX.XX/32', + ], + 'Note' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + 'AclStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'Pending' => '', + 'Ignored' => '', + 'Processed' => '', + ], + 'example' => 'Pending', + ], + 'AclAssessmentDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAclCheckNotExist', + 'errorMessage' => 'ACL check not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25E655B0-CAED-53D4-8054-F983126****\\",\\n \\"CheckRecord\\": {\\n \\"AclTotalCount\\": 10,\\n \\"RecordAssessmentDetail\\": \\"建议删除无效策略，同时可帮助节省规格。\\",\\n \\"CheckName\\": \\"PolicyHitCountZero\\",\\n \\"Description\\": \\"由于业务下线或其它原因等，导致对象策略一段时间命中次数为0。\\",\\n \\"LastCheckTime\\": \\"1724982259\\",\\n \\"Level\\": \\"High\\",\\n \\"TaskId\\": \\"task-c92d4544ef7b6a42\\",\\n \\"Acls\\": [\\n {\\n \\"Acl\\": {\\n \\"Direction\\": \\"out\\",\\n \\"Order\\": 1,\\n \\"SourceType\\": \\"group\\",\\n \\"ApplicationName\\": \\"ANY\\",\\n \\"HitTimes\\": 1,\\n \\"Description\\": \\"test_policy\\",\\n \\"SourceGroupType\\": \\"ip\\",\\n \\"DnsResultTime\\": 1579261141,\\n \\"DnsResult\\": \\"192.0.XX.XX\\",\\n \\"Proto\\": \\"TCP\\",\\n \\"DestinationGroupType\\": \\"domain\\",\\n \\"Destination\\": \\"kms.cn-shanghai.aliyuncs.com\\",\\n \\"HitLastTime\\": 1579261141,\\n \\"DestPortGroup\\": \\"my_port_group\\\\n\\",\\n \\"AclUuid\\": \\"997b38e0-01fa-4db7-8d30-02ebf6fdb747\\",\\n \\"DestPortType\\": \\"port\\",\\n \\"Source\\": \\"172.28.7.167\\",\\n \\"DestinationType\\": \\"domain\\",\\n \\"DestPort\\": \\"80/80\\",\\n \\"IpVersion\\": 4,\\n \\"AclAction\\": \\"log\\",\\n \\"Release\\": \\"true\\",\\n \\"ApplicationId\\": \\"plugin_idp4_ciam\\",\\n \\"DestinationGroupCidrs\\": [\\n \\"192.0.XX.XX/32\\"\\n ],\\n \\"DestPortGroupPorts\\": [\\n \\"80/80\\"\\n ],\\n \\"SourceGroupCidrs\\": [\\n \\"111.48.54.39/32\\"\\n ],\\n \\"ApplicationNameList\\": [\\n \\"ANY\\"\\n ],\\n \\"SpreadCnt\\": 10,\\n \\"CreateTime\\": 1761062400,\\n \\"ModifyTime\\": 1761062400,\\n \\"RepeatType\\": \\"Permanent\\",\\n \\"RepeatDays\\": [\\n 6\\n ],\\n \\"RepeatStartTime\\": \\"08:00\\\\n\\",\\n \\"RepeatEndTime\\": \\"23:30\\",\\n \\"StartTime\\": 1730318400,\\n \\"EndTime\\": 1758334822,\\n \\"AddressListCount\\": 1,\\n \\"GroupUuid\\": \\"b91d86c3-2b52-4534-aae9-8d0339b12a48\\",\\n \\"AutoAddTagEcs\\": 0,\\n \\"GroupName\\": \\"钟馗开门白名单\\",\\n \\"ReferenceCount\\": 1,\\n \\"GroupType\\": \\"ip\\",\\n \\"TagRelation\\": \\"or\\",\\n \\"TagList\\": [\\n {\\n \\"TagValue\\": \\"tfTestAcc0\\",\\n \\"TagKey\\": \\"ss\\"\\n }\\n ],\\n \\"AddressList\\": [\\n \\"183.2.201.71/32,60.28.235.22/32,210.51.58.107/32,60.28.235.81/32,210.51.58.51/32,60.28.235.52/32,1.1.1.1/32,154.212.141.143/32,167.94.146.55/32,185.226.197.47/32,101.251.238.174/32\\"\\n ],\\n \\"NatGatewayId\\": \\"ngw-2ze4w62zbdkwjmoqeokgl\\",\\n \\"DomainResolveType\\": 0,\\n \\"VpcFirewallId\\": \\"vfw-925514970c2c4bcab222\\",\\n \\"Addresses\\": [\\n {\\n \\"Address\\": \\"192.0.XX.XX/32\\",\\n \\"Note\\": \\"已审核\\"\\n }\\n ]\\n },\\n \\"AclStatus\\": \\"Pending\\",\\n \\"AclAssessmentDetail\\": \\"无流量命中策略。\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'CreateAclCheck' => [ + 'summary' => '创建ACL检查', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219356', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'NAT' => '', + 'AddressBook' => '', + 'VPC' => '', + 'Internet' => '', + ], + 'example' => 'Internet', + 'enum' => [ + 'Internet', + 'NAT', + 'VPC', + 'AddressBook', + ], + ], + ], + [ + 'name' => 'CheckNames', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PolicyDuplicate' => '', + 'PolicyConflict' => '', + 'AddressBookIpSeparated' => '', + 'DefaultPolicyNotDeny' => '', + 'PolicySourceDestinationSame' => '', + 'PolicyPortHighRisk' => '', + 'PolicyTooLoose' => '', + 'PolicyHitCountZero' => '', + 'AddressBookPortSeparated' => '', + 'AddressBookDomainValid' => '', + ], + 'example' => 'PolicyHitCountZero', + 'enum' => [ + 'PolicyHitCountZero', + 'PolicySourceDestinationSame', + 'PolicyDuplicate', + 'PolicyConflict', + 'DefaultPolicyNotDeny', + 'PolicyPortHighRisk', + 'PolicyTooLoose', + 'AddressBookIpSeparated', + 'AddressBookPortSeparated', + 'AddressBookDomainValid', + ], + ], + 'required' => false, + 'maxItems' => 7, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '4FB718F0-CC04-5A12-B17B-188CFC3F****', + ], + 'TaskIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'task-c92d4544ef7b6a42'."\n", + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAclCheckQuotaUnavailable', + 'errorMessage' => 'ACL check quota unavailable.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorAclCheckBusy', + 'errorMessage' => 'ACL check is busy.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FB718F0-CC04-5A12-B17B-188CFC3F****\\",\\n \\"TaskIds\\": [\\n \\"task-c92d4544ef7b6a42\\\\n\\"\\n ]\\n}","type":"json"}]', + ], + 'UpdateAclCheckDetailStatus' => [ + 'summary' => '修改ACL检查状态', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219361', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'task-c92d4544ef7b6a42', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'bbbb43c9-a931-4d89-9939-86d509139a20', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Pending' => '', + 'Ignored' => '', + 'Processed' => '', + ], + 'example' => 'Pending', + 'enum' => [ + 'Pending', + 'Processed', + 'Ignored', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '850A84D6************00090125EEB1', + ], + 'CheckRecord' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Acls' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Acl' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'in', + ], + 'Order' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'desc', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'net', + ], + 'ApplicationName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ANY', + ], + 'HitTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_policy', + ], + 'SourceGroupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ip', + ], + 'DnsResultTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DnsResult' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.1/32', + ], + 'Proto' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ANY', + ], + 'DestinationGroupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'domain', + ], + 'Destination' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'kms.cn-shanghai.aliyuncs.com', + ], + 'HitLastTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DestPortGroup' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AclUuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1e8ed1b2-cebc-4b95-a9cc-0cb7ce2c0c2c', + ], + 'DestPortType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.71.94.24', + ], + 'DestinationType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'group', + ], + 'DestPort' => [ + 'description' => '', + 'type' => 'string', + 'example' => '22/22', + ], + 'IpVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'AclAction' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'log', + ], + 'Release' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'DestinationGroupCidrs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.1/32', + ], + ], + 'DestPortGroupPorts' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '22/22', + ], + ], + 'SourceGroupCidrs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.1/32', + ], + ], + 'ApplicationNameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SSH', + ], + ], + 'SpreadCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ModifyTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'RepeatType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'RepeatDays' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'RepeatStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '08:00', + ], + 'RepeatEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736130347', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1752754426', + ], + 'AddressListCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupUuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5a96a798-9b73-47f7-831e-1d7aa3c987a9', + ], + 'AutoAddTagEcs' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'subscribe', + ], + 'ReferenceCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'port', + ], + 'TagRelation' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'and', + ], + 'TagList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tfTestAcc0', + ], + 'TagKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'produce', + ], + ], + ], + ], + 'AddressList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '183.2.201.71/32,60.28.235.22/32,210.51.58.107/32,60.28.235.81/32,210.51.58.51/32,60.28.235.52/32,1.1.1.1/32,154.212.141.143/32,167.94.146.55/32,185.226.197.47/32,101.251.238.174/32', + ], + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-gw85zno51npz7lgc04z89', + ], + 'DomainResolveType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VpcFirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cen-cw4z051hr8x53qniv5', + ], + ], + ], + 'AclStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'configuring', + ], + 'AclAssessmentDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'RecordAssessmentDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CheckName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PolicyHitCountZero', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dwd_mysql_lingwan_faxing_chat_config_di', + ], + 'LastCheckTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1724982259', + ], + 'Level' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'High', + ], + 'PolicyTotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'task-c92d4544ef7b6a42', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAclCheckNotExist', + 'errorMessage' => 'ACL check not exist.', + ], + [ + 'errorCode' => 'ErrorAclCheckDetailNotExist', + 'errorMessage' => 'ACL check detail not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6************00090125EEB1\\",\\n \\"CheckRecord\\": {\\n \\"Acls\\": [\\n {\\n \\"Acl\\": {\\n \\"Direction\\": \\"in\\",\\n \\"Order\\": 0,\\n \\"SourceType\\": \\"net\\",\\n \\"ApplicationName\\": \\"ANY\\",\\n \\"HitTimes\\": 1,\\n \\"Description\\": \\"test_policy\\",\\n \\"SourceGroupType\\": \\"ip\\",\\n \\"DnsResultTime\\": 1579261141,\\n \\"DnsResult\\": \\"192.168.0.1/32\\",\\n \\"Proto\\": \\"ANY\\",\\n \\"DestinationGroupType\\": \\"domain\\",\\n \\"Destination\\": \\"kms.cn-shanghai.aliyuncs.com\\",\\n \\"HitLastTime\\": 1579261141,\\n \\"DestPortGroup\\": \\"所有端口\\",\\n \\"AclUuid\\": \\"1e8ed1b2-cebc-4b95-a9cc-0cb7ce2c0c2c\\",\\n \\"DestPortType\\": \\"port\\",\\n \\"Source\\": \\"10.71.94.24\\",\\n \\"DestinationType\\": \\"group\\",\\n \\"DestPort\\": \\"22/22\\",\\n \\"IpVersion\\": 4,\\n \\"AclAction\\": \\"log\\",\\n \\"Release\\": \\"true\\",\\n \\"ApplicationId\\": \\"HTTP\\",\\n \\"DestinationGroupCidrs\\": [\\n \\"192.168.0.1/32\\"\\n ],\\n \\"DestPortGroupPorts\\": [\\n \\"22/22\\"\\n ],\\n \\"SourceGroupCidrs\\": [\\n \\"192.168.0.1/32\\"\\n ],\\n \\"ApplicationNameList\\": [\\n \\"SSH\\"\\n ],\\n \\"SpreadCnt\\": 10,\\n \\"CreateTime\\": 1761062400,\\n \\"ModifyTime\\": 1761062400,\\n \\"RepeatType\\": \\"None\\",\\n \\"RepeatDays\\": [\\n 1\\n ],\\n \\"RepeatStartTime\\": \\"08:00\\",\\n \\"RepeatEndTime\\": \\"23:30\\",\\n \\"StartTime\\": 1736130347,\\n \\"EndTime\\": 1752754426,\\n \\"AddressListCount\\": 1,\\n \\"GroupUuid\\": \\"5a96a798-9b73-47f7-831e-1d7aa3c987a9\\",\\n \\"AutoAddTagEcs\\": 0,\\n \\"GroupName\\": \\"subscribe\\",\\n \\"ReferenceCount\\": 1,\\n \\"GroupType\\": \\"port\\",\\n \\"TagRelation\\": \\"and\\",\\n \\"TagList\\": [\\n {\\n \\"TagValue\\": \\"tfTestAcc0\\",\\n \\"TagKey\\": \\"produce\\"\\n }\\n ],\\n \\"AddressList\\": [\\n \\"183.2.201.71/32,60.28.235.22/32,210.51.58.107/32,60.28.235.81/32,210.51.58.51/32,60.28.235.52/32,1.1.1.1/32,154.212.141.143/32,167.94.146.55/32,185.226.197.47/32,101.251.238.174/32\\"\\n ],\\n \\"NatGatewayId\\": \\"ngw-gw85zno51npz7lgc04z89\\",\\n \\"DomainResolveType\\": 0,\\n \\"VpcFirewallId\\": \\"cen-cw4z051hr8x53qniv5\\"\\n },\\n \\"AclStatus\\": \\"configuring\\",\\n \\"AclAssessmentDetail\\": \\"无流量命中策略。\\"\\n }\\n ],\\n \\"RecordAssessmentDetail\\": \\"由于业务下线或其它原因等，导致对象策略一段时间命中次数为0。\\",\\n \\"CheckName\\": \\"PolicyHitCountZero\\",\\n \\"Description\\": \\"dwd_mysql_lingwan_faxing_chat_config_di\\",\\n \\"LastCheckTime\\": \\"1724982259\\",\\n \\"Level\\": \\"High\\",\\n \\"PolicyTotalCount\\": 1,\\n \\"TaskId\\": \\"task-c92d4544ef7b6a42\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeAddressBook' => [ + 'summary' => 'Queries the details about an address book for an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68175', + 'abilityTreeNodes' => [ + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10. Maximum value: 50.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query condition that is used to search for the address book.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the address book. Valid values:'."\n" + ."\n" + .'* **ip**: IP address book'."\n" + .'* **domain**: domain address book'."\n" + .'* **port**: port address book'."\n" + .'* **tag**: Elastic Compute Service (ECS) tag-based address book'."\n" + .'* **allCloud**: cloud service address book'."\n" + .'* **threat**: threat intelligence address book'."\n" + .'* **ipv6**: IPv6 address book'."\n" + .'> If you do not specify a type, the domain address books and ECS tag-based address books are queried.', + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + ], + ], + [ + 'name' => 'ContainPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port that is included in the address book. This parameter takes effect only when the **GroupType** parameter is set to **port**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B36F150A-1E27-43AA-B72C-D2AC712F09DA', + ], + 'TotalCount' => [ + 'description' => 'The total number of the returned address books.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Acls' => [ + 'description' => 'The information about the address book.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressListCount' => [ + 'description' => 'The number of addresses in the address book.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GroupUuid' => [ + 'description' => 'The UUID of the address book.'."\n", + 'type' => 'string', + 'example' => 'f04ac7ce-628b-4cb7-be61-310222b7****', + ], + 'AutoAddTagEcs' => [ + 'description' => 'Indicates whether the public IP addresses of ECS instances are automatically added to the address book if the instances match the specified tags. The setting takes effect on both newly purchased ECS instances whose tag settings are complete and ECS instances whose tag settings are modified. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Description' => [ + 'description' => 'The description of the address book.'."\n", + 'type' => 'string', + 'example' => 'my address book', + ], + 'GroupName' => [ + 'description' => 'The name of the address book.'."\n", + 'type' => 'string', + 'example' => 'demo_address_book', + ], + 'ReferenceCount' => [ + 'description' => 'The number of times that the address book is referenced.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'GroupType' => [ + 'description' => 'The type of the address book. Valid values:'."\n" + ."\n" + .'* **ip**: IP address book'."\n" + .'* **domain**: domain address book'."\n" + .'* **port**: port address book'."\n" + .'* **tag**: ECS tag-based address book'."\n" + .'* **allCloud**: cloud service address book'."\n" + .'* **threat**: threat intelligence address book'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'TagRelation' => [ + 'description' => 'The logical relationship among ECS tags. Valid values:'."\n" + ."\n" + .'* **and**: Only the public IP addresses of ECS instances that match all the specified tags can be added to the address book.'."\n" + .'* **or**: The public IP addresses of ECS instances that match any of the specified tags can be added to the address book.'."\n", + 'type' => 'string', + 'example' => 'and', + ], + 'TagList' => [ + 'description' => 'The details about the ECS tags that can be automatically added to the address book.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'The value of the ECS tag.'."\n", + 'type' => 'string', + 'example' => 'admin', + ], + 'TagKey' => [ + 'description' => 'The key of the ECS tag.'."\n", + 'type' => 'string', + 'example' => 'company', + ], + ], + ], + ], + 'AddressList' => [ + 'description' => 'The addresses in the address book.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The address in the address book.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX/32', + ], + ], + 'Addresses' => [ + 'description' => 'A list of addresses in the address book, each with a single address description.', + 'type' => 'array', + 'items' => [ + 'description' => 'Address in the address book with a single address description.', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => 'Address information in the address book.', + 'type' => 'string', + 'example' => '192.168.0.1/32', + ], + 'Note' => [ + 'description' => 'Single address description.', + 'type' => 'string', + 'example' => 'description', + ], + ], + ], + ], + 'AckClusterConnectorId' => [ + 'title' => 'ACK集群连接器ID。', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab1', + ], + 'AckClusterConnectorName' => [ + 'title' => 'ACK集群连接器名称。', + 'type' => 'string', + 'example' => 'ACK集群连接器', + ], + 'AckLabels' => [ + 'title' => 'ACK集群容器组标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'ACK集群容器组标签的键。', + 'type' => 'string', + 'example' => 'app', + ], + 'Value' => [ + 'title' => 'ACK集群容器组标签的值。', + 'type' => 'string', + 'example' => 'storage-operator', + ], + ], + ], + ], + 'AckNamespaces' => [ + 'title' => 'ACK集群容器组命名空间列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + ], + 'RegionNo' => [ + 'title' => '当GroupType是ACK地址簿时，地址簿仅在该地域的ACL策略生效。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersGroupType', + 'errorMessage' => 'The group type is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"RequestId\\": \\"B36F150A-1E27-43AA-B72C-D2AC712F09DA\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Acls\\": [\\n {\\n \\"AddressListCount\\": 2,\\n \\"GroupUuid\\": \\"f04ac7ce-628b-4cb7-be61-310222b7****\\",\\n \\"AutoAddTagEcs\\": 1,\\n \\"Description\\": \\"DEMO地址簿\\",\\n \\"GroupName\\": \\"demo_address_book\\",\\n \\"ReferenceCount\\": 3,\\n \\"GroupType\\": \\"ip\\",\\n \\"TagRelation\\": \\"and\\",\\n \\"TagList\\": [\\n {\\n \\"TagValue\\": \\"全部VALUE\\",\\n \\"TagKey\\": \\"company\\"\\n }\\n ],\\n \\"AddressList\\": [\\n \\"[ \\\\\\"192.168.XX.XX/32\\\\\\", \\\\\\"192.168.XX.XX/32\\\\\\" ]\\"\\n ],\\n \\"Addresses\\": [\\n {\\n \\"Address\\": \\"192.168.0.1/32\\",\\n \\"Note\\": \\"单地址描述\\"\\n }\\n ],\\n \\"AckClusterConnectorId\\": \\"ac-7c1bad6c3cc84c33baab\\",\\n \\"AckClusterConnectorName\\": \\"ack-cluster-connector-name\\",\\n \\"AckLabels\\": [\\n {\\n \\"Key\\": \\"app\\",\\n \\"Value\\": \\"storage-operator\\"\\n }\\n ],\\n \\"AckNamespaces\\": [\\n \\"default\\"\\n ],\\n \\"RegionNo\\": \\"cn-beijing\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAddressBookResponse>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <RequestId>B36F150A-1E27-43AA-B72C-D2AC712F09DA</RequestId>\\n <TotalCount>100</TotalCount>\\n <Acls>\\n <AddressListCount>2</AddressListCount>\\n <GroupUuid>f04ac7ce-628b-4cb7-be61-310222b7****</GroupUuid>\\n <AutoAddTagEcs>1</AutoAddTagEcs>\\n <Description>DEMO地址簿</Description>\\n <GroupName>demo_address_book</GroupName>\\n <ReferenceCount>3</ReferenceCount>\\n <GroupType>ip</GroupType>\\n <TagRelation>and</TagRelation>\\n <TagList>\\n <TagValue>全部VALUE</TagValue>\\n <TagKey>company</TagKey>\\n </TagList>\\n <AddressList>[ \\"192.168.XX.XX/32\\", \\"192.168.XX.XX/32\\" ]</AddressList>\\n </Acls>\\n</DescribeAddressBookResponse>","errorExample":""}]', + 'title' => 'DescribeAddressBook', + 'description' => 'You can call this operation to query the details about an address book for an access control policy.'."\n" + ."\n" + .'## [](#qps)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'AddAddressBook' => [ + 'summary' => 'Creates an address book for access control. Supported address book types are IP address books, Elastic Compute Service (ECS) tag-based address books, port address books, and domain address books. An ECS tag-based address book includes the public IP addresses of the ECS instances that have specific tags.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68093', + 'abilityTreeNodes' => [ + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AddressList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The addresses that you want to add to the address book. Separate multiple addresses with commas (,).'."\n" + ."\n" + .'> If you set GroupType to `ip`, `port` or `domain`, you must specify AddressList.'."\n" + ."\n" + .'* If you set GroupType to `ip`, you must add IP addresses to the address book. Example: 192.0.XX.XX/32,192.0.XX.XX/24.'."\n" + .'* If you set GroupType to `port`, you must add port numbers or port ranges to the address book. Example: 80,100/200.'."\n" + .'* If you set GroupType to `domain`, you must add domain names to the address book. Example: example.com,aliyundoc.com.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '192.0.XX.XX/32, 192.0.XX.XX/24', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the address book.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sz-001', + 'maxLength' => 256, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the address book.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sz-001', + 'maxLength' => 128, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the address book. Valid values:'."\n" + ."\n" + .'* **ip**: IP address book'."\n" + .'* **domain**: domain address book'."\n" + .'* **port**: port address book'."\n" + .'* **tag**: ECS tag-based address book'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ip', + ], + ], + [ + 'name' => 'AutoAddTagEcs', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically add public IP addresses of ECS instances to the address book if the instances match the specified tags. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0** (default): no'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TagRelation', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logical relation among the ECS tags that you want to match. Valid values:'."\n" + ."\n" + .'* **and** (default): Only the public IP addresses of ECS instances that match all the specified tags can be added to the address book.'."\n" + .'* **or**: The public IP addresses of ECS instances that match one of the specified tags can be added to the address book.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'and', + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ECS tags that you want to match.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'The value of the ECS tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'TagKey' => [ + 'description' => 'The key of the ECS tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TXY', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AckClusterConnectorId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ACK集群连接器ID。', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab1', + ], + ], + [ + 'name' => 'AckNamespaces', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'ACK集群容器组命名空间列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + ], + ], + [ + 'name' => 'AckLabels', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'ACK集群容器组标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'ACK集群容器组标签的键。', + 'type' => 'string', + 'example' => 'app', + ], + 'Value' => [ + 'title' => 'ACK集群容器组标签的值。', + 'type' => 'string', + 'example' => 'storage-operator', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GroupUuid' => [ + 'description' => 'The UUID of the returned address book.'."\n", + 'type' => 'string', + 'example' => 'f04ac7ce-628b-4cb7-be61-310222b7****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersGroupType', + 'errorMessage' => 'The group type is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersGroupAddress', + 'errorMessage' => 'The IP address of the address group is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorAddressGroupExist', + 'errorMessage' => 'The address group already exists.', + ], + [ + 'errorCode' => 'ErrorParamDomain', + 'errorMessage' => 'The parameter Domain is invalid.', + ], + [ + 'errorCode' => 'ErrorUUIDNew', + 'errorMessage' => 'The UUID is invalid.', + ], + [ + 'errorCode' => 'ErrorAddressGroupCountExceed', + 'errorMessage' => 'The maximum number of address group is exceeded.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorParametersTagKey', + 'errorMessage' => 'The tag key is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersTagList', + 'errorMessage' => 'The tag list is invalid.', + ], + [ + 'errorCode' => 'ErrorTagCountExceed', + 'errorMessage' => 'The maximum number of tag is exceeded.', + ], + [ + 'errorCode' => 'ErrorParametersTagRelation', + 'errorMessage' => 'The tag relation is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersGroupPort', + 'errorMessage' => 'The group port is invalid.', + ], + [ + 'errorCode' => 'ErrorPortCountExceed', + 'errorMessage' => 'The maixmum number of port in the group is exceeded.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ErrorAckClusterConnectorBusy', + 'errorMessage' => 'The ACK cluster connector is operating.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ErrorAckClusterConnectorNotFound', + 'errorMessage' => 'The specified resource ACK cluster connector is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"GroupUuid\\": \\"f04ac7ce-628b-4cb7-be61-310222b7****\\",\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddAddressBookResponse>\\n <GroupUuid>f04ac7ce-628b-4cb7-be61-310222b7****</GroupUuid>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****</RequestId>\\n</AddAddressBookResponse>","errorExample":""}]', + 'title' => 'AddAddressBook', + 'description' => 'You can call the AddAddressBook operation to create an address book for access control. The address book can be an IP address book, an ECS tag-based address book, a port address book, or a domain address book.'."\n" + ."\n" + .'## [](#qps)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => 'All Alibaba Cloud API requests must include common request parameters. For more information about common request parameters, see [Common request parameters](~~94763~~). For more information about sample requests, see the "**Examples**" section of this topic.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAddressBook' => [ + 'summary' => 'Modifies the address book that is specified in an access control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68460', + 'abilityTreeNodes' => [ + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AddressList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The addresses in the address book. Separate multiple addresses with commas (,). If you set GroupType to **ip**, **port**, or **domain**, you must specify this parameter.'."\n" + ."\n" + .'* If you set GroupType to **ip**, you must specify IP addresses for the address book. Example: 1.2.XX.XX/32,1.2.XX.XX/24.'."\n" + .'* If you set GroupType to **port**, you must specify port numbers or port ranges for the address book. Example: 80/80,100/200.'."\n" + .'* If you set GroupType to **domain**, you must specify domain names for the address book. Example: demo1.aliyun.com,demo2.aliyun.com.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/32, 192.0.XX.XX/24', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the address book.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'bj-001', + 'maxLength' => 256, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the address book.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'bj-001', + 'maxLength' => 128, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GroupUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the address book.'."\n" + ."\n" + .'> To modify the address book, you must provide the ID of the address book. You can call the [DescribeAddressBook](~~138869~~) operation to query the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0657ab9d-fe8b-4174-b2a6-6baf358e****', + ], + ], + [ + 'name' => 'AutoAddTagEcs', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically add public IP addresses of Elastic Compute Service (ECS) instances to the address book if the instances match the specified tags. Valid values:'."\n" + ."\n" + .'* **1**: yes'."\n" + .'* **0**: no'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TagRelation', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logical relationship among ECS tags. Valid values:'."\n" + ."\n" + .'* **and**: Only the public IP addresses of ECS instances that match all the specified tags can be added to the address book.'."\n" + .'* **or**: The public IP addresses of ECS instances that match one of the specified tags can be added to the address book.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'and', + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ECS tags that you want to match.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'The value of ECS tag N that you want to match.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'TagKey' => [ + 'description' => 'The key of ECS tag N that you want to match.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TXY', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'Modification mode with the following values:'."\n" + ."\n" + .'- **Cover**: Use the value of the AddressList parameter to overwrite the original address book.'."\n" + .'- **Append**: After the original address book, append addresses using the value of the AddressList parameter.'."\n" + .'- **Delete**: Delete addresses using the value of the AddressList parameter from the address book.'."\n" + ."\n" + .'>When GroupType is **ip**, **ipv6**, **port**, or **domain**, if this parameter is not configured, the default is to use the **Cover** method to modify the address book.'."\n" + .'><notice>When GroupType is **tag**, this parameter must be empty.</notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'Cover', + 'enum' => [ + 'Cover', + 'Append', + 'Delete', + ], + ], + ], + [ + 'name' => 'AckNamespaces', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'ACK集群容器组命名空间列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + [ + 'name' => 'AckLabels', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'ACK集群容器组标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'ACK集群容器组标签的键。', + 'type' => 'string', + 'example' => 'app', + ], + 'Value' => [ + 'title' => 'ACK集群容器组标签的值。', + 'type' => 'string', + 'example' => 'storage-operator', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAddressCountExceed', + 'errorMessage' => 'The maximum number of addresses is exceeded.', + ], + [ + 'errorCode' => 'ErrorParametersGroupAddress', + 'errorMessage' => 'The IP address of the address group is invalid.', + ], + [ + 'errorCode' => 'ErrorParamDomain', + 'errorMessage' => 'The parameter Domain is invalid.', + ], + [ + 'errorCode' => 'ErrorAddressGroupNotExist', + 'errorMessage' => 'The address group does not exist.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorParametersGroupPort', + 'errorMessage' => 'The group port is invalid.', + ], + [ + 'errorCode' => 'ErrorAclExtendedCountExceed', + 'errorMessage' => 'ACL or extended ACL rules are not matched.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorAddressGroupExist', + 'errorMessage' => 'The address group already exists.', + ], + [ + 'errorCode' => 'ErrorAclDomainAnyCountExceed', + 'errorMessage' => 'The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.', + ], + [ + 'errorCode' => 'ErrorParametersAddressGroupAddressNotFound', + 'errorMessage' => 'The address to be deleted does not exist in the address book.', + ], + [ + 'errorCode' => 'InvalidParameter.AddressBook.AddressDuplicate', + 'errorMessage' => 'The address book address %s is already exist.', + ], + [ + 'errorCode' => 'ErrorAckClusterConnectorBusy', + 'errorMessage' => 'The ACK cluster connector is operating.', + ], + ], + [ + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'An authentication error occurred.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ErrorAckClusterConnectorNotFound', + 'errorMessage' => 'The specified resource ACK cluster connector is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAddressBookResponse>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n</ModifyAddressBookResponse>","errorExample":""}]', + 'title' => 'ModifyAddressBook', + 'description' => 'You can call the ModifyAddressBook operation to modify the address book that is configured for access control. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see [Common parameters](~~94763~~).'."\n" + ."\n" + .'For more information about sample requests, see the "**Examples**" section of this topic.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAddressBook' => [ + 'summary' => 'Deletes an address book for access control.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68139', + 'abilityTreeNodes' => [ + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The natural language of the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'GroupUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the address book.'."\n" + ."\n" + .'To delete the address book, you must provide the ID of the address book. You can call the DescribeAddressBook operation to query the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0657ab9d-fe8b-4174-b2a6-6baf358e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125EEB1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAddressGroupReference', + 'errorMessage' => 'The address group is in use and cannot be deleted.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorAddressGroupNotExist', + 'errorMessage' => 'The address group does not exist.', + ], + ], + [ + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'An authentication error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125EEB1\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAddressBookResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125EEB1</RequestId>\\n</DeleteAddressBookResponse>","errorExample":""}]', + 'title' => 'DeleteAddressBook', + 'description' => 'You can call the DeleteAddressBook operation to delete an address book for access control. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => 'All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see [Common parameters](~~94763#concept-aw3-bc2-pfb~~ "This topic describes the common parameters for API operations provided by Cloud Firewall.").'."\n" + ."\n" + .'For more information about sample requests, see the **Examples** section of this topic.'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAccessInstanceRegionList' => [ + 'summary' => '查询接入实例地域列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235038', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ready', + ], + ], + [ + 'name' => 'AccessInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AckClusterConnector' => '', + 'PrivateDns' => '', + ], + 'example' => 'AckClusterConnector', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + 'RegionNoList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\",\\n \\"RegionNoList\\": [\\n \\"cn-beijing\\"\\n ]\\n}","type":"json"}]', + ], + 'DescribeAccessInstanceTask' => [ + 'summary' => '查询接入实例任务', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226332', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pdi-3bc2f91695ee48bd9377', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'task-c92d4544ef7b6a42', + ], + ], + [ + 'name' => 'AccessInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AckClusterConnector' => '', + 'PrivateDNS' => '', + ], + 'example' => 'AckClusterConnector', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******', + ], + 'IsFound' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'running', + ], + 'TaskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3c9d576f-fce0-4caa-9116-15033509bdb6', + ], + 'TaskStartTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17151361285', + ], + 'TaskFinishTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17151381075', + ], + 'TaskSteps' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StepName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'StepStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'finished', + ], + 'StepProgress' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100%', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15FCCC52-1E23-57AE-B5EF-3E00A3******\\",\\n \\"IsFound\\": true,\\n \\"TaskStatus\\": \\"running\\",\\n \\"TaskName\\": \\"创建ACK集群连接器\\",\\n \\"TaskId\\": \\"3c9d576f-fce0-4caa-9116-15033509bdb6\\",\\n \\"TaskStartTimestamp\\": 17151361285,\\n \\"TaskFinishTimestamp\\": 17151381075,\\n \\"TaskSteps\\": [\\n {\\n \\"StepName\\": \\"获取ACK集群信息\\",\\n \\"StepStatus\\": \\"finished\\",\\n \\"StepProgress\\": \\"100%\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAccessInstanceVpcList' => [ + 'summary' => '查询接入实例VPC列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235040', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'PageNo', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '450D47F5-956E-543E-8502-2F71C8C54E72', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'VpcList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-2ze1t4irqj0fljlbb****'."\n", + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Cloud_Firewall_VPC', + ], + 'FirewallVpc' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"450D47F5-956E-543E-8502-2F71C8C54E72\\",\\n \\"TotalCount\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"VpcList\\": [\\n {\\n \\"VpcId\\": \\"vpc-2ze1t4irqj0fljlbb****\\\\n\\",\\n \\"VpcName\\": \\"Cloud_Firewall_VPC\\",\\n \\"FirewallVpc\\": false\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAccessInstanceVSwitchList' => [ + 'summary' => '查询接入实例的交换机列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235044', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-qzeaol304m***', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'PageNo', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '450D47F5-956E-543E-8502-2F71C8C54E72', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Zones' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'VSwitchList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-uf6b5lyul0x******', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-qzeaol304m***', + ], + 'VSwitchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ManagedVSW', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'AvailableIpAddressCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '254', + ], + 'FirewallVSwitch' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"450D47F5-956E-543E-8502-2F71C8C54E72\\",\\n \\"TotalCount\\": 1,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"VSwitchList\\": [\\n {\\n \\"VpcId\\": \\"vpc-uf6b5lyul0x******\\",\\n \\"VSwitchId\\": \\"vsw-qzeaol304m***\\",\\n \\"VSwitchName\\": \\"ManagedVSW\\",\\n \\"CidrBlock\\": \\"192.168.0.0/16\\",\\n \\"AvailableIpAddressCount\\": 254,\\n \\"FirewallVSwitch\\": false\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAccessInstanceZoneList' => [ + 'summary' => '查询接入实例支持的可用区列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235042', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'AccessInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AckClusterConnector' => '', + 'PrivateDNS' => '', + ], + 'example' => 'AckClusterConnector', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '31306819-C4BC-56F3-BBE6-*****', + ], + 'ZoneList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-g', + ], + ], + 'Zones' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-g', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorRegionNo', + 'errorMessage' => 'regionNo error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31306819-C4BC-56F3-BBE6-*****\\",\\n \\"ZoneList\\": [\\n \\"cn-beijing-g\\"\\n ],\\n \\"Zones\\": [\\n {\\n \\"LocalName\\": \\"北京 可用区G\\",\\n \\"ZoneId\\": \\"cn-beijing-g\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAckClusters' => [ + 'summary' => '查询阿里云K8S容器服务（ACK）集群，查询符合条件的ACK集群（例如指定集群类型、集群规格）列表信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfwC140SS', + 'FEATUREcfw0T2ZBS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cb0f5640b1b2d404cad6ba21509d7847b', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-cluster-name', + ], + ], + [ + 'name' => 'ClusterSpec', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ack.pro.small' => '', + ], + 'example' => 'ack.pro.small', + ], + ], + [ + 'name' => 'ConnectorStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ready', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Clusters' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '135809047715****', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cb0f5640b1b2d404cad6ba21509d7847b', + ], + 'ClusterName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ack-cluster-name', + ], + 'ClusterType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'ExternalKubernetes' => '', + 'ManagedKubernetes' => '', + 'Kubernetes' => '', + ], + 'example' => 'ManagedKubernetes', + ], + 'Profile' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'Lingjun' => '', + 'Serverless' => '', + 'Default' => '', + 'Edge' => '', + ], + 'example' => 'Default', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-2vcg932hsxsxuqbgl****', + ], + 'Network' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'terway-eniip' => 'Terway-eniip', + 'Flannel' => 'Flannel', + ], + 'example' => 'terway-eniip', + ], + 'ClusterSpec' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'ack.pro.small' => '', + ], + 'example' => 'ack.pro.small', + ], + 'State' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'running' => '', + 'scaling' => '', + 'stopped' => '', + 'upgrading' => '', + 'updating' => '', + 'deleting' => '', + 'deleted' => '', + 'initial' => '', + 'draining' => '', + 'delete_failed' => '', + 'failed' => '', + 'removing' => '', + ], + 'example' => 'running', + ], + ], + ], + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'C5DDD596-1191-5F36-A504-8733045A****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorRegionNo', + 'errorMessage' => 'regionNo error.', + ], + [ + 'errorCode' => 'ErrorAckNotOpen', + 'errorMessage' => 'ACK service is not open.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Clusters\\": [\\n {\\n \\"MemberUid\\": \\"135809047715****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ClusterId\\": \\"cb0f5640b1b2d404cad6ba21509d7847b\\",\\n \\"ClusterName\\": \\"ack-cluster-name\\",\\n \\"ClusterType\\": \\"ManagedKubernetes\\",\\n \\"Profile\\": \\"Default\\",\\n \\"VpcId\\": \\"vpc-2vcg932hsxsxuqbgl****\\",\\n \\"Network\\": \\"terway-eniip\\",\\n \\"ClusterSpec\\": \\"ack.pro.small\\",\\n \\"State\\": \\"running\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"C5DDD596-1191-5F36-A504-8733045A****\\",\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + ], + 'DescribeAckClusterConnectors' => [ + 'summary' => '批量查询ACK集群连接器列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfwC140SS', + 'FEATUREcfw0T2ZBS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'ConnectorName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0E0C30C977463****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AckClusterConnectors' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'connector-7ff4df316c9a458d****', + ], + 'ConnectorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '159663371500****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'f9b9815a5280****', + ], + 'ClusterName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'TestClusterA', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + 'PrimaryVswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + 'PrimaryVswitchZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-g', + ], + 'PrimaryVswitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.100.2.XXX', + ], + 'StandbyVswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + 'StandbyVswitchZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + 'StandbyVswitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.100.1.XXX'."\n", + ], + 'Ttl' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ConnectorStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ready', + ], + 'ConnectorHealthCheckStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'healthy', + ], + 'UnhealthyReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'GroupUuids' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' "b84dec36-c4fc-458e-98b8-f1b5dd23****",'."\n" + .' "8015d9eb-8382-4388-b965-b92d806d****"'."\n" + .' ]', + ], + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1760493347', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'E7F333E0-7B70-54DA-A307-4B2B49DE****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorRegionNo', + 'errorMessage' => 'regionNo error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNo\\": 1,\\n \\"AckClusterConnectors\\": [\\n {\\n \\"ConnectorId\\": \\"ac-7c1bad6c3cc84c33baab\\",\\n \\"ConnectorName\\": \\"ack-cluster-connector-name\\",\\n \\"MemberUid\\": \\"159663371500****\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"ClusterId\\": \\"f9b9815a5280****\\",\\n \\"ClusterName\\": \\"TestClusterA\\",\\n \\"VpcId\\": \\"vpc-j6cvhdscntzuvr0x****\\",\\n \\"PrimaryVswitchId\\": \\"vsw-2ze2gtlfozrab01cfo****\\",\\n \\"PrimaryVswitchZoneId\\": \\"cn-beijing-g\\",\\n \\"PrimaryVswitchIp\\": \\"10.100.2.XXX\\",\\n \\"StandbyVswitchId\\": \\"vsw-2zerfbbje7dvnbii2****\\",\\n \\"StandbyVswitchZoneId\\": \\"cn-beijing-h\\",\\n \\"StandbyVswitchIp\\": \\"10.100.1.XXX\\\\n\\",\\n \\"Ttl\\": 30,\\n \\"ConnectorStatus\\": \\"ready\\",\\n \\"ConnectorHealthCheckStatus\\": \\"healthy\\",\\n \\"UnhealthyReason\\": \\"指定的ACK集群不存在\\",\\n \\"GroupUuids\\": [\\n \\"[\\\\\\"b84dec36-c4fc-458e-98b8-f1b5dd23****\\\\\\",\\\\\\"8015d9eb-8382-4388-b965-b92d806d****\\\\\\"]\\"\\n ],\\n \\"CreateTime\\": \\"1760493347\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"E7F333E0-7B70-54DA-A307-4B2B49DE****\\",\\n \\"TotalCount\\": 20\\n}","type":"json"}]', + ], + 'DescribeAckClusterConnector' => [ + 'summary' => '查询指定ACK集群连接器', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfw0T2ZBS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ConnectorId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckClusterConnector' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + 'ConnectorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ack-cluster-connector-name', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '135809047715****'."\n", + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c857d908016794125883a9ee8196cba17', + ], + 'ClusterName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ack-cluster-name', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + 'Ttl' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PrimaryVswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + 'PrimaryVswitchZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-g', + ], + 'PrimaryVswitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.100.1.1', + ], + 'StandbyVswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + 'StandbyVswitchZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + 'StandbyVswitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.100.2.1', + ], + 'ConnectorStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '', + 'deleting' => '', + 'ready' => '', + ], + 'example' => 'ready', + ], + 'ConnectorHealthCheckStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '', + 'healthy' => '', + 'unhealthy' => '', + ], + 'example' => 'healthy', + ], + 'UnhealthyReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'The ACK cluster status is unavailable.', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1724982259', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '45E2E720-D2B4-506F-B682-1FCBE971****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ErrorAckClusterConnectorNotFound', + 'errorMessage' => 'The specified resource ACK cluster connector is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AckClusterConnector\\": {\\n \\"ConnectorId\\": \\"ac-7c1bad6c3cc84c33baab\\",\\n \\"ConnectorName\\": \\"ack-cluster-connector-name\\",\\n \\"MemberUid\\": \\"135809047715****\\\\n\\",\\n \\"RegionNo\\": \\"cn-beijing\\",\\n \\"ClusterId\\": \\"c857d908016794125883a9ee8196cba17\\",\\n \\"ClusterName\\": \\"ack-cluster-name\\",\\n \\"VpcId\\": \\"vpc-j6cvhdscntzuvr0x****\\",\\n \\"Ttl\\": 30,\\n \\"PrimaryVswitchId\\": \\"vsw-2zerfbbje7dvnbii2****\\",\\n \\"PrimaryVswitchZoneId\\": \\"cn-beijing-g\\",\\n \\"PrimaryVswitchIp\\": \\"10.100.1.1\\",\\n \\"StandbyVswitchId\\": \\"vsw-2ze2gtlfozrab01cfo****\\",\\n \\"StandbyVswitchZoneId\\": \\"cn-beijing-h\\",\\n \\"StandbyVswitchIp\\": \\"10.100.2.1\\",\\n \\"ConnectorStatus\\": \\"ready\\",\\n \\"ConnectorHealthCheckStatus\\": \\"healthy\\",\\n \\"UnhealthyReason\\": \\"The ACK cluster status is unavailable.\\",\\n \\"CreateTime\\": \\"1724982259\\"\\n },\\n \\"RequestId\\": \\"45E2E720-D2B4-506F-B682-1FCBE971****\\"\\n}","type":"json"}]', + ], + 'DescribeAckClusterNamespaces' => [ + 'summary' => '查询阿里云K8S容器服务（ACK）集群命名空间', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfw0T2ZBS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ConnectorId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckNamespaces' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '133173B9-8010-5DF5-8B93-********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAckClusterQueryClusterNamespace', + 'errorMessage' => 'Failed to query cluster namespaces.', + ], + [ + 'errorCode' => 'ErrorAckClusterNotFound', + 'errorMessage' => 'The specified resource ACK cluster is not found.', + ], + [ + 'errorCode' => 'ErrorAckNotOpen', + 'errorMessage' => 'ACK service is not open.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ErrorAckClusterConnectorNotFound', + 'errorMessage' => 'The specified resource ACK cluster connector is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AckNamespaces\\": [\\n \\"default\\"\\n ],\\n \\"RequestId\\": \\"133173B9-8010-5DF5-8B93-********\\"\\n}","type":"json"}]', + ], + 'DescribeAckClusterPodLabels' => [ + 'summary' => '查询阿里云K8S容器服务（ACK）集群标签', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfw0T2ZBS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ConnectorId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckLabels' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'app', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'storage-operator', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6169C0A4-B91A-5D48-AE4D-B9432D15****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ErrorAckClusterConnectorNotFound', + 'errorMessage' => 'The specified resource ACK cluster connector is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AckLabels\\": [\\n {\\n \\"Key\\": \\"app\\",\\n \\"Value\\": \\"storage-operator\\"\\n }\\n ],\\n \\"RequestId\\": \\"6169C0A4-B91A-5D48-AE4D-B9432D15****\\"\\n}","type":"json"}]', + ], + 'CreateAckClusterConnector' => [ + 'summary' => '创建ACK集群连接器', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfwC140SS', + 'FEATUREcfw0T2ZBS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ConnectorName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ack-cluster-connector-name', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cb0f5640b1b2d404cad6ba21509d7847b', + ], + ], + [ + 'name' => 'PrimaryVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + ], + [ + 'name' => 'PrimaryVswitchIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.1.1', + ], + ], + [ + 'name' => 'StandbyVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + ], + [ + 'name' => 'StandbyVswitchIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.2.1', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckClusterConnector' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + 'ConnectorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ack-cluster-connector-name', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '135809047715****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cb0f5640b1b2d404cad6ba21509d7847b', + ], + 'ClusterName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ack-cluster-name', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + 'PrimaryVswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + 'PrimaryVswitchZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'PrimaryVswitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.100.1.1', + ], + 'StandbyVswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + 'StandbyVswitchZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'StandbyVswitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.100.2.1', + ], + 'Ttl' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ConnectorStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '', + 'deleting' => '', + 'ready' => '', + ], + 'example' => 'ready', + ], + 'ConnectorHealthCheckStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '', + 'healthy' => '', + 'unhealthy' => '', + ], + 'example' => 'healthy', + ], + 'AckClientHostIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.40.32.240', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'task-c92d4544ef7b6a42', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1724982259', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '0DC783F1-B3A7-578D-8A63-*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorVSwitchAndPrivateIpAddressMismatched', + 'errorMessage' => 'The vSwitch and privateIpAddress are mismatched.', + ], + [ + 'errorCode' => 'ErrorAckClusterNotFound', + 'errorMessage' => 'The specified resource ACK cluster is not found.', + ], + [ + 'errorCode' => 'ErrorAckClusterConnectorReverseEndpointIpNotAllocated', + 'errorMessage' => 'The IP is already allocated, failed to create reverse endpoint.', + ], + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorRegionNo', + 'errorMessage' => 'regionNo error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorVswitchNoAvailableIP', + 'errorMessage' => 'the vswitch has no available ip.', + ], + [ + 'errorCode' => 'ErrorVswitchNotFound', + 'errorMessage' => 'vswitch not found', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorAckClusterNetworkOnlySupportTerway', + 'errorMessage' => 'The ACK cluster network only support Terway.', + ], + [ + 'errorCode' => 'ErrorAckVpcAndVSwitchVpcMismatched', + 'errorMessage' => 'The ACK VPC and vSwitch VPC are mismatched.', + ], + [ + 'errorCode' => 'ErrorPrimaryStandbyVswitchSameZone', + 'errorMessage' => 'The primary and standby vSwitch are in the same availability zone.', + ], + [ + 'errorCode' => 'ErrorAckClusterSpecOnlySupportAckPro', + 'errorMessage' => 'The ACK cluster spec only support ack.pro.small.', + ], + [ + 'errorCode' => 'ErrorAckClusterConnectorQuotaExceeded', + 'errorMessage' => 'ACK cluster connector resource exceeds the quota limit.', + ], + [ + 'errorCode' => 'ErrorAckNotOpen', + 'errorMessage' => 'ACK service is not open.', + ], + [ + 'errorCode' => 'ErrorAckClusterConnectorExist', + 'errorMessage' => 'The ACK cluster connector already exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AckClusterConnector\\": {\\n \\"ConnectorId\\": \\"ac-7c1bad6c3cc84c33baab\\",\\n \\"ConnectorName\\": \\"ack-cluster-connector-name\\",\\n \\"MemberUid\\": \\"135809047715****\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"ClusterId\\": \\"cb0f5640b1b2d404cad6ba21509d7847b\\",\\n \\"ClusterName\\": \\"ack-cluster-name\\",\\n \\"VpcId\\": \\"vpc-j6cvhdscntzuvr0x****\\",\\n \\"PrimaryVswitchId\\": \\"vsw-2zerfbbje7dvnbii2****\\",\\n \\"PrimaryVswitchZoneId\\": \\"cn-hangzhou-g\\",\\n \\"PrimaryVswitchIp\\": \\"10.100.1.1\\",\\n \\"StandbyVswitchId\\": \\"vsw-2ze2gtlfozrab01cfo****\\",\\n \\"StandbyVswitchZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StandbyVswitchIp\\": \\"10.100.2.1\\",\\n \\"Ttl\\": 30,\\n \\"ConnectorStatus\\": \\"ready\\",\\n \\"ConnectorHealthCheckStatus\\": \\"healthy\\",\\n \\"AckClientHostIp\\": \\"10.40.32.240\\",\\n \\"TaskId\\": \\"task-c92d4544ef7b6a42\\",\\n \\"CreateTime\\": \\"1724982259\\"\\n },\\n \\"RequestId\\": \\"0DC783F1-B3A7-578D-8A63-*****\\"\\n}","type":"json"}]', + ], + 'UpdateAckClusterConnector' => [ + 'summary' => '修改ACK集群连接器', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfw0T2ZBS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ConnectorId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + [ + 'name' => 'ConnectorName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-cluster-connector-name', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckClusterConnector' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + 'ConnectorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ack-cluster-connector-name', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '135809047715****'."\n", + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c57ecf39ff32c415e8549a7df27a7e947', + ], + 'ClusterName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ack-cluster-name', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + 'PrimaryVswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + 'PrimaryVswitchZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-g', + ], + 'PrimaryVswitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.100.1.1', + ], + 'StandbyVswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + 'StandbyVswitchZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + 'StandbyVswitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.100.2.1', + ], + 'Ttl' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ConnectorStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '', + 'deleting' => '', + 'ready' => '', + ], + 'example' => 'ready', + ], + 'ConnectorHealthCheckStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '', + 'healthy' => '', + 'unhealthy' => '', + ], + 'example' => 'healthy', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1724982259', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '5D16AADE-DA2E-5CAB-AA3B-AA197D97****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid is invalid.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorAckClusterConnectorStatusNotAllowOperate', + 'errorMessage' => 'The ACK cluster connector status is not allow operate.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ErrorAckClusterConnectorNotFound', + 'errorMessage' => 'The specified resource ACK cluster connector is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AckClusterConnector\\": {\\n \\"ConnectorId\\": \\"ac-7c1bad6c3cc84c33baab\\",\\n \\"ConnectorName\\": \\"ack-cluster-connector-name\\",\\n \\"MemberUid\\": \\"135809047715****\\\\n\\",\\n \\"RegionNo\\": \\"cn-beijing\\",\\n \\"ClusterId\\": \\"c57ecf39ff32c415e8549a7df27a7e947\\",\\n \\"ClusterName\\": \\"ack-cluster-name\\",\\n \\"VpcId\\": \\"vpc-j6cvhdscntzuvr0x****\\",\\n \\"PrimaryVswitchId\\": \\"vsw-2zerfbbje7dvnbii2****\\",\\n \\"PrimaryVswitchZoneId\\": \\"cn-beijing-g\\",\\n \\"PrimaryVswitchIp\\": \\"10.100.1.1\\",\\n \\"StandbyVswitchId\\": \\"vsw-2ze2gtlfozrab01cfo****\\",\\n \\"StandbyVswitchZoneId\\": \\"cn-beijing-h\\",\\n \\"StandbyVswitchIp\\": \\"10.100.2.1\\",\\n \\"Ttl\\": 30,\\n \\"ConnectorStatus\\": \\"ready\\",\\n \\"ConnectorHealthCheckStatus\\": \\"healthy\\",\\n \\"CreateTime\\": \\"1724982259\\"\\n },\\n \\"RequestId\\": \\"5D16AADE-DA2E-5CAB-AA3B-AA197D97****\\"\\n}","type":"json"}]', + ], + 'DeleteAckClusterConnector' => [ + 'summary' => '删除ACK集群连接器', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '231709', + 'abilityTreeNodes' => [ + 'FEATUREcfw0T2ZBS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ConnectorId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '133173B9-8010-5DF5-8B93-********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorAckClusterConnectorAddressGroupReference', + 'errorMessage' => 'The ACK cluster connector has address group, can not be deleted.', + ], + [ + 'errorCode' => 'ErrorAckClusterConnectorStatusNotAllowOperate', + 'errorMessage' => 'The ACK cluster connector status is not allow operate.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ErrorAckClusterConnectorNotFound', + 'errorMessage' => 'The specified resource ACK cluster connector is not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"133173B9-8010-5DF5-8B93-********\\"\\n}","type":"json"}]', + ], + 'DescribePrivateDnsEndpointList' => [ + 'summary' => '查询私网DNS终端节点列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226267', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'AccessInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'PageNo', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AccessInstanceList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1379490574415****', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1844802493****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FirewallType' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' "internet",'."\n" + .' "vpc",'."\n" + .' "nat"'."\n" + .']', + ], + ], + 'AccessInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'AccessInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PrivateDnsType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Custom', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-2zelphbaourpun****', + ], + 'PrimaryDns' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'StandbyDns' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.1.2', + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + 'IpProtocol' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'tcp', + ], + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'normal', + ], + 'DomainNameCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1715075765', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090****\\",\\n \\"TotalCount\\": 3,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"AccessInstanceList\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"MemberUid\\": 0,\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"FirewallType\\": [\\n \\"[\\\\n \\\\\\"internet\\\\\\",\\\\n \\\\\\"vpc\\\\\\",\\\\n \\\\\\"nat\\\\\\"\\\\n]\\"\\n ],\\n \\"AccessInstanceId\\": \\"123\\",\\n \\"AccessInstanceName\\": \\"test\\",\\n \\"PrivateDnsType\\": \\"Custom\\",\\n \\"VpcId\\": \\"vpc-2zelphbaourpun****\\",\\n \\"PrimaryDns\\": \\"1.1.1.1\\",\\n \\"StandbyDns\\": \\"1.1.1.2\\",\\n \\"Port\\": 443,\\n \\"IpProtocol\\": 0,\\n \\"Status\\": 0,\\n \\"DomainNameCount\\": 3,\\n \\"TaskId\\": \\"123\\",\\n \\"GmtCreate\\": 1715075765\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribePrivateDnsEndpointDetail' => [ + 'summary' => '查询私网DNS终端节点详情', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226302', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '4E7F94C7-781F-5192-86CF-DB0850****', + ], + 'AliUid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '119898001566xxxx', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '258039427902****', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FirewallType' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '['."\n" + .' "internet",'."\n" + .' "vpc",'."\n" + .' "nat"'."\n" + .']', + ], + ], + 'AccessInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pd-12345', + ], + 'AccessInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PrivateDnsType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Custom', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-uf6b5lyul0x******', + ], + 'PrimaryVSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-8vbno9zxz8j9qiot****', + ], + 'PrimaryZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen-d', + ], + 'PrimaryVSwitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.1.1.1', + ], + 'StandbyVSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-8vb6jk75wfcwnuq****', + ], + 'StandbyZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen-e', + ], + 'StandbyVSwitchIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.1.1.2', + ], + 'PrimaryDns' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'StandbyDns' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.1.2', + ], + 'Port' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'IpProtocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tcp', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'normal', + ], + 'EndpointId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ep-1nmi412c28c374****', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '132', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1715075765', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E7F94C7-781F-5192-86CF-DB0850****\\",\\n \\"AliUid\\": 0,\\n \\"MemberUid\\": 0,\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"FirewallType\\": [\\n \\"[\\\\n \\\\\\"internet\\\\\\",\\\\n \\\\\\"vpc\\\\\\",\\\\n \\\\\\"nat\\\\\\"\\\\n]\\"\\n ],\\n \\"AccessInstanceId\\": \\"pd-12345\\",\\n \\"AccessInstanceName\\": \\"测试\\",\\n \\"PrivateDnsType\\": \\"Custom\\",\\n \\"VpcId\\": \\"vpc-uf6b5lyul0x******\\",\\n \\"PrimaryVSwitchId\\": \\"vsw-8vbno9zxz8j9qiot****\\",\\n \\"PrimaryZoneId\\": \\"cn-shenzhen-d\\",\\n \\"PrimaryVSwitchIp\\": \\"10.1.1.1\\",\\n \\"StandbyVSwitchId\\": \\"vsw-8vb6jk75wfcwnuq****\\",\\n \\"StandbyZoneId\\": \\"cn-shenzhen-e\\",\\n \\"StandbyVSwitchIp\\": \\"10.1.1.2\\",\\n \\"PrimaryDns\\": \\"1.1.1.1\\",\\n \\"StandbyDns\\": \\"1.1.1.2\\",\\n \\"Port\\": 80,\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"Status\\": \\"normal\\",\\n \\"EndpointId\\": \\"ep-1nmi412c28c374****\\",\\n \\"TaskId\\": \\"132\\",\\n \\"GmtCreate\\": 1715075765\\n}","type":"json"}]', + ], + 'DescribePrivateDnsStatistics' => [ + 'summary' => '查询私有DNS的统计信息', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainNameCreatedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1725864531', + ], + ], + [ + 'name' => 'DomainNameCreatedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1726305596', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'AbnormalPrivateDnsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'CreatedPrivateDnsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'DomainNameTotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'NewDomainNameTotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NormalPrivateDnsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'PrivateDnsRegionList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DomainNameCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'NewDomainNameCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PrivateDnsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '5716ED52-1B82-5DE1-8695-EFEC453D****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AbnormalPrivateDnsCount\\": 12,\\n \\"CreatedPrivateDnsCount\\": 6,\\n \\"DomainNameTotalCount\\": 5,\\n \\"NewDomainNameTotalCount\\": 2,\\n \\"NormalPrivateDnsCount\\": 21,\\n \\"PrivateDnsRegionList\\": [\\n {\\n \\"DomainNameCount\\": 10,\\n \\"NewDomainNameCount\\": 1,\\n \\"PrivateDnsCount\\": 1,\\n \\"RegionNo\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"RequestId\\": \\"5716ED52-1B82-5DE1-8695-EFEC453D****\\"\\n}","type":"json"}]', + ], + 'CreatePrivateDnsEndpoint' => [ + 'summary' => '创建私网DNS终端节点', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226205', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'PrivateDnsType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'PrimaryVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6b0dkyryer8******'."\n", + ], + ], + [ + 'name' => 'StandbyVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-8vb6jk75wfcwn******'."\n", + ], + ], + [ + 'name' => 'PrimaryVSwitchIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.1.1.1'."\n", + ], + ], + [ + 'name' => 'StandbyVSwitchIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.2.2.2', + ], + ], + [ + 'name' => 'IpProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'UDP', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewall', + ], + 'required' => true, + 'maxItems' => 3, + 'minItems' => 1, + ], + ], + [ + 'name' => 'PrimaryDns', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1', + ], + ], + [ + 'name' => 'StandbyDns', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.2', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '850A84D6************00090125EEB1', + ], + 'AccessInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pd-12345', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '132', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorPrivateDnsType', + 'errorMessage' => 'private dns type error.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsPrivateZoneConfigure', + 'errorMessage' => 'private dns parameter error.', + ], + [ + 'errorCode' => 'ErrorVswitchId', + 'errorMessage' => 'vswitch id error.', + ], + [ + 'errorCode' => 'ErrorVswitchIpAddress', + 'errorMessage' => 'vswitch ip error.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsIpAddress', + 'errorMessage' => 'private dns ip address error.', + ], + [ + 'errorCode' => 'ErrorVswitchNoAvailableIP', + 'errorMessage' => 'the vswitch has no available ip.', + ], + [ + 'errorCode' => 'ErrorVfwVpcNoAvailable', + 'errorMessage' => 'the vpc is cloud firewall vpc, please reselect vpc.', + ], + [ + 'errorCode' => 'ErrorProxyVswitchNoAvailable', + 'errorMessage' => 'the vswitch is cloud firewall vswitch, please reselect vswitch.', + ], + [ + 'errorCode' => 'ErrorFirewallTypeDuplicates', + 'errorMessage' => 'firewallType duplicates.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsIpSame', + 'errorMessage' => 'the primary and backup DNS IP cannot be the same.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsEndpointQuotaExceeded', + 'errorMessage' => 'Private DNS endpoint resource exceeds the quota limit.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6************00090125EEB1\\",\\n \\"AccessInstanceId\\": \\"pd-12345\\",\\n \\"TaskId\\": \\"132\\"\\n}","type":"json"}]', + ], + 'ModifyPrivateDnsEndpoint' => [ + 'summary' => '修改私网DNS终端节点', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226261', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'PrivateDnsType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'PrimaryDns', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1', + ], + ], + [ + 'name' => 'StandbyDns', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.2', + ], + ], + [ + 'name' => 'AccessInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '6B780BD6-282C-51A9-A8E6-59F636BAFA54', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorPrivateDnsNotFound', + 'errorMessage' => 'private dns not found.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsIpAddress', + 'errorMessage' => 'private dns ip address error.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsIpSame', + 'errorMessage' => 'the primary and backup DNS IP cannot be the same.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B780BD6-282C-51A9-A8E6-59F636BAFA54\\"\\n}","type":"json"}]', + ], + 'DeletePrivateDnsEndpoint' => [ + 'summary' => '删除私网DNS终端节点', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226262', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '822B9125-6E1A-551C-8EAF-6E7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorPrivateDnsOperationDenied', + 'errorMessage' => 'private dns operation is not allowed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"822B9125-6E1A-551C-8EAF-6E7****\\"\\n}","type":"json"}]', + ], + 'DescribePrivateDnsDomainNameList' => [ + 'summary' => '查询私网DNS域名列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226316', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageNo', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '822B9125-6E1A-551C-8EAF-6E7AE74****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DomainNameList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[\\"example.com\\"]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsNotFound', + 'errorMessage' => 'private dns not found.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsRegionNotAvailable', + 'errorMessage' => 'private dns region not available.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"822B9125-6E1A-551C-8EAF-6E7AE74****\\",\\n \\"TotalCount\\": 132,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"DomainNameList\\": [\\n \\"[\\\\\\\\\\\\\\"example.com\\\\\\\\\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + ], + 'AddPrivateDnsDomainName' => [ + 'summary' => '添加私网DNS域名', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226307', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cfw-xxx', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'DomainNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "internal.xxx.com",'."\n" + .' "api.xxx.com"'."\n" + .' ]', + ], + 'required' => true, + 'maxItems' => 1000, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorPrivateDnsNotFound', + 'errorMessage' => 'private dns not found.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsDomainName', + 'errorMessage' => 'private dns domain name error.', + ], + [ + 'errorCode' => 'ErrorPrivateDnsDomainNameMaxLimit', + 'errorMessage' => 'the number of private DNS domain names exceeds the maximum limit.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\"\\n}","type":"json"}]', + ], + 'DeletePrivateDnsDomainName' => [ + 'summary' => '删除私网DNS域名', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226315', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"example.com\\"]', + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-0009012****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorPrivateDnsDomainName', + 'errorMessage' => 'private dns domain name error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-0009012****\\"\\n}","type":"json"}]', + ], + 'DeletePrivateDnsAllDomainName' => [ + 'summary' => '清空私网DNS域名', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226320', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccessInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF****\\"\\n}","type":"json"}]', + ], + 'DescribeLogStoreInfo' => [ + 'summary' => 'Get Log Service Information', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68305', + 'abilityTreeNodes' => [ + 'FEATUREcfwQ1YIKB', + 'FEATUREcfwG8G31D', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ttl' => [ + 'description' => 'Log storage duration. Unit: days.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '日志存储时长。单位：天。', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => 'C6C3B72B********E95FB0A161', + 'title' => '本次请求的id。', + ], + 'Quota' => [ + 'description' => 'Available log storage capacity. Unit: Byte.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000000', + 'title' => '存储容量阈值,单位字节。', + ], + 'ProjectName' => [ + 'description' => 'The Project name of the log service.', + 'type' => 'string', + 'example' => 'project-xxx-cn-hangzhou', + 'title' => '日志服务project的名称。', + ], + 'LogStoreName' => [ + 'description' => 'The name of the SLS LogStore in the log service.', + 'type' => 'string', + 'example' => 'xxx-logstore', + 'title' => '日志服务的logStore名称。', + ], + 'Used' => [ + 'description' => 'Used storage capacity. Unit: Byte.'."\n" + ."\n" + .'> The statistics of the log service have a delay of approximately two hours.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '已使用的日志分析容量。', + ], + 'RegionId' => [ + 'description' => 'The region ID for log delivery.', + 'type' => 'string', + 'example' => 'cn-shanghai', + 'title' => '日志投递的地域ID。', + ], + 'InfoList' => [ + 'title' => '信息列表。', + 'type' => 'array', + 'items' => [ + 'title' => '信息列表。', + 'type' => 'object', + 'properties' => [ + 'Ttl' => [ + 'title' => '日志存储时长。单位：天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'Quota' => [ + 'title' => '存储容量阈值,单位字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000000', + ], + 'ProjectName' => [ + 'title' => '日志服务的Project名称。', + 'type' => 'string', + 'example' => 'cloudfirewall-project-14151892848****-cn-hangzhou', + ], + 'LogStoreName' => [ + 'title' => '日志服务的logStore名称。', + 'type' => 'string', + 'example' => 'xxx-logstore', + ], + 'Used' => [ + 'title' => '已存储的日志量，单位：Byte（字节）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21852955752', + ], + 'MaxSplitShard' => [ + 'title' => '弹性扩展shard数目可以支持的最大值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Shard' => [ + 'title' => '当前已经使用的shard数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RegionId' => [ + 'title' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'Site' => [ + 'title' => '该logStore所属的站点。cn：中国内地、intl：非中国内地。', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + 'LogVersion' => [ + 'title' => '日志版本。1:代表有1个logStore，2:代表有两个logStore。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalQuota' => [ + 'title' => '用户购买的日志存储的总容量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000000', + ], + 'LogModifyQuota' => [ + 'title' => '用户可以进行日志模式切换的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TaskId' => [ + 'title' => '任务ID。', + 'type' => 'string', + 'example' => '用户进行日志修改所产生的任务id。', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ttl\\": 20,\\n \\"RequestId\\": \\"C6C3B72B********E95FB0A161\\",\\n \\"Quota\\": 50000000,\\n \\"ProjectName\\": \\"project-xxx-cn-hangzhou\\",\\n \\"LogStoreName\\": \\"xxx-logstore\\",\\n \\"Used\\": 0,\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"InfoList\\": [\\n {\\n \\"Ttl\\": 180,\\n \\"Quota\\": 50000000,\\n \\"ProjectName\\": \\"cloudfirewall-project-14151892848****-cn-hangzhou\\",\\n \\"LogStoreName\\": \\"xxx-logstore\\",\\n \\"Used\\": 21852955752,\\n \\"MaxSplitShard\\": 4,\\n \\"Shard\\": 2,\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"Site\\": \\"cn\\"\\n }\\n ],\\n \\"LogVersion\\": 2,\\n \\"TotalQuota\\": 50000000,\\n \\"LogModifyQuota\\": 2,\\n \\"TaskId\\": \\"用户进行日志修改所产生的任务id。\\"\\n}","type":"json"}]', + 'title' => 'Get Log Service Information', + 'translator' => 'machine', + ], + 'DescribeTrafficLog' => [ + 'summary' => '查询日志', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68392', + 'abilityTreeNodes' => [ + 'FEATUREcfwQ1YIKB', + 'FEATUREcfwG8G31D', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '139.217.234.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1730946241', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1742926322', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8b115ae3-da64-4b80-81c1-1cd2dd42****', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '182.92.206.XXX', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.68.60.XXX', + ], + ], + [ + 'name' => 'SrcPrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.134.XX', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'in' => '', + 'out' => '', + ], + 'example' => 'out', + ], + ], + [ + 'name' => 'AssetRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RuleResult', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'IpProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'icmp', + ], + ], + [ + 'name' => 'SrcPort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8082', + ], + ], + [ + 'name' => 'DstPort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '9876', + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + '', + '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'RuleSource', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'VulLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '', + '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'Isp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'FlowType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'UnidirectionalFlow' => '', + 'BidirectionalFlow' => '', + ], + 'example' => 'All', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DnsFirewall' => '', + 'VpcFirewall' => '', + 'InternetFirewall' => '', + ], + 'example' => 'VpcFirewall', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'SrcVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9309pkwe06lv****tk4', + ], + ], + [ + 'name' => 'DstVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz95m1aq9b0h****vk1yb', + ], + ], + [ + 'name' => 'SrcVpcRegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DstVpcRegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'DomainUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 4 => 'IPv4', + 6 => 'IPv6', + ], + 'example' => '4', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '128599825273****', + ], + ], + [ + 'name' => 'NatFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-7a9c8901ed394****', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-2zew6yn017hhzbm****', + ], + ], + [ + 'name' => 'AclPreState', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'AclPreRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '00000000-0000-0000-0000-000000000000', + ], + ], + [ + 'name' => 'AppDpiState', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'TlsScopeId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'tis-98fd64c5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '633D92D1-768A-547F-8ADC-2870CF0A99F6', + ], + 'PageInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'in', + ], + 'AttackType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 1 => '', + '', + '', + '', + '', + ], + 'example' => '0', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '14151892****7022', + ], + 'CountryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'US', + ], + 'DstPort' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'SrcPrivateIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '172.16.101.7', + ], + 'IpProtocol' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tcp', + ], + 'DomainName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aliyun.com', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-000000000000', + ], + 'AppName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'AttackApp' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'WebLogic', + ], + 'PacketCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23', + ], + 'AppId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RuleResult' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'pass', + ], + 'Ext' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'DstIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2.2.2.2', + ], + 'PacketBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '355', + ], + 'InBytes' => [ + 'description' => '', + 'type' => 'string', + 'example' => '125', + ], + 'IspId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '50075069', + ], + 'Isp' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FOP Dmytro Nedilskyi', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SrcPort' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20206', + ], + 'RuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1751423363', + ], + 'VpcFirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-4045ca7***', + ], + 'CityId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FI', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1751423362', + ], + 'CloseReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tcp_fin', + ], + 'OutBytes' => [ + 'description' => '', + 'type' => 'string', + 'example' => '230', + ], + 'VulLevel' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleSource' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'OutPackets' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11', + ], + 'InPackets' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12', + ], + 'SrcIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'Location' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'DomainUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx.com', + ], + 'CloudInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-*', + ], + 'AclPreState' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'normal', + ], + 'AclPreRuleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'AclPreRuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'AppDpiState' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Rules' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sharepoint', + ], + 'RuleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '17', + ], + ], + ], + ], + 'SrcVpc' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-8vba1c1em97h0ji71****', + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'yi-vpc', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + 'DstVpc' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-8vba1c1em97h0ji71b****', + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'yi-vpc', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'PrivateIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '172.21.234.XXX', + ], + 'PrivatePort' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'TlsRuleId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tir-xxx', + ], + 'TlsRuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'TlsScopeId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tls-xxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorAliUidBlackList', + 'errorMessage' => 'The specified aliUid is invalid.', + ], + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorTrafficSlsFirewallType', + 'errorMessage' => 'The firewall type of traffic log is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorPortError', + 'errorMessage' => 'The port is invalid.', + ], + [ + 'errorCode' => 'ErrorIpProtocolError', + 'errorMessage' => 'The protocol is invalid.', + ], + [ + 'errorCode' => 'ErrorDirectionError', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorAttackTypeError', + 'errorMessage' => 'The attack type is invalid.', + ], + [ + 'errorCode' => 'ErrorVulLevelFailed', + 'errorMessage' => 'VulLevel has failed.', + ], + [ + 'errorCode' => 'ErrorRuleResultError', + 'errorMessage' => 'The rule result is invalid.', + ], + [ + 'errorCode' => 'ErrorAppIdError', + 'errorMessage' => 'An app ID error occurred.', + ], + [ + 'errorCode' => 'ErrorFlowType', + 'errorMessage' => 'The flow type is invalid.', + ], + [ + 'errorCode' => 'ErrorIspError', + 'errorMessage' => 'The ISP name is invalid.', + ], + [ + 'errorCode' => 'ErrorLocationError', + 'errorMessage' => 'The location name is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainName', + 'errorMessage' => 'The domain name is invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorSLSLogStore', + 'errorMessage' => 'Failed to get SLS logstore.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"633D92D1-768A-547F-8ADC-2870CF0A99F6\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2\\n },\\n \\"DataList\\": [\\n {\\n \\"Direction\\": \\"in\\",\\n \\"AttackType\\": 0,\\n \\"MemberUid\\": \\"14151892****7022\\",\\n \\"CountryId\\": \\"US\\",\\n \\"DstPort\\": 80,\\n \\"SrcPrivateIP\\": \\"172.16.101.7\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"DomainName\\": \\"aliyun.com\\",\\n \\"RuleId\\": \\"00000000-0000-0000-0000-000000000000\\",\\n \\"AppName\\": \\"HTTP\\",\\n \\"AttackApp\\": \\"WebLogic\\",\\n \\"PacketCount\\": 23,\\n \\"AppId\\": 6,\\n \\"RuleResult\\": 0,\\n \\"Ext\\": \\"无\\",\\n \\"DstIP\\": \\"2.2.2.2\\",\\n \\"PacketBytes\\": 355,\\n \\"InBytes\\": \\"125\\",\\n \\"IspId\\": \\"50075069\\",\\n \\"Isp\\": \\"FOP Dmytro Nedilskyi\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SrcPort\\": 20206,\\n \\"RuleName\\": \\"test\\",\\n \\"EndTime\\": 1751423363,\\n \\"VpcFirewallId\\": \\"vfw-4045ca7***\\",\\n \\"CityId\\": \\"FI\\",\\n \\"StartTime\\": 1751423362,\\n \\"CloseReason\\": \\"tcp_fin\\",\\n \\"OutBytes\\": \\"230\\",\\n \\"VulLevel\\": 0,\\n \\"RuleSource\\": \\"0\\",\\n \\"OutPackets\\": \\"11\\",\\n \\"InPackets\\": \\"12\\",\\n \\"SrcIP\\": \\"1.1.1.1\\",\\n \\"Location\\": \\"杭州\\",\\n \\"DomainUrl\\": \\"xxx.com\\",\\n \\"CloudInstanceId\\": \\"ngw-*\\",\\n \\"AclPreState\\": \\"normal\\",\\n \\"AclPreRuleId\\": \\"2\\",\\n \\"AclPreRuleName\\": \\"test\\",\\n \\"AppDpiState\\": \\"success\\",\\n \\"Rules\\": [\\n {\\n \\"RuleName\\": \\"sharepoint\\",\\n \\"RuleId\\": \\"17\\"\\n }\\n ],\\n \\"SrcVpc\\": {\\n \\"VpcId\\": \\"vpc-8vba1c1em97h0ji71****\\",\\n \\"VpcName\\": \\"yi-vpc\\",\\n \\"RegionNo\\": \\"cn-beijing\\"\\n },\\n \\"DstVpc\\": {\\n \\"VpcId\\": \\"vpc-8vba1c1em97h0ji71b****\\",\\n \\"VpcName\\": \\"yi-vpc\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\"\\n },\\n \\"PrivateIp\\": \\"172.21.234.XXX\\",\\n \\"PrivatePort\\": 80,\\n \\"TlsRuleId\\": \\"tir-xxx\\",\\n \\"TlsRuleName\\": \\"test\\",\\n \\"TlsScopeId\\": \\"tls-xxx\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSlsAnalyzeOpenStatus' => [ + 'summary' => '获取SLS开启状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68367', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OpenStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6CC01A2B-92FB-535C-9415-9A951C20****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OpenStatus\\": \\"false\\",\\n \\"RequestId\\": \\"6CC01A2B-92FB-535C-9415-9A951C20****\\"\\n}","type":"json"}]', + ], + 'DescribeClearAuthInfo' => [ + 'summary' => '获取清空授权信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68232', + 'abilityTreeNodes' => [ + 'FEATUREcfwE8FJHT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1755964800', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8DDEE254-5639-5548-82D1-AAAC7347****', + ], + 'LeftTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": 1755964800,\\n \\"RequestId\\": \\"8DDEE254-5639-5548-82D1-AAAC7347****\\",\\n \\"LeftTimes\\": 20\\n}","type":"json"}]', + ], + 'DescribeLocationInfo' => [ + 'summary' => '获取位置信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68303', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '180.169.141.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CD3BE433-FAB0-55D8-918A-69B306****', + ], + 'CnCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '340', + ], + 'OverseasCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '238', + ], + 'OverseasList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LocId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'US', + ], + 'LocName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'CnList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LocId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3301', + ], + 'LocName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'CnProvinceList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ProvinceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Cities' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LocId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'LocName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3BE433-FAB0-55D8-918A-69B306****\\",\\n \\"CnCount\\": 340,\\n \\"OverseasCount\\": 238,\\n \\"OverseasList\\": [\\n {\\n \\"LocId\\": \\"US\\",\\n \\"LocName\\": \\"美国\\"\\n }\\n ],\\n \\"CnList\\": [\\n {\\n \\"LocId\\": \\"3301\\",\\n \\"LocName\\": \\"杭州市\\"\\n }\\n ],\\n \\"CnProvinceList\\": [\\n {\\n \\"ProvinceName\\": \\"浙江\\",\\n \\"Cities\\": [\\n {\\n \\"LocId\\": \\"123\\",\\n \\"LocName\\": \\"杭州。\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeIspInfo' => [ + 'summary' => '获取ISP信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68302', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '39.91.37.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IspId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'isp-dhyw2lxfpc****', + ], + 'IspName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5,\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"DataList\\": [\\n {\\n \\"IspId\\": 0,\\n \\"IspName\\": \\"电信\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCreatedNatFirewall' => [ + 'summary' => '获取已经创建的 NAT 防火墙', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '116773', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '121.225.255.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '072B5287-8A85-529E-BD47-F8AC2DB1****', + ], + 'CreatedNatFirewalls' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NatFirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cfw-adk2ad45sf4t8****', + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-uf6i0zkjtz4t2sttf****', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-text', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"072B5287-8A85-529E-BD47-F8AC2DB1****\\",\\n \\"CreatedNatFirewalls\\": [\\n {\\n \\"NatFirewallId\\": \\"cfw-adk2ad45sf4t8****\\",\\n \\"NatGatewayId\\": \\"ngw-uf6i0zkjtz4t2sttf****\\",\\n \\"NatGatewayName\\": \\"ngw-text\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeBatchSlsDispatchStatus' => [ + 'summary' => '获取日志分发状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68214', + 'abilityTreeNodes' => [ + 'FEATUREcfwQ1YIKB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + 'title' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + 'title' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7036EBAB-F85F-5AAE-976F-C75AEE59****', + 'title' => '返回结果的请求id。', + ], + 'LogstoreName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rs-stats', + 'title' => '日志服务的logStore名称。', + ], + 'ProjectName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cloudfirewallnew-project-199053910542****-cn-hangzhou', + 'title' => '日志服务的project。', + ], + 'ItemList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DispatchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '互联网流量日志、VPC流量日志、NAT流量日志', + 'title' => '投递类型中文名称。', + ], + 'DispatchValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'internet_log', + 'title' => '分类日志的key。取值：'."\n" + ."\n" + .'**internet_log**'."\n" + ."\n" + .'**vpc_firewall_log**'."\n" + ."\n" + .'**nat_firewall_log**'."\n" + ."\n" + .'**ipv6_firewall_log**'."\n" + ."\n" + .'**dns_firewall_log**。', + ], + 'SearchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'log_type', + 'title' => '固定为log_type，无需关注。', + ], + 'Enable' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '该投递类型开关情况。', + ], + 'ConfigStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success_finished', + 'title' => '配置状态。', + ], + 'FilterKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'other' => '', + 'attack' => '', + 'acl' => 'ACL', + ], + 'example' => 'attack', + 'title' => '具体字段名称。attack代表攻击事件日志，acl代表访问控制日志，other代表除这两种情况之外的其他日志。', + ], + 'title' => '互联网和VPC的详细投递配置。', + ], + ], + 'title' => '日志投递配置详情。', + ], + 'title' => '日志投递配置详情。', + ], + 'LogVersion' => [ + 'title' => '日志版本，1代表只有1个logStore，2代表有2个。', + 'type' => 'string', + 'example' => '1', + ], + 'InfoList' => [ + 'title' => 'logStore的详细信息列表', + 'type' => 'array', + 'items' => [ + 'title' => '信息列表。', + 'type' => 'object', + 'properties' => [ + 'LogstoreName' => [ + 'title' => '日志服务的logStore名称。', + 'type' => 'string', + 'example' => 'cloudfirewall-logstore', + ], + 'ProjectName' => [ + 'title' => '日志服务的Project名称。', + 'type' => 'string', + 'example' => 'cloudfirewall-project-1204872307283650-cn-hangzhou', + ], + 'ItemList' => [ + 'title' => '日志投递配置详情。', + 'type' => 'array', + 'items' => [ + 'title' => '日志投递配置详情。', + 'type' => 'object', + 'properties' => [ + 'DispatchName' => [ + 'title' => '投递类型中文名称。', + 'type' => 'string', + 'example' => '互联网流量日志、VPC流量日志、NAT流量日志', + ], + 'DispatchValue' => [ + 'title' => '分类日志的key。取值：'."\n" + ."\n" + .'**internet_log**'."\n" + ."\n" + .'**vpc_firewall_log**'."\n" + ."\n" + .'**nat_firewall_log**'."\n" + ."\n" + .'**ipv6_firewall_log**'."\n" + ."\n" + .'**dns_firewall_log**', + 'type' => 'string', + 'example' => 'ipv6_firewall_log', + ], + 'SearchName' => [ + 'title' => '固定为log_type，无需关注。', + 'type' => 'string', + 'example' => 'log_type', + ], + 'Enable' => [ + 'title' => '该投递类型开关情况。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConfigStatus' => [ + 'title' => '配置状态。', + 'type' => 'string', + 'example' => 'success_finished', + ], + 'FilterKeys' => [ + 'title' => '互联网和VPC的详细投递配置。', + 'type' => 'array', + 'items' => [ + 'title' => '具体字段名称。attack代表攻击事件日志，acl代表访问控制日志，other代表除这两种情况之外的其他日志。', + 'type' => 'string', + 'example' => 'attack,other', + ], + ], + ], + ], + ], + 'Site' => [ + 'title' => 'cn代表中国内地，intl代表非中国内地，global代表全球。', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvokeError', + 'errorMessage' => 'Invoke rosttea\'s api failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7036EBAB-F85F-5AAE-976F-C75AEE59****\\",\\n \\"LogstoreName\\": \\"rs-stats\\",\\n \\"ProjectName\\": \\"cloudfirewallnew-project-199053910542****-cn-hangzhou\\",\\n \\"ItemList\\": [\\n {\\n \\"DispatchName\\": \\"互联网流量日志\\",\\n \\"DispatchValue\\": \\"internet_log\\",\\n \\"SearchName\\": \\"log_type\\",\\n \\"Enable\\": true,\\n \\"ConfigStatus\\": \\"success_finished\\",\\n \\"FilterKeys\\": [\\n \\"attack\\"\\n ]\\n }\\n ],\\n \\"LogVersion\\": \\"1\\",\\n \\"InfoList\\": [\\n {\\n \\"LogstoreName\\": \\"cloudfirewall-logstore\\",\\n \\"ProjectName\\": \\"cloudfirewall-project-1204872307283650-cn-hangzhou\\",\\n \\"ItemList\\": [\\n {\\n \\"DispatchName\\": \\"互联网流量日志、VPC流量日志、NAT流量日志\\",\\n \\"DispatchValue\\": \\"ipv6_firewall_log\\",\\n \\"SearchName\\": \\"log_type\\",\\n \\"Enable\\": true,\\n \\"ConfigStatus\\": \\"success_finished\\",\\n \\"FilterKeys\\": [\\n \\"attack,other\\"\\n ]\\n }\\n ],\\n \\"Site\\": \\"cn\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateSlsLogDispatch' => [ + 'summary' => 'Create Cloud Firewall SLS Log Delivery', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214748', + 'abilityTreeNodes' => [ + 'FEATUREcfwG8G31D', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SlsRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID of the Simple Log Service project.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The log retention period. Unit: days.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '850A84D6************00090125EEB1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6************00090125EEB1\\"\\n}","type":"json"}]', + 'title' => 'CreateSlsLogDispatch', + 'translator' => 'machine', + ], + 'ModifySlsDispatchStatus' => [ + 'summary' => '修改SLS投递', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68482', + 'abilityTreeNodes' => [ + 'FEATUREcfwQ1YIKB', + 'FEATUREcfwG8G31D', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EnableStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '投递： true:有效，false:不投递。', + ], + ], + [ + 'name' => 'DispatchValue', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'internet_log', + 'title' => '分类日志的key'."\n" + .'共有以下取值：'."\n" + .'['."\n" + .'"internet_log",'."\n" + .'"vpc_firewall_log",'."\n" + .'"nat_firewall_log",'."\n" + .'"ipv6_firewall_log",'."\n" + .'"dns_firewall_log"'."\n" + .']', + ], + ], + [ + 'name' => 'FilterKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'attack,acl', + 'title' => '查询指定过滤条件的场景。用 ","拼接'."\n" + .'['."\n" + .'"attack.acl,other",'."\n" + .'"attack",'."\n" + .'"acl",'."\n" + .'"other",'."\n" + .'"acl,other"'."\n" + .']。', + ], + ], + [ + 'name' => 'NewRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'title' => '区域。', + ], + ], + [ + 'name' => 'Site', + 'in' => 'query', + 'schema' => [ + 'title' => '这个字段用来指示修改哪个站点，如果日志版本为1，这个字段可以不填，或者global,如果日志版本为2，这个字段必须填，cn或者intl', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CE901E31-4AE9-579D-AC37-D2F1BB43****', + 'title' => '返回结果的请求id。', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => 'Illegal operation, unable to operate within 5 minutes, please try again in 5 minutes.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE901E31-4AE9-579D-AC37-D2F1BB43****\\"\\n}","type":"json"}]', + ], + 'ModifyUserSlsLogStorageTime' => [ + 'summary' => '修改用户日志存储时间', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68491', + 'abilityTreeNodes' => [ + 'FEATUREcfwQ1YIKB', + 'FEATUREcfwG8G31D', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vipcloudfw-cn-uqm3fz****', + 'title' => '云防火墙的id。', + ], + ], + [ + 'name' => 'StorageTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '180', + 'title' => '日志存储时间（单位：天）。可选值：-**0**：最近一天-**30**：最近30天', + ], + ], + [ + 'name' => 'LogVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '日志版本，主要有1（1个logStore）和2（2个logStore）', + 'type' => 'integer', + 'format' => 'int32', + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'SlsRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'SLS地域ID。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '337A4DBA-8A01-5E9C-99CA-84293E13****', + 'title' => '本次请求的id。', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"337A4DBA-8A01-5E9C-99CA-84293E13****\\"\\n}","type":"json"}]', + ], + 'ClearLogStoreStorage' => [ + 'summary' => '清空防火墙日志', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68112', + 'abilityTreeNodes' => [ + 'FEATUREcfwQ1YIKB', + 'FEATUREcfwG8G31D', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Site', + 'in' => 'query', + 'schema' => [ + 'title' => '代表要清空的站点名称，如果只有1个logStore，可以不填，如果有2个logStore，需要填cn或者intl。', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => 'http状态码。', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '21C27710-2DB1-5F2A-8588-72D0541B****', + 'title' => '本次请求的id。', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '返回结果。取值：-**true**：表示成功-**false**：表示失败', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"21C27710-2DB1-5F2A-8588-72D0541B****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DescribeUserAlarmConfig' => [ + 'summary' => '获取用户告警配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68397', + 'abilityTreeNodes' => [ + 'FEATUREcfwHNNY65', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '59.82.135.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9D250177-4F11-58B8-9AFE-A4624FF1****', + ], + 'AlarmConfig' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AlarmPeriod' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'AlarmValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '80', + ], + 'AlarmHour' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AlarmType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'weeklyReport' => 'weeklyReport', + 'trafficPreAlert' => 'trafficPreAlert', + 'outgoingRiskAll' => 'outgoingRiskAll', + 'Middlethreat' => 'Middlethreat', + 'bandwidth' => 'bandwidth', + 'ipsHighthreat' => 'ipsHighthreat', + 'outgoingRiskNonWhite' => 'outgoingRiskNonWhite', + 'ipsIgnoreResolved' => 'ipsIgnoreResolved', + ], + 'example' => 'bandwidth', + ], + 'AlarmNotify' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 'sms/email', + 'sms', + 'email', + 'none', + ], + 'example' => '1', + ], + 'AlarmWeekDay' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'NotifyConfig' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NotifyValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'NotifyType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mail', + ], + ], + ], + ], + 'ContactConfig' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1530811****@qq.com'."\n", + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1531123****', + ], + 'MobilePhone' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'AlarmLang' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + 'DefaultContact' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Email' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1530811****@qq.com', + ], + 'MobilePhone' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1531123****', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'internal error: sql select.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D250177-4F11-58B8-9AFE-A4624FF1****\\",\\n \\"AlarmConfig\\": [\\n {\\n \\"AlarmPeriod\\": 30,\\n \\"AlarmValue\\": \\"80\\",\\n \\"AlarmHour\\": 0,\\n \\"AlarmType\\": \\"bandwidth\\",\\n \\"AlarmNotify\\": 1,\\n \\"AlarmWeekDay\\": 0\\n }\\n ],\\n \\"NotifyConfig\\": [\\n {\\n \\"NotifyValue\\": \\"0\\",\\n \\"NotifyType\\": \\"mail\\"\\n }\\n ],\\n \\"ContactConfig\\": [\\n {\\n \\"Status\\": 1,\\n \\"Email\\": \\"1530811****@qq.com\\\\n\\",\\n \\"Name\\": \\"1531123****\\",\\n \\"MobilePhone\\": \\"张三\\"\\n }\\n ],\\n \\"AlarmLang\\": \\"zh\\",\\n \\"DefaultContact\\": {\\n \\"Name\\": \\"张三\\",\\n \\"Email\\": \\"1530811****@qq.com\\",\\n \\"MobilePhone\\": \\"1531123****\\",\\n \\"Status\\": \\"0\\"\\n }\\n}","type":"json"}]', + ], + 'ModifyUserAlarmConfig' => [ + 'summary' => '修改用户告警配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68489', + 'abilityTreeNodes' => [ + 'FEATUREcfwHNNY65', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '117.129.64.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AlarmConfig', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AlarmValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'on', + ], + 'AlarmType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'weeklyReport' => 'weeklyReport', + 'trafficPreAlert' => 'trafficPreAlert', + 'outgoingRiskAll' => 'outgoingRiskAll', + 'ipsMiddlethreat' => 'ipsMiddlethreat', + 'bandwidth' => 'bandwidth', + 'ipsHighthreat' => 'ipsHighthreat', + 'outgoingRiskNonWhite' => 'outgoingRiskNonWhite', + 'ipsIgnoreResolved' => 'ipsIgnoreResolved', + ], + 'example' => 'bandwidth', + ], + 'AlarmPeriod' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '8:00~20:00', + '', + ], + 'example' => '0', + ], + 'AlarmHour' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'AlarmNotify' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'sms/email', + 'sms', + 'email', + 'none', + ], + 'example' => '0', + ], + 'AlarmWeekDay' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NotifyConfig', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NotifyType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'mail' => 'mail', + 'sms' => 'sms', + ], + 'example' => 'mail', + ], + 'NotifyValue' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1351234****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ContactConfig', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '1', + ], + 'Email' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '91632****@qq.com', + ], + 'MobilePhone' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1351234****'."\n", + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Ben', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AlarmLang', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'UseDefaultContact', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3B168A0F-A43D-5FD0-8059-B51BDD6E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersAlarmConfig', + 'errorMessage' => 'invalid alarmConfig.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorParametersNotifyConfig', + 'errorMessage' => 'invalid notifyConfig.', + ], + [ + 'errorCode' => 'ErrorParamSms', + 'errorMessage' => 'invalid sms number.', + ], + [ + 'errorCode' => 'ErrorParamEmail', + 'errorMessage' => 'invalid email address.', + ], + [ + 'errorCode' => 'ErrorParamCountExceed', + 'errorMessage' => 'sms or email count exceed.', + ], + [ + 'errorCode' => 'ErrorDBDeleteError', + 'errorMessage' => 'A database delete error occurred.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql update.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'internal error: sql insert.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3B168A0F-A43D-5FD0-8059-B51BDD6E****\\"\\n}","type":"json"}]', + ], + 'DescribeInstanceRdAccounts' => [ + 'summary' => '获取实例RD账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68270', + 'abilityTreeNodes' => [ + 'FEATUREcfw98HUGQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.170.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'MemberDisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cloudfirewall_2', + ], + ], + [ + 'name' => 'MemberDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'renewal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '06D1EC07-C9EB-58AC-A750-C87C9A0****', + ], + 'Accounts' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'AccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '171054237268****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorNoInstanceInDb', + 'errorMessage' => 'no instance for process in db.', + ], + [ + 'errorCode' => 'ErrorParamsInvalid', + 'errorMessage' => 'Invalid Params', + ], + [ + 'errorCode' => 'ErrorInstanceAliuidNotDaMa', + 'errorMessage' => 'instance aliuid not DA or MA.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06D1EC07-C9EB-58AC-A750-C87C9A0****\\",\\n \\"Accounts\\": [\\n {\\n \\"DisplayName\\": \\"test\\",\\n \\"AccountId\\": \\"171054237268****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInstanceMembers' => [ + 'summary' => 'Queries the information about members in Cloud Firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68269', + 'abilityTreeNodes' => [ + 'FEATUREcfw98HUGQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: **20**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UID of the member.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'MemberDisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the member.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloudfirewall_2', + ], + ], + [ + 'name' => 'MemberDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The remarks of the member. The remarks must be 1 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'renewal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A531AE1A-FBA2-48B6-BAB8-84D02BD409EE', + ], + 'PageInfo' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of the members.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Members' => [ + 'description' => 'The information about the member.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MemberDesc' => [ + 'description' => 'The remarks of the member.'."\n", + 'type' => 'string', + 'example' => 'renewal', + ], + 'MemberDisplayName' => [ + 'description' => 'The name of the member.'."\n", + 'type' => 'string', + 'example' => 'cloudfirewall_2', + ], + 'CreateTime' => [ + 'description' => 'The time when the member was added to Cloud Firewall. The value is a timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1615189819', + ], + 'MemberUid' => [ + 'description' => 'The UID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '258039427902****', + ], + 'MemberStatus' => [ + 'description' => 'The status of the member. Valid values:'."\n" + ."\n" + .'* **normal**'."\n" + .'* **deleting**'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'ModifyTime' => [ + 'description' => 'The time when the member was last modified. The value is a timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1615189819', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A531AE1A-FBA2-48B6-BAB8-84D02BD409EE\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 20\\n },\\n \\"Members\\": [\\n {\\n \\"MemberDesc\\": \\"renewal\\",\\n \\"MemberDisplayName\\": \\"cloudfirewall_2\\",\\n \\"CreateTime\\": 1615189819,\\n \\"MemberUid\\": 0,\\n \\"MemberStatus\\": \\"normal\\",\\n \\"ModifyTime\\": 1615189819\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceMembersResponse>\\n <RequestId>A531AE1A-FBA2-48B6-BAB8-84D02BD409EE</RequestId>\\n <PageInfo>\\n <CurrentPage>1</CurrentPage>\\n <PageSize>20</PageSize>\\n <TotalCount>20</TotalCount>\\n </PageInfo>\\n <Members>\\n <MemberDesc>renewal</MemberDesc>\\n <MemberDisplayName>cloudfirewall_2</MemberDisplayName>\\n <CreateTime>1615189819</CreateTime>\\n <MemberStatus>normal</MemberStatus>\\n <ModifyTime>1615189819</ModifyTime>\\n </Members>\\n</DescribeInstanceMembersResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceMembers', + 'description' => 'You can use this operation to query the information about members in Cloud Firewall.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddInstanceMembers' => [ + 'summary' => 'Adds members to Cloud Firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68097', + 'abilityTreeNodes' => [ + 'FEATUREcfw98HUGQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Members', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The members.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'None.'."\n", + 'type' => 'object', + 'properties' => [ + 'MemberDesc' => [ + 'description' => 'The remarks of the member. The value must be 1 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'renewal', + ], + 'MemberUid' => [ + 'description' => 'The UID of the member. You can add up to 20 members to Cloud Firewall at a time.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '258039427902****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B40A54DF-C142-44F7-8441-B31C1EADB36E', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorParamsInvalid', + 'errorMessage' => 'Invalid Params', + ], + [ + 'errorCode' => 'ErrotMaxInstanceMemberNumExceed', + 'errorMessage' => 'The maximum number of firewall instance members is exceeded.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorInstanceTooManyMembersOnce', + 'errorMessage' => 'too many members once.', + ], + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + [ + 'errorCode' => 'ErrorInstanceMemberAlreadyExist', + 'errorMessage' => 'instance member is already exist.', + ], + [ + 'errorCode' => 'ErrorInstanceMemberIsMaster', + 'errorMessage' => 'instance member is master account.', + ], + [ + 'errorCode' => 'ErrorInstanceAliuidNotDaMa', + 'errorMessage' => 'instance aliuid not DA or MA.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'internal error: sql insert.', + ], + [ + 'errorCode' => 'ErrorInstanceMemberNotBelongRd', + 'errorMessage' => 'instance member not belong rd.', + ], + [ + 'errorCode' => 'ErrorInstanceMemberNotStsGrant', + 'errorMessage' => 'instance member is not sts grant.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B40A54DF-C142-44F7-8441-B31C1EADB36E\\"\\n}","errorExample":""},{"type":"xml","example":"<AddInstanceMembersResponse>\\n <RequestId>B40A54DF-C142-44F7-8441-B31C1EADB36E</RequestId>\\n</AddInstanceMembersResponse>","errorExample":""}]', + 'title' => 'AddInstanceMembers', + 'description' => 'You can call this operation to add members to Cloud Firewall.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceMemberAttributes' => [ + 'summary' => 'Updates the information about members in Cloud Firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68474', + 'abilityTreeNodes' => [ + 'FEATUREcfw98HUGQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Members', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The members that to be modified.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MemberDesc' => [ + 'description' => 'The remarks of the member in Cloud Firewall.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'renewal', + ], + 'MemberUid' => [ + 'description' => 'The UID of the member in Cloud Firewall.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123412341234****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AB74E747-BA5C-492C-87DD-CEA67FCFFFE5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorParamsInvalid', + 'errorMessage' => 'Invalid Params', + ], + [ + 'errorCode' => 'ErrorInstanceTooManyMembersOnce', + 'errorMessage' => 'too many members once.', + ], + ], + [ + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'An authentication error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AB74E747-BA5C-492C-87DD-CEA67FCFFFE5\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceMemberAttributesResponse>\\n <RequestId>AB74E747-BA5C-492C-87DD-CEA67FCFFFE5</RequestId>\\n</ModifyInstanceMemberAttributesResponse>","errorExample":""}]', + 'title' => 'ModifyInstanceMemberAttributes', + 'description' => 'You can call the ModifyInstanceMemberAttributes operation to update the information about members in Cloud Firewall. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second for each account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteInstanceMembers' => [ + 'summary' => 'Removes members from Cloud Firewall.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68151', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MemberUids', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The UIDs of the members.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The UID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '258039427902****', + ], + 'required' => true, + 'example' => '1234123412341234', + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '03E8AA70-0CC9-42EA-97AA-EA68377930B4', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorInstanceTooManyMembersOnce', + 'errorMessage' => 'too many members once.', + ], + [ + 'errorCode' => 'ErrorInstanceMemberHasFirewall', + 'errorMessage' => 'instance member has firewall resource.', + ], + ], + [ + [ + 'errorCode' => 'ErrorAuthentication', + 'errorMessage' => 'An authentication error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"03E8AA70-0CC9-42EA-97AA-EA68377930B4\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteInstanceMembersResponse>\\n <RequestId>03E8AA70-0CC9-42EA-97AA-EA68377930B4</RequestId>\\n</DeleteInstanceMembersResponse>","errorExample":""}]', + 'title' => 'DeleteInstanceMembers', + 'description' => 'You can call this operation to remove up to 20 members from Cloud Firewall at a time. Separate multiple members with commas (,). After a member is removed, Cloud Firewall can no longer access the cloud resources of the member. Proceed with caution. Before you call this operation, call the [DescribeInstanceMembers](~~271704~~) operation to obtain the information about the members that are added to Cloud Firewall.'."\n" + ."\n" + .'## [](#qps-)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDownloadTask' => [ + 'summary' => 'Queries file download tasks, including the task information and download URLs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174551', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数, 不得超过100, 超过100会设置为100', + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => 'The type of the task. For more information about task types, see the descriptions in the "DescribeDownloadTaskType" topic. If you do not specify this parameter, all files are queried by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewallAsset', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3F2BED13-F3D0-5984-80D6-D5F298CFEA88', + ], + 'Tasks' => [ + 'description' => 'The tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The task information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '任务id', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '1111', + ], + 'TaskName' => [ + 'title' => '名称', + 'description' => 'The name of the task.'."\n", + 'type' => 'string', + 'example' => 'Internet Boundary Firewall Assets - IPv4', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* **finish**'."\n" + .'* **start**'."\n" + .'* **error**'."\n" + .'* **expire**: The task file is invalid and cannot be downloaded.'."\n", + 'type' => 'string', + 'example' => 'finish', + ], + 'FileURL' => [ + 'description' => 'The URL of the OSS file.'."\n", + 'type' => 'string', + 'example' => 'https://cfw-table-download-cn.oss-cn-hangzhou.aliyuncs.com/%E4%BA%92%E8%81%94%E7%BD%91%E8%BE%B9%E7%95%8C%E9%98%B2%E7%81%AB%E5%A2%99%E8%B5%84%E4%BA%A7-IPv4_1069.csv?Expires=1708583913&OSSAccessKeyId=****&Signature=******%3D', + ], + 'FileSize' => [ + 'title' => '', + 'description' => 'The size of the file.'."\n", + 'type' => 'string', + 'example' => '24.04KB', + ], + 'CreateTime' => [ + 'description' => 'The time when the task was created. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706595827', + ], + 'ExpireTime' => [ + 'description' => 'The time when the task expires. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714371828', + ], + 'TaskType' => [ + 'description' => 'The type of the task.'."\n", + 'type' => 'string', + 'example' => 'InternetFirewallAsset', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 132,\\n \\"RequestId\\": \\"3F2BED13-F3D0-5984-80D6-D5F298CFEA88\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskId\\": \\"1111\\",\\n \\"TaskName\\": \\"互联网边界防火墙资产-IPv4\\",\\n \\"Status\\": \\"finish\\",\\n \\"FileURL\\": \\"https://cfw-table-download-cn.oss-cn-hangzhou.aliyuncs.com/%E4%BA%92%E8%81%94%E7%BD%91%E8%BE%B9%E7%95%8C%E9%98%B2%E7%81%AB%E5%A2%99%E8%B5%84%E4%BA%A7-IPv4_1069.csv?Expires=1708583913&OSSAccessKeyId=****&Signature=******%3D\\",\\n \\"FileSize\\": \\"24.04KB\\",\\n \\"CreateTime\\": 1706595827,\\n \\"ExpireTime\\": 1714371828,\\n \\"TaskType\\": \\"InternetFirewallAsset\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDownloadTask', + ], + 'DescribeDownloadTaskType' => [ + 'summary' => 'Queries the types of download tasks. The type corresponds to the TaskType fields in the download task-related operations.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '175450', + 'abilityTreeNodes' => [ + 'FEATUREcfwE8FJHT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数, 不得超过100, 超过100会设置为100', + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => 'The type of the task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewallAsset', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B835494C-D093-5524-BBDE-BD272077B40E', + ], + 'TaskTypeArray' => [ + 'description' => 'The task types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'title' => '名称', + 'description' => 'The name of the task type.'."\n", + 'type' => 'string', + 'example' => 'Internet Boundary Firewall Assets', + ], + 'TaskType' => [ + 'description' => 'The type of the task.'."\n", + 'type' => 'string', + 'example' => 'InternetFirewallAsset', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"B835494C-D093-5524-BBDE-BD272077B40E\\",\\n \\"TaskTypeArray\\": [\\n {\\n \\"TaskName\\": \\"互联网边界防火墙资产\\",\\n \\"TaskType\\": \\"InternetFirewallAsset\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDownloadTaskType', + ], + 'CreateDownloadTask' => [ + 'summary' => 'Creates a file download task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174565', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => 'The language of the content within the response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the task. For more information about task types, see the descriptions in the "DescribeDownloadTaskType" topic.', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewallAsset', + ], + ], + [ + 'name' => 'TaskData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query condition of the download task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"SearchItem\\":\\"\\",\\"UserType\\":\\"buy\\",\\"IpVersion\\":\\"4\\"}', + ], + ], + [ + 'name' => 'TimeZone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time zone of the time information in the downloaded file. The value must be an identifier of a time zone in the Internet Assigned Numbers Authority (IANA) database. The default value is Asia/Shanghai, which indicates UTC+8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Asia/Shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The unique ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E7F333E0-7B70-54DA-A307-4B2B49DEE923', + ], + 'TaskName' => [ + 'title' => '', + 'description' => 'The name of the file download task.'."\n", + 'type' => 'string', + 'example' => 'Internet Boundary Firewall Assets - IPv4', + ], + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'finish: The task finished. You can query the task to obtain the download link of the file.'."\n" + ."\n" + .'start: The task start.'."\n" + ."\n" + .'error: An error occurred.'."\n" + ."\n" + .'expire: The task file is invalid and cannot be downloaded.', + 'type' => 'string', + 'example' => 'start', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBInsertError', + 'errorMessage' => 'A database insert error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": 132,\\n \\"RequestId\\": \\"E7F333E0-7B70-54DA-A307-4B2B49DEE923\\",\\n \\"TaskName\\": \\"互联网边界防火墙资产-IPv4\\",\\n \\"Status\\": \\"start\\"\\n}","type":"json"}]', + 'title' => 'CreateDownloadTask', + ], + 'DeleteDownloadTask' => [ + 'summary' => 'Deletes file download tasks.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174566', + 'abilityTreeNodes' => [ + 'FEATUREcfwHCOW32', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the file download task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4376', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '064022A8-F415-572C-B3C1-657152833F11', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorDBDeleteError', + 'errorMessage' => 'A database delete error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"064022A8-F415-572C-B3C1-657152833F11\\"\\n}","type":"json"}]', + 'title' => 'DeleteDownloadTask', + 'description' => 'You can call this operation to delete file download tasks and delete the files.'."\n" + ."\n" + .'**'."\n" + ."\n" + .'**Warning** Both tasks and involved files are deleted. You can no longer download the involved files by using the download links. This operation is irreversible. Proceed with caution.'."\n", + 'responseParamsDescription' => 'If the request is successful, the task is deleted.'."\n", + ], + 'DescribeAclBackupList' => [ + 'summary' => '获取ACL备份列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68169', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '110.191.179.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6C9105F2-9F31-5A62-8D52-FA65A3E5****', + ], + 'Backups' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BackUpTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743683400', + ], + 'AclCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'description', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersPageSizeOrNo', + 'errorMessage' => 'Either pageSize or pageNo is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 32,\\n \\"RequestId\\": \\"6C9105F2-9F31-5A62-8D52-FA65A3E5****\\",\\n \\"Backups\\": [\\n {\\n \\"BackUpTime\\": 1743683400,\\n \\"AclCount\\": 10,\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'AddAclBackupData' => [ + 'summary' => '备份ACL', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68092', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '115.194.124.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'bj-001', + ], + ], + [ + 'name' => 'BackUpTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1743683400'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '244EA37C-D2AB-54A7-B6E3-7ED0E9A1****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorBackupCountExceed', + 'errorMessage' => 'The maximum number of backups is exceeded.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"244EA37C-D2AB-54A7-B6E3-7ED0E9A1****\\"\\n}","type":"json"}]', + ], + 'UseAclBackupData' => [ + 'summary' => '使用ACL备份', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68538', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + 'FEATUREcfwO822TD', + 'FEATUREcfwFIV6PB', + 'FEATUREcfwTW8EA1', + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123.113.99.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'BackUpTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1743683400'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'Parameters error.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorDBUpdate', + 'errorMessage' => 'internal error: sql updat.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'An error occurred while encoding JSON.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\"\\n}","type":"json"}]', + ], + 'DeleteAclBackupData' => [ + 'summary' => '删除ACL备份', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68138', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + 'FEATUREcfw7YI1ZZ', + 'FEATUREcfw8B8ITI', + 'FEATUREcfwO822TD', + 'FEATUREcfwFIV6PB', + 'FEATUREcfwTW8EA1', + 'FEATUREcfwC140SS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'BackUpTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1743683400'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '75E60025-43C5-5635-B7B7-272C5246****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75E60025-43C5-5635-B7B7-272C5246****\\"\\n}","type":"json"}]', + ], + 'DescribeSecurityMode' => [ + 'summary' => '获取安全模式', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68358', + 'abilityTreeNodes' => [ + 'FEATUREcfw516PD4', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '218.108.54.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg_server', + 'deprecated' => true, + ], + 'SecurityMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C6D68A02-54D5-5F5C-A8AA-6D6C2874****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Module\\": \\"sg_server\\",\\n \\"SecurityMode\\": 1,\\n \\"RequestId\\": \\"C6D68A02-54D5-5F5C-A8AA-6D6C2874****\\"\\n}","type":"json"}]', + ], + 'DescribePageDocuments' => [ + 'summary' => '获取文档', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68334', + 'abilityTreeNodes' => [ + 'FEATUREcfwVPGXSE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '223.167.221.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + [ + 'name' => 'PageName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'overview' => '', + 'access' => '', + 'switch' => '', + ], + 'example' => 'overview', + ], + ], + [ + 'name' => 'TabName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'internet', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg_server', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7C81E1AD-08C0-5E09-853B-FDC77B90****', + ], + 'ImageUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://img.alicdn.com/tfs/TB1E4FCAuT2gK0jSZFvXXXnFXXa-3399-662.png', + ], + 'More' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://zjysfy.womanhospital.cn/pub/hos/0/noneBackGround.png', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'Docs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://notify-center-test.ybaobx.com/webhook/arms', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorSourceCodeError', + 'errorMessage' => 'The source code is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Module\\": \\"sg_server\\",\\n \\"RequestId\\": \\"7C81E1AD-08C0-5E09-853B-FDC77B90****\\",\\n \\"ImageUrl\\": \\"https://img.alicdn.com/tfs/TB1E4FCAuT2gK0jSZFvXXXnFXXa-3399-662.png\\",\\n \\"More\\": {\\n \\"Url\\": \\"https://zjysfy.womanhospital.cn/pub/hos/0/noneBackGround.png\\",\\n \\"Title\\": \\"test\\"\\n },\\n \\"Docs\\": [\\n {\\n \\"Url\\": \\"https://notify-center-test.ybaobx.com/webhook/arms\\",\\n \\"Title\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDomainResolve' => [ + 'summary' => 'Queries Domain Name System (DNS) records.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68245', + 'abilityTreeNodes' => [ + 'FEATUREcfwTW8EA1', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name whose DNS record you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version of the asset that is protected by Cloud Firewall. Valid values:'."\n" + ."\n" + .'* **4**: IPv4 (default)'."\n" + .'* **6**: IPv6'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + 'ResolveResult' => [ + 'description' => 'The details about the DNS record of the domain name.'."\n", + 'type' => 'object', + 'properties' => [ + 'IpAddrs' => [ + 'description' => 'The IP address to which the domain name is resolved. Multiple IP addresses are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '11.1.X.X,12.1.X.X', + ], + 'UpdateTime' => [ + 'description' => 'The time when the domain name was resolved. The value of this parameter is a timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579091739', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid is invalid.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorDomainResolve', + 'errorMessage' => 'A domain resolution error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D\\",\\n \\"ResolveResult\\": {\\n \\"IpAddrs\\": \\"11.1.X.X,12.1.X.X\\",\\n \\"UpdateTime\\": 1579091739\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainResolveResponse>\\n <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>\\n <ResolveResult>\\n <IpAddrs>11.1.X.X,12.1.X.X</IpAddrs>\\n <UpdateTime>1579091739</UpdateTime>\\n </ResolveResult>\\n</DescribeDomainResolveResponse>","errorExample":""}]', + 'title' => 'DescribeDomainResolve', + 'description' => 'You can use this operation to query the DNS record of a domain name. This operation can retrieve DNS records only from Alibaba Cloud DNS. Before you can call this operation, make sure that your domain name is hosted on Alibaba Cloud DNS.'."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeFirewallDropStatistics' => [ + 'summary' => '获取防火墙DROP数据统计', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68258', + 'abilityTreeNodes' => [ + 'FEATUREcfw9GLVIS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IpsDropCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalDropCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BEA1D173-D5DB-582E-9637-438D5CE3****', + ], + 'VulnDropCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AclDropCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpsDropCnt\\": 20,\\n \\"TotalDropCnt\\": 50,\\n \\"RequestId\\": \\"BEA1D173-D5DB-582E-9637-438D5CE3****\\",\\n \\"VulnDropCnt\\": 10,\\n \\"AclDropCnt\\": 20\\n}","type":"json"}]', + ], + 'DescribeUserAssetIPTrafficInfo' => [ + 'summary' => 'Queries the information about the traffic of a specified asset that belongs to your Alibaba Cloud account.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '143435', + 'abilityTreeNodes' => [ + 'FEATUREcfwB677AM', + 'FEATUREcfwVWCDEU', + 'FEATUREcfwG6EEQD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言', + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + [ + 'name' => 'AssetIP', + 'in' => 'query', + 'schema' => [ + 'title' => '资产IP', + 'description' => 'The IP address of the asset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'TrafficTime', + 'in' => 'query', + 'schema' => [ + 'title' => '时间', + 'description' => 'The time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1656923760', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656837360', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656923760', + ], + 'InBps' => [ + 'description' => 'The network throughput, which indicates the inbound traffic rate. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4520', + ], + 'OutBps' => [ + 'description' => 'The network throughput, which indicates the outbound traffic rate. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4180', + ], + 'InPps' => [ + 'description' => 'The inbound network throughput, which indicates the number of packets that are sent inbound per second. Unit: packets per second (pps).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '233', + ], + 'OutPps' => [ + 'description' => 'The outbound network throughput, which indicates the number of packets that are sent outbound per second. Unit: pps.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '224', + ], + 'SessionCount' => [ + 'description' => 'The number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'NewConn' => [ + 'description' => 'The new connection creation rate.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"StartTime\\": 1656837360,\\n \\"EndTime\\": 1656923760,\\n \\"InBps\\": 4520,\\n \\"OutBps\\": 4180,\\n \\"InPps\\": 233,\\n \\"OutPps\\": 224,\\n \\"SessionCount\\": 50,\\n \\"NewConn\\": 43\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserAssetIPTrafficInfoResponse>\\n <RequestId>F0F82705-CFC7-5F83-86C8-A063892F****</RequestId>\\n <StartTime>1656837360</StartTime>\\n <EndTime>1656923760</EndTime>\\n <InBps>4520</InBps>\\n <OutBps>4180</OutBps>\\n <InPps>233</InPps>\\n <OutPps>224</OutPps>\\n <SessionCount>50</SessionCount>\\n <NewConn>43</NewConn>\\n</DescribeUserAssetIPTrafficInfoResponse>","errorExample":""}]', + 'title' => 'DescribeUserAssetIPTrafficInfo', + ], + 'DescribeCfwRiskLevelSummary' => [ + 'summary' => 'Queries the firewall risk level.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174512', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + 'FEATUREcfwMD8M6R', + 'FEATUREcfwOG6NL8', + 'FEATUREcfwBM3Y9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of your Cloud Firewall.'."\n" + ."\n" + .'> For more information about Cloud Firewall supported regions, see [Supported regions](~~195657~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EcsEIP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F1F30435-FA0A-52DA-A5DE-C16FD6C171DA', + ], + 'RiskList' => [ + 'description' => 'The list of risks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotProtected', + ], + 'Num' => [ + 'description' => 'The number of at-risk Elastic Compute Service (ECS) instances.'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'Level' => [ + 'description' => 'The risk levels. Valid values:'."\n" + ."\n" + .'* **medium**'."\n", + 'type' => 'string', + 'example' => 'medium', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1F30435-FA0A-52DA-A5DE-C16FD6C171DA\\",\\n \\"RiskList\\": [\\n {\\n \\"Type\\": \\"ResourceNotProtected\\",\\n \\"Num\\": \\"50\\",\\n \\"Level\\": \\"medium\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeCfwRiskLevelSummary', + ], + 'DescribeRiskSecurityGroupDetail' => [ + 'summary' => '获取风险安全组详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68354', + 'abilityTreeNodes' => [ + 'FEATUREcfw9GLVIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '220.189.117.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3b1adf8d-1949-4c8e-809b-fb92ee11****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-2vc0p803vgxumn6r****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test-instance-name', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '33C94306-2064-5A06-9645-01419967****', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RiskSgDetail' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-8vbuzirdl3w1r7exw****', + ], + 'RiskLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'high', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shanghai'."\n", + ], + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-instance-name', + ], + 'EcsCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg-2vc0p803vgxumn6r****', + ], + 'EcsInfo' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PublicIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.107.141.XXX', + ], + 'EcsInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tyf_test', + ], + 'PrivateIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '172.24.121.XXX', + ], + 'EcsInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i-bp1gra23yai47d8e****', + ], + ], + ], + ], + 'RuleInfo' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'high', + ], + 'RuleStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'enable', + ], + 'Suggestion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'RuleUuid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4c1e72c9-6690-408b-9048-065f0f10****', + ], + 'RuleName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"33C94306-2064-5A06-9645-01419967****\\",\\n \\"TotalCount\\": 5,\\n \\"RiskSgDetail\\": [\\n {\\n \\"VpcId\\": \\"vpc-8vbuzirdl3w1r7exw****\\",\\n \\"RiskLevel\\": \\"high\\",\\n \\"RegionNo\\": \\"cn-shanghai\\\\n\\",\\n \\"InstanceName\\": \\"test-instance-name\\",\\n \\"EcsCount\\": 10,\\n \\"InstanceId\\": \\"sg-2vc0p803vgxumn6r****\\",\\n \\"EcsInfo\\": [\\n {\\n \\"PublicIp\\": \\"47.107.141.XXX\\",\\n \\"EcsInstanceName\\": \\"tyf_test\\",\\n \\"PrivateIp\\": \\"172.24.121.XXX\\",\\n \\"EcsInstanceId\\": \\"i-bp1gra23yai47d8e****\\"\\n }\\n ],\\n \\"RuleInfo\\": [\\n {\\n \\"RiskLevel\\": \\"high\\",\\n \\"RuleStatus\\": \\"enable\\",\\n \\"Suggestion\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"RuleUuid\\": \\"4c1e72c9-6690-408b-9048-065f0f10****\\",\\n \\"RuleName\\": \\"test\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSecurityProxy' => [ + 'summary' => 'Queries information about NAT firewalls.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68360', + 'abilityTreeNodes' => [ + 'FEATUREcfwOG6NL8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy-nat80d763eb0dee4eacaec9', + ], + ], + [ + 'name' => 'ProxyName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'nat-idmp-fir', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-zm0h3c1exm5bifuorg8c5', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'ProxyList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-wz9xn35tq33hunzvpu0se', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'normal', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'NatGatewayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs-slb-eip-waf', + ], + 'MemberUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1797733170015112', + ], + 'ProxyId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'proxy-nat4921f192b6cf438d93f8', + ], + 'ProxyName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nat-idmp-fir', + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-bp1kw9igsq0yyzeanqamx', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-5gu2qqfmjmwl8ktzgfekl', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'NatGatewayId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ngw-2zex8sf4s5vus8rq3rjqo', + ], + 'Detail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '“”', + ], + 'SnatIpList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + ], + 'StrictMode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Cloudfw::2017-12-07::DescribeNatFirewallList', + ], + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5,\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\",\\n \\"ProxyList\\": [\\n {\\n \\"VpcId\\": \\"vpc-wz9xn35tq33hunzvpu0se\\",\\n \\"Status\\": \\"normal\\",\\n \\"RegionNo\\": \\"ap-southeast-1\\",\\n \\"NatGatewayName\\": \\"ecs-slb-eip-waf\\",\\n \\"MemberUid\\": \\"1797733170015112\\",\\n \\"ProxyId\\": \\"proxy-nat4921f192b6cf438d93f8\\",\\n \\"ProxyName\\": \\"nat-idmp-fir\\",\\n \\"VpcName\\": \\"vpc-bp1kw9igsq0yyzeanqamx\\",\\n \\"VSwitchId\\": \\"vsw-5gu2qqfmjmwl8ktzgfekl\\",\\n \\"CidrBlock\\": \\"192.168.0.0/16\\",\\n \\"NatGatewayId\\": \\"ngw-2zex8sf4s5vus8rq3rjqo\\",\\n \\"Detail\\": \\"“”\\",\\n \\"SnatIpList\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"StrictMode\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSecurityProxy', + ], + 'CreateVpcFirewallCenManualConfigure' => [ + 'summary' => '创建VPC防火墙手动配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68134', + 'abilityTreeNodes' => [ + 'FEATUREcfwMD8M6R', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cen-37nddhri7jf0d2****', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-qzeaol304m***', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VpcFirewallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B14757D0-4640-4B44-AC67-7F558F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ErrorDBUpdateError', + 'errorMessage' => 'A database update error occurred.', + ], + ], + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorInvalidMemberUid', + 'errorMessage' => 'Member uid is invalid', + ], + [ + 'errorCode' => 'ErrorFirewallName', + 'errorMessage' => 'firewall name invalid', + ], + [ + 'errorCode' => 'ErrorCenId', + 'errorMessage' => 'CEN ID is error', + ], + [ + 'errorCode' => 'ErrorVpcIdError', + 'errorMessage' => 'Vpc ID invalid.', + ], + [ + 'errorCode' => 'ErrorUserNotFound', + 'errorMessage' => 'User not found', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorVpcFirewallNotFound', + 'errorMessage' => 'The specified VPC firewall does not exist, please select again.', + ], + [ + 'errorCode' => 'ErrorDBTxError', + 'errorMessage' => 'A database transaction error occurred.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'record operation log error.', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcFirewallId\\": \\"vfw-m5e7dbc4y****\\",\\n \\"RequestId\\": \\"B14757D0-4640-4B44-AC67-7F558F****\\"\\n}","type":"json"}]', + ], + 'BatchCopyVpcFirewallControlPolicy' => [ + 'summary' => 'Copies all access control policies from a policy group of a source virtual private cloud (VPC) firewall to a policy group of a destination VPC firewall.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '104390', + 'abilityTreeNodes' => [ + 'FEATUREcfw8B8ITI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceVpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the policy group of the source VPC firewall. Valid values:'."\n" + ."\n" + .'* If the VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a Cloud Enterprise Network (CEN) instance, the value of this parameter is the ID of the CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance.'."\n" + .'* If the VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit, the value of this parameter is the instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallAclGroupList](~~159760~~) operation to query the IDs of policy groups.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'TargetVpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the policy group of the destination VPC firewall. Valid values:'."\n" + ."\n" + .'* If the VPC firewall protects mutual access traffic between a VPC and a specified network instance that is attached to a CEN instance, the value of this parameter is the ID of the CEN instance. The network instance can be a VPC, a VBR, or a CCN instance.'."\n" + .'* If the VPC firewall protects traffic between two VPCs that are connected by using an Express Connect circuit, the value of this parameter is the instance ID of the VPC firewall.'."\n" + ."\n" + .'> You can call the [DescribeVpcFirewallAclGroupList](~~159760~~) operation to query the IDs of policy groups.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-e37d3a04cf79446a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k6j3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersSource', + 'errorMessage' => 'The source is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParametersTarget', + 'errorMessage' => 'Target VPC Firewall ID not exist.', + ], + [ + 'errorCode' => 'ErrorParametersSourceTarget', + 'errorMessage' => 'Source and target firewall is same.', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125k6j3\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchCopyVpcFirewallControlPolicyResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125k6j3</RequestId>\\n</BatchCopyVpcFirewallControlPolicyResponse>","errorExample":""}]', + 'title' => 'BatchCopyVpcFirewallControlPolicy', + 'description' => 'You can call the BatchCopyVpcFirewallControlPolicy operation to copy all access control policies from a policy group of a source VPC firewall to a policy group of a destination VPC firewall. '."\n" + ."\n" + .'Before you call this operation, we recommend that you back up access control policies. For more information about how to back up an access control policy, see [Back up an access control policy](https://www.alibabacloud.com/help/en/cloud-firewall/latest/back-up-and-roll-back-an-access-control-policy). '."\n" + ."\n" + .'After you call this operation, all the access control policies in the policy group of the destination VPC firewall are replaced. '."\n" + ."\n" + .'The policy groups of the source VPC firewall and the destination VPC firewall must belong to the same Alibaba Cloud account. '."\n" + ."\n" + .'## Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. When the number of calls to this operation per second exceeds the limit, throttling is triggered. Throttling may affect your business. We recommend that you take note of the limit on this operation.', + ], + 'ModifyControlPolicyPosition' => [ + 'summary' => 'Modifies the priority of an IPv4 access control policy for the Internet firewall. An IPv4 access control policy refers to a policy whose source IP address and destination IP address are IPv4 addresses.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68468', + 'abilityTreeNodes' => [ + 'FEATUREcfwJZTBPW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address of the request.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* zh: Chinese (default)'."\n" + .'* en: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The direction of the traffic to which the IPv4 access control policy applies. Valid values:'."\n" + ."\n" + .'* in: inbound traffic'."\n" + .'* out: outbound traffic'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new priority of the IPv4 access control policy. You must specify a numeric value for this parameter. The value 1 indicates the highest priority. A larger value indicates a lower priority.'."\n" + ."\n" + .'> The new priority cannot exceed the priority range of the IPv4 access control policy. Otherwise, an error occurs when you call this operation. Before you call this operation, we recommend that you use the [DescribePolicyPriorUsed](~~138862~~) operation to query the priority range of the IPv4 access control policy in the specified direction.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'OldOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The original priority of the IPv4 access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125EEB1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParametersUid', + 'errorMessage' => 'The aliUid parameter is invalid.', + ], + [ + 'errorCode' => 'ErrorParameterIpVersion', + 'errorMessage' => 'The IP version is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersDirection', + 'errorMessage' => 'The direction is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelect', + 'errorMessage' => 'An error occurred while querying database.', + ], + [ + 'errorCode' => 'ErrorParameters', + 'errorMessage' => 'A parameter error occurred.', + ], + [ + 'errorCode' => 'ErrorParametersNewOrder', + 'errorMessage' => 'The newOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorParametersOldOrder', + 'errorMessage' => 'The oldOrder is invalid.', + ], + [ + 'errorCode' => 'ErrorDBDelete', + 'errorMessage' => 'An error occurred while deleting the database.', + ], + [ + 'errorCode' => 'ErrorDBInsert', + 'errorMessage' => 'An error occurred while performing an insert operation in the database.', + ], + [ + 'errorCode' => 'ErrorRecordLog', + 'errorMessage' => 'An error occurred while updating the operation log.', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Cloudfw::2017-12-07::ModifyControlPolicyPriority', + ], + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-00090125EEB1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyControlPolicyPositionResponse>\\n <RequestId>850A84D6-0DE4-4797-A1E8-00090125EEB1</RequestId>\\n</ModifyControlPolicyPositionResponse>","errorExample":""}]', + 'title' => 'ModifyControlPolicyPosition', + 'description' => 'You can use this operation to modify the priority of an IPv4 access control policy for the Internet firewall. No API operations are provided for you to modify the priority of an IPv6 access control policy for the Internet firewall.'."\n" + ."\n" + .'## [](#qps)Limits'."\n" + ."\n" + .'You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DescribeVpcFirewallTrafficAssetList' => [ + 'summary' => '查询VPC互访的资产信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68328', + 'abilityTreeNodes' => [ + 'FEATUREcfwG6EEQD', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言, 枚举值.'."\n" + .'默认值: zh'."\n" + .'可选值: en', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间,Unix timestamp, 精确到秒', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间,Unix timestamp, 精确到秒', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1656750960', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数, 不得超过100, 超过100会设置为100', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IP', + 'in' => 'query', + 'schema' => [ + 'title' => '公网IP', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47.92.x.x', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'title' => '公网IP', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'www.****.com', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序, 枚举值, 可选:asc, desc', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段, 枚举值.'."\n" + .'默认值: SessionCount'."\n" + .'可选值: InBytes, OutBytes,TotalBytes,SessionCount', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SessionCount', + 'enum' => [], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-m5ewlqkuf7orclr1****', + ], + ], + [ + 'name' => 'IsAITraffic', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C5BE1AA4-934A-5085-89CC-9AD1CAC3****', + ], + 'DataList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IP' => [ + 'title' => '域名', + 'description' => '', + 'type' => 'string', + 'example' => 'a.com', + ], + 'VpcId' => [ + 'title' => '域名', + 'description' => '', + 'type' => 'string', + 'example' => 'a.com', + ], + 'TotalBytes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '253023143', + ], + 'SessionCount' => [ + 'title' => '会话数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'IpsHitCnt' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-bp1mos0vhefmx5ah6****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorAliUid', + 'errorMessage' => 'Aliuid invalid.', + ], + [ + 'errorCode' => 'ErrorTimeError', + 'errorMessage' => 'The time is invalid.', + ], + [ + 'errorCode' => 'ErrorDBSelectError', + 'errorMessage' => 'A database select error occurred.', + ], + [ + 'errorCode' => 'ErrorIntervalError', + 'errorMessage' => 'The interval is invalid.', + ], + [ + 'errorCode' => 'ErrorIpFormat', + 'errorMessage' => 'The IP address is invalid.', + ], + [ + 'errorCode' => 'ErrorSecuritySuggest', + 'errorMessage' => 'The security suggest is invalid.', + ], + [ + 'errorCode' => 'ErrorSortError', + 'errorMessage' => 'The sort is invalid.', + ], + [ + 'errorCode' => 'ErrorOrderFailed', + 'errorMessage' => 'The order is invalid.', + ], + [ + 'errorCode' => 'ErrorPageNo', + 'errorMessage' => 'Either page number or page size is invalid.', + ], + [ + 'errorCode' => 'ErrorDomainName', + 'errorMessage' => 'The domain name is invalid.', + ], + [ + 'errorCode' => 'ErrorDataTypeError', + 'errorMessage' => 'The data type is invalid.', + ], + [ + 'errorCode' => 'ErrorMarshalJSON', + 'errorMessage' => 'internal error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 132,\\n \\"RequestId\\": \\"C5BE1AA4-934A-5085-89CC-9AD1CAC3****\\",\\n \\"DataList\\": [\\n {\\n \\"IP\\": \\"a.com\\",\\n \\"VpcId\\": \\"a.com\\",\\n \\"TotalBytes\\": 253023143,\\n \\"SessionCount\\": 12,\\n \\"IpsHitCnt\\": 10,\\n \\"VpcName\\": \\"vpc-bp1mos0vhefmx5ah6****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'SetAutoProtectNewAssets' => [ + 'summary' => '开启自动保护新入资产', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '68526', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60.182.79.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AutoProtect', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'api_server', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErrorParamsNotEnough', + 'errorMessage' => 'Parameters are insufficient.', + ], + [ + 'errorCode' => 'ErrorDbFailed', + 'errorMessage' => 'Query db failed.', + ], + [ + 'errorCode' => 'ErrorNoInstanceInDb', + 'errorMessage' => 'no instance for process in db.', + ], + [ + 'errorCode' => 'ErrorInstanceStatusNotNormal', + 'errorMessage' => 'This operation is not supported when the instance is in the current state.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Module\\": \\"api_server\\",\\n \\"RequestId\\": \\"F0F82705-CFC7-5F83-86C8-A063892F****\\"\\n}","type":"json"}]', + ], + 'DescribeRegionResourceTypeAutoEnable' => [ + 'summary' => '查询地域和资产类型引流设置', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcfwEWN5PJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + 'RegionResourceAutoEnable' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'boolean', + 'example' => 'RegionResourceAutoEnable: {'."\n" + .'"cn-shenzhen": {'."\n" + .'"SlbEIP": false,'."\n" + .'}', + 'description' => '', + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2841452-CB8D-4F7D-B247-38E1CF7334F8\\",\\n \\"RegionResourceAutoEnable\\": {\\n \\"key\\": {\\n \\"key\\": true\\n }\\n }\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote-nebula-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'cloudfw.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cloudfw.ap-southeast-1.aliyuncs.com', + ], + ], +]; |