diff options
Diffstat (limited to 'data/zh_cn/cloudfw/2017-12-07')
| -rw-r--r-- | data/zh_cn/cloudfw/2017-12-07/api-docs.php | 59913 |
1 files changed, 59913 insertions, 0 deletions
diff --git a/data/zh_cn/cloudfw/2017-12-07/api-docs.php b/data/zh_cn/cloudfw/2017-12-07/api-docs.php new file mode 100644 index 0000000..96325b0 --- /dev/null +++ b/data/zh_cn/cloudfw/2017-12-07/api-docs.php @@ -0,0 +1,59913 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cloudfw', + 'version' => '2017-12-07', + ], + 'directories' => [ + [ + 'id' => 362724, + 'title' => '概览', + 'type' => 'directory', + 'children' => [ + 'DescribeUserBuyVersion', + 'DescribeSlrGrant', + 'DescribeMemberInfo', + 'DescribeInstanceRiskLevels', + 'DescribeInternetOpenStatistic', + 'ModifyCfwInstance', + 'ReleasePostInstance', + 'ReleaseExpiredInstance', + 'DescribeRiskEventTopAttackAsset', + 'DescribeAttackAppCategory', + 'DescribeOutgoingRiskTrend', + 'DescribeUnprotectedPortTrend', + 'DescribeVpcFirewallDropTrafficTrend', + 'DescribeOutgoingRiskDomainAndIpCount', + [ + 'id' => 362739, + 'title' => '流量趋势', + 'type' => 'directory', + 'children' => [ + 'DescribeNatFirewallDropTrafficTrend', + 'DescribeInternetDropTrafficTrend', + 'DescribeInvadeEcsTrend', + ], + ], + [ + 'id' => 362743, + 'title' => '按量付费', + 'type' => 'directory', + 'children' => [ + 'DescribePostpayEnabledProtection', + 'DescribePostpayTrafficTotal', + 'DescribePostpayTrafficDetail', + 'DescribePostpayUserInternetStatus', + 'DescribePostpayUserNatStatus', + 'DescribePostpayUserVpcStatus', + 'UpdatePostpayUserInternetStatus', + 'UpdatePostpayUserNatStatus', + 'UpdatePostpayUserVpcStatus', + ], + ], + ], + ], + [ + 'id' => 362753, + 'title' => '防火墙开关', + 'type' => 'directory', + 'children' => [ + 'DescribeRegionInfo', + 'DescribeCtrlInstanceMemberAccounts', + 'DescribeFirewallTask', + [ + 'id' => 362757, + 'title' => '互联网边界防火墙', + 'type' => 'directory', + 'children' => [ + 'DescribeResourceTypeAutoEnable', + 'DescribeAssetList', + 'DescribeAssetStatistic', + 'DescribeAssetRiskList', + 'CreateInstanceSyncTask', + 'ModifyResourceTypeAutoEnable', + 'PutEnableFwSwitch', + 'PutEnableAllFwSwitch', + 'PutDisableFwSwitch', + 'PutDisableAllFwSwitch', + ], + ], + [ + 'id' => 362768, + 'title' => 'NAT边界防火墙', + 'type' => 'directory', + 'children' => [ + 'DescribeNatFirewallQuota', + 'DescribeNatFirewallList', + 'DescribeFirewallVSwitch', + 'DescribeNatFirewallPrecheckDetail', + 'DescribeFirewallVswitchResources', + 'DescribeSecurityProxyResources', + 'CreateNatFirewallSyncTask', + 'CreateNatFirewallPreCheck', + 'CreateSecurityProxy', + 'SwitchSecurityProxy', + 'UpdateSecurityProxy', + 'DeleteSecurityProxy', + ], + ], + [ + 'id' => 362781, + 'title' => 'VPC边界防火墙', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallSummaryInfo', + 'DescribeVpcFirewallAccessDetail', + 'DescribeVpcFirewallPrecheckDetail', + 'CreateVpcFirewallPrecheck', + 'CreateVpcFirewallTask', + [ + 'id' => 362787, + 'title' => '云企业网（企业版）', + 'type' => 'directory', + 'children' => [ + 'DescribeTrFirewallsV2List', + 'DescribeTrFirewallsV2Detail', + 'DescribeTrFirewallsV2RouteList', + 'DescribeTrFirewallV2RoutePolicyList', + 'DescribeTrFirewallPolicyBackUpAssociationList', + 'DescribeTransitRouterResourcesList', + 'CreateTrFirewallV2', + 'CreateTrFirewallV2RoutePolicy', + 'ModifyTrFirewallV2Configuration', + 'ModifyFirewallV2RoutePolicySwitch', + 'ModifyTrFirewallV2RoutePolicyScope', + 'DeleteTrFirewallV2', + 'DeleteFirewallV2RoutePolicies', + ], + ], + [ + 'id' => 362801, + 'title' => '云企业网（基础版）', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallCenSummaryList', + 'DescribeVpcFirewallCenList', + 'DescribeVpcFirewallCenDetail', + 'DescribeNetworkInstanceList', + 'DescribeVpcZone', + 'DescribeVpcFirewallZone', + 'DescribeVpcFirewallManualVSwitchList', + 'CreateVpcFirewallCenConfigure', + 'ModifyVpcFirewallCenConfigure', + 'ModifyVpcFirewallCenSwitchStatus', + 'DeleteVpcFirewallCenConfigure', + ], + ], + [ + 'id' => 362813, + 'title' => '高速通道', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallList', + 'DescribeVpcFirewallDetail', + 'CreateVpcFirewallConfigure', + 'ModifyVpcFirewallConfigure', + 'ModifyVpcFirewallSwitchStatus', + 'DeleteVpcFirewallConfigure', + ], + ], + ], + ], + ], + ], + [ + 'id' => 362820, + 'title' => '流量分析', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 362821, + 'title' => '主动外联', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 362822, + 'title' => '可视分析', + 'type' => 'directory', + 'children' => [ + 'DescribeInternetTimeTop', + 'DescribeNatFirewallTimeTop', + ], + ], + 'DescribeNetworkTrafficTopRatio', + 'DescribeOutgoingStatistic', + 'DescribeOutgoingAssetList', + 'DescribeConfiguredDomainNames', + 'DescribeConfiguredDestinationIP', + 'DescribeOutgoingDestinationCategory', + 'DescribeOutgoingTag', + 'DescribeOutgoingDomain', + 'DescribeOutgoingDomainDetail', + 'DescribeOutgoingDestination', + 'DescribeOutgoingDestinationIP', + 'DescribeOutgoingDestinationIPDetail', + ], + ], + [ + 'id' => 362837, + 'title' => '公网暴露', + 'type' => 'directory', + 'children' => [ + 'DescribeInternetTrafficTop', + 'DescribeInternetTrafficTrend', + 'DescribeNatFirewallTrafficTrend', + 'DescribeInternetServiceNameList', + 'DescribeInternetOpenIp', + 'DescribeInternetOpenPort', + 'DescribeInternetOpenService', + 'DescribeInternetOpenDetail', + 'DescribeInternetSlb', + 'DescribeOpenIpAccessSrcStat', + ], + ], + [ + 'id' => 362848, + 'title' => 'VPC互访', + 'type' => 'directory', + 'children' => [ + 'DescribeNetworkInstanceRelationList', + 'DescribeVpcFirewallAssetList', + ], + ], + [ + 'id' => 362851, + 'title' => 'AI访问流量', + 'type' => 'directory', + 'children' => [ + 'DescribeAITrafficAnalysisStatus', + 'DescribeVpcFirewallDomainList', + 'DescribeVpcFirewallDomainRelationList', + 'UpdateAITrafficAnalysisStatus', + 'ModifyObjectGroupOperation', + ], + ], + ], + ], + [ + 'id' => 362857, + 'title' => '检测响应', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 362858, + 'title' => '入侵防御', + 'type' => 'directory', + 'children' => [ + 'DescribeRiskEventTopAttackApp', + 'DescribeRiskEventTopAttackType', + 'DescribeRiskEventStatistic', + 'DescribeRiskEventPayload', + 'DescribeRiskEventGroup', + ], + ], + [ + 'id' => 362864, + 'title' => '漏洞防护', + 'type' => 'directory', + 'children' => [ + 'DescribeVulnerabilityProtectedList', + 'DescribeUnprotectedVulnTrend', + ], + ], + [ + 'id' => 362867, + 'title' => '失陷感知', + 'type' => 'directory', + 'children' => [ + 'DescribeInvadeEventList', + 'DescribeInvadeEventNameList', + 'DescribeInvadeEventStatistic', + 'DescribeInvadeEventDetail', + ], + ], + [ + 'id' => 362872, + 'title' => '数据泄露', + 'type' => 'directory', + 'children' => [ + 'DescribeSdlEventList', + 'DescribeSdlEventSdList', + 'DescribeSdlEventDetail', + 'DescribeSdlEventStatistic', + 'DescribeSdlStatistic', + 'DescribeSensitiveSwitch', + 'ModifySensitiveSwitch', + 'EnableSdlProtectedAsset', + 'DisableSdlProtectedAsset', + ], + ], + ], + ], + [ + 'id' => 362882, + 'title' => '防护配置', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 362883, + 'title' => '访问控制', + 'type' => 'directory', + 'children' => [ + 'DescribeAclApps', + 'DescribeAclWhitelist', + [ + 'id' => 362886, + 'title' => '互联网边界', + 'type' => 'directory', + 'children' => [ + 'DescribeAclRuleCount', + 'DescribeControlPolicy', + 'DescribeACLProtectTrend', + 'DescribePolicyAdvancedConfig', + 'DescribePolicyPriorUsed', + 'DescribeControlPolicyDomainResolve', + 'AddControlPolicy', + 'AddDomainResolveRealtimeTask', + 'ModifyControlPolicy', + 'ModifyControlPolicyPriority', + 'ModifyPolicyAdvancedConfig', + 'DeleteControlPolicy', + 'DeleteControlPolicyTemplate', + 'ResetRuleHitCount', + ], + ], + [ + 'id' => 362901, + 'title' => 'NAT边界', + 'type' => 'directory', + 'children' => [ + 'DescribeNatAclPageStatus', + 'DescribeNatFirewallAclGroupList', + 'DescribeNatFirewallControlPolicy', + 'DescribeNatFirewallPolicyPriorUsed', + 'CreateNatFirewallControlPolicy', + 'ModifyNatFirewallControlPolicy', + 'ModifyNatFirewallControlPolicyPosition', + 'ResetNatFirewallRuleHitCount', + 'DeleteNatFirewallControlPolicy', + 'DeleteNatFirewallControlPolicyBatch', + ], + ], + [ + 'id' => 362912, + 'title' => 'VPC边界', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallAssetRegionList', + 'DescribeVpcFirewallAclGroupList', + 'DescribeVpcFirewallControlPolicy', + 'DescribeVpcFirewallPolicyPriorUsed', + 'CreateVpcFirewallControlPolicy', + 'ModifyVpcFirewallControlPolicy', + 'ModifyVpcFirewallControlPolicyPosition', + 'ModifyVpcFirewallAclEngineMode', + 'ResetVpcFirewallRuleHitCount', + 'DeleteVpcFirewallControlPolicy', + 'BatchDeleteVpcFirewallControlPolicy', + ], + ], + [ + 'id' => 362924, + 'title' => 'DNS边界', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcListLite', + 'DescribeDnsFirewallPolicy', + 'DescribePrefixLists', + 'AddDnsFirewallPolicy', + 'ModifyDnsFirewallPolicy', + 'DeleteDnsFirewallPolicy', + ], + ], + ], + ], + [ + 'id' => 362931, + 'title' => 'IPS防护', + 'type' => 'directory', + 'children' => [ + 'DescribeThreatIntelligenceSwitch', + 'ModifyThreatIntelligenceSwitch', + 'ModifyIpsRulesToDefault', + 'DescribeSignatureLibVersion', + [ + 'id' => 362936, + 'title' => '互联网边界', + 'type' => 'directory', + 'children' => [ + 'DescribeDefaultIPSConfig', + 'DescribeUserIPSWhitelist', + 'ModifyIpsRules', + 'ModifyDefaultIPSConfig', + 'ModifyUserIPSWhitelist', + [ + 'id' => 362942, + 'title' => '私网溯源', + 'type' => 'directory', + 'children' => [ + 'DescribeIpsPrivateAssoc', + 'CreateIpsPrivateAssoc', + 'DeleteIpsPrivateAssoc', + ], + ], + ], + ], + [ + 'id' => 362946, + 'title' => 'VPC边界', + 'type' => 'directory', + 'children' => [ + 'DescribeVfwIPSConfigList', + 'DescribeVpcFirewallDefaultIPSConfig', + 'DescribeVpcFirewallIPSWhitelist', + 'ModifyVpcFirewallDefaultIPSConfig', + 'ModifyVpcFirewallIPSWhitelist', + ], + ], + ], + ], + [ + 'id' => 362952, + 'title' => 'TLS检查', + 'type' => 'directory', + 'children' => [ + 'ListTlsInspectCACertificates', + 'GetTlsInspectCertificateDownloadUrl', + ], + ], + [ + 'id' => 362955, + 'title' => '策略分析', + 'type' => 'directory', + 'children' => [ + 'DescribeAclCheckQuota', + 'DescribeAclChecks', + 'DescribeAclCheck', + 'CreateAclCheck', + 'UpdateAclCheckDetailStatus', + ], + ], + [ + 'id' => 362961, + 'title' => '地址簿', + 'type' => 'directory', + 'children' => [ + 'DescribeAddressBook', + 'AddAddressBook', + 'ModifyAddressBook', + 'DeleteAddressBook', + ], + ], + [ + 'id' => 362966, + 'title' => '同步节点', + 'type' => 'directory', + 'children' => [ + 'DescribeAccessInstanceRegionList', + 'DescribeAccessInstanceTask', + 'DescribeAccessInstanceVpcList', + 'DescribeAccessInstanceVSwitchList', + 'DescribeAccessInstanceZoneList', + [ + 'id' => 362972, + 'title' => 'ACK集群', + 'type' => 'directory', + 'children' => [ + 'DescribeAckClusters', + 'DescribeAckClusterConnectors', + 'DescribeAckClusterConnector', + 'DescribeAckClusterNamespaces', + 'DescribeAckClusterPodLabels', + 'CreateAckClusterConnector', + 'UpdateAckClusterConnector', + 'DeleteAckClusterConnector', + ], + ], + [ + 'id' => 362981, + 'title' => '私有DNS', + 'type' => 'directory', + 'children' => [ + 'DescribePrivateDnsEndpointList', + 'DescribePrivateDnsEndpointDetail', + 'DescribePrivateDnsStatistics', + 'CreatePrivateDnsEndpoint', + 'ModifyPrivateDnsEndpoint', + 'DeletePrivateDnsEndpoint', + 'DescribePrivateDnsDomainNameList', + 'AddPrivateDnsDomainName', + 'DeletePrivateDnsDomainName', + 'DeletePrivateDnsAllDomainName', + ], + ], + ], + ], + ], + ], + [ + 'id' => 362992, + 'title' => '日志监控', + 'type' => 'directory', + 'children' => [ + 'DescribeLogStoreInfo', + 'DescribeTrafficLog', + 'DescribeSlsAnalyzeOpenStatus', + 'DescribeClearAuthInfo', + 'DescribeLocationInfo', + 'DescribeIspInfo', + 'DescribeCreatedNatFirewall', + 'DescribeBatchSlsDispatchStatus', + 'CreateSlsLogDispatch', + 'ModifySlsDispatchStatus', + 'ModifyUserSlsLogStorageTime', + 'ClearLogStoreStorage', + ], + ], + [ + 'id' => 363005, + 'title' => '系统设置', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 363006, + 'title' => '告警通知', + 'type' => 'directory', + 'children' => [ + 'DescribeUserAlarmConfig', + 'ModifyUserAlarmConfig', + ], + ], + [ + 'id' => 363009, + 'title' => '多账号统一管理', + 'type' => 'directory', + 'children' => [ + 'DescribeInstanceRdAccounts', + 'DescribeInstanceMembers', + 'AddInstanceMembers', + 'ModifyInstanceMemberAttributes', + 'DeleteInstanceMembers', + ], + ], + [ + 'id' => 363015, + 'title' => '下载任务', + 'type' => 'directory', + 'children' => [ + 'DescribeDownloadTask', + 'DescribeDownloadTaskType', + 'CreateDownloadTask', + 'DeleteDownloadTask', + ], + ], + [ + 'id' => 363020, + 'title' => '工具箱', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 363021, + 'title' => '策略备份与回滚', + 'type' => 'directory', + 'children' => [ + 'DescribeAclBackupList', + 'AddAclBackupData', + 'UseAclBackupData', + 'DeleteAclBackupData', + ], + ], + 'DescribeSecurityMode', + ], + ], + ], + ], + [ + 'id' => 363027, + 'title' => '废弃', + 'type' => 'directory', + 'children' => [ + 'DescribePageDocuments', + 'DescribeDomainResolve', + 'DescribeFirewallDropStatistics', + 'DescribeUserAssetIPTrafficInfo', + 'DescribeCfwRiskLevelSummary', + 'DescribeRiskSecurityGroupDetail', + 'DescribeSecurityProxy', + 'CreateVpcFirewallCenManualConfigure', + 'BatchCopyVpcFirewallControlPolicy', + 'ModifyControlPolicyPosition', + ], + ], + [ + 'id' => 363038, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribeVpcFirewallTrafficAssetList', + 'SetAutoProtectNewAssets', + 'DescribeRegionResourceTypeAutoEnable', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeUserBuyVersion' => [ + 'summary' => '获取用户版本信息。', + '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' => '实例ID。若填写实例ID，则根据实例ID查询。不填写则默认查询最新实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '云防火墙账号的AliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '119898001566xxxx', + ], + 'InstanceId' => [ + 'description' => '购买的云防火墙实例id。'."\n" + ."\n" + .'> 使用试用版本时此字段无意义。', + 'type' => 'string', + 'example' => 'vipcloudfw-cn-xxxxx', + ], + 'StartTime' => [ + 'description' => '云防火墙实例的开通时间。'."\n" + .'>使用毫秒级时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1692504764000', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'F71B03EE-xxxxx-91D79CC6AA1A', + ], + 'Version' => [ + 'description' => '云防火墙实例的版本信息。取值：'."\n" + .'- **2**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **4**：旗舰版'."\n" + .'- **10**：按量付费版本', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UserStatus' => [ + 'description' => '云防火墙实例的状态。取值：'."\n" + .'- **true**：有效'."\n" + .'- **false**：无效', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Expire' => [ + 'description' => '云防火墙实例的到期时间。'."\n" + .'>使用毫秒级时间戳格式。'."\n" + ."\n" + .'>使用按量付费版本时该字段无意义。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1726934400000', + ], + 'LogStatus' => [ + 'description' => '日志投递开启状态。取值：'."\n" + .'- **true**：已开启'."\n" + .'- **false**：未开启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceStatus' => [ + 'description' => '云防火墙实例的生产状态。取值：'."\n" + ."\n" + .'- **normal**：实例正常运行中'."\n" + ."\n" + .'- **init**：实例初始化中'."\n" + ."\n" + .'- **deleting**：实例正在删除 '."\n" + ."\n" + .'- **abnormal**：实例存在异常'."\n" + ."\n" + .'- **free**：无有效实例', + 'type' => 'string', + 'example' => 'normal', + ], + 'MaxOverflow' => [ + 'description' => '是否开通超量弹性计费。取值：'."\n" + .'- **1000000**：已开通'."\n" + .'- **0**：未开通'."\n" + ."\n" + .'> 该字段仅对包年包月用户生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'VpcNumber' => [ + 'description' => '购买的VPC边界防护规格数。'."\n" + ."\n" + .'> 该字段仅对包年包月用户生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'IpNumber' => [ + 'description' => '购买的互联网边界防护规格数。'."\n" + ."\n" + .'> 该字段仅对包年包月用户生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63', + ], + 'LogStorage' => [ + 'description' => '购买的日志存储容量。'."\n" + .'> 该字段仅对包年包月用户生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'InternetBandwidth' => [ + 'description' => '购买的互联网防火墙流量处理能力。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'VpcBandwidth' => [ + 'description' => '购买的VPC防火墙流量处理能力。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'NatBandwidth' => [ + 'description' => '购买的NAT防火墙流量处理能力。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'MajorVersion' => [ + 'title' => '主版本', + 'description' => '主版本', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DefaultBandwidth' => [ + 'title' => '版本默认带宽', + 'description' => '版本默认带宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ExtensionBandwidth' => [ + 'title' => '拓展带宽', + 'description' => '拓展带宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'TemporaryBandwidth' => [ + 'title' => '临时升级带宽', + 'description' => '临时升级带宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'GeneralInstance' => [ + 'title' => '通用实例规格数', + 'description' => '通用实例规格数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ThreatIntelligence' => [ + 'title' => '威胁情报开通状态', + 'description' => '威胁情报开通状态', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Sdl' => [ + 'title' => '数据泄漏开通状态', + 'description' => '数据泄漏开通状态', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PrivateDnsConnectorQuota' => [ + 'title' => '私有DNS连接器配额', + 'description' => '私有DNS连接器配额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'AckClusterConnectorQuota' => [ + 'title' => 'ACK集群连接器配额', + 'description' => 'ACK集群连接器配额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + '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' => '获取用户云防火墙实例信息', + 'description' => '本接口一般用于查询获取用户云防火墙实例信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP地址。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '获取用户SLR授权信息', + ], + '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' => '成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '150795602499****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果的请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'F2665618-3C41-51A4-8DAF-586FB68****', + ], + 'MemberUid' => [ + 'description' => '成员账号UID。', + 'type' => 'string', + 'example' => '128720273643****', + ], + 'AdminUid' => [ + 'description' => '主账号UID。', + '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"}]', + 'title' => '查询成员信息', + ], + 'DescribeInstanceRiskLevels' => [ + 'summary' => '查询实例风险等级。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '实例列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例列表。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '实例的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '181ad081-e4f2-4e3e-b925-03b67f648397', + ], + 'InstanceId' => [ + 'description' => '云防火墙的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vipcloudfw-cn-7mz2fj8nm0u', + ], + 'IntranetIp' => [ + 'description' => '实例的私网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.17.XX.XX', + ], + 'InternetIp' => [ + 'description' => '实例的公网IP。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的公网IP。', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '9AABB1B7-C81F-5158-9EF9-B2DD5D3DA014', + ], + 'InstanceRisks' => [ + 'description' => '实例风险列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '云防火墙实例的ID。', + 'type' => 'string', + 'example' => 'vipcloudfw-cn-7mz2fj8nm0u', + ], + 'Level' => [ + 'description' => '风险等级。取值包括：'."\n" + .'- **medium**：中等', + 'type' => 'string', + 'example' => 'medium', + ], + 'Details' => [ + 'description' => 'ECS实例风险列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS实例风险列表。', + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => '服务器IP地址。', + 'type' => 'string', + 'example' => '203.107.XX.XX', + ], + 'Type' => [ + 'description' => '类型。', + 'type' => 'string', + 'example' => 'ResourceNotProtected', + ], + 'Level' => [ + 'description' => '风险等级。取值包括：'."\n" + .'- **medium**：中等', + 'type' => 'string', + 'example' => 'medium', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例风险等级', + ], + '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' => '访问者源IP地址。', + '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' => '全部开放公网IP。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'InternetPortNum' => [ + 'description' => '全部开放端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '38', + ], + 'InternetUnprotectedPortNum' => [ + 'description' => '未受ACL保护端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'InternetRiskServiceNum' => [ + 'description' => '风险应用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '6AB7822C-0D73-5D1D-81FD-45D4FB7C****', + ], + 'InternetRiskPortNum' => [ + 'description' => '风险端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'InternetRiskIpNum' => [ + 'description' => '风险开放公网IP。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'InternetSlbIpNum' => [ + 'description' => 'SLB公网IP数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InternetServiceNum' => [ + 'description' => '全部开放应用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'InternetSlbIpPortNum' => [ + 'description' => 'SLB公网端口数。', + '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"}]', + 'title' => '获取互联网开放统计', + ], + 'ModifyCfwInstance' => [ + 'summary' => '更新用户实例相关信息，用于按量付费2.0用户。', + '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' => '云防火墙实例的ID。', + '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' => '更新的实例属性的Code。'."\n" + .'目前支持：'."\n" + ."\n" + .'- Code：MajorVersion，对应Value可选值：2。仅对按量付费1.0用户支持，即按量付费1.0升级为按量付费2.0。'."\n" + .'><warning>请确保已充分了解按量付费2.0的收费方式和价格。></warning>'."\n" + .'><warning>请注意，若升级前已开启日志投递，升级后日志投递会继续开启，且会切换至新日志库。></warning>'."\n" + .'- Code: ThreatIntelligence，对应Value可选值：0,1。仅对按量付费2.0用户支持，用于按量付费2.0用户开关威胁情报。'."\n" + .'- Code: Sdl，对应Value可选值：0,1。仅对按量付费2.0用户支持，用于按量付费2.0用户开关敏感数据泄漏检测。', + 'type' => 'string', + 'required' => false, + 'example' => 'Sdl', + ], + 'Value' => [ + 'description' => '对应Code的Value。可选值详见Code描述。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '修改云防火墙实例', + 'description' => '请确保在使用该接口前，已充分了解云防火墙产品按量版的收费方式和[价格](https://help.aliyun.com/zh/cloud-firewall/cloudfirewall/product-overview/pay-as-you-go)。', + ], + 'ReleasePostInstance' => [ + 'summary' => '释放按量付费防火墙。', + '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' => '云防火墙实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'EE316A19-xxxx-5043-9DF1-C04458ABC570', + ], + 'Success' => [ + 'description' => '本次请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReleaseStatus' => [ + 'description' => '是否释放成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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' => '释放按量付费防火墙', + ], + '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' => '云防火墙实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cfw-y3gpqq705****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '结果的请求id。', + 'type' => 'string', + 'example' => '9EC1DB0F-EE53-5D36-B5DA-71CB******', + ], + 'Success' => [ + 'description' => '本次请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReleaseStatus' => [ + 'description' => '是否释放成功：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + '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"}]', + 'title' => '释放已到期防火墙实例', + ], + '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' => '访问者源IP地址。', + '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' => '请求ID。', + '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' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-8vbdrjrxzt78****', + ], + 'RegionNo' => [ + 'description' => '地域id。', + 'type' => 'string', + 'example' => 'cn-chengdu', + ], + 'Ip' => [ + 'description' => 'IP地址。', + '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"}]', + 'title' => '获取top风险事件资产', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果的请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询攻击类别列表', + 'description' => '本接口一般用于分页查询云防火墙防护的资产的信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP地址。', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '1CA8D98E-A71B-5856-A658-3E8B3152E****', + ], + 'Interval' => [ + 'description' => '时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'TotalRiskIp' => [ + 'description' => '全部风险IP。', + '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' => '风险IP数。', + '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"}]', + 'title' => '查询外联风险趋势', + ], + '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' => '访问者源IP地址。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询未保护的端口趋势', + ], + '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' => '访问者源IP地址。', + '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' => '升降序。取值：'."\n" + ."\n" + .'- **asc**：升序。'."\n" + .'- **desc**（默认）：降序。', + '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' => '返回结果的请求ID。', + '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' => 'ACL拦截数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'IpsDrop' => [ + 'description' => 'IPS拦截数。', + '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"}]', + 'title' => '查询VPC防火墙拦截趋势', + ], + 'DescribeOutgoingRiskDomainAndIpCount' => [ + 'summary' => '获取入侵防御风险数。', + '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' => '返回结果的请求ID。', + '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' => '风险IP数量。', + '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"}]', + 'title' => '获取入侵防御风险数', + ], + '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' => '访问源IP地址。', + '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' => '请求ID。', + '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"}]', + 'title' => '概览页-nat防火墙拦截趋势。', + ], + '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' => '访问源的IP地址。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'RatioAverage' => [ + 'description' => '流量倍增模式。取值：-**0**：优先级方式-**1**：负载均衡方式', + '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' => '查询到的ip地址的数量。', + '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' => '对象取值范围：**\\[0,10000\\]**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DropRingRatio' => [ + 'description' => '网络流量的速率。单位：kbps。', + '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"}]', + 'title' => '互联网防御趋势', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP地址。', + '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' => '返回结果的请求ID。', + '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' => 'ECS数量。', + '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"}]', + 'title' => '查询ECS漏洞趋势', + ], + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询按量付费版本防护状态', + ], + 'DescribePostpayTrafficTotal' => [ + 'summary' => '查询后付费计费流量总计，包括各个边界防火墙。', + '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' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalAssets' => [ + 'title' => '总数', + 'description' => '所有边界防护总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '826B6280-9704-5643-97B1-6B47AC3F027A', + ], + 'TotalTraffic' => [ + 'description' => '总流量。包年包月版本对应为弹性处理总流量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2320274874426', + ], + 'TotalNatAssets' => [ + 'description' => 'NAT边界防护总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalNatTraffic' => [ + 'description' => 'NAT边界总流量。包年包月版本对应为NAT边界弹性处理总流量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '560646279', + ], + 'TotalVpcAssets' => [ + 'description' => 'VPC边界防护总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'TotalVpcTraffic' => [ + 'description' => 'VPC边界总流量。包年包月版本对应为VPC边界弹性处理总流量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2320274874426', + ], + 'TotalInternetAssets' => [ + 'description' => '互联网边界防护总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '128', + ], + 'TotalInternetTraffic' => [ + 'description' => '互联网边界总流量。包年包月版本对应为互联网边界弹性处理总流量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2320274874426', + ], + 'TotalBillTraffic' => [ + 'description' => '包年包月版本对应为弹性处理总出账流量，即减免后的流量大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2320274874426', + ], + 'TotalSdlFreeTraffic' => [ + 'description' => '数据泄漏检测总免费使用流量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TotalSdlBillTraffic' => [ + 'description' => '数据泄漏检测总计费流量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + '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' => '查询后付费计费流量总计', + 'description' => '统计范围为该用户当前云防火墙实例，包括自购买之日起的所有数据。', + ], + 'DescribePostpayTrafficDetail' => [ + 'summary' => '查询后付费计费流量明细。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为10。可设置的最大值为50。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。'."\n" + .'默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => '设置查询开始时间。使用YYYYMMDD格式的日期表示。', + 'type' => 'string', + 'required' => true, + 'example' => '20240101', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询结束时间。使用YYYYMMDD格式的日期表示。', + 'type' => 'string', + 'required' => true, + 'example' => '20240131', + ], + ], + [ + 'name' => 'SearchItem', + 'in' => 'query', + 'schema' => [ + 'description' => '资产的IP或者实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'TrafficType', + 'in' => 'query', + 'schema' => [ + 'description' => '统计流量的边界类型。必填。取值：'."\n" + .' '."\n" + .'- **EIP_TRAFFIC**：互联网边界流量。'."\n" + .' '."\n" + .'- **NatGateway_TRAFFIC**：NAT边界流量。'."\n" + .'- **VPC_TRAFFIC**：VPC边界流量。', + 'type' => 'string', + 'required' => true, + 'example' => 'VPC_TRAFFIC', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按照指定的字段排序。取值：'."\n" + ."\n" + .'- **resourceId**：资源ID。'."\n" + .'- **trafficDay**：日期。', + 'type' => 'string', + 'required' => false, + 'example' => 'resourceId', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '地域信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '流量统计总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '0525EADE-C112-5702-A5BC-0E2F6F94DB23', + ], + 'TrafficList' => [ + 'description' => '流量统计列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量统计信息。', + 'type' => 'object', + 'properties' => [ + 'TrafficDay' => [ + 'description' => '流量统计日期。', + 'type' => 'string', + 'example' => '20231001', + ], + 'TrafficType' => [ + 'description' => '统计流量的边界类型。取值：'."\n" + .' '."\n" + .'- **EIP_TRAFFIC**：互联网边界流量。'."\n" + .' '."\n" + .'- **NatGateway_TRAFFIC**：NAT边界流量。'."\n" + .'- **VPC_TRAFFIC**：VPC边界流量。', + 'type' => 'string', + 'example' => 'EIP_TRAFFIC', + ], + 'InstanceId' => [ + 'description' => '资产实例的ID。', + 'type' => 'string', + 'example' => 'i-8vb2d7c9mtn0bo9qcraq', + ], + 'ResourceId' => [ + 'description' => '资源ID。互联网边界为资产的公网IP，NAT边界为资产的防火墙实例ID。', + 'type' => 'string', + 'example' => '39.106.146.214', + ], + 'InstanceType' => [ + 'description' => '资产类型。仅互联网边界该值生效。', + 'type' => 'string', + 'example' => 'EcsPublicIP', + ], + 'TotalBytes' => [ + 'description' => '出方向和入方向总的网络吞吐量（总共发送和接收多少字节）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1215096939', + ], + 'InBytes' => [ + 'description' => '入方向的网络吞吐量（总计字节数）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1115096939', + ], + 'OutBytes' => [ + 'description' => '出方向的网络吞吐量（总计字节数）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000', + ], + 'ProtectionDuration' => [ + 'description' => '防护时长（单位：小时）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RegionNo' => [ + 'description' => '所在地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询后付费计费流量明细', + 'description' => '该明细对于按量付费用户精确至具体资源实例粒度，对于包年包月用户仅支持整体查询。', + ], + 'DescribePostpayUserInternetStatus' => [ + 'summary' => '查询按量付费用户互联网边界开关模块状态。', + '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' => '云防火墙实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-zsk39m******', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '返回消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '0DC783F1-B3A7-578D-8A63-*****', + ], + 'Status' => [ + 'description' => '云防火墙互联网边界开关模块状态。取值：'."\n" + ."\n" + .'- **open**：模块已开启。'."\n" + .'- **init**：模块开启中。'."\n" + .'- **closed**：模块未开启。', + 'type' => 'string', + 'example' => 'open', + ], + 'UnprotectedDate' => [ + 'description' => '未开启防护的天数。仅当模块开启时，该参数有效。', + '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' => '查询按量付费用户互联网边界开关模块状态', + ], + 'DescribePostpayUserNatStatus' => [ + 'summary' => '查询按量付费用户NAT边界开关模块状态。', + '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' => '云防火墙实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-zsk39m******', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '6B780BD6-282C-51A9-A8E6-59F636******', + ], + 'Status' => [ + 'description' => '云防火墙NAT边界开关模块状态。取值：'."\n" + ."\n" + .'- **open**：模块已开启。'."\n" + .'- **init**：模块开启中。'."\n" + .'- **closed**：模块未开启。', + 'type' => 'string', + 'example' => 'open', + ], + 'UnprotectedDate' => [ + 'description' => '未开启防护的天数。仅当模块开启时，该参数有效。', + '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' => '查询按量付费用户NAT边界开关模块状态', + ], + 'DescribePostpayUserVpcStatus' => [ + 'summary' => '查询按量付费用户VPC边界开关模块状态。', + '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' => '云防火墙实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-************', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + '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' => '7447795A-39AB-52CB-8F92-128DF******', + ], + 'Status' => [ + 'description' => '云防火墙VPC边界开关模块状态。取值：'."\n" + ."\n" + .'- **open**：模块已开启。'."\n" + .'- **init**：模块开启中。'."\n" + .'- **closed**：模块未开启。', + 'type' => 'string', + 'example' => 'open', + ], + 'UnprotectedDate' => [ + 'description' => '未开启防护的天数。仅当模块开启时，该参数有效。', + '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' => '查询按量付费用户VPC边界开关模块状态', + ], + 'UpdatePostpayUserInternetStatus' => [ + 'summary' => '更新按量付费用户互联网边界开关模块状态。', + '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' => '云防火墙实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-zsk39m******', + ], + ], + [ + 'name' => 'Operate', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型，目前只支持开通操作。'."\n" + ."\n" + .'- open: 开通', + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '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' => '更新按量付费用户互联网边界开关模块状态', + ], + 'UpdatePostpayUserNatStatus' => [ + 'summary' => '更新按量付费用户NAT边界开关模块状态。', + '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' => '云防火墙实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-************', + ], + ], + [ + 'name' => 'Operate', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型，目前只支持开通操作。'."\n" + ."\n" + .'- open: 开通', + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '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' => '更新按量付费用户NAT边界开关模块状态', + ], + 'UpdatePostpayUserVpcStatus' => [ + 'summary' => '更新按量付费用户VPC边界开关模块状态。', + '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' => '云防火墙实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfw_elasticity_public_cn-************', + ], + ], + [ + 'name' => 'Operate', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型，目前只支持开通操作。'."\n" + .'- open: 开通', + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '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' => '更新按量付费用户VPC边界开关模块状态', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '59.82.59.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '25E655B0-CAED-53D4-8054-F983126****', + ], + 'DataList' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据对象。', + 'type' => 'object', + 'properties' => [ + 'RegionName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '上海', + ], + 'RegionId' => [ + 'description' => '地域id。', + '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"}]', + 'title' => '获取Region信息', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '获取成员账号列表', + 'description' => '本接口一般用于查询云防火墙成员账号信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ChildInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-cd6000c588214403****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务的类型。枚举类型：'."\n" + ."\n" + .'- **NAT**：NAT边界任务'."\n" + ."\n" + .'- **VPC**：VPC边界任务', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '199431783', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsFound' => [ + 'description' => '是否存在任务。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TaskStatus' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **init**'."\n" + ."\n" + .'- **running**'."\n" + ."\n" + .'- **finished**'."\n" + ."\n" + .'- **rollback**'."\n" + ."\n" + .'- **rollbackDone**', + 'type' => 'string', + 'example' => 'init', + ], + 'TaskWaitingTime' => [ + 'description' => '等待时间，单位：分钟。', + 'type' => 'string', + 'example' => '30', + ], + 'TaskSteps' => [ + 'description' => '任务步骤。', + 'type' => 'array', + 'items' => [ + 'description' => '任务步骤。', + 'type' => 'object', + 'properties' => [ + 'StepStatus' => [ + 'description' => '任务步骤状态。枚举类型：'."\n" + ."\n" + .'- **init** '."\n" + ."\n" + .'- **running**'."\n" + ."\n" + .'- **finished**'."\n" + ."\n" + .'- **failed**', + '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' => '返回结果的请求ID。', + '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' => '任务ID。', + '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"}]', + 'title' => '获取防火墙任务', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + '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。', + '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"}]', + 'title' => '查询资产类型默认引流', + 'description' => '本接口一般用于获取域名DNS的解析结果。当前仅支持从阿里云云解析DNS获取解析结果。要查询的域名必须使用云解析DNS，才能查询到其解析结果。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeAssetList' => [ + 'summary' => '查询云防火墙防护的资产的信息。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + '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' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙所在的地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙状态。取值：'."\n" + ."\n" + .'- **open**：保护中。'."\n" + .'- **opening**：保护开启中。'."\n" + .'- **closed**：保护未开启。'."\n" + .'- **closing**：保护关闭中。'."\n" + ."\n" + .'>不设置该参数表示查询所有防火墙状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'SearchItem', + 'in' => 'query', + 'schema' => [ + 'description' => '资产的IP或者实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '本参数已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'eip', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资产类型。取值：'."\n" + ."\n" + .'- **BastionHostEgressIP**：堡垒机出口IP。'."\n" + .'- **BastionHostIngressIP**：堡垒机入口IP。'."\n" + .'- **EcsEIP**：ECS EIP。'."\n" + .'- **EcsPublicIP**：ECS公网IP。'."\n" + .'- **EIP**：弹性公网IP。'."\n" + .'- **EniEIP**：弹性网卡EIP。'."\n" + .'- **NatEIP**：NAT EIP。'."\n" + .'- **SlbEIP**：SLB EIP(CLB EIP)。'."\n" + .'- **SlbPublicIP**：SLB 公网IP(CLB 公网IP)。'."\n" + .'- **NatPublicIP**：NAT公网IP。'."\n" + .'- **HAVIP**：高可用虚拟IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'EIP', + ], + ], + [ + 'name' => 'SgStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '安全组策略状态。取值：'."\n" + ."\n" + .'- **pass**：已下发。'."\n" + .'- **block**：未下发。'."\n" + .'- **unsupport**：不支持。'."\n" + .'>不设置该参数表示查询所有安全组策略状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'pass', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙防护的资产的IP版本。取值：'."\n" + ."\n" + .'- **4**（默认）：IPv4。'."\n" + .'- **6**：IPv6。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '用户类型。取值：'."\n" + ."\n" + .'- **buy**（默认）：付费用户。'."\n" + .'- **free**：免费用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'buy', + ], + ], + [ + 'name' => 'NewResourceTag', + 'in' => 'query', + 'schema' => [ + 'description' => '资产发现的时间。取值：'."\n" + .'- **discovered in 1 hour**：资产是1小时内新增的。'."\n" + .'- **discovered in 1 day**：资产是1天内新增的。'."\n" + .'- **discovered in 7 days**：资产是7天内新增的。', + 'type' => 'string', + 'required' => false, + 'example' => 'discovered in 1 hour', + ], + ], + [ + 'name' => 'OutStatistic', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询外联流量信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SensitiveStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '数据泄漏检测开启状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '云防火墙防护的资产总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + 'Assets' => [ + 'description' => '云防火墙防护的资产信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '资产的风险级别。取值：'."\n" + ."\n" + .'- **low**：低风险。'."\n" + ."\n" + .'- **middle**：中风险。'."\n" + ."\n" + .'- **hight**：高风险。'."\n" + ."\n" + .'> 仅当UserType的值为free时，才会返回该参数。', + 'type' => 'string', + 'example' => 'low', + ], + 'BindInstanceName' => [ + 'description' => '绑定资产实例名称。', + 'type' => 'string', + 'example' => 'instance01', + ], + 'Type' => [ + 'description' => '该参数已废弃。', + 'type' => 'string', + 'example' => 'eip', + ], + 'SgStatusTime' => [ + 'description' => '最近一次安全组状态检测时间，使用时间戳格式。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615082937', + ], + 'ResourceInstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-8vbdrjrxzt78****', + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '258039427902****', + ], + 'IntranetAddress' => [ + 'description' => '服务器内网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'SyncStatus' => [ + 'description' => '资产引流支持状态。取值：'."\n" + ."\n" + .'- **enable**：支持引流。'."\n" + .'- **disable**：不支持引流。'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'AliUid' => [ + 'description' => '阿里云账号的UID。'."\n" + ."\n" + .'> 云防火墙成员账号的主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158039427902****', + ], + 'ProtectStatus' => [ + 'description' => '防火墙状态。取值：'."\n" + ."\n" + .'- **open**：保护中。'."\n" + .'- **opening**：保护开启中。'."\n" + .'- **closed**：未受保护。'."\n" + .'- **closing**：保护关闭中。'."\n", + 'type' => 'string', + 'example' => 'open', + ], + 'InternetAddress' => [ + 'description' => '服务器公网IP。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'BindInstanceId' => [ + 'description' => '绑定资产实例ID。', + 'type' => 'string', + 'example' => 'i-8vbdrjrxzt78****', + ], + 'RegionID' => [ + 'description' => '资产所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionStatus' => [ + 'description' => '资产所在地域是否支持开启云防火墙防护状态。取值：'."\n" + ."\n" + .'- **enable**：支持。'."\n" + .'- **disable**：不支持。'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'ResourceType' => [ + 'description' => '资产类型。取值：'."\n" + ."\n\n" + .'- **BastionHostEgressIP**：堡垒机出口IP。'."\n" + .'- **BastionHostIngressIP**：堡垒机入口IP。'."\n" + .'- **EcsEIP**：ECS EIP。'."\n" + .'- **EcsPublicIP**：ECS公网IP。'."\n" + .'- **EIP**：弹性公网IP。'."\n" + .'- **EniEIP**：弹性网卡EIP。'."\n" + .'- **NatEIP**：NAT EIP。'."\n" + .'- **SlbEIP**：SLB EIP。'."\n" + .'- **SlbPublicIP**：SLB公网IP。'."\n" + .'- **NatPublicIP**：NAT公网IP。'."\n" + .'- **HAVIP**：高可用虚拟IP。', + 'type' => 'string', + 'example' => 'EIP', + ], + 'IpVersion' => [ + 'description' => '云防火墙防护的资产的IP地址版本。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **4**：表示IPv4地址。'."\n" + ."\n" + .'- **6**：表示IPv6地址。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'SgStatus' => [ + 'description' => '安全组策略。取值：'."\n" + ."\n" + .'- **pass**：已下发。'."\n" + .'- **block**：未下发。'."\n" + .'- **unsupport**：不支持。', + 'type' => 'string', + 'example' => 'block', + ], + 'Note' => [ + 'description' => '资产的备注信息。取值：'."\n" + ."\n" + .'- **REGION\\_NOT\\_SUPPORT**：地域不支持。'."\n" + .'- **NETWORK\\_NOT\\_SUPPORT**：网络不支持。', + 'type' => 'string', + 'example' => 'REGION_NOT_SUPPORT', + ], + 'Name' => [ + 'description' => '云防火墙防护的资产的实例名称。', + 'type' => 'string', + 'example' => 'instance01', + ], + 'CreateTimeStamp' => [ + 'description' => '云防火墙发现资产的时间。', + 'type' => 'string', + 'example' => '2023-02-28 10:29:58', + ], + 'NewResourceTag' => [ + 'description' => '资产发现的时间。取值：'."\n" + .'- **discovered in 1 hour**：资产是1小时内新增的。'."\n" + .'- **discovered in 1 day**：资产是1天内新增的。'."\n" + .'- **discovered in 7 days**：资产是7天内新增的。', + 'type' => 'string', + 'example' => 'discovered in 1 hour', + ], + 'SensitiveDataStatus' => [ + 'description' => '数据泄漏检测开启状态。', + 'type' => 'string', + 'example' => 'open', + ], + 'Last7DayOutTrafficBytes' => [ + 'description' => '近7日外联流量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询云防火墙防护的资产的信息', + 'description' => '本接口一般用于分页查询云防火墙防护的资产的信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAssetStatistic' => [ + 'summary' => '查询云防火墙防护的资产的统计信息。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '112.239.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言', + 'description' => '指定请求和接收消息的语言类型。-**zh**：中文-**en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言', + 'description' => '指定请求和接收消息的语言类型。-**zh**：中文-**en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回对象', + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求id。', + 'type' => 'string', + 'example' => '850A84******25g4d2', + ], + 'ResourceSpecStatistic' => [ + 'title' => '区域规格', + 'description' => '规格占用统计信息。', + 'type' => 'object', + 'properties' => [ + 'IpNumUsed' => [ + 'title' => 'IP使用数量', + 'description' => '公网IP开启保护数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'IpNumSpec' => [ + 'title' => 'IP规格', + 'description' => '公网IP保护规格数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SensitiveDataIpNumSpec' => [ + 'description' => '敏感数据IP规格数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SensitiveDataIpNumUsed' => [ + 'description' => '敏感数据IP开启数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'GeneralInstanceSpecStatistic' => [ + 'title' => '售卖2.0通用实例规格', + 'description' => '售卖2.0通用实例规格', + 'type' => 'object', + 'properties' => [ + 'TotalGeneralInstanceUsedCnt' => [ + 'title' => '总规格', + 'description' => '总规格', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCfwGeneralInstanceUsedCnt' => [ + 'title' => '互联网墙开启实例数量', + 'description' => '互联网墙开启实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalVfwGeneralInstanceUsedCnt' => [ + 'title' => 'vpc墙开启实例数量', + 'description' => 'vpc墙开启实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalNatGeneralInstanceUsedCnt' => [ + 'title' => 'nat墙开启实例数量', + 'description' => 'nat墙开启实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCfwGeneralInstanceCnt' => [ + 'title' => '互联网墙所有实例数量', + 'description' => '互联网墙所有实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalNatGeneralInstanceCnt' => [ + 'title' => 'nat墙所有实例数量', + 'description' => 'nat墙所有实例数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CfwGeneralInstanceRegionStatistic' => [ + 'title' => '互联网墙地域已使用规格统计', + 'description' => '互联网墙地域规格统计', + 'type' => 'array', + 'items' => [ + 'title' => '互联网墙地域规格统计详情', + 'description' => '互联网墙地域规格统计详情', + 'type' => 'object', + 'properties' => [ + 'RegionNo' => [ + 'title' => '地域信息', + 'description' => '地域信息', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MemberList' => [ + 'title' => '地域成员列表', + 'description' => '地域成员列表', + 'type' => 'array', + 'items' => [ + 'title' => '地域成员', + 'description' => '地域成员', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + 'CfwTotalGeneralInstanceRegionStatistic' => [ + 'title' => '互联网墙地域全量规格统计', + 'description' => '互联网墙地域全量规格统计', + 'type' => 'array', + 'items' => [ + 'title' => '互联网墙地域规格统计详情', + 'description' => '互联网墙地域规格统计详情', + 'type' => 'object', + 'properties' => [ + 'RegionNo' => [ + 'title' => '地域信息', + 'description' => '地域信息', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'MemberList' => [ + 'title' => '地域成员列表', + 'description' => '地域成员列表', + 'type' => 'array', + 'items' => [ + 'title' => '地域成员', + 'description' => '地域成员', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取资产统计信息', + ], + 'DescribeAssetRiskList' => [ + 'summary' => '获取资产风险等级列表。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙防护的资产的IP版本。'."\n" + ."\n\n" + .'取值：'."\n" + ."\n" + .'- **4**（默认）：IpV4'."\n" + ."\n" + .'- **6**：IpV6', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '4', + ], + ], + [ + 'name' => 'IpAddrList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'flat', + 'schema' => [ + 'description' => '待查询的IP地址列表参数，IP地址之间用半角逗号（,）分隔，一次性最多查询20个IP地址。'."\n" + ."\n" + .'>- IPv4举例：47.97.XX.XX。'."\n" + .'>- IPv6举例：2001:db8:ffff:ffff:ffff:XXXX:ffff。', + 'type' => 'array', + 'items' => [ + 'description' => '待查询的IP地址列表参数，IP地址之间用半角逗号（,）分隔，一次性最多查询20个IP地址。'."\n" + ."\n" + .'>- IPv4举例：47.97.XX.XX。'."\n" + .'>- IPv6举例：2001:db8:ffff:ffff:ffff:XXXX:ffff。', + 'type' => 'string', + 'required' => false, + 'example' => '47.97.XX.XX', + ], + 'required' => false, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '443C5781-1C03-5FCD-8EC5-FB9C0B9AC396', + ], + 'AssetList' => [ + 'description' => '返回的资产详情。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的资产详情。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + .'- **low**：低风险'."\n" + .'- **middle**：中风险'."\n" + .'- **high**：高风险', + 'type' => 'string', + 'example' => 'low', + ], + 'Ip' => [ + 'description' => '服务器IP。', + 'type' => 'string', + 'example' => '39.108.XX.XX', + ], + 'IpVersion' => [ + 'description' => '云防火墙防护的资产的IP地址版本。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **4**：表示IPv4地址。'."\n" + ."\n" + .'- **6**：表示IPv6地址。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Reason' => [ + 'description' => '风险原因。', + 'type' => 'string', + 'example' => 'other', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取资产风险等级列表', + ], + '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' => '访问者源IP', + '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' => '本次请求的ID。', + '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"}]', + 'title' => '创建互联网资产同步任务', + ], + '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' => [ + 'title' => '接收消息的语言类型。', + 'description' => '接收消息的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文（默认）', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceTypeAutoEnable', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型开启自动保护。', + '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}', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'title' => '地区编号', + 'description' => '地区编号', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B14757D0-4640-4B44-AC67-7F558F****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B14757D0-4640-4B44-AC67-7F558F****\\"\\n}","type":"json"}]', + 'title' => '修改新增资产自动保护', + ], + 'PutEnableFwSwitch' => [ + 'summary' => '开启防火墙开关。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpaddrList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IP地址列表。'."\n" + ."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP地址列表。'."\n" + ."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。', + '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' => '区域列表。'."\n" + ."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。', + 'type' => 'array', + 'items' => [ + 'description' => '区域列表。'."\n" + ."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。', + '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' => '资产类型列表。'."\n" + ."\n" + .'取值：'."\n" + .'- BastionHostIP：堡垒机出口IP。'."\n" + .'- BastionHostIngressIP：堡垒机入口IP。 '."\n" + .'- EcsEIP：ECS EIP。'."\n" + .'- EcsPublicIP ：ECS公网IP。'."\n" + .'- EIP：弹性公网IP。'."\n" + .'- EniEIP：弹性网卡EIP。'."\n" + .'- NatEIP：NAT EIP。'."\n" + .'- SlbEIP：SLB EIP。'."\n" + .'- SlbPublicIP：SLB公网IP。'."\n" + .'- NatPublicIP：NAT公网IP。'."\n" + .'- HAVIP：高可用虚拟IP。'."\n" + ."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '资产类型列表。'."\n" + ."\n" + .'取值：'."\n" + .'- BastionHostIP：堡垒机出口IP。'."\n" + .'- BastionHostIngressIP：堡垒机入口IP。 '."\n" + .'- EcsEIP：ECS EIP。'."\n" + .'- EcsPublicIP ：ECS公网IP。'."\n" + .'- EIP：弹性公网IP。'."\n" + .'- EniEIP：弹性网卡EIP。'."\n" + .'- NatEIP：NAT EIP。'."\n" + .'- SlbEIP：SLB EIP。'."\n" + .'- SlbPublicIP：SLB公网IP。'."\n" + .'- NatPublicIP：NAT公网IP。'."\n" + .'- HAVIP：高可用虚拟IP。'."\n" + ."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EcsPublicIp,NatEip', + ], + 'required' => false, + 'example' => '["EcsPublicIp","NatEip"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'title' => '成员唯一标识符', + 'description' => '成员唯一标识符', + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'IP版本号', + 'description' => 'IP版本号', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + 'AbnormalResourceStatusList' => [ + 'description' => '资产未同步时的状态信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Resource' => [ + 'description' => '资产IP。', + 'type' => 'string', + 'example' => '203.0.113.0', + ], + 'Status' => [ + 'description' => '资产未同步时的状态。取值：'."\n" + .'- ip_not_sync：资产未同步。', + 'type' => 'string', + 'example' => 'ip_not_sync', + ], + 'Msg' => [ + 'description' => '资产未同步时的信息。取值：'."\n" + .'- cloudfirewall do not sync this ip address：云防火墙没有同步这个资产IP。', + 'type' => 'string', + 'example' => 'cloudfirewall do not sync this ip address', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '开启防火墙开关', + 'description' => '本接口用于开启防火墙开关，防火墙开关开启后流量才会经过云防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'PutEnableAllFwSwitch' => [ + 'summary' => '开启所有防火墙开关。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze8v2x5kd9qyvp2****', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '开启所有防火墙开关', + 'description' => '本接口用于防护您阿里云账号的所有公网IP。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见[公共参数](~~94763~~)。'."\n" + .'调用API的请求格式，请参见本文**示例**中的请求示例。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutDisableFwSwitch' => [ + 'summary' => '关闭防火墙开关。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpaddrList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IP地址列表。'."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP地址。', + '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' => '区域列表。'."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。', + 'type' => 'array', + 'items' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'required' => false, + 'example' => '["cn-hangzhou","cn-shanghai"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'ResourceTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产类型列表。'."\n" + ."\n" + .'> IpaddrList、RegionList、ResourceTypeList三个参数不允许同时为空，必须为其中一个参数设置取值。', + 'type' => 'array', + 'items' => [ + 'description' => '资产类型。取值：'."\n" + ."\n" + .'- BastionHostIP：堡垒机出口IP。'."\n" + .'- BastionHostIngressIP：堡垒机入口IP。 '."\n" + .'- EcsEIP：ECS EIP。'."\n" + .'- EcsPublicIP ：ECS公网IP。'."\n" + .'- EIP：弹性公网IP。'."\n" + .'- EniEIP：弹性网卡EIP。'."\n" + .'- NatEIP：NAT EIP。'."\n" + .'- SlbEIP：SLB EIP。'."\n" + .'- SlbPublicIP：SLB公网IP。'."\n" + .'- NatPublicIP：NAT公网IP。'."\n" + .'- HAVIP：高可用虚拟IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'EcsPublicIP', + ], + 'required' => false, + 'example' => '["EcsPublicIp","NatEip"]', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'title' => '成员唯一标识符', + 'description' => '成员唯一标识符', + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'IP版本号', + 'description' => 'IP版本号', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '关闭防火墙开关', + 'description' => '本接口用于关闭防火墙开关，关闭防火墙开关后流量不经过云防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见[公共参数](~~94763~~)。'."\n" + .'调用API的请求格式，请参见本文**示例**中的请求示例。', + ], + 'PutDisableAllFwSwitch' => [ + 'summary' => '关闭所有防火墙开关。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze8v2x5kd9qyvp2****', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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":"<PutDisableAllFwSwitchResponse>\\r\\n<RequestId>B2841452-CB8D-4F7D-B247-38E1CF7334F8</RequestId>\\r\\n</PutDisableAllFwSwitchResponse>","errorExample":""}]', + 'title' => '关闭所有防火墙开关', + 'description' => '本接口用于关闭所有防火墙开关。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见[公共参数](~~94763~~)。 '."\n" + .'调用API的请求格式，请参见本文**示例**中的请求示例。', + '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' => '访问源的IP地址。', + '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' => '请求ID。', + '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"}]', + 'title' => '获取NAT防火墙配额', + ], + 'DescribeNatFirewallList' => [ + 'summary' => '本接口用于获取NAT边界防火墙的详细信息。', + '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' => '返回消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '返回消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页面的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置每页包含NAT边界防火墙的数量。'."\n" + ."\n" + .'默认值为**10**，表示每页包含**10**条结果。最大值为**50**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy-nat97a******'."\n", + ], + ], + [ + 'name' => 'ProxyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙名称。支持大小写英文字母、中文、数字、下划线（_）、长度为[4,50]个字符,且不能以下划线开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'nat-防火墙测试'."\n", + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC所在的地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-bp123456g******', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙状态。取值：'."\n" + ."\n" + .'- configuring：创建中'."\n" + .'- deleting：删除中'."\n" + .'- normal：正常'."\n" + .'- abnormal：异常'."\n" + .'- opening：开启中'."\n" + .'- closing：关闭中'."\n" + .'- closed：已关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '147783******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'NAT边界防火墙的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******'."\n", + ], + 'NatFirewallList' => [ + 'description' => '云防火墙列表', + 'type' => 'array', + 'items' => [ + 'description' => '云防火墙列表', + 'type' => 'object', + 'properties' => [ + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19106481******', + ], + 'AliUid' => [ + 'description' => '阿里云账号的UID。'."\n" + ."\n" + .'> 云防火墙成员账号的主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19106481******'."\n", + ], + 'ProxyId' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'example' => 'proxy-nat30******', + ], + 'ProxyName' => [ + 'description' => 'NAT防火墙名称。', + 'type' => 'string', + 'example' => 'nat-防火墙测试'."\n", + ], + 'ProxyStatus' => [ + 'description' => '云防火墙状态。取值：'."\n" + ."\n" + .'- configuring：创建中'."\n" + .'- deleting：删除中'."\n" + .'- normal：正常 '."\n" + .'- abnormal：异常'."\n" + .'- opening：开启中'."\n" + .'- closing：关闭中'."\n" + .'- closed：已关闭', + 'type' => 'string', + 'example' => 'normal', + ], + 'RegionId' => [ + 'description' => '云防火墙所在的地域ID。'."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'NatGatewayId' => [ + 'description' => '要查询的NAT网关的ID。', + 'type' => 'string', + 'example' => 'ngw-uf6tnblxip4qcxg******', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关的名称', + 'type' => 'string', + 'example' => 'NAT网关测试'."\n", + ], + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-2ze26ya******', + ], + 'VpcName' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'example' => 'vpc-测试实例', + ], + 'ErrorDetail' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => '防火墙创建失败', + ], + 'StrictMode' => [ + 'description' => '是否启用严格模式'."\n" + ."\n" + .'- 1：启用严格模式 '."\n" + .'- 0：禁用严格模式', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NatRouteEntryList' => [ + 'description' => 'NAT网关默认路由条目列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'NAT网关默认路由条目。', + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'NAT网关默认路由所在路由表。', + 'type' => 'string', + 'example' => 'vtb-bp18o0gb******', + ], + 'NextHopId' => [ + 'description' => '原NAT网关下一跳转地址。', + 'type' => 'string', + 'example' => 'ngw-2ze0s284r9atg5******', + ], + 'NextHopType' => [ + 'description' => '下一跳的网络类型。取值：NatGateway。', + 'type' => 'string', + 'example' => 'NatGateway', + ], + 'DestinationCidr' => [ + 'description' => '默认路由目的网段。', + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + ], + ], + 'ProxyVSwitchId' => [ + 'description' => '防火墙使用的交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1amn3t1ktjjy8******', + ], + 'ProxyRouteTableId' => [ + 'description' => '防火墙使用的路由表ID。', + 'type' => 'string', + 'example' => 'vtb-bp1pmyga7p4j10a******', + ], + 'ProxyNetworkInterfaceId' => [ + 'description' => '防火墙使用的弹性网卡ID。', + 'type' => 'string', + 'example' => 'eni-bp127llmo4v5qju******', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询NAT防火墙', + ], + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1sqg9w******', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-5b202e7f0be64611****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '成员账号UID。', + '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' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'A1562A68-99FA-5D6B-BD5B-2F959F25****', + ], + 'VswitchList' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机列表。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-2zeez7gymz5r4pi****am', + ], + 'CidrBlock' => [ + 'description' => 'IPv4网段。', + 'type' => 'string', + 'example' => '192.168.0.XX/16', + ], + 'VswitchId' => [ + 'description' => '交换机id。', + 'type' => 'string', + 'example' => 'vsw-bp10qla9mgi42eo****', + ], + 'AvailableIpCount' => [ + 'description' => '可用ip数量。', + 'type' => 'string', + 'example' => '10', + ], + 'VswitchName' => [ + 'description' => '交换机名称。', + 'type' => 'string', + 'example' => 'vsw-test', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'MemberUid' => [ + 'description' => '成员账号UID。', + 'type' => 'string', + 'example' => '184480249330****', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + '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' => '防火墙实例ID。', + '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"}]', + 'title' => '获取防火墙创建的交换机', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => ' NAT网关的ID。 ', + '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' => '网络实例ID。', + 'type' => 'string', + 'example' => 'vpc-m5emh0w6v2e15****', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'FirewallId' => [ + 'description' => '防火墙实例ID。', + 'type' => 'string', + 'example' => 'vfw-tr-7a9c8901ed394****', + ], + 'PrecheckTimestamp' => [ + 'description' => '预检查时间戳。', + 'type' => 'string', + 'example' => '1715136000', + ], + 'PrecheckStatus' => [ + 'description' => '预检查状态。取值：'."\n" + ."\n" + .'- **running**：预检查正在进行中'."\n" + ."\n" + .'- **passed**：预检查已通过'."\n" + ."\n" + .'- **failed**：预检查未通过', + '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' => '各预检查项的状态。取值：'."\n" + ."\n" + .'- **running**：预检查正在进行中'."\n" + ."\n" + .'- **passed**：预检查已通过'."\n" + ."\n" + .'- **failed**：预检查未通过', + 'type' => 'string', + 'example' => 'passed', + ], + 'Info' => [ + 'description' => '检查不通过的信息。', + 'type' => 'string', + 'example' => 'VPC防火墙配额已满', + ], + 'Suggestion' => [ + 'description' => '处理建议。', + 'type' => 'string', + 'example' => 'VPC防火墙配额已满，建议您提高防火墙配额', + ], + ], + ], + ], + 'PrecheckEntityGroupStatus' => [ + 'description' => '预检查的状态。取值：'."\n" + ."\n" + .'- **running**'."\n" + ."\n" + .'- **passed**'."\n" + ."\n" + .'- **failed**', + 'type' => 'string', + 'example' => 'running', + ], + 'FailedCount' => [ + 'description' => '预检查未通过数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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"}]', + 'title' => '查询NAT防火墙预检查结果', + ], + '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' => 'VPC实例ID。', + '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' => '返回结果的请求ID。', + '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' => 'IPv4网段。', + 'type' => 'string', + 'example' => '192.168.0.XX/16', + ], + 'VswitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp10qla9mgi42eo****', + ], + 'AvailableIpCount' => [ + 'description' => '可用区下可用IP。', + 'type' => 'string', + 'example' => '10', + ], + 'VswitchName' => [ + 'description' => '交换机名称。', + 'type' => 'string', + 'example' => 'vsw-test', + ], + 'RouteTableType' => [ + 'description' => '路由表的类型。取值：'."\n" + ."\n" + .'- **Custom**：自定义路由表。'."\n" + ."\n" + .'- **System**：系统路由表。', + 'type' => 'string', + 'example' => 'Custom', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-shanghai-b', + ], + 'RouteTableId' => [ + 'description' => '路由表的ID。', + 'type' => 'string', + 'example' => 'vtb-uf6ml7rgw5gzzdr****', + ], + 'Detail' => [ + 'description' => '事件详情。', + 'type' => 'string', + 'example' => '[]', + ], + 'FirewallList' => [ + 'description' => '防火墙列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防火墙列表。', + 'type' => 'object', + 'properties' => [ + 'FirewallId' => [ + 'description' => '防火墙实例ID。', + '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"}]', + 'title' => '查询防火墙交换机资源', + ], + 'DescribeSecurityProxyResources' => [ + 'summary' => '查询NAT防火墙资源。', + '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' => 'NAT网关ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-uf6y16l23fm8hq0****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '成员账号UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '136481150091****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'A8E8D50E-9F45-5662-B116-A1D0807F****', + ], + 'ResourceList' => [ + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表。', + 'type' => 'object', + 'properties' => [ + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'VpcList' => [ + 'description' => 'vpc列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'vpc列表信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vbuzirdl3w1r7exw****', + ], + 'VpcName' => [ + 'description' => 'VPC实例名称。', + 'type' => 'string', + 'example' => 'vpc-wz94a4q37rgl7g****', + ], + 'CidrBlock' => [ + 'description' => 'VPC的IPv4网段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'MemberUid' => [ + 'description' => '成员账号UID。', + 'type' => 'string', + 'example' => '157862808111****', + ], + 'NatGateways' => [ + 'description' => 'NAT网关列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'NAT网关信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'NAT网关状态。', + 'type' => 'string', + 'example' => 'Available', + ], + 'Detail' => [ + 'description' => 'NAT网关状态。', + 'type' => 'string', + 'example' => 'Available', + ], + 'NatGatewayId' => [ + 'description' => 'NAT网关ID。', + 'type' => 'string', + 'example' => 'ngw-bp1bm0k2t8i6ooxu****', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关名称。', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'NatRouteEntryList' => [ + 'description' => 'NAT路由表列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'NAT路由表。', + 'type' => 'object', + 'properties' => [ + 'NextHopId' => [ + 'description' => '下一跳实例ID。', + 'type' => 'string', + 'example' => 'ngw-2zey0w2u02u1x584m****', + ], + 'DestinationCidr' => [ + 'description' => '目的网段。', + 'type' => 'string', + 'example' => '10.0.70.XX/24', + ], + 'RouteTableId' => [ + 'description' => '路由表ID。', + '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"}]', + 'title' => '查询NAT防火墙资源', + ], + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '创建NAT防火墙资产同步任务', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'formData', + 'schema' => [ + 'description' => 'NAT所在的地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-2zeiljdml8pble168****', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'formData', + 'schema' => [ + 'description' => ' NAT网关的ID。 ', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'A426611F-04FA-5205-8D04-4F6DCF09****', + ], + 'PreCheckId' => [ + 'description' => '预校验ID。', + 'type' => 'string', + 'example' => '2122', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A426611F-04FA-5205-8D04-4F6DCF09****\\",\\n \\"PreCheckId\\": \\"2122\\"\\n}","type":"json"}]', + 'title' => '创建NAT防火墙预检查', + 'description' => '使用本接口创建一条对经过NAT防火墙流量放行、拒绝或观察的策略。', + ], + 'CreateSecurityProxy' => [ + 'summary' => '创建NAT防火墙。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙名称。支持大小写英文字母、中文、数字、下划线（_）、长度为4~50个字符，且不能以下划线开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'nat-防火墙名称', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC所在的地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => ' NAT网关的ID。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-bp1okz6k7******', + ], + ], + [ + 'name' => 'VswitchAuto', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用交换机自动模式。取值：'."\n" + .'- **true**：自动模式'."\n" + .'- **false**：手动模式', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。交换机手动模式时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1sqg9w******', + ], + ], + [ + 'name' => 'NatRouteEntryList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'NAT网关待切换路由列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全防护目的地址列表。', + 'type' => 'object', + 'properties' => [ + 'NextHopId' => [ + 'description' => '原NAT网关下一跳转地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-bp1okz6******', + ], + 'DestinationCidr' => [ + 'description' => '默认路由目的网段。', + 'type' => 'string', + 'required' => true, + 'example' => '0.0.0.0/0', + ], + 'NextHopType' => [ + 'description' => '下一跳的网络类型。取值：NatGateway。', + 'type' => 'string', + 'required' => true, + 'example' => 'NatGateway', + ], + 'RouteTableId' => [ + 'description' => 'NAT网关默认路由所在路由表。', + 'type' => 'string', + 'required' => true, + 'example' => 'vtb-2ze1******', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '安全防护开关。取值：'."\n" + .'- **open**：打开'."\n" + .'- **close**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'close', + ], + ], + [ + 'name' => 'StrictMode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用严格模式'."\n" + ."\n" + .'- 1：启用严格模式'."\n" + .'- 0：禁用严格模式', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'VswitchCidr', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机的网段。交换机自动模式时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ProxyId' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'example' => 'proxy-nat97a******', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******', + ], + ], + ], + ], + ], + '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' => ' 创建NAT防火墙', + ], + 'SwitchSecurityProxy' => [ + 'summary' => '开/关NAT防火墙。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + ."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy-natbf******', + ], + ], + [ + 'name' => 'Switch', + 'in' => 'query', + 'schema' => [ + 'description' => '安全防护开关。取值：'."\n" + .'- open：打开'."\n" + .'- close：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'F1E55690-3ABA-58FA-90E3-593EF******', + ], + ], + ], + ], + ], + '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' => '开/关NAT防火墙', + ], + 'UpdateSecurityProxy' => [ + 'summary' => '更新NAT边界防火墙。', + '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' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy-natfdc73073e031****8e0d', + ], + ], + [ + 'name' => 'ProxyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙名称。支持大小写英文字母、中文、数字、下划线（_）、长度为4~50个字符，且不能以下划线开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy_auto_heyuan', + ], + ], + [ + 'name' => 'StrictMode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用严格模式'."\n" + ."\n" + .'- 1：严格模式'."\n" + .'- 0：宽松模式', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '应用模块', + 'type' => 'string', + 'example' => 'ips_server', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '更新NAT边界防火墙', + ], + 'DeleteSecurityProxy' => [ + 'summary' => '删除NAT防火墙。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy-nat00ab******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '7447795A-39AB-52CB-8F92-128DF******', + ], + ], + ], + ], + ], + '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' => '删除NAT防火墙', + ], + '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' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '用户类型。取值：'."\n" + ."\n" + .'**buy**: 付费用户'."\n" + ."\n" + .'**free**: 免费用户', + 'type' => 'string', + 'required' => false, + 'example' => 'buy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AvailableVpcFirewallQuota' => [ + 'description' => 'vpc防火墙剩余可用配额。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'CenExpressConnectVpcCount' => [ + 'description' => '通过CEN方式连接的 VPC 数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'CenFirewallVpcCount' => [ + 'description' => '云企业网VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CenTrVpcCount' => [ + 'description' => '总的centr的vpc数。', + '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' => '已配置的cen基础版防火墙实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ConfiguredCenFirewallRegionCount' => [ + 'description' => '已配置的云企业网地域数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfiguredCenFirewallVpcCount' => [ + 'description' => '已配置的云企业网VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + ], + 'ConfiguredCenTrFirewallCount' => [ + 'description' => '已配置的centr防火墙实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfiguredExpressConnectFirewallCount' => [ + 'description' => '已配置的高速通道数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfiguredExpressConnectVpcCount' => [ + 'description' => '已配置的高速通道VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfiguredVpcFirewallCount' => [ + 'description' => '已配置的所有边界防火墙数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ConfiguredVpcFirewallVpcCount' => [ + 'description' => '已配置防火墙的VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExpressConnectVpcCount' => [ + 'description' => '高速通道VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NotConfiguredCenFirewallCount' => [ + 'description' => '未配置的云企业网防火墙数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotConfiguredCenTrFirewallCount' => [ + 'description' => '未配置的centr防火墙实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'NotConfiguredExpressConnectFirewallCount' => [ + 'description' => '未配置的高速通道防火墙数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'NotConfiguredVpcFirewallCount' => [ + 'description' => '未配置的所有边界防火墙数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'OpenedCenExpressConnectVpcCount' => [ + 'description' => '已开启并正常工作的 VPC 连接数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'OpenedCenFirewallCount' => [ + 'description' => '已开启的云企业网防火墙数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'OpenedCenFirewallVpcCount' => [ + 'description' => '云企业网已防护VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenedCenTrFirewallVpcCount' => [ + 'description' => '已防护的centr的vpc数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'OpenedEcrCount' => [ + 'description' => '云企业网ECR数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenedExpressConnectFirewallCount' => [ + 'description' => '已开启高速通道防火墙数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'OpenedExpressConnectVpcCount' => [ + 'description' => '高速通道已防护VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'OpenedPeerTrCount' => [ + 'description' => '已防护cen-tr的的跨地域连接。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'OpenedVbrCount' => [ + 'description' => '已防护cen-tr的vbr总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenedVpcCount' => [ + 'description' => '总的已防护VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + 'OpenedVpcFirewallCount' => [ + 'description' => '已开启的所有边界防火墙数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'OpenedVpnCount' => [ + 'description' => '已防护cen-tr的vpn总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '8AABEF64-7ABF-52CB-BA6C-0598E3DB****', + ], + 'TotalEcrCount' => [ + 'description' => '总的ECR数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalPeerTrCount' => [ + 'description' => '总的cen-tr的跨地域连接数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'TotalVbrCount' => [ + 'description' => '总的cen-tr的vbr数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalVpcCount' => [ + 'description' => '总的互联VPC数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalVpcFirewallQuota' => [ + 'description' => '总vpc防火墙配额。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalVpnCount' => [ + 'description' => '总的cen-tr的vpn数量。', + '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"}]', + 'title' => '获取VPC防火墙总结信息', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => 'VPC实例ID。', + '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' => '流量的方向。取值：'."\n" + .'- **in**：表示进方向。'."\n" + .'- **out**：表示出方向。'."\n" + ."\n" + .'>不设置该参数表示查询所有流量方向。', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + [ + 'name' => 'IPProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '协议类型。取值：'."\n" + .'- **tcp**：tcp协议'."\n" + .'- **udp**：udp协议', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '风险评估等级。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'PeerVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '对端VPC的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-90rq0anm6t8vbwbo****', + ], + ], + [ + 'name' => 'PeerAssetIP', + 'in' => 'query', + 'schema' => [ + 'description' => '对端源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '10.125.1.XX', + ], + ], + [ + 'name' => 'PeerAssetInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '对端资产实例ID。', + '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' => '本端资产ip。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值如下:'."\n" + ."\n" + .' - **InBytes**'."\n" + ."\n" + .'- **OutBytes**'."\n" + ."\n" + .'- **TotalBytes**'."\n" + ."\n" + .'- **InPackets**'."\n" + ."\n" + .'- **OutPackets**'."\n" + ."\n" + .'- **SessionCount**', + 'type' => 'string', + 'required' => false, + 'example' => 'InBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '升降序。取值：'."\n" + ."\n" + .'- **asc**：升序。'."\n" + .'- **desc**（默认）：降序。', + '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' => '结果的请求ID。', + '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' => '对端实例ID。', + 'type' => 'string', + 'example' => 'i-123451', + ], + 'PeerAssetIP' => [ + 'description' => '对端源IP。', + 'type' => 'string', + 'example' => '10.125.1.XX', + ], + 'RegionNo' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'OutBytes' => [ + 'description' => '发送字节数, 单位Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'InBytes' => [ + 'description' => '接收字节数, 单位Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17845821669.0', + ], + 'peerVpcName' => [ + 'description' => '对端VPC名称。', + 'type' => 'string', + 'example' => 'vpc-test', + ], + 'PeerVpcId' => [ + 'description' => '对端VPC的实例ID。', + '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"}]', + 'title' => '获取VPC防火墙接入详情', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NetworkInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络实例的类型。取值：'."\n" + ."\n" + .'- **cen_firewall**：cen基础版防火墙'."\n" + ."\n" + .'- **cen_tr_firewall**：cen-tr防火墙', + 'type' => 'string', + 'required' => false, + 'example' => 'cen_firewall', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zev8s8rxao33xt****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '云企业网实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-hxsqf2bv6di1a****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '转发路由器实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-2vcn4u2g86tm72****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙成员账号的UID。', + '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' => '网络实例ID。', + 'type' => 'string', + 'example' => 'vpc-m5emh0w6v2e15****', + ], + 'RegionNo' => [ + 'description' => '所在地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FirewallId' => [ + 'description' => '防火墙实例ID。', + 'type' => 'string', + 'example' => 'vfw-tr-7a9c8901ed394****', + ], + 'PrecheckTimestamp' => [ + 'description' => '预检查时间戳。', + 'type' => 'string', + 'example' => '1715136000', + ], + 'PrecheckStatus' => [ + 'description' => '预检查状态。取值：'."\n" + ."\n" + .'- **running**：预检查正在进行中'."\n" + ."\n" + .'- **passed**：预检查已通过'."\n" + ."\n" + .'- **failed**：预检查未通过', + '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' => '各预检查项的状态。取值：'."\n" + ."\n" + .'- **running**：预检查正在进行中'."\n" + ."\n" + .'- **passed**：预检查已通过'."\n" + ."\n" + .'- **failed**：预检查未通过', + 'type' => 'string', + 'example' => 'passed', + ], + 'Info' => [ + 'description' => '检查不通过的信息', + 'type' => 'string', + 'example' => 'VPC防火墙配额已满', + ], + 'Suggestion' => [ + 'description' => '处理建议', + 'type' => 'string', + 'example' => 'VPC防火墙配额已满，建议您提高防火墙配额', + ], + ], + ], + ], + 'PrecheckEntityGroupStatus' => [ + 'description' => '预检查的状态。取值：'."\n" + ."\n" + .'- **running**'."\n" + ."\n" + .'- **passed**'."\n" + ."\n" + .'- **failed**', + 'type' => 'string', + 'example' => 'running', + ], + 'FailedCount' => [ + 'description' => '预检查未通过的规则数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '获取VPC防火墙预检查详情', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NetworkInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络实例的类型。取值：'."\n" + ."\n" + .'- **cen_firewall**。'."\n" + ."\n" + .'- **cen_tr_firewall**。'."\n" + ."\n" + .'- **ec_firewall**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen_tr_firewall', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + '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' => '云企业网实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-iv8m2lj2fqg1xt****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'string', + 'required' => false, + 'example' => '128599825273****', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '转发路由器实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-t4n16htuv1jalj9cq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PrecheckId' => [ + 'description' => '预检查任务id。', + 'type' => 'string', + 'example' => '4197', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '创建VPC防火墙开墙前置任务', + 'description' => '使用本接口创建一条对经过NAT防火墙流量放行、拒绝或观察的策略。', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '创建VPC防火墙资产同步任务', + 'description' => '本接口一般用于创建VPC边界防火墙。该VPC边界防火墙是防护通过高速通道连接的两个VPC之间的流量。该VPC边界防火墙不支持防护VPC跨地域、跨账号以及VPC与VBR间的互访流量。更多信息，请参见[VPC边界防火墙限制说明](~~172295~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DescribeTrFirewallsV2List' => [ + 'summary' => '获取TR防火墙列表。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '转发路由器实例I的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FirewallSwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的状态。取值：'."\n" + ."\n" + .'- **opened**：已开启'."\n" + ."\n" + .'- **closed**：已关闭'."\n" + ."\n" + .'- **notconfigured**：表示暂未配置VPC边界防火墙'."\n" + ."\n" + .'- **configured**：表示已配置VPC边界防火墙'."\n" + ."\n" + .'- **creating**：表示正在创建VPC边界防火墙'."\n" + ."\n" + .'- **opening**：表示正在开启VPC边界防火墙'."\n" + ."\n" + .'- **deleting**：表示正在删除VPC边界防火墙'."\n" + ."\n\n" + .'> 不设置该参数表示查询所有状态的VPC边界防火墙', + 'type' => 'string', + 'required' => false, + 'example' => 'opened', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-f1799baa9e254651****', + ], + ], + [ + 'name' => 'FirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC边界防火墙云企业网企业版'."\n", + ], + ], + [ + 'name' => 'RouteMode', + 'in' => 'query', + 'schema' => [ + 'description' => '路由模式。取值：'."\n" + ."\n" + .'- **managed**：表示自动模式。'."\n" + ."\n" + .'- **manual**：表示手动模式。'."\n" + ."\n" + .'> 不设置该参数表示查询所有路由模式的VPC边界防火墙。', + 'type' => 'string', + 'required' => false, + 'example' => 'managed', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '云企业网实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-rig0t5zi96crkl****', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '转发路由器实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-uf6egtvyaedvt20xl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'string', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '1471E2EC-F706-5F11-A79B-BD583ACB8297', + ], + 'VpcTrFirewalls' => [ + 'description' => 'VPC边界防火墙列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙。', + 'type' => 'object', + 'properties' => [ + 'CenId' => [ + 'description' => ' 云企业网实例的ID。 ', + 'type' => 'string', + 'example' => 'cen-03f8s0z052ka3v****', + ], + 'CenName' => [ + 'description' => '云企业网实例名称。', + 'type' => 'string', + 'example' => 'cen_swas', + ], + 'CloudFirewallVpcOrderType' => [ + 'description' => '防火墙VPC产生的TR费用付费方, 取值:'."\n" + ."\n" + .'- **PayByCloudFirewall**: 由云防火墙承担费用'."\n" + .'- **PayByCenOwner**: 由云企业网实例所属账号承担费用', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PayByCenOwner', + ], + 'FirewallId' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'example' => 'vfw-tr-99bc4f0fc88b4d00****', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'VPC边界防火墙的状态。取值：'."\n" + ."\n" + .'- **opened**：已开启'."\n" + ."\n" + .'- **closed**：已关闭'."\n" + ."\n" + .'- **notconfigured**：表示暂未配置VPC边界防火墙'."\n" + ."\n" + .'- **configured**：表示已配置VPC边界防火墙'."\n" + ."\n" + .'- **creating**：表示正在创建VPC边界防火墙'."\n" + ."\n" + .'- **opening**：表示正在开启VPC边界防火墙'."\n" + ."\n" + .'- **deleting**：表示正在删除VPC边界防火墙'."\n" + ."\n\n" + .'> 不设置该参数表示查询所有状态的VPC边界防火墙', + 'type' => 'string', + 'example' => 'opened', + ], + 'IpsConfig' => [ + 'description' => 'IPS配置信息。', + 'type' => 'object', + 'properties' => [ + 'BasicRules' => [ + 'description' => '基础规则开关。取值：'."\n" + ."\n" + .'- **1**：开启状态'."\n" + ."\n" + .'- **0**：关闭状态', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableAllPatch' => [ + 'description' => '虚拟补丁开关。取值：'."\n" + ."\n" + .'- **1**：开启状态'."\n" + .'- **0**：关闭状态', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleClass' => [ + 'description' => 'IPS规则组。取值：'."\n" + ."\n" + .'- **1**：宽松规则组。'."\n" + ."\n" + .'- **2**：中等规则组。'."\n" + ."\n" + .'- **3**：严格规则组。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RunMode' => [ + 'description' => 'IPS防御模式。取值：'."\n" + ."\n" + .'- **1**：拦截模式'."\n" + .'- **0**：观察模式', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'OwnerId' => [ + 'description' => 'VPC实例所属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '171761785151****', + ], + 'PrecheckStatus' => [ + 'description' => '是否可以自动开墙。取值：'."\n" + ."\n" + .'- **passed**：可以自动开墙'."\n" + ."\n" + .'- **failed**：不可以自动开墙'."\n" + ."\n" + .'- **unknown**：未知状态', + 'type' => 'string', + 'example' => 'passed', + ], + 'ProtectedResource' => [ + 'description' => '已防护的资源列表。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已防护的资源个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EcrList' => [ + 'description' => '已防护的ECR列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已防护的ECR列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "ecr-d6yi3kl5qxmvkz****"'."\n" + .']', + ], + ], + 'PeerTrList' => [ + 'description' => '已防护的对端TR列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已防护的对端TR列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "tr-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VbrList' => [ + 'description' => '已防护的VBR列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已防护的VBR列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "vbr-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VpcList' => [ + 'description' => '已防护的VPC列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已防护的VPC列表。', + 'type' => 'string', + 'example' => '["vpc-2zegxdvs5f2je81ph****"]', + ], + ], + 'VpnList' => [ + 'description' => '已防护的VPN列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已防护的VPN列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "vpn-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + ], + ], + 'RegionNo' => [ + 'description' => '转发路由器实例I的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionStatus' => [ + 'description' => '地域开放状态。取值：'."\n" + ."\n" + .'- **enable**：已开放，表示该地域允许配置VPC边界防火墙'."\n" + ."\n" + .'- **disable**：未开放，表示该地域不允许配置VPC边界防火墙', + 'type' => 'string', + 'example' => 'enable', + ], + 'ResultCode' => [ + 'description' => '创建VPC边界防火墙的操作结果代码。取值：'."\n" + ."\n" + .'- **RegionDisable**：表示网络实例所在的地域是VPC边界防火墙不支持的地域, 不允许创建VPC边界防火墙'."\n" + ."\n" + .'- **空字符串**，表示该网络实例可以正常创建VPC边界防火墙', + 'type' => 'string', + 'example' => ' RegionDisable', + ], + 'RouteMode' => [ + 'description' => '路由模式。取值：'."\n" + ."\n" + .'- **managed**：表示自动模式'."\n" + ."\n" + .'- **manual**：表示手动模式', + 'type' => 'string', + 'example' => 'managed', + ], + 'TransitRouterId' => [ + 'description' => '转发路由器实例ID。', + 'type' => 'string', + 'example' => 'tr-2vcmhjs88nil55fvu****', + ], + 'UnprotectedResource' => [ + 'description' => '未防护的资源列表。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '未防护的资源个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EcrList' => [ + 'description' => '未防护的ECR列表。', + 'type' => 'array', + 'items' => [ + 'description' => '未防护的ECR列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "ecr-d6yi3kl5qxmvkz****"'."\n" + .']', + ], + ], + 'PeerTrList' => [ + 'description' => '未防护的对端TR列表。', + 'type' => 'array', + 'items' => [ + 'description' => '未防护的对端TR列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "tr-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VbrList' => [ + 'description' => '未防护的VBR列表。', + 'type' => 'array', + 'items' => [ + 'description' => '未防护的VBR列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "vbr-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VpcList' => [ + 'description' => '未防护的VPC列表。', + 'type' => 'array', + 'items' => [ + 'description' => '未防护的VPC列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "vpc-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + 'VpnList' => [ + 'description' => '未防护的VPN列表。', + 'type' => 'array', + 'items' => [ + 'description' => '未防护的VPN列表。', + 'type' => 'string', + 'example' => '['."\n" + .' "vpn-2zegxdvs5f2je81ph****"'."\n" + .']', + ], + ], + ], + ], + 'VpcFirewallName' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'example' => 'VPC边界防火墙', + ], + 'AclConfig' => [ + 'description' => 'ACL引擎模式。', + 'type' => 'object', + 'properties' => [ + 'StrictMode' => [ + 'description' => '是否启用严格模式'."\n" + ."\n" + .'- 1：启用严格模式 '."\n" + .'- 0：禁用严格模式', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取云企业网（企业版）防火墙列表', + ], + 'DescribeTrFirewallsV2Detail' => [ + 'summary' => '获取TR防火墙详情。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-a5a6b89f46764928****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FirewallName' => [ + 'description' => 'VPC边界防火墙实例名称。', + 'type' => 'string', + 'example' => 'cloudfirewall-manual', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '7E53A7FB-3EB9-5E33-8E50-B8F417D1E02B', + ], + 'FirewallId' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'example' => 'vfw-tr-9c7c711abdfa4d80****', + ], + 'FirewallStatus' => [ + 'description' => '防火墙状态。取值：'."\n" + ."\n" + .'- Creating：创建中'."\n" + ."\n" + .'- Deleting：删除中'."\n" + ."\n" + .'- Ready：就绪', + 'type' => 'string', + 'example' => 'Ready', + ], + 'CenId' => [ + 'description' => '云企业网实例ID。', + 'type' => 'string', + 'example' => 'cen-37nddhri7jf0d2****', + ], + 'TransitRouterId' => [ + 'description' => '转发路由器实例ID。', + 'type' => 'string', + 'example' => 'tr-wz9y8sgug8b1xb416****', + ], + 'RegionNo' => [ + 'description' => '转发路由器实例I的地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FirewallEniId' => [ + 'description' => '防火墙ENI ID。', + 'type' => 'string', + 'example' => 'eni-uf621u00nafypeex****', + ], + 'FirewallEniVpcId' => [ + 'description' => '防火墙ENI 所在的VPC ID。', + 'type' => 'string', + 'example' => 'vpc-2zeppcci782zeh2bk****', + ], + 'FirewallEniVswitchId' => [ + 'description' => '防火墙ENI 所在的VSWITCH ID。', + 'type' => 'string', + 'example' => 'vsw-uf6ptq1kl1c1d9pw9****', + ], + 'FirewallDescription' => [ + 'description' => '防火墙描述。', + 'type' => 'string', + 'example' => 'VPC边界防火墙', + ], + 'RouteMode' => [ + 'description' => '路由模式。取值：'."\n" + ."\n" + .'- **managed**：表示自动模式'."\n" + ."\n" + .'- **manual**：表示手动模式', + 'type' => 'string', + 'example' => 'managed', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'VPC边界防火墙的状态。取值：'."\n" + ."\n" + .'- **opened**：已开启'."\n" + ."\n" + .'- **closed**：已关闭'."\n" + ."\n" + .'- **notconfigured**：表示暂未配置VPC边界防火墙'."\n" + ."\n" + .'- **configured**：表示已配置VPC边界防火墙'."\n" + ."\n" + .'- **creating**：表示正在创建VPC边界防火墙'."\n" + ."\n" + .'- **opening**：表示正在开启VPC边界防火墙'."\n" + ."\n" + .'- **deleting**：表示正在删除VPC边界防火墙'."\n" + ."\n\n" + .'> 不设置该参数表示查询所有状态的VPC边界防火墙', + 'type' => 'string', + 'example' => 'opened', + ], + 'FirewallVpcCidr' => [ + 'description' => '自动模式下防火墙VPC网段。', + 'type' => 'string', + 'example' => '10.0.0.0/16', + ], + 'FirewallSubnetCidr' => [ + 'description' => '自动模式下防火墙VPC中存放防火墙ENI的子网网段。', + 'type' => 'string', + 'example' => '10.0.1.0/24', + ], + 'TrAttachmentMasterCidr' => [ + 'description' => '自动模式下防火墙VPC中用于连接TR的子网主用网段。', + 'type' => 'string', + 'example' => '10.0.2.0/24', + ], + 'TrAttachmentSlaveZone' => [ + 'description' => '自动模式下防火墙VPC中用于连接TR的子网备用可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'TrAttachmentSlaveCidr' => [ + 'description' => '自动模式下防火墙VPC中用于连接TR的子网备用网段。', + 'type' => 'string', + 'example' => '10.0.3.0/24', + ], + 'TrAttachmentMasterZone' => [ + 'description' => '自动模式下防火墙VPC中用于连接TR的子网主用可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'TrAttachmentId' => [ + 'description' => '自动模式下防火墙 VPC 中用于连接 TR 的关联Id。', + 'type' => 'string', + 'example' => 'tr-attach-r1llaxxeha71jsm36v', + ], + ], + ], + ], + ], + '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' => '获取TR防火墙详情', + ], + 'DescribeTrFirewallsV2RouteList' => [ + 'summary' => '获取TR防火墙路由表列表。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-8bcfa0f2f12d411e****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-7d5c672e37ee4175****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。默认值为1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为10.', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FirewallRouteDetailList' => [ + 'description' => '云防火墙路由表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云防火墙路由表。', + 'type' => 'object', + 'properties' => [ + 'TrFirewallRoutePolicyId' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'example' => 'policy-04ecbbc6720d4f90****', + ], + 'TrFirewallRouteTableId' => [ + 'description' => '路由所属路由表的ID。', + 'type' => 'string', + 'example' => 'vtb-2zeockxxxorv0mnhz****', + ], + 'TrFirewallRouteDestination' => [ + 'description' => '路由目的地址。', + 'type' => 'string', + 'example' => '192.168.10.0/25', + ], + 'TrFirewallRouteNexthop' => [ + 'description' => '路由下一跳ID。', + 'type' => 'string', + 'example' => 'tr-attach-hnxab1y0pxn16p****', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'ABF190A2-B4D0-53F6-995A-5690A721F91C', + ], + ], + ], + ], + ], + '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' => '获取TR防火墙路由表列表', + ], + 'DescribeTrFirewallV2RoutePolicyList' => [ + 'summary' => '获取TR防火墙路由策略列表。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-d5ba592ac6c84aff****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-7b66257c14e141fb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TrFirewallRoutePolicies' => [ + 'description' => '防火墙路由策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防火墙路由策略。', + 'type' => 'object', + 'properties' => [ + 'PolicyType' => [ + 'description' => 'VPC边界防火墙云企业网企业版引流场景类型。取值：'."\n" + ."\n" + .'- **fullmesh**：多点间互联'."\n" + ."\n" + .'- **one_to_one**：点到点'."\n" + ."\n" + .'- **end_to_end**：点到多点', + 'type' => 'string', + 'example' => 'fullmesh', + ], + 'PolicyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => '新加坡点到多点', + ], + 'PolicyDescription' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'example' => '点到多点', + ], + 'SrcCandidateList' => [ + 'description' => '主引流实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主引流实例。', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => '引流实例的ID。', + 'type' => 'string', + 'example' => 'vpc-2ze9epancaw8t4sha****', + ], + 'CandidateType' => [ + 'description' => '引流实例类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + ], + ], + ], + 'DestCandidateList' => [ + 'description' => '子引流实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子引流实例。', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => '引流实例的ID。', + 'type' => 'string', + 'example' => 'vpc-2ze9epancaw8t4sha****', + ], + 'CandidateType' => [ + 'description' => '引流实例类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + ], + ], + ], + 'TrFirewallRoutePolicyId' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'example' => 'policy-7b66257c14e141fb****', + ], + 'PolicyStatus' => [ + 'description' => '策略状态。取值：'."\n" + ."\n" + .'- creating：创建中'."\n" + ."\n" + .'- deleting：删除中'."\n" + ."\n" + .'- opening：开启中'."\n" + ."\n" + .'- opened：已开启'."\n" + ."\n" + .'- closing：关闭中'."\n" + ."\n" + .'- closed：已关闭', + 'type' => 'string', + 'example' => 'opened', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '95EB5F3A-67FE-5780-92BD-5ECBA772AB7E', + ], + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + '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' => '获取TR防火墙路由策略列表', + ], + 'DescribeTrFirewallPolicyBackUpAssociationList' => [ + 'summary' => '获取TR防火墙ACL备份。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-8b268ce1b26e4c68****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-5dcafb12ff794a56****', + ], + ], + [ + 'name' => 'CandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '引流实例列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => '引流实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9grb8ng3y7h7lf2****'."\n", + ], + 'CandidateType' => [ + 'description' => '引流实例类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyAssociationBackupConfigs' => [ + 'description' => '恢复路由表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '恢复路由表。', + 'type' => 'object', + 'properties' => [ + 'CandidateType' => [ + 'description' => '引流实例类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'CandidateId' => [ + 'description' => '引流实例ID。', + 'type' => 'string', + 'example' => 'vpc-wz9grb8ng3y7h7lf2****', + ], + 'OriginalRouteTableId' => [ + 'description' => '恢复路由表ID。', + 'type' => 'string', + 'example' => 'vtb-wz9slp3s7m4qrzvnq****', + ], + 'CurrentRouteTableId' => [ + 'description' => '引流后路由表。', + 'type' => 'string', + 'example' => 'vtb-wz9898grickmh5j09****', + ], + 'CandidateName' => [ + 'description' => '引流实例名称。', + 'type' => 'string', + 'example' => 'VPC引流实例', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'C264A756-9B48-57E3-B312-716941E146C6', + ], + ], + ], + ], + ], + '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' => '获取TR防火墙恢复路由表', + ], + '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' => '云企业网Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-djz1i6p8shzioz****', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '转发路由器ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-2zefgvkcl2qcexbb7****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '边界防火墙实例ID。', + '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' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9lllsbftdm0svpj****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'A61A2516-0A22-5B3F-986B-3D4BF2A****', + ], + 'TransitRouterAttachedResources' => [ + 'description' => 'TR交换机资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'TR交换机资源列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '实例ID。', + '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"}]', + 'title' => '查询TR交换机资源列表', + ], + 'CreateTrFirewallV2' => [ + 'summary' => '创建TR防火墙。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC边界防火墙云企业网企业版', + ], + ], + [ + 'name' => 'RouteMode', + 'in' => 'query', + 'schema' => [ + 'description' => '路由模式。取值：'."\n" + ."\n" + .'- **managed**：表示自动模式'."\n" + ."\n" + .'- **manual**：表示手动模式', + 'type' => 'string', + 'required' => false, + 'example' => 'managed', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '转发路由器实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-m5etmb2q7e0mxcur****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '转发路由器实例I的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FirewallVpcCidr', + 'in' => 'query', + 'schema' => [ + 'description' => '自动模式下防火墙VPC网段。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.0/16', + ], + ], + [ + 'name' => 'FirewallSubnetCidr', + 'in' => 'query', + 'schema' => [ + 'description' => '自动模式下防火墙VPC中存放防火墙ENI的子网网段。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.1.0/24', + ], + ], + [ + 'name' => 'TrAttachmentSlaveCidr', + 'in' => 'query', + 'schema' => [ + 'description' => '自动模式下防火墙VPC中用于连接TR的子网备用网段。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.16/28', + ], + ], + [ + 'name' => 'TrAttachmentMasterCidr', + 'in' => 'query', + 'schema' => [ + 'description' => '自动模式下防火墙VPC中用于连接TR的子网主用网段。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.3.0/24', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '云企业网实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-4xbjup276au29r****', + ], + ], + [ + 'name' => 'FirewallDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC边界防火墙云企业网企业版', + ], + ], + [ + 'name' => 'FirewallVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '手动模式下创建防火墙ENI的VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9r5qvryn0lg3atb****', + ], + ], + [ + 'name' => 'FirewallVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '手动模式下创建防火墙ENI的VSW ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6ydz3vqj77mr5l6****', + ], + ], + [ + 'name' => 'TrAttachmentSlaveZone', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机备可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-chengdu-b', + ], + ], + [ + 'name' => 'TrAttachmentMasterZone', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机主可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-chengdu-a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FirewallId' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'example' => 'vfw-tr-37e22bf0d9b34870****', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '822B9125-6E1A-551C-8EAF-6E7AE7444B00', + ], + ], + ], + ], + ], + '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' => '创建TR防火墙', + ], + 'CreateTrFirewallV2RoutePolicy' => [ + 'summary' => '创建TR防火墙路由规则。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙云企业网企业版引流场景类型。取值：'."\n" + ."\n" + .'- **fullmesh**：多点间互联'."\n" + ."\n" + .'- **one_to_one**：点到点'."\n" + ."\n" + .'- **end_to_end**：点到多点', + 'type' => 'string', + 'required' => false, + 'example' => 'fullmesh', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '引流名称。', + 'type' => 'string', + 'required' => false, + 'example' => '新加坡点到多点', + ], + ], + [ + 'name' => 'PolicyDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '引流描述。', + 'type' => 'string', + 'required' => false, + 'example' => '新加坡点到多点', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-f8ce36689b224f77****', + ], + ], + [ + 'name' => 'SrcCandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '主引流实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '引流实例。', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => '引流实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze9epancaw8t4sha****', + ], + 'CandidateType' => [ + 'description' => '引流实例类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DestCandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '子引流实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子引流实例。', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => '引流实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze9epancaw8t4sha****', + ], + 'CandidateType' => [ + 'description' => '引流实例类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TrFirewallRoutePolicyId' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'example' => 'policy-8ebed27e13e14ce2****', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'C91D68BA-A0BE-51BF-A0F1-1CB5C57FE58D', + ], + ], + ], + ], + ], + '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' => '创建TR防火墙路由规则', + ], + 'ModifyTrFirewallV2Configuration' => [ + 'summary' => '修改TR防火墙配置。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-bcdf89d405ce4bd2****', + ], + ], + [ + 'name' => 'FirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例名。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC边界防火墙', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'A74C8FDD-2BEF-52D5-8B01-EB6FD94606F9', + ], + ], + ], + ], + ], + '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' => '修改TR防火墙配置', + ], + 'ModifyFirewallV2RoutePolicySwitch' => [ + 'summary' => '修改路由策略开关。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-5b202e7f0be64611****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-93684cc5caa44b2e****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicySwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '策略开关。取值：'."\n" + ."\n" + .'- open：开启'."\n" + ."\n" + .'- close：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'ShouldRecover', + 'in' => 'query', + 'schema' => [ + 'description' => '是否恢复引流配置。取值：'."\n" + ."\n" + .'- true：路由回滚'."\n" + ."\n" + .'- false：路由撤销', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '1F6D4A8D-EC01-5996-A61A-AA3B56490C00', + ], + ], + ], + ], + ], + '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' => '修改路由策略开关', + ], + 'ModifyTrFirewallV2RoutePolicyScope' => [ + 'summary' => '修改TR防火墙路由策略范围。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-4d724d0139df48f1****', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-tr-6520de0253bc4669****', + ], + ], + [ + 'name' => 'SrcCandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '主引流实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主引流实例。', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => '引流实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze9epancaw8t4sha****'."\n", + ], + 'CandidateType' => [ + 'description' => '引流实例类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DestCandidateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '子引流实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子引流实例。', + 'type' => 'object', + 'properties' => [ + 'CandidateId' => [ + 'description' => '引流实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze9epancaw8t4uzi****'."\n", + ], + 'CandidateType' => [ + 'description' => '引流实例类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ShouldRecover', + 'in' => 'query', + 'schema' => [ + 'description' => '是否恢复引流配置。取值：'."\n" + ."\n" + .'- true：路由回滚'."\n" + ."\n" + .'- false：路由撤销', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TrFirewallRoutePolicyId' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'example' => 'policy-4d724d0139df48f1****', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '修改TR防火墙路由策略范围', + 'description' => '支持*点到多点*和*多点间互联*场景的修改，不支持*点到点*场景的修改。', + ], + 'DeleteTrFirewallV2' => [ + 'summary' => '删除TR防火墙。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-99bc4f0fc88b4d00****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'A774E66E-B170-59FC-9AAF-3068B15E991F', + ], + ], + ], + ], + ], + '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' => '删除TR防火墙', + ], + 'DeleteFirewallV2RoutePolicies' => [ + 'summary' => '删除TR防火墙路由策略。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-d5ba592ac6c84aff****', + ], + ], + [ + 'name' => 'TrFirewallRoutePolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙路由策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-2d06d3568fd74d60****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '22B6B889-4E9F-56B3-AF3D-53749C477D1D', + ], + ], + ], + ], + ], + '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' => '删除TR防火墙路由策略', + ], + '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' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。默认值为1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页面的数量。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'TransitRouterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'CEN转发路由器类型。 取值:'."\n" + ."\n" + .'**Basic**: 基础版'."\n" + ."\n" + .'**Enterprise**: 企业版', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '云企业网实例的ID。', + 'type' => 'string', + 'example' => 'cen-maqfw3abcmjy56****', + ], + 'RegionNoList' => [ + 'description' => 'vpc边界防火墙的地域id列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'vpc边界防火墙的地域id列表。', + '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"}]', + 'title' => '获取VPC_CEN列表', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DescribeVpcFirewallCenList' => [ + 'summary' => '查询VPC边界防火墙（防护云企业网内的网络实例和指定VPC之间的互访流量）的信息。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC所在的地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '网络实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'FirewallSwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的状态。取值：'."\n" + ."\n" + .'- **opened**：已开启。'."\n" + ."\n" + .'- **closed**：已关闭。'."\n" + ."\n" + .'- **notconfigured**：表示暂未配置VPC边界防火墙。'."\n" + ."\n" + .'- **configured**：表示已配置但未开启VPC边界防火墙。'."\n" + ."\n" + .'> 不设置该参数表示查询所有状态的VPC边界防火墙。', + 'type' => 'string', + 'required' => false, + 'example' => 'opened', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试环境防火墙', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '云企业网实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-x5jayxou71ad73****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页面的页码。'."\n" + ."\n" + .'默认值为1，表示返回第1页数据。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置每页包含VPC边界防火墙的数量。'."\n" + ."\n" + .'默认值为10，表示每页包含10条结果。最大值为50。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RouteMode', + 'in' => 'query', + 'schema' => [ + 'description' => '路由模式。取值：'."\n" + ."\n" + .'- **auto**：表示自动模式。'."\n" + ."\n" + .'- **manual**：表示手动模式。'."\n" + ."\n" + .'> 不设置该参数表示查询所有路由模式的VPC边界防火墙。', + 'type' => 'string', + 'required' => false, + 'example' => 'auto', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号（其他阿里云账号）UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'TransitRouterType', + 'in' => 'query', + 'schema' => [ + 'description' => '转发实例路由器类型。可选值：'."\n" + ."\n" + .'- **Basic**：基础版转发路由器。'."\n" + ."\n" + .'- **Enterprise**：企业版转发路由器。', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'VPC边界防火墙的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k8g2', + ], + 'VpcFirewalls' => [ + 'description' => 'VPC边界防火墙的详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => 'VPC边界防火墙的互通类型。取值：cen，表示云企业网。', + 'type' => 'string', + 'example' => 'cen', + ], + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RegionStatus' => [ + 'description' => '地域开放状态。取值：'."\n" + ."\n" + .'- **enable**：已开放，表示该地域允许配置VPC边界防火墙。'."\n" + ."\n" + .'- **disable**：未开放，表示该地域不允许配置VPC边界防火墙。', + 'type' => 'string', + 'example' => 'enable', + ], + 'CenId' => [ + 'description' => '云企业网实例ID。', + 'type' => 'string', + 'example' => 'cen-x5jayxou71ad73****', + ], + 'VpcFirewallName' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'example' => '测试防火墙', + ], + 'ResultCode' => [ + 'description' => '创建VPC边界防火墙的操作结果代码。取值：'."\n" + ."\n" + .'- **Unauthorized**：表示存在未授权的网络实例, 不允许创建VPC边界防火墙。'."\n" + ."\n" + .'- **RegionDisable**：表示网络实例所在的地域是VPC边界防火墙不支持的地域, 不允许创建VPC边界防火墙。'."\n" + ."\n" + .'- **OpsDisable**：表示不允许创建VPC边界防火墙。'."\n" + ."\n" + .'- **VbrNotSupport**：表示云企业网中的VBR不支持创建VPC边界防火墙。'."\n" + ."\n" + .'- 空字符串，表示该网络实例可以正常创建VPC边界防火墙。'."\n", + 'type' => 'string', + 'example' => 'Unauthorized', + ], + 'CenName' => [ + 'description' => '云企业网实例名称。', + 'type' => 'string', + 'example' => '测试云企业网', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'VPC边界防火墙开关的状态。取值：'."\n" + ."\n" + .'- **opened**：已开启。'."\n" + ."\n" + .'- **closed**：已关闭。'."\n" + ."\n" + .'- **notconfigured**：表示暂未配置VPC边界防火墙。', + 'type' => 'string', + 'example' => 'opened', + ], + 'LocalVpc' => [ + 'description' => 'VPC的详细信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'TransitRouterType' => [ + 'description' => '云企业网转发路由器（CEN-TR）的版本。取值：'."\n" + ."\n" + .'- **Basic**：基础版转发路由器。'."\n" + ."\n" + .'- **Enterprise**：企业版转发路由器。', + 'type' => 'string', + 'example' => 'Basic', + ], + 'NetworkInstanceId' => [ + 'description' => '网络实例ID。', + 'type' => 'string', + 'example' => 'vpc-2zefk9fbn8j7v585g****', + ], + 'RouteMode' => [ + 'description' => '路由模式。取值：'."\n" + ."\n" + .'- **auto**：表示自动模式。'."\n" + ."\n" + .'- **manual**：表示手动模式。'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'RegionNo' => [ + 'description' => 'VPC所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AuthorizationStatus' => [ + 'description' => 'VPC的授权状态。取值：**authorized**，表示已授权。', + 'type' => 'string', + 'example' => 'authorized', + ], + 'ManualVSwitchId' => [ + 'description' => '路由模式为手动模式时指定的vSwitch的ID。', + 'type' => 'string', + 'example' => 'vsw-zeq4o875u****', + ], + 'OwnerId' => [ + 'description' => 'VPC所属阿里云账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158039427902****', + ], + 'NetworkInstanceType' => [ + 'description' => '网络实例的类型。取值：'."\n" + ."\n" + .'- **VPC**（Virtual Private Cloud）。'."\n" + ."\n" + .'- **VBR**（Virtual Border Router）。'."\n" + ."\n" + .'- **CCN**（Cloud Connect Network）。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'VpcName' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'example' => '测试用实例', + ], + 'SupportManualMode' => [ + 'description' => '路由模式是否支持手动模式。取值：'."\n" + ."\n" + .'- **1**：支持。'."\n" + ."\n" + .'- **0**：不支持。', + 'type' => 'string', + 'example' => '0', + ], + 'NetworkInstanceName' => [ + 'description' => '网络实例的名称。', + 'type' => 'string', + 'example' => '测试业务VPC', + ], + 'VpcCidrTableList' => [ + 'description' => 'VPC的网段列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC的网段列表信息。', + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'VPC的路由表ID。', + 'type' => 'string', + 'example' => 'vtb-1234', + ], + 'RouteEntryList' => [ + 'description' => 'VPC的路由条目列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC的路由条目列表。', + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => 'VPC中的下一跳实例ID。', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => 'VPC的目标网段。', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + 'DefendCidrList' => [ + 'description' => 'VPC边界防火墙防护的网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙防护的网段。', + 'type' => 'string', + 'example' => '10.0.XX.XX/24', + ], + ], + ], + ], + 'IpsConfig' => [ + 'description' => 'IPS配置信息。', + 'type' => 'object', + 'properties' => [ + 'BasicRules' => [ + 'description' => '基础规则开关。取值：'."\n" + ."\n" + .'- **1**：开启状态。'."\n" + ."\n" + .'- **0**：关闭状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableAllPatch' => [ + 'description' => '虚拟补丁开关。取值：'."\n" + ."\n" + .'- **1**：开启状态。'."\n" + ."\n" + .'- **0**：关闭状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RunMode' => [ + 'description' => 'IPS防御模式。取值：'."\n" + ."\n" + .'- **1**：拦截模式。'."\n" + ."\n" + .'- **0**：观察模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleClass' => [ + 'description' => 'IPS规则组。取值：'."\n" + ."\n" + .'- **1**：宽松规则组。'."\n" + ."\n" + .'- **2**：中等规则组。'."\n" + ."\n" + .'- **3**：严格规则组。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'MemberUid' => [ + 'description' => '当前阿里云账号的成员账号（其他阿里云账号）UID。', + 'type' => 'string', + 'example' => '258039427902****', + ], + 'PrecheckStatus' => [ + 'description' => '是否可以自动开墙，即云防火墙会根据路由学习，自动防护VPC流量。取值：'."\n" + ."\n" + .'- **passed**：可以自动开墙。'."\n" + ."\n" + .'- **failed**：不可以自动开墙。'."\n" + ."\n" + .'- **unknown**：未知状态。'."\n", + 'type' => 'string', + 'example' => 'failed', + ], + 'AclConfig' => [ + 'description' => 'ACL引擎模式。', + 'type' => 'object', + 'properties' => [ + 'StrictMode' => [ + 'description' => '是否启用严格模式'."\n" + ."\n" + .'- 1：启用严格模式 '."\n" + .'- 0：禁用严格模式', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询云企业网（基础版）防火墙列表', + 'description' => '本接口一般用于查询VPC边界防火墙的信息。该VPC边界防火墙是防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DescribeVpcFirewallCenDetail' => [ + 'summary' => '查询VPC边界防火墙（防护云企业网内的网络实例和指定VPC之间的互访流量）的详细信息。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcFirewallCenList](~~345777~~)接口查询VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'NetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '创建VPC边界防火墙的VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zefk9fbn8j7v585g****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => 'VPC边界防火墙的互通类型。取值：**cen**，表示云企业网。'."\n", + 'type' => 'string', + 'example' => 'cen', + ], + 'VpcFirewallName' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'example' => '测试防火墙', + ], + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'VPC边界防火墙的开关状态。取值：'."\n" + ."\n" + .'- **opened**：已开启。'."\n" + ."\n" + .'- **closed**：已关闭。'."\n" + ."\n" + .'- **notconfigured**：未配置。', + 'type' => 'string', + 'example' => 'opened', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125g4d2', + ], + 'LocalVpc' => [ + 'description' => 'VPC的详细信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'TransitRouterType' => [ + 'description' => '云企业网转发路由器（CEN-TR）的版本。取值：'."\n" + ."\n" + .'- **Basic**：基础版。'."\n" + ."\n" + .'- **Enterprise**：企业版。', + 'type' => 'string', + 'example' => 'Basic', + ], + 'RouteMode' => [ + 'description' => '路由模式,。取值：'."\n" + ."\n" + .'- auto：表示自动模式。'."\n" + ."\n" + .'- manual：表示手动模式。'."\n", + 'type' => 'string', + 'example' => 'auto', + ], + 'NetworkInstanceId' => [ + 'description' => '创建VPC边界防火墙的VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-2zefk9fbn8j7v585g****', + ], + 'RegionNo' => [ + 'description' => 'VPC所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ManualVSwitchId' => [ + 'description' => '路由模式为手动模式时指定的vSwitch的ID。', + 'type' => 'string', + 'example' => 'vsw-zeq4o875u****', + ], + 'OwnerId' => [ + 'description' => 'VPC所属阿里云账户的UID。', + 'type' => 'string', + 'example' => '158039427902****', + ], + 'NetworkInstanceType' => [ + 'description' => '网络实例的类型。取值：**VPC**。'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'VpcName' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'example' => '测试用实例', + ], + 'SupportManualMode' => [ + 'description' => '路由模式是否支持手动模式。取值：'."\n" + ."\n" + .'- **1**：支持。'."\n" + .'- **0**：不支持。', + 'type' => 'string', + 'example' => '0', + ], + 'TransitRouterId' => [ + 'description' => 'CEN-TR的实例ID。', + 'type' => 'string', + 'example' => 'tr-2zetwxskej633l3u1****', + ], + 'AttachmentId' => [ + 'description' => '网络实例的连接ID。', + 'type' => 'string', + 'example' => 'tr-attach-sxig7bye51fid5****', + ], + 'NetworkInstanceName' => [ + 'description' => '网络实例的名称。', + 'type' => 'string', + 'example' => '测试业务vpc', + ], + 'AttachmentName' => [ + 'description' => '网络实例的连接名称', + 'type' => 'string', + 'example' => '本地测试', + ], + 'VpcCidrTableList' => [ + 'description' => 'VPC的网段列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => 'VPC的路由表ID。', + 'type' => 'string', + 'example' => 'vtb-1234', + ], + 'RouteEntryList' => [ + 'description' => 'VPC的路由条目列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => 'VPC中的下一跳实例ID。', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => 'VPC的目标网段。', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + 'EniList' => [ + 'description' => '弹性网卡列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EniId' => [ + 'description' => 'VPC中弹性网卡的实例ID。', + 'type' => 'string', + 'example' => 'eni-8vbhfosfqv2rff42****', + ], + 'EniPrivateIpAddress' => [ + 'description' => 'VPC中弹性网卡的私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'EniVSwitchId' => [ + 'description' => 'VPC中弹性网卡的虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-wz9viido7j436b0n1****', + ], + ], + ], + ], + 'DefendCidrList' => [ + 'description' => 'VPC边界防火墙防护的网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙防护的网段。', + 'type' => 'string', + 'example' => '10.0.XX.XX/24', + ], + ], + ], + ], + 'FirewallVpc' => [ + 'description' => '防火墙所使用VPC。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-bp1245k5oagy2bp74****', + ], + 'VpcCidr' => [ + 'description' => 'VPC的网段。', + 'type' => 'string', + 'example' => '10.0.0.0/8', + ], + 'VswitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1sqg9wms9wxcs1****', + ], + 'VswitchCidr' => [ + 'description' => '虚拟交换机的网段。', + 'type' => 'string', + 'example' => '10.0.0.1/24', + ], + 'ZoneId' => [ + 'description' => '防火墙主可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'AllowConfiguration' => [ + 'description' => 'CEN基础版创建VPC防火墙时是否允许配置防火墙VPC网段。取值：'."\n" + .'- **1**：允许。'."\n" + .'- **0**：不允许。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VswitchZoneId' => [ + 'description' => '虚拟交换机的可用区ID', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'StandbyZoneId' => [ + 'description' => '防火墙备可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询VPC边界防火墙的详细信息', + 'description' => '本接口一般用于获取VPC边界防火墙的详细信息。该VPC边界防火墙是防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '云企业Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-x5jayxou71ad73****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D2373503-3921-59F2-93A6-3DA7FB7****', + ], + 'NetworkInstanceList' => [ + 'description' => '网络实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '网络实例信息。', + 'type' => 'object', + 'properties' => [ + 'NetworkInstanceId' => [ + 'description' => '网络实例ID。', + 'type' => 'string', + 'example' => 'vpc-m5ewlqkuf7or****', + ], + 'NetworkInstanceName' => [ + 'description' => '网络实例名。', + 'type' => 'string', + 'example' => 'vpc-test', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + '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"}]', + 'title' => '获取网络实例列表', + ], + 'DescribeVpcZone' => [ + 'summary' => '查询VPC zone。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'string', + 'required' => false, + 'example' => '1415189284827022', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => [ + 'description' => '环境。取值：'."\n" + .'- **VPC**：VPC'."\n" + .'- **TransitRouter**：TransitRouter', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '694DFBF3-C060-529F-92D0-7FC7E0DA1E21', + ], + 'ZoneList' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区列表。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'LocalName' => [ + 'description' => '可用区名称。', + 'type' => 'string', + 'example' => '华东 1 可用区 B', + ], + 'ZoneType' => [ + 'description' => '查询到的可用区的类型，默认取值为 AvailabilityZone 即普通云上可用区。', + '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' => '查询VPC zone', + ], + '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' => '云防火墙成员账号的UID。', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + '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' => 'cen-tr企业版使用', + 'VPC' => 'cen基础版使用', + ], + 'example' => 'TransitRouter', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '云企业网实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-4xbjup276au29r****', + ], + ], + [ + 'name' => 'TransitRouterId', + 'in' => 'query', + 'schema' => [ + 'description' => '转发路由器实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'tr-m5etmb2q7e0mxcur****', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问者源IP地址。', + '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' => '结果的请求ID。', + 'type' => 'string', + 'example' => '337A4DBA-8A01-5E9C-99CA-84293E13****', + ], + 'ZoneList' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID', + 'type' => 'string', + 'example' => 'cn-hangzhou-c', + ], + 'LocalName' => [ + 'description' => '可用区名称。', + 'type' => 'string', + 'example' => '杭州 可用区C', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + 'title' => '查询VPC防火墙可用区', + ], + 'DescribeVpcFirewallManualVSwitchList' => [ + 'summary' => '查询VPC防火墙手动模式交换机列表。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-m5ewlqkuf7orclr1****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '18820897691****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-uf62kq7c364sil2z2****', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp10d0kcp907721z****', + ], + 'CidrBlock' => [ + 'description' => 'IPv4网段。', + 'type' => 'string', + 'example' => '10.0.31.0/24', + ], + 'AvailableIpAddressCount' => [ + 'description' => '交换机中可用的IP地址数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RegionNo' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-a', + ], + 'AliUid' => [ + 'description' => '阿里云账号的UID。'."\n" + ."\n" + .'> 云防火墙成员账号的主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122167357026****', + ], + 'RouteTableId' => [ + 'description' => '关联路由表ID。', + 'type' => 'string', + 'example' => 'vtb-2zet3gyk01o07so****', + ], + 'OwnerId' => [ + 'description' => '所属用户ID。', + '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"}]', + 'title' => '查询VPC防火墙手动模式交换机列表', + ], + 'CreateVpcFirewallCenConfigure' => [ + 'summary' => '创建VPC边界防火墙（防护云企业网内的网络实例和指定VPC之间的互访流量）。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => '测试用实例', + ], + ], + [ + 'name' => 'NetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '创建VPC边界防火墙的VPC实例ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp10zlifxh6j0232w****', + ], + ], + [ + 'name' => 'VpcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '创建VPC边界防火墙的VPC所属地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '设置VPC边界防火墙的开关状态。取值：'."\n" + ."\n" + .'- **open**（默认）：创建VPC边界防火墙后自动开启防护。'."\n" + .'- **close**：创建VPC边界防火墙后不自动开启防护。您可以调用接口[ModifyVpcFirewallCenSwitchStatus](~~345780~~)开启防护。', + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '云企业网实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cen-x5jayxou71ad73****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定云防火墙接口所属的vSwitch ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-qzeaol304m***', + ], + ], + [ + 'name' => 'FirewallVpcCidrBlock', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙所使用VPC网段, 需配置子网掩码不大于28位网段来分配给创建防火墙过程所需VPC网段，用以自动创建防火墙安全VPC（Cloud_Firewall_VPC）进行流量引流处理。'."\n" + ."\n" + .'如果不填此参数，则默认自动分配网段10.0.0.0/8。'."\n" + ."\n" + .'> 参数仅本CEN本地域首次创建VPC防火墙时有效。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.0/8', + ], + ], + [ + 'name' => 'FirewallVpcZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙所属的主可用区ID。'."\n" + .'如果您的业务延时敏感，您可以自定义防火墙可用区和业务VPC交换机可用区相同，以便降低延时。'."\n" + ."\n" + .'如果不填此参数，则默认自动分配防火墙可用区。'."\n" + ."\n\n" + ."\n" + .'> 参数仅本CEN本地域首次创建VPC防火墙时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-a', + ], + ], + [ + 'name' => 'FirewallVSwitchCidrBlock', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙所使用vSwitch网段, 需配置子网掩码不大于29位且不与网络规划冲突的网段来分配给创建防火墙过程所需vSwitch网段，用以自动创建防火墙安全VPC内的交换机（Cloud_Firewall_VSWITCH）进行流量引流处理。交换机网段必须是防火墙VPC网段的子网。'."\n" + ."\n" + .'如果不填此参数, 则默认自动分配网段10.219.219.216/29。'."\n" + ."\n" + .'> 参数仅本CEN本地域首次创建VPC防火墙时有效。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.*.*/28', + ], + ], + [ + 'name' => 'FirewallVpcStandbyZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙所属的备可用区ID。只有防火墙主可用区服务不可用时, 防火墙会自动切换到备可用区继续运行。'."\n" + ."\n" + .'如果不填此参数，则默认自动分配防火墙备可用区。'."\n" + ."\n\n" + ."\n" + .'> 参数仅本CEN本地域首次创建VPC防火墙时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '创建VPC边界防火墙', + 'description' => '本接口一般用于为云企业网内的VPC实例创建VPC边界防火墙。该VPC边界防火墙可以防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量，不支持防护VBR与VBR、CCN与CCN、VBR与CCN之间的互访流量。更多信息，请参见[VPC边界防火墙限制说明](~~172295~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'ModifyVpcFirewallCenConfigure' => [ + 'summary' => '修改VPC边界防火墙（防护云企业网内的网络实例和指定VPC之间的互访流量）的配置信息。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。'."\n" + ."\n" + .'> 您可以通过调用[DescribeVpcFirewallCenList](~~345777~~)接口查询VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => '测试用实例', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '修改VPC边界防火墙的配置信息（云企业网）', + 'description' => '本接口一般用于修改VPC边界防火墙的配置信息。该VPC边界防火墙是防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量。'."\n" + .'调用本接口前，必须已经调用[CreateVpcFirewallCenConfigure](~~345772~~)接口创建了VPC边界防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'ModifyVpcFirewallCenSwitchStatus' => [ + 'summary' => '修改VPC边界防火墙（防护云企业网内的网络实例和指定VPC之间的互访流量）的开关状态。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。'."\n" + ."\n" + .'> 您可以通过调用[DescribeVpcFirewallCenList](~~345777~~)接口查询VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '设置VPC边界防火墙的开关状态。取值：'."\n" + ."\n" + .'- **open**：开启。'."\n" + ."\n" + .'- **close**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '修改VPC边界防火墙的开关状态（云企业网）', + 'description' => '本接口一般用于修改VPC边界防火墙的开关状态。该VPC边界防火墙是防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量。打开VPC边界防火墙的开关后，云企业网内的网络实例和指定VPC之间的互访流量会受VPC边界防火墙防护。关闭VPC边界防火墙的开关后，VPC边界防火墙不再防护云企业网内的网络实例和指定VPC之间的互访流量。'."\n" + ."\n" + .'调用本接口前，必须已经调用[CreateVpcFirewallCenConfigure](~~345772~~)接口创建了VPC边界防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DeleteVpcFirewallCenConfigure' => [ + 'summary' => '删除VPC边界防火墙（防护云企业网内的网络实例和指定VPC之间的互访流量）。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙的实例ID。'."\n" + ."\n" + .'> 您可以通过调用[DescribeVpcFirewallCenList](~~345777~~)接口查询VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '删除VPC边界防火墙（云企业网）', + 'description' => '本接口一般用于删除VPC边界防火墙。该VPC边界防火墙是防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量。'."\n" + .'调用本接口前，必须已经调用[CreateVpcFirewallCenConfigure](~~345772~~)接口创建了VPC边界防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DescribeVpcFirewallList' => [ + 'summary' => '查询VPC边界防火墙（防护通过高速通道连接的两个VPC之间的流量）的信息。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC所在的地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'FirewallSwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的状态。取值：'."\n" + ."\n" + .'- **opened**：已开启。'."\n" + .'- **closed**：已关闭。'."\n" + .'- **notconfigured**：表示暂未配置VPC边界防火墙。'."\n" + .'- **configured**：表示已配置VPC边界防火墙。'."\n" + ."\n" + .'> 不设置该参数表示查询所有状态的VPC边界防火墙。', + 'type' => 'string', + 'required' => false, + 'example' => 'opened', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试环境防火墙', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页面的页码。'."\n" + ."\n" + .'默认值为**1**，表示返回第**1**页数据。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置每页包含VPC边界防火墙的数量。'."\n" + ."\n" + .'默认值为**10**，表示每页包含**10**条结果。最大值为**50**。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'ConnectSubType', + 'in' => 'query', + 'schema' => [ + 'description' => '连接子类型。取值：'."\n" + ."\n" + .'- **vpc2vpc**：高速通道。'."\n" + .'- **vpcpeer**：对等连接。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpcpeer', + ], + ], + [ + 'name' => 'PeerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '对端VPC云账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'VPC防火墙的列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'VPC边界防火墙的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125k8g2', + ], + 'VpcFirewalls' => [ + 'description' => 'VPC边界防火墙的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙的详细信息。', + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => 'VPC边界防火墙的互通类型。取值：**expressconnect**，表示高速通道。', + 'type' => 'string', + 'example' => 'expressconnect', + ], + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RegionStatus' => [ + 'description' => '地域开放状态。取值：'."\n" + ."\n" + .'- **enable**：已开放，表示该地域允许配置VPC边界防火墙。'."\n" + .'- **disable**：未开放，表示该地域不允许配置VPC边界防火墙。', + 'type' => 'string', + 'example' => 'enable', + ], + 'Bandwidth' => [ + 'description' => '高速通道的带宽规格。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VpcFirewallName' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'example' => '测试防火墙', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'VPC边界防火墙开关的状态。取值：'."\n" + ."\n" + .'- **opened**：已开启。'."\n" + .'- **closed**：已关闭。'."\n" + .'- **notconfigured**：表示暂未配置VPC边界防火墙。', + 'type' => 'string', + 'example' => 'opened', + ], + 'LocalVpc' => [ + 'description' => '本端VPC的详细信息。', + 'type' => 'object', + 'properties' => [ + 'VpcName' => [ + 'description' => '本端VPC的实例名称。', + 'type' => 'string', + 'example' => '测试用实例', + ], + 'VpcId' => [ + 'description' => '本端VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'AuthorizationStatus' => [ + 'description' => '本端VPC的授权状态。取值：authorized，表示已授权。', + 'type' => 'string', + 'example' => 'authorized', + ], + 'OwnerId' => [ + 'description' => '本端VPC所属阿里云账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158039427902****', + ], + 'RegionNo' => [ + 'description' => '本端VPC所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VpcCidrTableList' => [ + 'description' => '本端VPC的网段列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '本端VPC的网段列表信息。', + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => '本端VPC的路由表ID。', + 'type' => 'string', + 'example' => 'vtb-1234', + ], + 'RouteEntryList' => [ + 'description' => '本端VPC的路由条目列表。', + 'type' => 'array', + 'items' => [ + 'description' => '本端VPC的路由条目列表。', + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => '本端VPC的下一跳实例ID。', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => '本端VPC的目标网段。', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'PeerVpc' => [ + 'description' => '对端VPC的详细信息。', + 'type' => 'object', + 'properties' => [ + 'VpcName' => [ + 'description' => '对端VPC的实例名称。', + 'type' => 'string', + 'example' => '测试vpc2', + ], + 'VpcId' => [ + 'description' => '对端VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'AuthorizationStatus' => [ + 'description' => '对端VPC的授权状态。取值：**authorized**，表示已授权。', + 'type' => 'string', + 'example' => 'authorized', + ], + 'OwnerId' => [ + 'description' => '对端VPC所属的阿里云账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158039427902****', + ], + 'RegionNo' => [ + 'description' => '对端VPC所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VpcCidrTableList' => [ + 'description' => '对端VPC网段列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对端VPC网段列表信息。', + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => '对端VPC的路由表ID。', + 'type' => 'string', + 'example' => 'vtb-1256', + ], + 'RouteEntryList' => [ + 'description' => '对端VPC路由条目列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对端VPC路由条目列表信息。', + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => '对端VPC的下一跳实例ID。', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => '对端VPC的目标网段。', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'IpsConfig' => [ + 'description' => 'IPS配置信息。', + 'type' => 'object', + 'properties' => [ + 'BasicRules' => [ + 'description' => '基础规则开关。取值：'."\n" + ."\n" + .'- **1**：开启状态。'."\n" + .'- **0**：关闭状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableAllPatch' => [ + 'description' => '虚拟补丁开关。取值：'."\n" + ."\n" + .'- **1**：开启状态。'."\n" + .'- **0**：关闭状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RunMode' => [ + 'description' => 'IPS防御模式。取值：'."\n" + ."\n" + .'- **1**：拦截模式。'."\n" + .'- **0**：观察模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleClass' => [ + 'description' => 'IPS规则组。取值：'."\n" + ."\n" + .'- **1**：宽松规则组。'."\n" + ."\n" + .'- **2**：中等规则组。'."\n" + ."\n" + .'- **3**：严格规则组。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'MemberUid' => [ + 'description' => '阿里云成员账号的UID。', + 'type' => 'string', + 'example' => '258039427902****', + ], + 'ResultCode' => [ + 'description' => '创建VPC边界防火墙的操作结果代码。取值：'."\n" + ."\n" + .'- **Unauthorized**：表示存在未授权的VPC, 不允许创建VPC边界防火墙。'."\n" + .'- **RegionDisable**：表示VPC所在的地域是VPC边界防火墙不支持的地域, 不允许创建VPC边界防火墙。'."\n" + .'- **空字符串**：表示该网络实例可以正常创建VPC边界防火墙。', + 'type' => 'string', + 'example' => 'Unauthorized', + ], + 'ConnectSubType' => [ + 'description' => '连接子类型。取值：'."\n" + ."\n" + .'- **vpc2vpc**：高速通道。'."\n" + .'- **vpcpeer**：对等连接。', + 'type' => 'string', + 'example' => 'vpcpeer', + ], + 'AclConfig' => [ + 'description' => 'ACL引擎模式。', + 'type' => 'object', + 'properties' => [ + 'StrictMode' => [ + 'description' => '是否启用严格模式'."\n" + ."\n" + .'- 1：启用严格模式 '."\n" + .'- 0：禁用严格模式', + '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' => '获取高速通道防火墙列表', + 'description' => '本接口一般用于分页查询VPC边界防火墙的信息。该VPC边界防火墙是防护通过高速通道连接两个VPC之间的流量。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DescribeVpcFirewallDetail' => [ + 'summary' => '查询VPC边界防火墙（防护通过高速通道连接的两个VPC之间的流量）的详细信息。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcFirewallList](~~342932~~)接口查询VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'LocalVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '本端VPC的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'PeerVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '对端VPC的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-90rq0anm6t8vbwbo****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectType' => [ + 'description' => 'VPC边界防火墙的互通类型。取值：**expressconnect**，表示高速通道。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'expressconnect', + ], + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125g4d2', + ], + 'Bandwidth' => [ + 'description' => '高速通道的带宽规格。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VpcFirewallName' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'example' => '测试防火墙', + ], + 'FirewallSwitchStatus' => [ + 'description' => 'VPC边界防火墙的状态。取值：'."\n" + .'- **opened**：已开启。'."\n" + .'- **closed**：已关闭。'."\n" + .'- **notconfigured**：表示暂未配置VPC边界防火墙。'."\n" + .'- **configured**：表示已配置VPC边界防火墙。', + 'type' => 'string', + 'example' => 'opened', + ], + 'LocalVpc' => [ + 'description' => '本端VPC的详细信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '本端VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + 'VpcName' => [ + 'description' => '本端VPC的实例名称。', + 'type' => 'string', + 'example' => '测试用实例', + ], + 'RegionNo' => [ + 'description' => '本端VPC所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'EniPrivateIpAddress' => [ + 'description' => '本端VPC中弹性网卡私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'RouterInterfaceId' => [ + 'description' => '本端VPC中路由器接口ID。', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'EniId' => [ + 'description' => '本端VPC中弹性网卡的实例ID。', + 'type' => 'string', + 'example' => 'eni-8vbhfosfqv2rff42****', + ], + 'VpcCidrTableList' => [ + 'description' => '本端VPC的网段列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => '本端VPC的路由表ID。', + 'type' => 'string', + 'example' => 'vtb-1234', + ], + 'RouteEntryList' => [ + 'description' => '本端VPC的路由条目列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => '本端VPC中的下一跳实例ID。', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => '本端VPC的目标网段。', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'PeerVpc' => [ + 'description' => '对端VPC的详细信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '对端VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-90rq0anm6t8vbwbo****', + ], + 'VpcName' => [ + 'description' => '对端VPC的实例名称。', + 'type' => 'string', + 'example' => '测试vpc2', + ], + 'RegionNo' => [ + 'description' => '对端VPC所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'EniPrivateIpAddress' => [ + 'description' => '对端VPC中弹性网卡私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'RouterInterfaceId' => [ + 'description' => '对端VPC中路由器接口ID。', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'EniId' => [ + 'description' => '对端VPC中弹性网卡的实例ID。', + 'type' => 'string', + 'example' => 'eni-8vbhfosfqv2rff42****', + ], + 'VpcCidrTableList' => [ + 'description' => '对端VPC的网段列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RouteTableId' => [ + 'description' => '对端VPC的路由表ID。', + 'type' => 'string', + 'example' => 'vtb-1256', + ], + 'RouteEntryList' => [ + 'description' => '对端VPC路由条目列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NextHopInstanceId' => [ + 'description' => '对端VPC中的下一跳实例ID。', + 'type' => 'string', + 'example' => 'vrt-m5eb5me6c3l5sezae****', + ], + 'DestinationCidr' => [ + 'description' => '对端VPC的目标网段。', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + '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' => '查询VPC边界防火墙的详情', + 'description' => '本接口用于获取VPC边界防火墙的详细信息。该VPC边界防火墙是防护通过高速通道连接的两个VPC之间的流量。'."\n" + .'调用本接口前，必须已经调用[CreateVpcFirewallConfigure](~~342893~~)接口创建了VPC边界防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'CreateVpcFirewallConfigure' => [ + 'summary' => '创建VPC边界防火墙（防护通过高速通道连接的两个VPC之间的流量）。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => '测试用实例', + ], + ], + [ + 'name' => 'LocalVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '本端VPC的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'LocalVpcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '本端VPC所属地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PeerVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '对端VPC的实例ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-wb8vbo90rq0anm6t****', + ], + ], + [ + 'name' => 'PeerVpcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '对端VPC所属地域ID。'."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '设置VPC边界防火墙创建后的开启状态。取值： '."\n" + ."\n" + .'- **open**（默认）：创建VPC边界防火墙后自动开启防护。'."\n" + ."\n" + .'- **close**：创建VPC边界防火墙后不自动开启防护。您可以调用接口[ModifyVpcFirewallSwitchStatus](~~342935~~)开启防护。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + [ + 'name' => 'LocalVpcCidrTableList', + 'in' => 'query', + 'schema' => [ + 'description' => '本端VPC的网段列表，以JSON格式表示，具体包含以下参数：'."\n" + ."\n" + .'- **RouteTableId**：表示本端VPC的路由表ID。'."\n" + .'- **RouteEntryList**：该参数使用JSON格式，包含DestinationCidr（表示本端VPC的目标网段）和NextHopInstanceId（表示本端VPC的下一跳实例ID）。', + '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' => '对端VPC的网段列表，以JSON格式表示，具体包含以下参数：'."\n" + .'- **RouteTableId**：表示对端VPC的路由表ID。'."\n" + .'- **RouteEntryList**：该参数使用JSON格式，包含DestinationCidr（表示对端VPC的目标网段）和NextHopInstanceId（表示对端VPC的下一跳实例ID）。', + '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' => '阿里云成员账号的UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125h4j6', + ], + ], + ], + ], + ], + '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' => '创建VPC边界防火墙', + 'description' => '本接口一般用于创建VPC边界防火墙。该VPC边界防火墙是防护通过高速通道连接的两个VPC之间的流量。该VPC边界防火墙不支持防护VPC跨地域、跨账号以及VPC与VBR间的互访流量。更多信息，请参见[VPC边界防火墙限制说明](~~172295~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'ModifyVpcFirewallConfigure' => [ + 'summary' => '修改VPC边界防火墙（防护通过高速通道连接的两个VPC之间的流量）的配置信息。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcFirewallList](~~342932~~)接口查询VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => '测试环境防火墙', + ], + ], + [ + 'name' => 'LocalVpcCidrTableList', + 'in' => 'query', + 'schema' => [ + 'description' => '本端VPC的网段信息，以JSON格式表示，具体包含以下参数：'."\n" + ."\n" + .'- **RouteTableId**：表示本端VPC的路由表ID。'."\n" + ."\n" + .'- **RouteEntryList**：该参数使用JSON格式，包含DestinationCidr（表示本端VPC的目标网段）和NextHopInstanceId（表示本端VPC的下一跳实例ID）。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcFirewallDetail](~~342892~~)接口查询VPC边界防火墙的本端VPC网段信息。', + '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' => '对端VPC的网段信息，以JSON格式表示，具体包含以下参数：'."\n" + ."\n" + .'- **RouteTableId**：表示对端VPC的路由表ID。'."\n" + ."\n" + .'- **RouteEntryList**：该参数使用JSON格式，包含DestinationCidr（表示对端VPC的目标网段）和NextHopInstanceId（表示对端VPC的下一跳实例ID）。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcFirewallDetail](~~342892~~)接口查询VPC边界防火墙的对端VPC网段信息。', + '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' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '修改VPC边界防火墙的配置信息', + 'description' => '本接口一般用于修改VPC边界防火墙的配置信息。该VPC边界防火墙是防护通过高速通道连接的两个VPC之间的流量。'."\n" + .'调用本接口前，必须已经调用[CreateVpcFirewallConfigure](~~342893~~)接口创建了VPC边界防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'ModifyVpcFirewallSwitchStatus' => [ + 'summary' => '修改VPC边界防火墙（防护通过高速通道连接的两个VPC之间的流量）的开关状态。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。'."\n" + ."\n" + .'> 您可以通过调用[DescribeVpcFirewallList](~~342932~~)接口查询VPC边界防火墙的实例ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'FirewallSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '设置VPC边界防火墙的开关状态。取值：'."\n" + ."\n" + .'- **open**：开启。'."\n" + ."\n" + .'- **close**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'open', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '修改VPC边界防火墙的开关状态', + 'description' => '本接口一般用于修改VPC边界防火墙的开关状态。该VPC边界防火墙是防护通过高速通道连接的两个VPC之间的流量。打开VPC边界防火墙的开关后，高速通道连接的两个VPC之间的互访流量会受VPC边界防火墙防护。关闭VPC边界防火墙的开关后，VPC边界防火墙不再防护通过高速通道连接的两个VPC之间的互访流量。'."\n" + ."\n" + .'调用本接口前，必须已经调用[CreateVpcFirewallConfigure](~~342893~~)接口创建了VPC边界防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DeleteVpcFirewallConfigure' => [ + 'summary' => '删除VPC边界防火墙（防护通过高速通道连接的两个VPC之间流量）。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要删除的VPC边界防火墙的实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙的实例ID。'."\n" + ."\n" + .'> 您可以通过调用[DescribeVpcFirewallList](~~342932~~)接口查询VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-m5e7dbc4y****', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '删除VPC边界防火墙', + 'description' => '本接口一般用于删除VPC边界防火墙。该VPC边界防火墙是防护通过高速通道连接的两个VPC之间流量。'."\n" + .'调用本接口前，必须已经调用[CreateVpcFirewallConfigure](~~342893~~)接口创建了VPC边界防火墙。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '访问者源IP', + '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' => '最大top数限制数,默认50,取值1-50。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => '源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '8.153.18.XX', + ], + ], + [ + 'name' => 'NatIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'AT公网IP,不填表示所有资产IP。', + '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' => '结果的请求id。', + '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' => '入方向流量的宽带速率，单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '187', + ], + 'ResourceInstanceId' => [ + 'description' => '资源实例ID', + 'type' => 'string', + 'example' => 'lb-bp14ue2rgktunncq****', + ], + 'NewConn' => [ + 'description' => '新建连接数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'OutPps' => [ + 'description' => '出方向包转发率。单位：pps', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IP' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '183.60.164.XXX', + ], + 'OutBps' => [ + 'description' => '出方向流量。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'PrivateIP' => [ + 'description' => '私网IP。', + 'type' => 'string', + 'example' => '10.21.186.XXX', + ], + 'SessionCount' => [ + 'description' => '会话数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'ResourceType' => [ + 'description' => '公网IP类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + ], + 'example' => 'EcsPublicIP', + ], + 'InPps' => [ + 'description' => '入方向包转发率，单位：pps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalPps' => [ + 'description' => '总数据包个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '88', + ], + 'TotalBps' => [ + 'description' => '总带宽，单位为bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '232', + ], + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-wz9o0uzfjuj81fx7m****', + ], + 'NatGatewayId' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'example' => 'ngw-wz98eedr5l5hkb8****e7', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关名称。', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'NatIP' => [ + 'description' => 'NAT公网IP。', + '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"}]', + 'title' => '查询互联网流量时间TOP', + ], + 'DescribeNatFirewallTimeTop' => [ + 'summary' => '查询NAT防火墙时间点流量TOP。', + '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' => 'NAT公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.93.47.XXX', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-uf62zzi7000bca7zn****', + ], + ], + [ + 'name' => 'SrcPrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT私网IP。', + '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' => '最大top数限制数，默认200，取值1-500。', + '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' => '结果的请求ID。', + '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' => 'IP地址。', + 'type' => 'string', + 'example' => '10.66.231.XXX', + ], + 'InBps' => [ + 'description' => '入方向带宽，单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '187', + ], + 'OutBps' => [ + 'description' => '出方向带宽，单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'TotalBps' => [ + 'description' => '总带宽，单位为bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '232', + ], + 'SessionCount' => [ + 'description' => '会话总数。', + 'type' => 'string', + 'example' => '27', + ], + 'NewConn' => [ + 'description' => '新建连接数。', + 'type' => 'string', + 'example' => '27', + ], + 'ResourceInstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-bp130nn8h6157dir****', + ], + 'ResourceInstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionNo' => [ + 'description' => '区域。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'NatGatewayId' => [ + 'description' => ' NAT网关的ID。 ', + 'type' => 'string', + 'example' => 'ngw-uf6pnry5vpawb****', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关名称', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'NatFirewallId' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'example' => 'vfw-tr-7a9c8901ed394****'."\n", + ], + 'NatFirewallName' => [ + 'description' => 'NAT防火墙名称。', + '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"}]', + 'title' => '查询NAT防火墙时间点流量TOP', + ], + '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' => '访问者源IP地址。', + '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' => '资产IP。', + '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' => '来源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' => '目标IP。', + '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' => 'IP属性。', + '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' => '源IP。', + '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' => '来源IP', + ], + 'example' => 'in_src_ip', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '查询网络流量TOP占比', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '117.32.136.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '关注目的IP数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalProtocolCount' => [ + 'description' => '外联协议数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UncoveredAclDstIP' => [ + 'description' => '未覆盖策略的目的IP数。', + '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' => '总外联目的IP数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '107', + ], + 'IgnoreDstIPCount' => [ + 'description' => '忽略目的IP数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '外联风险目的IP数。', + '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"}]', + 'title' => '获取主动外联统计信息', + ], + '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' => '资产公网IP类型。', + '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' => '公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.116.70.XXX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '私网IP。', + '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' => '查询Nat私网外联。', + 'type' => 'string', + 'required' => false, + 'example' => 'NatPrivate', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-bp123456g******', + ], + ], + [ + 'name' => 'NatGatewayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关名称', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '资产公网IP类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + 'EIP' => 'EIP', + ], + 'example' => 'EcsPublicIP', + ], + 'AssetInstanceId' => [ + 'description' => '资产实例Id。', + 'type' => 'string', + 'example' => 'i-8vbcmllue4d94nto****', + ], + 'GroupName' => [ + 'description' => '关注情况。', + 'type' => 'string', + 'enumValueTitles' => [ + 'subscribe' => '已关注', + 'ignore' => '已忽略', + ], + 'example' => 'subscribe', + ], + 'AssetsRegion' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OutBytes' => [ + 'description' => '流出流量, 请求流量,单位bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'SecurityRisk' => [ + 'description' => '安全风险。', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => '常资产', + 'risk' => '风险资产', + ], + 'example' => 'risk', + ], + 'InBytes' => [ + 'description' => '流入流量, 应答流量,单位bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '244438.0', + ], + 'PublicIP' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '47.96.181.XXX', + ], + 'AssetInstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'PrivateIP' => [ + 'description' => '私网ip。', + 'type' => 'string', + 'example' => '10.21.242XXX', + ], + 'NatGatewayId' => [ + 'description' => 'NAT网关ID。', + 'type' => 'string', + 'example' => 'ngw-bp1utx6wj4x9qu9tl****', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关名。', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'OutgoingDomainCnt' => [ + 'description' => '外联域名数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'OutgoingDstIPCnt' => [ + 'description' => '外联IP数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'TotalBytes' => [ + 'description' => '总流量。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12498767', + ], + 'PrivateIPList' => [ + 'description' => '私网IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '私网IP列表。', + 'type' => 'string', + 'example' => '["47.256.35.XXX"]', + ], + ], + 'IpsHitCnt' => [ + 'description' => 'ips命中情况。', + '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"}]', + 'title' => '获取外联资产列表', + ], + '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' => '访问者源IP地址。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询主动外联域名列表', + ], + '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' => '访问者源IP地址。', + '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' => '目的IP。', + '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' => '返回结果的请求ID。', + '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' => '目的IP。', + '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"}]', + 'title' => '查询主动外联IP列表', + ], + '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' => '访问者源IP地址。', + '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' => '分类ID。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'All' => '全部', + 'RiskDomain' => '风险域名', + 'AliYun' => '阿里云产品', + 'NotAliYun' => '非阿里云产品', + ], + 'example' => 'All', + ], + ], + [ + 'name' => 'TypeId', + 'in' => 'query', + 'schema' => [ + 'description' => '固定类别ID。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'All' => '全部', + 'AliYun' => '阿里云产品', + 'NotAliYun' => '非阿里云产品', + ], + 'example' => 'All', + ], + ], + [ + 'name' => 'DstType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DstIP' => '目的IP', + 'Domain' => '域名', + ], + 'example' => 'domain', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'C1ED80BC-FFC8-57DB-8151-705DC31****', + ], + 'TypeList' => [ + 'description' => '主动外联分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主动外联分类。', + 'type' => 'object', + 'properties' => [ + 'TypeName' => [ + 'description' => '固定类别名称。', + 'type' => 'string', + 'example' => '阿里云云产品', + ], + 'TypeId' => [ + 'description' => '固定类别ID。', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => '全部', + 'AliYun' => '阿里云产品', + 'NotAliYun' => '非阿里云产品', + ], + 'example' => 'All', + ], + 'TypeDescribe' => [ + 'description' => '固定类别描述。', + 'type' => 'string', + 'example' => '阿里云产品', + ], + 'CategoryList' => [ + 'description' => '主动外联分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主动外联分类。', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '主动外联分类ID。', + 'type' => 'string', + 'example' => 'AliYun', + ], + 'CategoryName' => [ + 'description' => '主动外联分类名称。', + 'type' => 'string', + 'example' => '阿里云产品', + ], + 'CategoryDescribe' => [ + 'description' => '主动外联分类描述。', + 'type' => 'string', + 'example' => '阿里云产品', + ], + 'ClassId' => [ + 'description' => '主动外联分类分级ID。', + '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"}]', + 'title' => '查询主动外联目的分类', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '60.179.226.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + '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' => '目标类型。取值：'."\n" + .'- **Domain** ：域名。'."\n" + .'- **DstIP** ：IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'Domain ', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签ID。', + 'type' => 'string', + 'required' => false, + 'example' => '103208', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'B532203E-813B-5BEB-B75B-315E1D08****', + ], + 'TagList' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表对象。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险评估等级。取值：'."\n" + .'- **0**：无风险。'."\n" + .'- **1**：低风险。'."\n" + .'- **2**：中风险。'."\n" + .'- **3**：高风险。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => 'test tag', + ], + 'TagId' => [ + 'description' => '标签ID。', + 'type' => 'string', + 'example' => 'tag-6833388d18cc****', + ], + 'TagDescribe' => [ + 'description' => '标签描述。', + 'type' => 'string', + 'example' => 'test describe', + ], + 'ClassId' => [ + 'description' => '分类等级。取值：'."\n" + ."\n" + .'- **Suspicious**：可疑。'."\n" + ."\n" + .'- **Malicious**：恶意。'."\n" + ."\n" + .'- **Trusted**：信任。', + '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"}]', + 'title' => '获取外联标签', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeOutgoingDomain' => [ + 'summary' => '查询主动外联的域名信息。', + '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' => '请求消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '设置分页查询每页包含多少条结果。'."\n" + ."\n" + .'默认值为6，表示每页包含6条结果。最大值为100。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => '设置分页查询返回第几页数据。'."\n" + ."\n" + .'默认值为1，表示返回第1页数据。', + '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' => '产品分类。默认值：空。取值：'."\n" + ."\n" + .'- **All** ：全部分类'."\n" + .'- **RiskDomain**：风险域名分类'."\n" + .'- **RiskIP** ：风险IP分类'."\n" + .'- **AliYun** ：云产品分类'."\n" + .'- **NotAliYun** ：非云产品分类', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'title' => '域名', + 'description' => '主动外联的域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'title' => '公网IP', + 'description' => '外联ECS的公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序, 枚举值, 可选:asc, desc', + 'description' => '按照指定的字段排序。取值：'."\n" + ."\n" + .'- **SessionCount**（默认值）：请求次数'."\n" + .'- **TotalBytes**：总流量数'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SessionCount', + 'enum' => [], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段, 枚举值.'."\n" + .'默认值: SessionCount'."\n" + .'可选值: InBytes, OutBytes,TotalBytes,SessionCount', + 'description' => '排序方式。取值：'."\n" + ."\n" + .'- **asc**：升序'."\n" + .'- **desc**（默认）：降序'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [], + ], + ], + [ + 'name' => 'TagIdNew', + 'in' => 'query', + 'schema' => [ + 'description' => '情报标签ID。取值：'."\n" + ."\n" + .'- **AliYun**：阿里云产品'."\n" + .'- **RiskDomain**：风险域名'."\n" + .'- **RiskIP**：风险IP'."\n" + .'- **TrustedDomain**：信誉网站'."\n" + .'- **AliPay**：支付宝'."\n" + .'- **DingDing**：钉钉'."\n" + .'- **WeChat**：微信'."\n" + .'- **QQ**：腾讯QQ'."\n" + .'- **SecurityService**：安全服务'."\n" + .'- **Microsoft**：微软'."\n" + .'- **Amazon**：亚马逊'."\n" + .'- **Pan**：网盘'."\n" + .'- **Map**：地图'."\n" + .'- **Code**：代码托管'."\n" + .'- **SystemService**：系统服务'."\n" + .'- **Taobao**：淘宝'."\n" + .'- **Google**：谷歌'."\n" + .'- **ThirdPartyService**：第三方平台服务'."\n" + .'- **FirstFlow**：首次'."\n" + .'- **Downloader**：恶意下载'."\n" + .'- **Alexa Top1M**：热门网站'."\n" + .'- **Miner**：矿池'."\n" + .'- **Intelligence**：威胁情报'."\n" + .'- **DDoS**：DDoS木马'."\n" + .'- **Ransomware**：勒索软件'."\n" + .'- **Spyware**：间谍软件'."\n" + .'- **Rogue**：流氓软件'."\n" + .'- **Botnet**：僵尸网络'."\n" + .'- **Suspicious**：可疑网站'."\n" + .'- **C&C**：远控'."\n" + .'- **Gang**：团伙'."\n" + .'- **CVE**：漏洞CVE'."\n" + .'- **Backdoor**：木马后门'."\n" + .'- **Phishing**：钓鱼网站'."\n" + .'- **APT**：APT攻击'."\n" + .'- **Supply Chain Attack**：供应链攻击'."\n" + .'- **Malicious software**：恶意软件', + 'type' => 'string', + 'required' => false, + 'example' => 'AliYun', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'description' => '统计流量的来源。默认取值为互联网防火墙。取值：'."\n" + ."\n" + .'- **internet**：互联网防火墙'."\n" + .'- **nat**：NAT防火墙', + 'type' => 'string', + 'required' => false, + 'example' => 'nat', + ], + ], + [ + 'name' => 'IsAITraffic', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅统计访问AI服务的流量。默认取值为否。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '外联域名的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'DomainList' => [ + 'description' => '外联域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '外联域名列表。', + 'type' => 'object', + 'properties' => [ + 'AclCoverage' => [ + 'title' => 'ACL覆盖', + 'description' => '访问控制策略是否覆盖。取值：'."\n" + ."\n" + .'- **Uncovered**：未覆盖'."\n" + .'- **FullCoverage**：已覆盖', + 'type' => 'string', + 'example' => 'Uncovered', + ], + 'Domain' => [ + 'title' => '域名', + 'description' => '主动外联的域名。', + 'type' => 'string', + 'example' => 'www.aliyundoc.com', + ], + 'AclRecommendDetail' => [ + 'title' => 'ACL推荐内容', + 'description' => 'ACL推荐内容。', + 'type' => 'string', + 'example' => '建议放行', + ], + 'HasAclRecommend' => [ + 'title' => '是否有ACL推荐规则', + 'description' => '是否有推荐ACL。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InBytes' => [ + 'title' => '入流量', + 'description' => '入方向的流量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3214', + ], + 'CategoryName' => [ + 'title' => '分类名称', + 'description' => '产品的分类名称。取值：'."\n" + ."\n" + .'- **阿里云产品**'."\n" + .'- **非阿里云产品**', + 'type' => 'string', + 'example' => '阿里云产品', + ], + 'RuleName' => [ + 'title' => '规则名称', + 'description' => 'ACL规则名称。', + 'type' => 'string', + 'example' => '默认规则', + ], + 'RuleId' => [ + 'title' => 'ACL规则ID', + 'description' => 'ACL规则ID。', + 'type' => 'string', + 'example' => 'add-dfadf-f****', + ], + 'SessionCount' => [ + 'title' => '会话数', + 'description' => '请求次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'GroupName' => [ + 'title' => '规则中的组名称', + 'description' => '规则的组名称。', + 'type' => 'string', + 'example' => '外量地址组', + ], + 'SecuritySuggest' => [ + 'title' => '安全建议', + 'description' => '主动外联域名的安全策略。取值：'."\n" + ."\n" + .'- **pass**：放行'."\n" + .'- **alert**：观察'."\n" + .'- **drop**：拒绝', + 'type' => 'string', + 'example' => 'pass', + ], + 'OutBytes' => [ + 'title' => '出流量', + 'description' => '出方向的流量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4582', + ], + 'AclStatus' => [ + 'title' => 'ACL状态', + 'description' => '访问控制策略的健康状态。取值：'."\n" + ."\n" + .'- **Normal**：健康'."\n" + .'- **Abnormal**：不健康', + 'type' => 'string', + 'example' => 'Normal', + ], + 'IsMarkNormal' => [ + 'title' => '是否正常', + 'description' => '外联域名是否标记为正常。取值：'."\n" + ."\n" + .'- **true**：正常'."\n" + .'- **false**：不正常', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CategoryId' => [ + 'title' => '分类ID', + 'description' => '产品分类ID。取值：'."\n" + ."\n" + .'- **Aliyun**：阿里云产品'."\n" + .'- **NotAliyun**：非阿里云产品', + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'AddressGroupUUID' => [ + 'title' => '地址簿UUID', + 'description' => '地址簿UUID。', + 'type' => 'string', + 'example' => 'fdad-fdafa-dafa-dfa****', + ], + 'AddressGroupName' => [ + 'title' => '地址簿名称', + 'description' => '地址簿的名称。', + 'type' => 'string', + 'example' => '外联地址簿', + ], + 'CategoryClassId' => [ + 'description' => '情报标签的分类。取值：'."\n" + ."\n" + .'- **Suspicious**：可疑'."\n" + .'- **Malicious**：恶意'."\n" + .'- **Trusted**：信任', + 'type' => 'string', + 'example' => 'Trusted', + ], + 'Business' => [ + 'description' => '网站业务。', + 'type' => 'string', + 'example' => '阿里云', + ], + 'HasAcl' => [ + 'description' => '是否已有`ACL`覆盖此域名管控。取值：'."\n" + ."\n" + .'- **true**：有'."\n" + .'- **false** ：没有', + 'type' => 'string', + 'example' => 'true', + ], + 'Organization' => [ + 'description' => '组织名称。', + 'type' => 'string', + 'example' => '阿里云计算有限公司', + ], + 'SecurityReason' => [ + 'description' => '安全原因。', + 'type' => 'string', + 'example' => '智能策略：该目的域名所属组织为阿里云计算有限公司，主要业务为阿里云，未发现安全风险，可用于配置外联白名单。', + ], + 'TotalBytes' => [ + 'description' => '总流量。单位：byte。', + 'type' => 'string', + 'example' => '800', + ], + 'TagList' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表对象。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'title' => '风险等级', + 'description' => '风险评估等级，取值：'."\n" + ."\n" + .'- **1**：低危'."\n" + .'- **2**：中危'."\n" + .'- **3**：高危', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TagName' => [ + 'title' => '标签名称', + 'description' => '标签名称。', + 'type' => 'string', + 'example' => '加白标签', + ], + 'TagId' => [ + 'title' => '标签ID', + 'description' => '情报标签ID。', + 'type' => 'string', + 'example' => 'AliYun', + ], + 'TagDescribe' => [ + 'title' => '标签描述', + 'description' => '标签描述。', + 'type' => 'string', + 'example' => '加白标签', + ], + 'ClassId' => [ + 'description' => '情报标签的分类。取值：'."\n" + ."\n" + .'- **Suspicious**：可疑'."\n" + .'- **Malicious**：恶意'."\n" + .'- **Trusted**：信任', + 'type' => 'string', + 'example' => 'Trusted', + ], + ], + ], + ], + 'ApplicationNameList' => [ + 'description' => '应用名称。', + 'type' => 'array', + 'items' => [ + 'description' => '应用名称列表。', + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + 'AssetCount' => [ + 'description' => '主动外联的资产总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PrivateAssetCount' => [ + 'description' => '主动外联的私网资产总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询主动外联的域名信息', + ], + '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' => '访问者源IP地址。', + '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' => '标签ID。', + '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' => '公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.96.181.XXX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '私网IP。', + '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' => '查询Nat私网外联。', + 'type' => 'string', + 'required' => false, + 'example' => 'NatPrivate', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => ' NAT网关的ID。 ', + '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' => '请求ID。', + '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' => '资产实例Id。', + 'type' => 'string', + 'example' => 'i-uf63wjhyoohc1g4z****', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'InBytes' => [ + 'description' => '流入流量, 应答流量,单位bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '244438.0', + ], + 'FirstTime' => [ + 'description' => '首次时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1738548990', + ], + 'PrivateIP' => [ + 'description' => '私网ip。', + 'type' => 'string', + 'example' => '10.21.242XXX', + ], + 'RuleId' => [ + 'description' => 'ACL规则ID。', + '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' => '资产公网IP类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + 'EIP' => 'EIP', + ], + 'example' => 'NatEIP', + ], + 'OutBytes' => [ + 'description' => '流出流量, 请求流量,单位bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PublicIP' => [ + 'description' => '公网IP。', + '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' => '标签ID', + 'type' => 'string', + 'enumValueTitles' => [ + 'FirstFlow' => '首次', + 'Period' => '周期', + ], + 'example' => 'FirstFlow', + ], + 'TagDescribe' => [ + 'description' => '标签描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'ClassId' => [ + 'description' => '风险分类ID。', + 'type' => 'string', + 'example' => '3', + ], + ], + ], + ], + 'TotalBytes' => [ + 'description' => '总流量。'."\n", + 'type' => 'string', + 'example' => '321120825843', + ], + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-9dp16jgwgyvn****', + ], + 'NatGatewayId' => [ + 'description' => 'NAT网关ID。', + 'type' => 'string', + 'example' => 'ngw-bp1utx6wj4x9qu9tl****', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关名称', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'IpsHitCnt' => [ + 'description' => 'ips命中数。', + '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"}]', + 'title' => '获取主动外联域名详情', + ], + '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' => '访问者源IP。', + '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' => '分类ID。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RiskDomain' => '风险域名', + 'AliYun' => '阿里云产品', + 'NotAliYun' => '非阿里云产品', + ], + 'example' => 'AliYun', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签ID', + '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' => '目标IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.111XXX', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.96.74.XXX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '私网IP。', + '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' => '是否仅统计访问AI服务的流量。默认取值为否。', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'A2845BA9-1642-5B27-9F04-8014DD94****', + ], + 'DstList' => [ + 'description' => '目的地址信息。', + 'type' => 'array', + 'items' => [ + 'description' => '目的地址信息。', + 'type' => 'object', + 'properties' => [ + 'DstIP' => [ + 'description' => '目的ip。', + 'type' => 'string', + 'example' => '101.6.15.XXX', + ], + 'AclRecommendDetail' => [ + 'description' => 'ACL推荐内容。', + 'type' => 'string', + 'example' => 'test', + ], + 'HasAclRecommend' => [ + 'description' => '是否有推荐ACL。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'false' => '否', + 'true' => '是', + ], + 'example' => 'false', + ], + 'InBytes' => [ + 'description' => '入方向的流量。单位：Byte。', + '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' => '出流量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'AclStatus' => [ + 'description' => '策略状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Normal' => '健康', + 'Abnormal' => '异常', + ], + 'example' => 'Normal', + ], + 'CategoryId' => [ + 'description' => '分类ID。', + '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' => '标签ID。', + '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"}]', + 'title' => '查询外联目的', + ], + 'DescribeOutgoingDestinationIP' => [ + 'summary' => '查询主动外联的目的IP信息。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间,Unix timestamp, 精确到秒', + 'description' => '设置查询开始时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => true, + 'example' => '1656837360', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => '设置查询结束时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => true, + 'example' => '1656923760', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '设置分页查询每页包含多少条结果。'."\n" + ."\n" + .'默认值为6，表示每页包含6条结果。最大值为10。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => '设置分页查询返回第几页数据。'."\n" + ."\n" + .'默认值为1，表示返回第1页数据。', + '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' => '产品分类ID。默认值为空，取值：'."\n" + ."\n" + .'- **All** ：全部分类'."\n" + .'- **RiskDomain** ：风险域名分类'."\n" + .'- **RiskIP** ：风险IP分类'."\n" + .'- **AliYun** ：云产品分类'."\n" + .'- **NotAliYun** ：非云产品分类', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'title' => '目的IP', + 'description' => '主动外联域名的目的IP。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'title' => '公网IP', + 'description' => '外联ECS的公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'title' => '私网IP', + 'description' => '外联ECS的私网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'title' => '端口号', + 'description' => '端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序, 枚举值, 可选:asc, desc', + 'description' => '按照指定的字段排序。取值：'."\n" + ."\n" + .'- **SessionCount**（默认值）：请求次数。'."\n" + .'- **TotalBytes**：总流量数。', + 'type' => 'string', + 'required' => false, + 'example' => 'SessionCount', + 'enum' => [], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段, 枚举值.'."\n" + .'默认值: SessionCount'."\n" + .'可选值: InBytes, OutBytes,TotalBytes,SessionCount', + 'description' => '排序方式。取值：'."\n" + ."\n" + .'- **asc**：升序。'."\n" + .'- **desc**（默认）：降序。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [], + ], + ], + [ + 'name' => 'TagIdNew', + 'in' => 'query', + 'schema' => [ + 'description' => '情报标签ID。取值：'."\n" + .'- **AliYun**：阿里云产品'."\n" + .'- **RiskDomain**：风险域名'."\n" + .'- **RiskIP**：风险IP'."\n" + .'- **TrustedDomain**：信誉网站'."\n" + .'- **AliPay**：支付宝'."\n" + .'- **DingDing**：钉钉'."\n" + .'- **WeChat**：微信'."\n" + .'- **QQ**：腾讯QQ'."\n" + .'- **SecurityService**：安全服务'."\n" + .'- **Microsoft**：微软'."\n" + .'- **Amazon**：亚马逊'."\n" + .'- **Pan**：网盘'."\n" + .'- **Map**：地图'."\n" + .'- **Code**：代码托管'."\n" + .'- **SystemService**：系统服务'."\n" + .'- **Taobao**：淘宝'."\n" + .'- **Google**：谷歌'."\n" + .'- **ThirdPartyService**：第三方平台服务'."\n" + .'- **FirstFlow**：首次'."\n" + .'- **Downloader**：恶意下载'."\n" + .'- **Alexa Top1M**：热门网站'."\n" + .'- **Miner**：矿池'."\n" + .'- **Intelligence**：威胁情报'."\n" + .'- **DDoS**：DDoS木马'."\n" + .'- **Ransomware**：勒索软件'."\n" + .'- **Spyware**：间谍软件'."\n" + .'- **Rogue**：流氓软件'."\n" + .'- **Botnet**：僵尸网络'."\n" + .'- **Suspicious**：可疑网站'."\n" + .'- **C&C**：远控'."\n" + .'- **Gang**：团伙'."\n" + .'- **CVE**：漏洞CVE'."\n" + .'- **Backdoor**：木马后门'."\n" + .'- **Phishing**：钓鱼网站'."\n" + .'- **APT**：APT攻击'."\n" + .'- **Supply Chain Attack**：供应链攻击'."\n" + .'- **Malicious software**：恶意软件', + 'type' => 'string', + 'required' => false, + 'example' => 'AliYun', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略支持的应用类型。取值：'."\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" + .'> 支持的应用类型取值与协议类型（Proto）取值存在依赖关系。Proto为TCP协议时，ApplicationNameList支持选择以上所有应用类型。当ApplicationNameList和ApplicationName同时传值时，以ApplicationNameList为准。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FTP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '外联IP的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'DstIPList' => [ + 'title' => '外联IP列表', + 'description' => '主动外联的IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主动外联的IP列表。', + 'type' => 'object', + 'properties' => [ + 'AclCoverage' => [ + 'title' => 'ACL覆盖', + 'description' => '是否覆盖访问控制策略。取值：'."\n" + ."\n" + .'- **Uncovered**：未覆盖。'."\n" + ."\n" + .'- **FullCoverage**：已覆盖。', + 'type' => 'string', + 'example' => 'Uncovered', + ], + 'DstIP' => [ + 'title' => '目的IP', + 'description' => '主动外联域名的目的IP。', + 'type' => 'string', + 'example' => '10.0.XX.XX', + ], + 'AclRecommendDetail' => [ + 'title' => 'ACL推荐内容', + 'description' => 'ACL的建议信息。', + 'type' => 'string', + 'example' => '建议放行', + ], + 'HasAclRecommend' => [ + 'title' => '是否有推荐ACL', + 'description' => '是否有推荐ACL。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InBytes' => [ + 'title' => '入方向流量', + 'description' => '入方向的流量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '472', + ], + 'CategoryName' => [ + 'title' => '分类名称', + 'description' => '产品的分类名称。取值：'."\n" + ."\n" + .'- **阿里云产品**'."\n" + ."\n" + .'- **非阿里云产品**', + 'type' => 'string', + 'example' => '阿里云产品', + ], + 'RuleName' => [ + 'title' => '规则名称', + 'description' => 'ACL规则名称。', + 'type' => 'string', + 'example' => '默认规则', + ], + 'RuleId' => [ + 'title' => '规则UUID', + 'description' => 'ACL规则UUID。', + 'type' => 'string', + 'example' => 'fadsfd-dfadf-df****', + ], + 'SessionCount' => [ + 'title' => '会话数', + 'description' => '请求次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'GroupName' => [ + 'title' => '规则中的组名称', + 'description' => '规则的组名称。', + 'type' => 'string', + 'example' => '规则_test', + ], + 'SecuritySuggest' => [ + 'title' => '安全建议', + 'description' => '主动外联域名的安全策略。取值：'."\n" + ."\n" + .'- **pass**：放行。'."\n" + ."\n" + .'- **alert**：拒绝。'."\n" + ."\n" + .'- **drop**：观察。', + 'type' => 'string', + 'example' => 'pass', + ], + 'OutBytes' => [ + 'title' => '出流量', + 'description' => '出方向的流量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '965', + ], + 'AclStatus' => [ + 'title' => 'ACL状态', + 'description' => '访问控制策略的健康状态。取值：'."\n" + ."\n" + .'- **Normal**：健康。'."\n" + .'- **Abnormal**：不健康。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'IsMarkNormal' => [ + 'title' => '是否正常', + 'description' => '是否加入白名单。取值：'."\n" + .'- **true**：已加入。'."\n" + ."\n" + .'- **false**：未加入。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CategoryId' => [ + 'title' => '分类ID', + 'description' => '产品分类ID。取值：'."\n" + ."\n" + .'- **Aliyun**：阿里云产品。'."\n" + ."\n" + .'- **NotAliyun**：非阿里云产品。', + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'TagList' => [ + 'title' => '标签列表', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'title' => '风险等级', + 'description' => '风险评估等级。取值：'."\n" + ."\n" + .'- **1**：低危。'."\n" + .'- **2**：中危。'."\n" + .'- **3**：高危。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [], + ], + 'TagName' => [ + 'title' => '标签名', + 'description' => '情报标签名称。', + 'type' => 'string', + 'example' => '放行标签', + ], + 'TagId' => [ + 'title' => '标签ID', + 'description' => '情报标签ID。', + 'type' => 'string', + 'example' => 'AliYun', + ], + 'TagDescribe' => [ + 'title' => '标签描述', + 'description' => '情报标签的描述。', + 'type' => 'string', + 'example' => '放行标签', + ], + 'ClassId' => [ + 'description' => '情报标签的分类。取值：'."\n" + ."\n" + .'- **Suspicious**：可疑。'."\n" + .'- **Malicious**：恶意。'."\n" + .'- **Trusted**：信任。', + 'type' => 'string', + 'example' => 'Trusted', + ], + ], + ], + ], + 'ApplicationPortList' => [ + 'description' => '应用端口列表。'."\n" + ."\n" + .'> 列表仅展示前99个应用端口。当外联应用端口超过99个时，仅展示前99条数据。', + 'type' => 'array', + 'items' => [ + 'title' => '端口列表', + 'description' => '端口列表。', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'title' => '端口', + 'description' => '应用的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ApplicationName' => [ + 'title' => '应用名', + 'description' => '访问控制策略支持的应用类型。取值：'."\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" + .'> 支持的应用类型取值与协议类型（Proto）取值存在依赖关系。Proto为TCP协议时，ApplicationNameList支持选择以上所有应用类型。当ApplicationNameList和ApplicationName同时传值时，以ApplicationNameList为准。'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'UnknownReason' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因列表。', + 'type' => 'array', + 'items' => [ + 'description' => '协议分析失败原因。', + 'type' => 'string', + 'example' => 'tcp_not_establish', + ], + ], + ], + ], + ], + 'CategoryClassId' => [ + 'description' => '情报标签的分类。取值：'."\n" + ."\n" + .'- **Suspicious**：可疑。'."\n" + .'- **Malicious**：恶意。'."\n" + .'- **Trusted**：信任。', + 'type' => 'string', + 'example' => 'Trusted', + ], + 'SecurityReason' => [ + 'description' => '安全原因。', + 'type' => 'string', + 'example' => '智能策略：该目的域名所属组织为阿里云计算有限公司，主要业务为阿里云，未发现安全风险，可用于配置外联白名单。', + ], + 'TotalBytes' => [ + 'description' => '总流量。单位：byte。', + 'type' => 'string', + 'example' => '800', + ], + 'HasAcl' => [ + 'description' => '是否有访问控制规则。取值：'."\n" + ."\n" + .'- **true**：有。'."\n" + .'- **false** ：没有。', + 'type' => 'string', + 'example' => 'true', + ], + 'AddressGroupList' => [ + 'description' => '地址簿信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressGroupUUID' => [ + 'description' => '地址簿唯一标识。', + 'type' => 'string', + 'example' => 'f04ac7ce-628b-4cb7-be61-310222b7****', + ], + 'AddressGroupName' => [ + 'description' => '地址簿名称。', + 'type' => 'string', + 'example' => 'IP地址簿', + ], + ], + ], + ], + 'AssetCount' => [ + 'description' => '主动外联的资产总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PrivateAssetCount' => [ + 'description' => '主动外联的私网资产总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'LocationName' => [ + 'description' => '区域名。', + 'type' => 'string', + 'example' => '山东省青岛市', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询主动外联的目的IP信息', + ], + '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' => '访问者源IP地址。', + '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' => '标签ID。', + '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' => '目的IP。', + 'type' => 'string', + 'required' => true, + 'example' => '34.136.111.XXX', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'PrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '私网IP。', + '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' => '查询Nat私网外联。', + 'type' => 'string', + 'required' => false, + 'example' => 'NatPrivate', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => ' NAT网关的ID。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-2zed6z6qkd7ogc****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LocationName' => [ + 'description' => '区域名。', + 'type' => 'string', + 'example' => '杭州', + ], + 'IspName' => [ + 'description' => '目的IP所属运营商。', + 'type' => 'string', + 'example' => '电信', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '云产品实例ID。', + 'type' => 'string', + 'example' => 'i-uf63wjhyoohc1g4z****', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'InBytes' => [ + 'description' => '入流量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'LocationName' => [ + 'description' => '目的IP所属地区名。', + 'type' => 'string', + 'example' => '杭州', + ], + 'FirstTime' => [ + 'description' => '首次时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1744682438', + ], + 'PrivateIP' => [ + 'description' => '私网IP。', + 'type' => 'string', + 'example' => '10.21.242XXX', + ], + 'RuleId' => [ + 'description' => '规则ID。', + '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' => '资产公网IP类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'EcsEIP' => 'EcsEIP', + 'EcsPublicIP' => 'EcsPublicIP', + 'NatPublicIP' => 'NatPublicIP', + 'NatEIP' => 'NatEIP', + 'EIP' => 'EIP', + ], + 'example' => 'EcsPublicIP', + ], + 'OutBytes' => [ + 'description' => '出流量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'IspName' => [ + 'description' => '目的IP所属运营商。', + 'type' => 'string', + 'example' => '电信', + ], + 'PublicIP' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '47.96.181.XXX', + ], + 'TotalBytes' => [ + 'description' => '总流量。', + 'type' => 'string', + 'example' => '458681', + ], + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-9dp16jgwgyvn****', + ], + 'NatGatewayId' => [ + 'description' => 'NAT网关ID。', + 'type' => 'string', + 'example' => 'ngw-bp1utx6wj4x9qu9tl****', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关名称。', + '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' => '标签ID。', + 'type' => 'string', + 'example' => 'FirstFlow', + ], + 'TagDescribe' => [ + 'description' => '标签描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'ClassId' => [ + 'description' => '分类ID。', + '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"}]', + 'title' => '获取外联目的IP详情', + ], + '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' => '访问源IP地址。', + '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' => '来源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 => '基础防御', + '虚拟补丁', + '基础ACL', + '威胁情报', + ], + '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' => '最大top数限制数,默认50,取值1-50。', + 'type' => 'string', + 'required' => false, + 'example' => '50', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataType' => [ + 'description' => '流量数据类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'in_src_location' => '来源地区', + 'in_src_ip' => '来源ip', + ], + 'example' => 'in_src_ip', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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' => '总流量。单位：byte。', + '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"}]', + 'title' => '查询互联网流量TOP趋势图', + ], + 'DescribeInternetTrafficTrend' => [ + 'summary' => '获取互联网流量趋势。', + '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' => '访问者源ip地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '101.80.171.196', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：表示中文'."\n" + .'- **en**：表示英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：表示中文'."\n" + .'- **en**：表示英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '互联网流量方向。取值：'."\n" + ."\n" + .'- **in**：外对内流量访问控制'."\n" + .'- **out**：内对外流量访问控制', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => true, + 'example' => '1670307484', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => true, + 'example' => '1674958929', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '溯源码。', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun', + ], + ], + [ + 'name' => 'SrcPublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '公网源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '47.112.210.136', + ], + ], + [ + 'name' => 'SrcPrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '私网源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.134.60', + ], + ], + [ + 'name' => 'TrafficType', + 'in' => 'query', + 'schema' => [ + 'description' => '采集的流量类型。取值：'."\n" + .' '."\n" + .'- **max**（默认）：流量峰值'."\n" + .' '."\n" + .'- **avg**：流量均值', + 'type' => 'string', + 'required' => false, + 'example' => 'max', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'MaxTotalBps' => [ + 'description' => '出方向和入方向总的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89783147', + ], + 'MaxBandwidthTime' => [ + 'description' => '峰值带宽发生时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672736400', + ], + 'AvgInBps' => [ + 'description' => '入方向的平均网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6114152', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'C7E837BE-0379-565E-B7B4-DE595C8D337C', + ], + 'MaxInBps' => [ + 'description' => '入方向的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10275643', + ], + 'MaxOutBps' => [ + 'description' => '出方向的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395188', + ], + 'AvgSession' => [ + 'description' => '平均请求次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '79013', + ], + 'MaxSession' => [ + 'description' => '峰值请求次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '931641', + ], + 'AvgTotalBps' => [ + 'description' => '出方向和入方向总的平均网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2306', + ], + 'AvgOutBps' => [ + 'description' => '出方向的平均网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70148993', + ], + 'TotalInBytes' => [ + 'description' => '入方向的网络吞吐量（总共发送多少字节）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41536824243873', + ], + 'TotalOutBytes' => [ + 'description' => '出方向的网络吞吐量（总共发送多少字节）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2660894567178', + ], + 'TotalBytes' => [ + 'description' => '出方向和入方向总的网络吞吐量（总共发送多少字节）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '963227674958', + ], + 'TotalSession' => [ + 'description' => '总请求次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1061449', + ], + 'TotalExceedBytes' => [ + 'description' => '总超量流量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4243873', + ], + 'MaxDayExceedBytes' => [ + 'description' => '最大日超量流量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '873', + ], + 'DataList' => [ + 'description' => '流量统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量统计信息列表。', + 'type' => 'object', + 'properties' => [ + 'SessionCount' => [ + 'description' => '请求次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'Time' => [ + 'description' => '流量发生的时间。使用秒级时间戳格式表示。'."\n" + ."\n" + .'若该时间点未加工完成，则其他字段值均为-1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1659405600', + ], + 'InBps' => [ + 'description' => '入方向的网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '187', + ], + 'InPps' => [ + 'description' => '入方向的网络吞吐率（每秒发送多少个分组数据包）。单位：pps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NewConn' => [ + 'description' => '新建连接数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'OutBytes' => [ + 'description' => '出方向的网络吞吐量（总共发送多少字节）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'OutPps' => [ + 'description' => '出方向的网络吞吐率（每秒发送多少个分组数据包）。单位：pps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'InBytes' => [ + 'description' => '入方向的网络吞吐量（总共发送多少字节）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'OutBps' => [ + 'description' => '出方向的网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'TotalBps' => [ + 'description' => '出方向和入方向总的网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '232', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取互联网流量趋势', + ], + 'DescribeNatFirewallTrafficTrend' => [ + 'summary' => '概览页-NAT流量趋势。', + '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' => '查询开始时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1739326980', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1739330580', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'SrcPublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '公网源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '47.112.210.136', + ], + ], + [ + 'name' => 'SrcPrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '私网源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.134.60', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。取值如下：'."\n" + .'- **60**：1分钟。'."\n" + .'- **1800**：半小时。', + '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' => '出方向和入方向总的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '66953194', + ], + 'MaxOutBps' => [ + 'description' => '出方向的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122596487', + ], + 'MaxInBps' => [ + 'description' => '入方向的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18038632', + ], + 'DataList' => [ + 'description' => '流量统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量统计信息列表。', + 'type' => 'object', + 'properties' => [ + 'TrafficTime' => [ + 'description' => '查询时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1734418980', + ], + 'MaxTotalBps' => [ + 'description' => '出方向和入方向总的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '66953194', + ], + 'MaxInBps' => [ + 'description' => '入方向的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18038632', + ], + 'MaxOutBps' => [ + 'description' => '出方向的峰值网络吞吐率（每秒发送多少bit）。单位：bps。', + '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' => '获取NAT防火墙流量趋势', + ], + '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' => '访问者源IP地址。', + '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' => '本次请求的ID。', + '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"}]', + 'title' => '获取互联网服务名称列表', + ], + 'DescribeInternetOpenIp' => [ + 'summary' => '查询云防火墙访问控制策略组的详细信息。', + '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' => '接收消息的语言类型。'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'SSH', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '风险等级，不填为全部风险等级。取值：'."\n" + .'- **3**：高风险'."\n" + .'- **2**：中风险'."\n" + .'- **1**：低风险'."\n" + .'- **0**：无风险', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'AssetsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6faknmuby7ezht****', + ], + ], + [ + 'name' => 'AssetsInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'launch-advisor-2023****', + ], + ], + [ + 'name' => 'PublicIp', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.1', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'AssetsType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的资产类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'EcsEIP', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '公网IP暴露的开始时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => false, + 'example' => '1681957629', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '公网IP暴露的结束时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => false, + 'example' => '1663640336', + ], + ], + [ + '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' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => '6B780BD6-282C-51A9-A8E6-59F636BAFA54', + ], + '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' => '40', + ], + ], + ], + 'DataList' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据列表。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + .'- **3**：高风险'."\n" + .'- **2**：中风险'."\n" + .'- **1**：低风险'."\n" + .'- **0**：无风险', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TrafficPercent1Day' => [ + 'description' => '具体流量信息参见TotalBytes字段。', + 'type' => 'string', + 'example' => '0', + ], + 'AclRecommendDetail' => [ + 'description' => '没有智能推荐策略的原因。取值：'."\n" + .'- 当前无智能策略推荐'."\n" + .'- 当前只对部分用户开放该功能'."\n" + .'- 策略配置已经修改，当前无智能策略推荐'."\n" + .'- 智能策略已经配置，当前无新智能策略推荐', + 'type' => 'string', + 'example' => '当前无智能策略推荐', + ], + 'AssetsName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'launch-advisor-2023****', + ], + 'RegionNo' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'AssetsType' => [ + 'description' => '实例的资产类型。', + 'type' => 'string', + 'example' => 'EcsEIP', + ], + 'HasAclRecommend' => [ + 'description' => '是否有推荐ACL。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DetailNum' => [ + 'description' => '端口总明细数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TrafficPercent7Day' => [ + 'description' => '具体流量信息参见TotalBytes字段。', + 'type' => 'string', + 'example' => '0', + ], + 'TrafficPercent30Day' => [ + 'description' => '具体流量信息参见TotalBytes字段。', + 'type' => 'string', + 'example' => ' 0', + ], + 'PublicIp' => [ + 'description' => '实例的公网IP。', + 'type' => 'string', + 'example' => '203.0.113.1', + ], + 'RiskReason' => [ + 'description' => '风险原因。', + 'type' => 'string', + 'example' => '历史流量均为黑流量', + ], + 'AssetsInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-bp1ix9w22kv6aew9****', + ], + 'PortList' => [ + 'description' => '端口列表。', + 'type' => 'array', + 'items' => [ + 'description' => '端口列表。', + 'type' => 'string', + 'example' => '["3000","5601","8886,"8887","8889"]', + ], + ], + 'ServiceNameList' => [ + 'description' => '应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用列表。', + 'type' => 'string', + 'example' => '[\'HTTPS\', \'RDP\', \'SSL\', \'Unknown\']', + ], + ], + 'TotalReplyBytes' => [ + 'description' => '7日总回应流量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'SrcIpCnt' => [ + 'description' => '源IP数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14151892****7022', + ], + 'InBytes' => [ + 'description' => '入方向的网络吞吐量（总共发送多少字节）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235', + ], + 'OutBytes' => [ + 'description' => '出方向的网络吞吐量（总共发送多少字节）。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123', + ], + 'TotalBytes' => [ + 'description' => '总流量。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '253023143', + ], + 'UnknownReason' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因。', + 'type' => 'array', + 'items' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因。', + 'type' => 'string', + 'example' => 'no_payload', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取防护资产暴露到互联网的IP', + ], + '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' => '访问源IP地址。', + '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' => '请求ID。', + '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' => '流量占比。取值范围：**1**~**100**。', + 'type' => 'string', + 'example' => '10', + ], + 'Protocol' => [ + 'description' => '协议。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'PublicIpNum' => [ + 'description' => '开放公网IP数量。', + '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' => '7日流量占比。', + 'type' => 'string', + 'example' => '30', + ], + 'TrafficPercent30Day' => [ + 'description' => '30日流量占比。', + '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' => '总流量。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '621404', + ], + 'UnknownReason' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因。', + 'type' => 'array', + 'items' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因。', + '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"}]', + 'title' => '获取互联网开放端口', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP地址。', + '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' => '请求ID。', + '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' => '风险级别 -1:评估中 0:无 1: 低危 2: 中危 3: 高危. 不选代表所有风险', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '无', + '低危', + '中危', + '高危', + ' -1' => '评估中', + ], + 'example' => '3', + ], + 'ProbRiskDesc' => [ + 'description' => '安全隐患描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'TrafficPercent1Day' => [ + 'description' => '1日流量占比。', + 'type' => 'string', + 'example' => '0', + ], + 'Protocol' => [ + 'description' => '协议类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'tcp' => 'tcp', + 'udp' => 'udp', + ], + 'example' => 'tcp', + ], + 'PublicIpNum' => [ + 'description' => '开放公网IP数量。', + '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' => '7日流量占比。', + 'type' => 'string', + 'example' => '77', + ], + 'TrafficPercent30Day' => [ + 'description' => '30日流量占比。', + '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' => '总流量。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '621404', + ], + 'UnknownReason' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因。', + 'type' => 'array', + 'items' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因。', + '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"}]', + 'title' => '获取互联网开放服务', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问源的IP地址。', + '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' => '端口，精确匹配1-65535，不带表示所有端口。', + 'type' => 'string', + 'required' => false, + 'example' => '9100', + ], + ], + [ + 'name' => 'AssetsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产ID，支持模糊搜索。', + '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' => '公网IP，精确匹配，不带表示查找所有公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '203.0.13.XX', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + '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' => '开始时间，默认当前时间-7天。', + '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' => '按公网IP排序', + 'Port' => '按端口排序', + ], + 'example' => 'ServiceName', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '1日流量占比。', + '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' => '实例所在的地域ID。', + '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' => '7日流量占比。', + 'type' => 'string', + 'example' => '30', + ], + 'TrafficPercent30Day' => [ + 'description' => '30日流量占比。', + 'type' => 'string', + 'example' => '48', + ], + 'ProbRisk' => [ + 'description' => '安全隐患。', + 'type' => 'string', + 'example' => 'test', + ], + 'PublicIp' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '39.101.167.XX', + ], + 'ServiceName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'Redis', + ], + 'Id' => [ + 'description' => '明细ID。', + 'type' => 'string', + 'example' => '1123', + ], + 'AssetsInstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-bp1ix9w22kv6aew9****', + ], + 'RiskReason' => [ + 'description' => '风险原因。', + 'type' => 'string', + 'example' => 'test', + ], + 'InBytes' => [ + 'description' => '入流量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'OutBytes' => [ + 'description' => '出流量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'TotalBytes' => [ + 'description' => '总流量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UnknownReason' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因。', + 'type' => 'array', + 'items' => [ + 'description' => '识别协议为Unknown情况下，未分析到协议的原因。', + '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"}]', + 'title' => '获取互联网开放详情', + ], + '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' => '访问者源IP地址。', + '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' => '公网IP, 支持模糊查找, 不带表示所有公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.108.60.XXX', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SLB实例Id, 支持模糊查找。', + 'type' => 'string', + 'required' => false, + 'example' => 'lb-2ze8v2x5kd9qyvp2****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SLB实例名称, 支持模糊查找。', + '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' => '返回结果的请求id。', + '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' => '访问控制Id。', + 'type' => 'string', + 'example' => 'acl-uf66n6l9mf3fgq8xs****', + ], + 'InstanceName' => [ + 'description' => 'SLB实例名称。', + 'type' => 'string', + 'example' => 'buyerpro1', + ], + 'RegionNo' => [ + 'description' => '区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'AclStatus' => [ + 'description' => '访问控制开关。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'acl关闭', + 'on' => 'acl打开', + ], + 'example' => 'on', + ], + 'PublicIp' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '39.108.57.XXX', + ], + 'IpProtocol' => [ + 'description' => '协议类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'tcp' => 'tcp', + 'udp' => 'udp', + 'http' => 'http', + 'https' => 'https', + ], + 'example' => 'tcp', + ], + 'InstanceId' => [ + 'description' => 'SLB实例Id。', + '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"}]', + 'title' => '获取互联网SLB', + ], + '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' => '访问者源IP地址。', + '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' => '目的IP。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '0DC783F1-B3A7-578D-8A63-*****', + ], + 'StatList' => [ + 'description' => '统计列表。', + 'type' => 'array', + 'items' => [ + 'description' => '统计列表。', + 'type' => 'object', + 'properties' => [ + 'AbnormalSrcIp' => [ + 'description' => '异常的ip地址数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'NormalSrcIp' => [ + 'description' => '正常的ip地址数量。', + '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"}]', + 'title' => '获取开放IP的访问源统计', + ], + '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' => [ + 'description' => '本端网络实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2vcwkr****', + ], + ], + [ + 'name' => 'PeerNetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '对端网络实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-dsf232d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '网络实例Id。', + 'type' => 'string', + 'example' => 'vpc-2vcwfqbrh4kr****', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + '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' => '网络实例ID。', + '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' => [ + 'description' => '关联的云企业网。', + 'type' => 'array', + 'items' => [ + 'description' => '关联的云企业网。', + 'type' => 'object', + 'properties' => [ + 'CenId' => [ + 'description' => '云企业网实例ID', + 'type' => 'string', + 'example' => 'cen-sdij1***', + ], + 'CenName' => [ + 'description' => '云企业网实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TransitRouterType' => [ + 'description' => '云企业网转发路由器（CEN-TR）的版本。取值：'."\n" + ."\n" + .'- **Basic**：基础版转发路由器。'."\n" + ."\n" + .'- **Enterprise**：企业版转发路由器。', + 'type' => 'string', + 'example' => 'Enterprise', + ], + 'AttachmentId' => [ + 'description' => '网络实例的连接ID。', + 'type' => 'string', + 'example' => 'tr-attach-b9dyqn***', + ], + 'AttachmentName' => [ + 'description' => '网络实例的连接名称', + 'type' => 'string', + 'example' => 'att-test2', + ], + ], + ], + ], + ], + ], + ], + 'AssociatedCen' => [ + 'description' => '关联的云企业网。', + 'type' => 'array', + 'items' => [ + 'description' => '关联的云企业网。', + 'type' => 'object', + 'properties' => [ + 'CenId' => [ + 'description' => '云企业网实例ID。', + 'type' => 'string', + 'example' => 'cen-sdij1***', + ], + 'CenName' => [ + 'description' => '云企业网实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TransitRouterType' => [ + 'description' => '转发实例路由器类型。可选值：'."\n" + ."\n" + .'- **Basic**：基础版转发路由器。'."\n" + ."\n" + .'- **Enterprise**：企业版转发路由器。', + 'type' => 'string', + 'example' => 'Enterprise', + ], + 'AttachmentId' => [ + 'description' => '网络实例的连接ID。', + 'type' => 'string', + 'example' => 'tr-attach-b92yqn***', + ], + 'AttachmentName' => [ + 'description' => '网络实例的连接名称', + 'type' => 'string', + 'example' => 'att-test1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + 'title' => '获取网络实例关系列表', + ], + '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' => 'VPC实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-wz9ulqcvly23w31zkh8sm****', + ], + ], + [ + 'name' => 'PeerVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '对端VPC的实例ID。', + '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' => 'ECS实例ID。', + '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' => '资产IP。', + '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' => '是否仅统计访问AI服务的流量。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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' => '资产实例Id。', + 'type' => 'string', + 'example' => ' i-hp3ez3rs9bxwt034****', + ], + 'OutBytes' => [ + 'description' => '出流量，单位Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0.0', + ], + 'RegionNo' => [ + 'description' => '区域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'AssetIP' => [ + 'description' => '资产IP。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'InBytes' => [ + 'description' => '入流量，单位Byte。', + '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' => '总流量。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IpsHitCnt' => [ + 'description' => 'IPS命中数。', + '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"}]', + 'title' => '查询VPC防火墙资产列表', + ], + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '4E7F94C7-781F-5192-86CF-DB085****', + ], + 'Status' => [ + 'description' => '开启状态。取值：'."\n" + ."\n" + .'- **open**：打开'."\n" + .'- **close**：关闭', + 'type' => 'string', + 'example' => 'open', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E7F94C7-781F-5192-86CF-DB085****\\",\\n \\"Status\\": \\"open\\"\\n}","type":"json"}]', + 'title' => '查询AI流量分析开启状态', + 'description' => '统计范围为该用户当前云防火墙实例，包括自购买之日起的所有数据。', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '访问域名的源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.92.x.x', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序, 枚举值, 可选:asc, desc', + 'description' => '顺序, 枚举值, 可选:asc, desc。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段, 枚举值.'."\n" + .'默认值: SessionCount'."\n" + .'可选值: InBytes, OutBytes,TotalBytes,SessionCount', + 'description' => '排序字段, 枚举值。'."\n" + ."\n" + .'默认值: TotalBytes。'."\n" + ."\n" + .'可选值: '."\n" + ."\n" + .'TotalBytes：根据总流量排序。'."\n" + ."\n" + .'SessionCount：根据会话数排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'SessionCount', + 'enum' => [], + ], + ], + [ + 'name' => 'SrcVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '源端VPC的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-t4nlt09olhpazpoeg****', + ], + ], + [ + 'name' => 'IsAITraffic', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅统计访问AI服务的流量。默认取值为否。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '请求该域名的流量大小。单位：byte。', + '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' => '响应流量大小。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4582', + ], + 'Business' => [ + 'description' => '该域名所属业务。', + 'type' => 'string', + 'example' => 'Google', + ], + 'TotalBytes' => [ + 'description' => '总流量大小。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8111126106', + ], + 'ApplicationNameList' => [ + 'description' => '应用协议列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用协议。', + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + 'SrcIpCount' => [ + 'description' => '访问该域名的源IP数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SrcVpcCount' => [ + 'description' => '访问该域名的源VPC数。', + '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"}]', + 'title' => '查询经过VPC防火墙访问的域名信息列表', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间,Unix timestamp, 精确到秒', + 'description' => '开始时间,Unix timestamp, 精确到秒。', + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间,Unix timestamp, 精确到秒', + 'description' => '结束时间,Unix timestamp, 精确到秒。', + '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' => '访问的源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.92.x.x', + ], + ], + [ + 'name' => 'SrcVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问的源VPC的id。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-t4nlt09olhpazpoeg****', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => '被访问的目的IP。', + 'type' => 'string', + 'required' => false, + 'example' => '34.136.111.XXX', + ], + ], + [ + 'name' => 'DstVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '被访问的目的VPC的id。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp10w5nb30r4jzfyc****', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段, 枚举值。'."\n" + ."\n" + .'默认值: TotalBytes。'."\n" + ."\n" + .'可选值: '."\n" + ."\n" + .'TotalBytes：根据总流量排序。'."\n" + ."\n" + .'SessionCount：根据会话数排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'TotalBytes', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '顺序, 枚举值, 可选:asc, desc。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '源IP。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'DstIP' => [ + 'description' => '目的IP。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'SrcVpcId' => [ + 'description' => '源VPC的Id。', + 'type' => 'string', + 'example' => 'vpc-t4nlt09olhpazpoeg****', + ], + 'DstVpcId' => [ + 'description' => '目的VPC的Id。', + 'type' => 'string', + 'example' => 'vpc-bp10w5nb30r4jzfyc****', + ], + 'SrcVpcName' => [ + 'description' => '源VPC的名称。', + 'type' => 'string', + 'example' => 'vpc-****', + ], + 'DstVpcName' => [ + 'description' => '目的VPC的名称。', + 'type' => 'string', + 'example' => 'vpc-****', + ], + 'SrcRegionId' => [ + 'description' => '源地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DstRegionId' => [ + 'description' => '目的地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'TotalBytes' => [ + 'description' => '总流量。单位：byte。', + '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' => 'IPS命中数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'FirstTime' => [ + 'description' => '首次发生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1767147003', + ], + 'LastTime' => [ + 'description' => '最近发生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1767147003', + ], + 'RequestBytes' => [ + 'description' => '请求流量。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ResponseBytes' => [ + 'description' => '响应流量。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + ], + ], + ], + 'DstVpcList' => [ + 'description' => '目的VPC列表。', + 'type' => 'array', + 'items' => [ + 'description' => '目的VPC列表。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '目的VPC的Id。', + 'type' => 'string', + 'example' => 'vpc-bp10w5nb30r4jzfyc****', + ], + 'VpcName' => [ + 'description' => '目的VPC的名称。', + '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"}]', + 'title' => '查询经过VPC防火墙访问指定域名的关系列表', + ], + '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' => '开启状态。取值：'."\n" + ."\n" + .'- **open**：打开'."\n" + .'- **close**：关闭', + '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"}]', + 'title' => '修改AI流量分析开启状态', + 'description' => '统计范围为该用户当前云防火墙实例，包括自购买之日起的所有数据。', + ], + 'ModifyObjectGroupOperation' => [ + 'summary' => '修改对象组操作。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '123.xxx.251.60', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ObjectOperation', + 'in' => 'query', + 'schema' => [ + 'description' => '操作加白、取消加白或关注、取消关注。'."\n" + .'取值：'."\n" + ."\n" + .'- **subscribe**：关注。'."\n" + .'- **unsubscribe**：取消关注。'."\n" + .'- **ignore**：加白。'."\n" + .'- **cancelIgnore**：取消加白。', + 'type' => 'string', + 'required' => true, + 'example' => 'ignore', + ], + ], + [ + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => [ + 'description' => '外联加白或关注类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **assetsIp**：资产ip。'."\n" + .'- **destinationIp**：目的ip。'."\n" + .'- **destinationPort**：目的端口。'."\n" + .'- **destinationDomain**：目的域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'destinationDomain', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略管控的流量方向。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **in**：流量从外到内。'."\n" + .'- **out**：流量从内到外。', + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'ObjectList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '操作对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '操作对象列表。', + 'type' => 'string', + 'required' => false, + 'example' => '8.25.xxx.55', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '操作的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'CB32593D************775F41D6ED84', + ], + ], + ], + ], + ], + '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' => '修改对象组操作', + ], + 'DescribeRiskEventTopAttackApp' => [ + 'summary' => '查询入侵防御攻击应用排行。', + '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' => '访问者源IP地址。', + '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' => '结果的请求ID。', + '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"}]', + 'title' => '查询入侵防御攻击应用排行', + ], + 'DescribeRiskEventTopAttackType' => [ + 'summary' => '查询入侵防御攻击事件排行。', + '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' => '访问者源IP地址。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询入侵防御攻击事件排行', + ], + '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' => '访问者源IP。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询入侵防御件数据', + ], + 'DescribeRiskEventPayload' => [ + 'summary' => '获取入侵防御事件的攻击Payload。', + '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' => '设置查询开始时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => true, + 'example' => '1669533617', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询结束时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => true, + 'example' => '1681288980', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的源IP。设置该参数表示查询包含了这条源IP的入侵防御事件。', + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.1', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的目的IP。设置该参数表示查询包含了这条目的IP的入侵防御事件。', + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.2', + ], + ], + [ + 'name' => 'UUID', + 'in' => 'query', + 'schema' => [ + 'description' => '入侵防御事件的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => 'e62c25e0-1073-46bd-9567-b8f12b3d****', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙类型。取值：'."\n" + .'- **VpcFirewall**：表示VPC边界防火墙'."\n" + .'- **InternetFirewall**（默认）：表示互联网边界防火墙', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewall', + ], + ], + [ + 'name' => 'SrcVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的源VPC ID。设置该参数表示查询包含了这条源VPC ID的入侵防御事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9j2lqyo15udw5nt****', + ], + ], + [ + 'name' => 'DstVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的目的VPC ID。设置该参数表示查询包含了这条目的VPC ID的入侵防御事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6jr1klwqb60dyn2****', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的公网资产IP。设置该参数表示查询包含了这条资产IP的失陷感知事件。', + 'type' => 'string', + 'required' => false, + 'example' => '203.0.113.3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DstIP' => [ + 'description' => '入侵防御事件的目的IP。', + 'type' => 'string', + 'example' => '203.0.113.1', + ], + 'DstPort' => [ + 'description' => '入侵防御事件的目的Port。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8080', + ], + 'DstVpcId' => [ + 'description' => '入侵防御事件的目的VPC ID。', + 'type' => 'string', + 'example' => 'vpc-bp10w5nb30r4jzfyc****', + ], + 'HitContentType' => [ + 'description' => '命中的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HitTo' => [ + 'description' => '命中截止的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '67', + ], + 'ParsedContent' => [ + 'description' => '命中的Payload。', + 'type' => 'string', + 'example' => '2f636f6d706f7365722f73656e645f656d61696c3f746f3d6d61667740776f66736f7961792675726c3d687474703a2f2f302e302e302e303a31323334352f692f6431366530312f313664622f673670772f', + ], + 'Payload' => [ + 'description' => '入侵防御事件的攻击Payload。', + 'type' => 'string', + 'example' => '302902010004067075626c6963a01c0204036a5f43020100020100300e300c06082b060102010101000500', + ], + 'PayloadLen' => [ + 'description' => '入侵防御事件的攻击Payload长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '457', + ], + 'Proto' => [ + 'description' => '入侵防御攻击事件的协议类型。取值：'."\n" + ."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'string', + 'example' => 'TCP', + ], + 'RealIp' => [ + 'description' => 'HTTP X-Real-IP字段。', + 'type' => 'string', + 'example' => '203.0.113.3', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '68055BA4-D8BD-5611-AC49-C651E619A12E', + ], + 'SrcIP' => [ + 'description' => '入侵防御事件的源IP。', + 'type' => 'string', + 'example' => '203.0.113.2', + ], + 'SrcPort' => [ + 'description' => '入侵防御事件的源端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '54360', + ], + 'SrcVpcId' => [ + 'description' => '入侵防御事件的源VPC ID。', + 'type' => 'string', + 'example' => 'vpc-t4nlt09olhpazpoeg****', + ], + 'XForwardFor' => [ + 'description' => 'HTTP X-Forwarded-For字段。', + 'type' => 'string', + 'example' => '203.0.113.4', + ], + ], + ], + ], + ], + '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' => '获取入侵防御事件的攻击payload', + ], + 'DescribeRiskEventGroup' => [ + 'summary' => '获取入侵防御事件的详细数据。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：表示中文。'."\n" + .'- **en**：表示英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：表示中文。'."\n" + .'- **en**：表示英文。', + 'type' => 'string', + 'required' => false, + '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' => '1534408267', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '入侵防御事件的流量的方向。取值：'."\n" + .'- **in**：表示进方向。'."\n" + .'- **out**：表示出方向。'."\n" + ."\n" + .'>不设置该参数表示查询所有流量方向。', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询每页包含多少条结果。'."\n" + ."\n" + .'默认值为**6**，表示每页包含6条结果。最大值为**10**。', + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询返回第几页数据。'."\n" + .'默认值为**1**，表示返回第1页数据。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'description' => '风险事件类型。 '."\n" + .'唯一取值：**session**，表示入侵防御事件。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'session', + ], + ], + [ + 'name' => 'RuleSource', + 'in' => 'query', + 'schema' => [ + 'description' => '入侵防御事件的检测规则来源。取值：'."\n" + .'- **1**：表示基础防御。'."\n" + .'- **2**：表示虚拟补丁。'."\n" + .'- **4**：表示威胁情报。'."\n" + ."\n" + .'> 不设置该参数表示查询所有规则来源。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleResult', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙的防御状态。取值：'."\n" + .'- **1**：表示告警。'."\n" + .'- **2**：表示拦截。'."\n" + ."\n" + .'> 不设置该参数表示查询所有防御状态。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的源IP。设置该参数表示查询包含了这条源IP的入侵防御事件。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'DstIP', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的目的IP。设置该参数表示查询包含了这条目的IP的入侵防御事件。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'VulLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '入侵防御事件的安全等级。取值：'."\n" + .'- **1**：表示低危。'."\n" + .'- **2**：表示中危。'."\n" + .'- **3**：表示高危。'."\n" + ."\n" + .'> 不设置该参数表示查询所有安全等级。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙类型。取值：'."\n" + .'- **VpcFirewall**：表示VPC边界防火墙。'."\n" + .'- **InternetFirewall**（默认）：表示互联网边界防火墙。', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewall', + ], + ], + [ + 'name' => 'SrcNetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '源VPC实例ID。'."\n" + .'> 仅在FirewallType为VpcFirewall时，需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6e9a9zyokj2ywuo****', + ], + ], + [ + 'name' => 'DstNetworkInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '目的VPC实例ID。'."\n" + .'> 仅在FirewallType为VpcFirewall时，需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6e9a9zyokj2ywuo****', + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => '入侵防御事件的攻击类型。取值：'."\n" + .'- **1**：表示异常连接。'."\n" + .'- **2**：表示命令执行。'."\n" + .'- **3**：表示暴力破解。'."\n" + .'- **4**：表示扫描。'."\n" + .'- **5**：表示其它。'."\n" + .'- **6**：表示信息泄露。'."\n" + .'- **7**：表示Dos攻击。'."\n" + .'- **8**：表示溢出攻击。'."\n" + .'- **9**：表示Web攻击。'."\n" + .'- **10**：表示木马后门。'."\n" + .'- **11**：表示病毒蠕虫。'."\n" + .'- **12**：表示挖矿行为。'."\n" + .'- **13**：表示反弹Shell。'."\n" + ."\n" + .'>不设置该参数表示查询全部攻击类型。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NoLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询IP地址位置信息。'."\n" + .'- **true**： 表示不查询IP地理位置信息。'."\n" + .'- **false**（默认）：表示查询IP地理位置信息。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AttackApp', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '被攻击应用的名称的列表，使用`["AttackApp1","AttackApp2"]`格式表示。', + 'type' => 'array', + 'items' => [ + 'description' => '被攻击应用的名称的列表，使用`["AttackApp1","AttackApp2"]`格式表示。', + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + ], + 'required' => false, + 'example' => '["MySql","DNS"]', + 'maxItems' => 50, + 'minItems' => 0, + ], + ], + [ + 'name' => 'BuyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '购买版本。取值：'."\n" + .'- **2**：高级版。'."\n" + .'- **3**：企业版。'."\n" + .'- **4**：旗舰版。'."\n" + .'- **10**：按量付费版。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定字段排序。取值：'."\n" + ."\n" + .'- **VulLevel**（默认）：根据风险等级排序。'."\n" + ."\n" + .'- **LastTime**：根据最近发生时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'LastTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值：'."\n" + ."\n" + .'- **asc**：升序。'."\n" + ."\n" + .'- **desc**（默认）：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '入侵防御事件名称。', + 'type' => 'string', + 'required' => false, + 'example' => '木马后门通信', + ], + ], + [ + 'name' => 'IsOnlyPrivateAssoc', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅查询已完成私网溯源的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AttackAppCategory', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '被攻击应用的类别的列表，使用["AttackAppCategory1","AttackAppCategory2"]格式表示。', + 'type' => 'array', + 'items' => [ + 'description' => '被攻击应用的类别的列表，使用["AttackAppCategory1","AttackAppCategory2"]格式表示。', + 'type' => 'string', + 'required' => false, + 'example' => 'AI组件', + ], + 'required' => false, + 'maxItems' => 50, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '入侵防御事件的详细数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '风险事件的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'B14757D0-4640-4B44-AC67-7F558FE7E6EF', + ], + 'DataList' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据列表。', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '该入侵防御事件的流量方向。取值：'."\n" + .'- **in**：表示进方向。'."\n" + .'- **out**：表示出方向。', + 'type' => 'string', + 'example' => 'in', + ], + 'EventName' => [ + 'description' => '入侵防御事件名称。', + 'type' => 'string', + 'example' => 'Web目录穿越攻击', + ], + 'DstIP' => [ + 'description' => '查询到的目的IP。表示入侵防御事件中包含了这条目的IP。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'AttackType' => [ + 'description' => '该入侵防御事件的攻击类型。取值：'."\n" + .'- **1**：表示异常连接。'."\n" + .'- **2**：表示命令执行。'."\n" + .'- **3**：表示暴力破解。'."\n" + .'- **4**：表示扫描。'."\n" + .'- **5**：表示其它。'."\n" + .'- **6**：表示信息泄露。'."\n" + .'- **7**：表示Dos攻击。'."\n" + .'- **8**：表示溢出攻击。'."\n" + .'- **9**：表示Web攻击。'."\n" + .'- **10**：表示木马后门。'."\n" + .'- **11**：表示病毒蠕虫。'."\n" + .'- **12**：表示挖矿行为。'."\n" + .'- **13**：表示反弹Shell。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tag' => [ + 'description' => '重保情报标签。', + 'type' => 'string', + 'example' => '重保情报', + ], + 'RuleId' => [ + 'description' => '本次入侵防御事件的防护规则ID。', + 'type' => 'string', + 'example' => '1000****', + ], + 'EventId' => [ + 'description' => '入侵防御事件ID。', + 'type' => 'string', + 'example' => '2b58efae-4c4b-4d96-9544-a586fb1f****', + ], + 'ResourceType' => [ + 'description' => '该入侵防御事件的公网IP类型。取值：'."\n" + .' - **EIP**：表示弹性公网IP。'."\n" + .' - **EcsPublicIP**：表示ECS公网IP。'."\n" + .' - **EcsEIP**：表示ECS EIP。'."\n" + .' - **NatPublicIP**：表示NAT公网IP。'."\n" + .' - **NatEIP**：表示NAT EIP。'."\n" + .' - **SlbPublicIp**：表示SLB 公网IP。', + 'type' => 'string', + 'example' => 'EcsPublicIP', + ], + 'FirstEventTime' => [ + 'description' => '入侵事件首次发生时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1534408189', + ], + 'Description' => [ + 'description' => '该入侵防御事件的描述。', + 'type' => 'string', + 'example' => '检测到HTTP请求的Web访问中使用了目录穿越攻击。', + ], + 'EventCount' => [ + 'description' => '入侵防御事件数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'VulLevel' => [ + 'description' => '该入侵防御事件的安全等级。取值：'."\n" + .'- **1**：表示低危。'."\n" + .'- **2**：表示中危。'."\n" + .'- **3**：表示高危。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AttackApp' => [ + 'description' => '被攻击应用的名称。', + 'type' => 'string', + 'example' => 'MySql', + ], + 'RuleSource' => [ + 'description' => '本次入侵防御事件的检测规则来源。取值：'."\n" + .'- **1**：表示基础防御。'."\n" + .'- **2**：表示虚拟补丁。'."\n" + .'- **4**：表示威胁情报。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleResult' => [ + 'description' => '防御状态。取值：'."\n" + .'- **1**：表示告警。'."\n" + .'- **2**：表示拦截。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SrcIP' => [ + 'description' => '查询到的源IP。表示入侵防御事件中包含了这条源IP。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'LastEventTime' => [ + 'description' => '入侵防御事件上次发生的时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1534408267', + ], + 'ResourcePrivateIPList' => [ + 'description' => '该入侵防御事件的私网IP信息，以**RegionNo**、**ResourceInstanceId**、**ResourceInstanceName**和**ResourcePrivateIP**的数组形式返回该IP信息。 '."\n" + .'其中，**RegionNo**表示该IP所属的地域ID，**ResourceInstanceId**表示该IP所属的实例ID，**ResourceInstanceName**表示该IP所属的实例名，**ResourcePrivateIP**表示该IP。', + 'type' => 'array', + 'items' => [ + 'description' => '该入侵防御事件的私网IP信息，以**RegionNo**、**ResourceInstanceId**、**ResourceInstanceName**和**ResourcePrivateIP**的数组形式返回该IP信息。 '."\n" + .'其中，**RegionNo**表示该IP所属的地域ID，**ResourceInstanceId**表示该IP所属的实例ID，**ResourceInstanceName**表示该IP所属的实例名，**ResourcePrivateIP**表示该IP。', + 'type' => 'object', + 'properties' => [ + 'ResourceInstanceName' => [ + 'description' => '实例名。', + 'type' => 'string', + 'example' => 'LD-shenzhen-zy****', + ], + 'ResourcePrivateIP' => [ + 'description' => '私网IP。', + 'type' => 'string', + 'example' => '10.255.XX.XX', + ], + 'ResourceInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-wz92jf4scg2zb74p****', + ], + 'RegionNo' => [ + 'description' => '地域ID。表示私网IP所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'SrcPrivateIPList' => [ + 'description' => '入侵防御事件的源私网IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '入侵防御事件的源私网IP列表。'."\n" + .'>只有出方向会返回该参数的值。', + 'type' => 'string', + 'example' => '["192.168.XX.XX","192.168.XX.XX"]', + ], + ], + 'VpcSrcInfo' => [ + 'description' => '该入侵防御事件的源VPC信息，该结构体包含**EcsInstanceId**、**EcsInstanceName**、**NetworkInstanceId**、**NetworkInstanceName**和**RegionNo**参数。 '."\n" + .'其中，**EcsInstanceId**表示该VPC中的ECS实例ID，**EcsInstanceName**表示该VPC中的ECS实例名，**NetworkInstanceId**表示该VPC实例ID，**NetworkInstanceName**表示该VPC实例名，**RegionNo**表示该VPC实例所属的地域ID。', + 'type' => 'object', + 'properties' => [ + 'EcsInstanceName' => [ + 'description' => 'ECS实例名。', + 'type' => 'string', + 'example' => 'LD-shenzhen-zy****', + ], + 'NetworkInstanceName' => [ + 'description' => 'VPC实例名。', + 'type' => 'string', + 'example' => 'VPC-SH-TX****', + ], + 'NetworkInstanceId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-uf6e9a9zyokj2ywuo****', + ], + 'EcsInstanceId' => [ + 'description' => 'ECS实例ID。', + 'type' => 'string', + 'example' => 'i-wz92jf4scg2zb74p****', + ], + 'RegionNo' => [ + 'description' => '地域ID。表示源VPC实例所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'VpcDstInfo' => [ + 'description' => '该入侵防御事件的目的VPC信息，该结构体包含**EcsInstanceId**、**EcsInstanceName**、**NetworkInstanceId**、**NetworkInstanceName**和**RegionNo**参数。 '."\n" + .'其中，**EcsInstanceId**表示该VPC中的ECS实例ID，**EcsInstanceName**表示该VPC中的ECS实例名，**NetworkInstanceId**表示该VPC实例ID，**NetworkInstanceName**表示该VPC实例名，**RegionNo**表示该VPC实例所属的地域ID。', + 'type' => 'object', + 'properties' => [ + 'EcsInstanceName' => [ + 'description' => 'ECS实例名。', + 'type' => 'string', + 'example' => 'LD-shenzhen-zy****', + ], + 'NetworkInstanceName' => [ + 'description' => 'VPC实例名。', + 'type' => 'string', + 'example' => 'VPC-SH-TX****', + ], + 'NetworkInstanceId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-uf6e9a9zyokj2ywuo****', + ], + 'EcsInstanceId' => [ + 'description' => 'ECS实例ID。', + 'type' => 'string', + 'example' => 'i-wz92jf4scg2zb74p****', + ], + 'RegionNo' => [ + 'description' => '地域ID。表示目的VPC实例所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'IPLocationInfo' => [ + 'description' => 'IP地理位置信息，该结构体包含**CityId**、**CityName**、**CountryId**和**CountryName**参数。 '."\n" + .'其中，**CityId**表示该IP所属的城市ID，**CityName**表示该IP所属的城市名，**CountryId**表示该IP所属的国家ID，**CountryName**表示该IP所属的国家名。', + 'type' => 'object', + 'properties' => [ + 'CityId' => [ + 'description' => '城市ID。', + 'type' => 'string', + 'example' => '510100', + ], + 'CountryName' => [ + 'description' => '国家名。', + 'type' => 'string', + 'example' => '中国', + ], + 'CityName' => [ + 'description' => '城市名。', + 'type' => 'string', + 'example' => '四川省成都', + ], + 'CountryId' => [ + 'description' => '国家ID。', + 'type' => 'string', + 'example' => 'CN', + ], + ], + ], + 'SrcIPTag' => [ + 'description' => '源IP标签，用于标识是否为云产品回源IP。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'WAF Back-to-origin Address', + ], + 'SrcIPTags' => [ + 'title' => 'IP标签列表。', + 'description' => 'IP标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'IP标签。', + 'description' => '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' => '获取入侵防御事件的详细数据', + 'description' => '本接口用于查询和下载入侵防御详细数据，建议一次查询5~10条。为避免查询超时，如果无需返回IP地理位置信息，请设置参数NoLocation为true。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见[公共参数](~~94763~~)。 '."\n" + .'调用API的请求格式，请参见本文**示例**中的请求示例。 ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVulnerabilityProtectedList' => [ + 'summary' => '获取云防火墙支持防护的漏洞列表。', + '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' => '访问源的IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '112.239.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '返回消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '返回消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '1646063922', + ], + ], + [ + 'name' => 'VulnStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞防护状态。取值：'."\n" + ."\n" + .'- **partProtected** ：部分防护中'."\n" + .'- **protected** ：防护中'."\n" + .'- **unProtected** ：未防护', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'protected' => 'protected', + 'unProtected' => 'unProtected', + 'partProtected' => 'partProtected', + ], + 'example' => 'protected', + ], + ], + [ + 'name' => 'VulnCveName', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞CVE编号。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CVE-2022-2992', + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞防护事件的攻击类型。取值：'."\n" + .'- **1**：异常连接'."\n" + .'- **2**：命令执行'."\n" + .'- **3**：暴力破解'."\n" + .'- **4**：扫描'."\n" + .'- **5**：其它'."\n" + .'- **6**：信息泄露'."\n" + .'- **7**：DoS攻击'."\n" + .'- **8**：溢出攻击'."\n" + .'- **9**：Web攻击'."\n" + .'- **10**：木马后门'."\n" + .'- **11**：病毒蠕虫'."\n" + .'- **12**：挖矿行为'."\n" + .'- **13**：反弹Shell'."\n" + ."\n" + .'>不设置该参数表示查询全部攻击类型。', + 'type' => 'string', + 'required' => false, + 'example' => '13', + ], + ], + [ + 'name' => 'VulnType', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞类型。取值：'."\n" + ."\n" + .'- **App**：应用漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **cms**：Web-CMS漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'emg', + ], + ], + [ + 'name' => 'VulnLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的当前页的页码。默认值为1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。支持最大取值为50。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortKey', + 'in' => 'query', + 'schema' => [ + 'description' => '排序依据。唯一取值：**attackCnt**，表示攻击次数。', + 'type' => 'string', + 'required' => false, + 'example' => 'attackCnt', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值：'."\n" + ."\n" + .'- **asc**：升序。'."\n" + .'- **desc**（默认）：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'VulnResource', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞影响的资产数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '用户类型。唯一取值：**buy**，表示付费型。', + 'type' => 'string', + 'required' => false, + 'example' => 'buy', + ], + ], + [ + 'name' => 'BuyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙的版本。按量付费版本填10，其它版本不需要填写。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙成员账号的UID。', + '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' => 'DescribeVulnerabilityProtectedList 应答', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'D355C631-1537-59C5-A56E-F6C5037B99E5', + ], + 'TotalCount' => [ + 'description' => '云防火墙已检测的漏洞总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ZeroResourceCount' => [ + 'description' => '检测到的漏洞资产数为0的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VulnList' => [ + 'description' => '漏洞信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞信息。', + 'type' => 'object', + 'properties' => [ + 'VulnName' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'fastjson <= 1.2.80 反序列化任意代码执行漏洞', + ], + 'AttackType' => [ + 'description' => '漏洞防护事件的攻击类型。取值：'."\n" + .'- **1**：异常连接'."\n" + .'- **2**：命令执行'."\n" + .'- **3**：暴力破解'."\n" + .'- **4**：扫描'."\n" + .'- **5**：其它'."\n" + .'- **6**：信息泄露'."\n" + .'- **7**：DoS攻击'."\n" + .'- **8**：溢出攻击'."\n" + .'- **9**：Web攻击'."\n" + .'- **10**：木马后门'."\n" + .'- **11**：病毒蠕虫'."\n" + .'- **12**：挖矿行为'."\n" + .'- **13**：反弹Shell', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'NeedRuleClass' => [ + 'description' => '需要开启的RuleClass等级。取值：'."\n" + ."\n" + .'- **1**（默认）：宽松'."\n" + .'- **2**：中等'."\n" + .'- **3**：严格', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VulnType' => [ + 'description' => '漏洞类型。取值：'."\n" + ."\n" + .'- **emg**：应急漏洞'."\n" + .'- **webcms**：Web-CMS漏洞'."\n" + .'- **app**：应用漏洞', + 'type' => 'string', + 'example' => 'emg', + ], + 'VulnKey' => [ + 'description' => '漏洞编码。', + 'type' => 'string', + 'example' => 'dedecms-archive.helper.php-vul', + ], + 'VulnLevel' => [ + 'description' => '漏洞等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + 'NeedOpenBasicRule' => [ + 'description' => '漏洞对应基础防御规则的状态。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭'."\n" + .'> 当取值为true时，一键防护时需要设置该漏洞对应的基础防御状态为拦截。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CveId' => [ + 'description' => 'CVE编号列表。', + 'type' => 'string', + 'example' => '12112131123, 1231123112', + ], + 'FirstTime' => [ + 'description' => '首次发生攻击的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1608687364', + ], + 'BasicRuleIds' => [ + 'description' => '关联的规则ID。', + 'type' => 'string', + 'example' => '12,12', + ], + 'LastTime' => [ + 'description' => '最近一次的攻击时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1608687364', + ], + 'NeedOpenVirtualPatcheUuids' => [ + 'description' => '需要升级为拦截模式的虚拟补丁规则UUID。', + 'type' => 'string', + 'example' => 'UUID-1231231234', + ], + 'NeedOpenBasicRuleUuids' => [ + 'description' => '需要升级为拦截模式的基础防御规则UUID。', + 'type' => 'string', + 'example' => 'UUID-1231231', + ], + 'NeedOpenVirtualPatche' => [ + 'description' => '漏洞对应虚拟补丁的状态。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭'."\n" + .'> 当取值为true时，一键防护时需要设置该漏洞对应的虚拟补丁状态为拦截。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VirtualPatcheIds' => [ + 'description' => '关联的规则ID。', + 'type' => 'string', + 'example' => '13,13', + ], + 'HighlightTag' => [ + 'description' => '该漏洞是否需要重要关注。取值：'."\n" + ."\n" + .'- **0**：不需要'."\n" + .'- **1**：需要', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NeedOpenRunMode' => [ + 'description' => '一键防护时是否需要设置威胁引擎运行模式。取值：'."\n" + ."\n" + .'- **true**：需要'."\n" + ."\n" + .'- **false**：不需要', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VulnStatus' => [ + 'description' => '漏洞防护状态。取值：'."\n" + ."\n" + .'- **partProtected**：部分防护中'."\n" + .'- **protected**：防护中'."\n" + .'- **unProtected**：未防护', + 'type' => 'string', + 'example' => 'protected', + ], + 'AttackCnt' => [ + 'description' => '漏洞的攻击次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceCnt' => [ + 'description' => '存在漏洞的资产数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MemberUid' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'example' => '119384235299****', + ], + 'ResourceList' => [ + 'description' => '漏洞资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞资产。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '漏洞资产类型。取值：'."\n" + ."\n" + .'- **SLB**'."\n" + .'- **EIP**'."\n" + .'- **ECS**', + 'type' => 'string', + 'example' => 'EIP', + ], + 'Eip' => [ + 'description' => '实例的EIP。', + 'type' => 'string', + 'example' => '203.107.XX.XX', + ], + 'InternetIp' => [ + 'description' => '实例的公网IP。', + 'type' => 'string', + 'example' => '47.96.XX.XX', + ], + 'VulnStatus' => [ + 'description' => '漏洞防护状态。取值：'."\n" + ."\n" + .'- **partProtected**：部分防护中'."\n" + .'- **protected**：防护中'."\n" + .'- **unProtected**：未防护', + 'type' => 'string', + 'example' => 'protected', + ], + 'ResourceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'ResourceName' => [ + 'description' => '实例的名称。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'IntranetIp' => [ + 'description' => '实例的私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'RegionId' => [ + 'description' => '云防火墙所在的地域ID。'."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + 'RuleTag' => [ + 'description' => '漏洞标签。', + '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' => '获取漏洞防护列表', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '112.15.190.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '请求ID。', + '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"}]', + 'title' => '查询未保护漏洞趋势', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeInvadeEventList' => [ + 'summary' => '查询云防火墙失陷感知事件的信息。', + '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' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'title' => '源IP', + 'description' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + 'title' => '语言', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => '设置查询开始时间。使用秒级时间戳格式表示。不填表示以最近30天开始查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1656750960', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => '设置查询结束时间。使用秒级时间戳格式表示。不填表示以当前时间结束。', + 'type' => 'string', + 'required' => false, + 'example' => '1656837360', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => '设置分页查询返回第几页数据。'."\n" + ."\n" + .'默认值为1，表示返回第1页数据。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页多少条', + 'description' => '设置分页查询每页包含多少条结果。'."\n" + ."\n" + .'默认值为6，表示每页包含6条结果。最大值为10。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AssetsInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ins_1321_asedb_****', + ], + ], + [ + 'name' => 'AssetsInstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名称', + 'description' => '实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_test', + ], + ], + [ + 'name' => 'IsIgnore', + 'in' => 'query', + 'schema' => [ + 'title' => '是否忽略', + 'description' => '是否已忽略该失陷感知。取值：'."\n" + ."\n" + .'- **true**：已忽略。'."\n" + ."\n" + .'- **false**：未忽略。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AssetsIP', + 'in' => 'query', + 'schema' => [ + 'title' => '资产IP', + 'description' => '受影响的资产IP。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + ], + [ + 'name' => 'EventKey', + 'in' => 'query', + 'schema' => [ + 'title' => '事件key', + 'description' => '失陷感知事件的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '69d189e2-ec17-4676-a2fe-02969234****', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'title' => '事件名称', + 'description' => '失陷感知事件的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'event_test', + ], + ], + [ + 'name' => 'EventUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '事件UUID', + 'description' => '失陷感知事件的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fadd-dfdd-****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'title' => '成员账号UID', + 'description' => '成员账号UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'ProcessStatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '处理状态列表', + 'description' => '处理状态列表。', + 'type' => 'array', + 'items' => [ + 'title' => '处理状态', + 'description' => '失陷感知事件处理状态。取值：'."\n" + ."\n" + .'- **0**：未处理。'."\n" + .'- **20**：已解决。'."\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' => '风险评估等级。', + 'type' => 'array', + 'items' => [ + 'title' => '风险等级值', + 'description' => '风险评估等级。取值：'."\n" + ."\n\n" + .'- **1**：低危。'."\n" + .'- **2**：中危。'."\n" + .'- **3**：高危。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'enum' => [], + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LowLevelPercent' => [ + 'title' => '低风险等级比例', + 'description' => '低风险等级比例。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'MiddleLevelPercent' => [ + 'title' => '中风险等级比例', + 'description' => '中风险等级比例。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'HighLevelPercent' => [ + 'title' => '高风险等级比例', + 'description' => '高风险等级比例。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'PageInfo' => [ + 'title' => '分页信息', + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页', + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '总数', + 'description' => '失陷感知事件的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + ], + ], + 'EventList' => [ + 'title' => '事件列表', + 'description' => '失陷感知事件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'title' => '风险等级', + 'description' => '风险评估等级。取值：'."\n" + ."\n\n" + .'- **1**：低危。'."\n" + .'- **2**：中危。'."\n" + .'- **3**：高危。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [], + ], + 'EventName' => [ + 'title' => '事件名称', + 'description' => '失陷感知事件的名称。', + 'type' => 'string', + 'example' => 'event_test', + ], + 'EventKey' => [ + 'title' => 'CVE编号', + 'description' => '失陷感知事件的ID。', + 'type' => 'string', + 'example' => '69d189e2-ec17-4676-a2fe-02969234****', + ], + 'EventUuid' => [ + 'title' => '事件UUID', + 'description' => '失陷感知事件的UUID。', + 'type' => 'string', + 'example' => 'fadd-dfdd-****', + ], + 'MemberUid' => [ + 'title' => '成员账号UID', + 'description' => '成员账号UID。', + 'type' => 'string', + 'example' => '135809047715****', + ], + 'AssetsType' => [ + 'title' => '资产类型', + 'description' => '受影响的资产类型。取值：'."\n" + ."\n" + .'- **BastionHostIP**：堡垒机出口IP。'."\n" + .'- **BastionHostIngressIP**：堡垒机入口IP。'."\n" + .'- **EcsEIP**：ECS EIP。'."\n" + .'- **EcsPublicIP**：ECS公网IP。'."\n" + .'- **EIP**：弹性公网IP。'."\n" + .'- **EniEIP**：弹性网卡EIP。'."\n" + .'- **NatEIP**：NAT EIP。'."\n" + .'- **SlbEIP**：SLB EIP。'."\n" + .'- **SlbPublicIP**：SLB公网IP。'."\n" + .'- **NatPublicIP**：NAT公网IP。'."\n" + .'- **HAVIP**：高可用虚拟IP。', + 'type' => 'string', + 'example' => 'EcsPublicIp', + ], + 'FirstTime' => [ + 'title' => '首次出现时间', + 'description' => '失陷感知事件首次出现的时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1656750960', + ], + 'EventSrc' => [ + 'title' => '事件来源', + 'description' => '失陷感知事件的来源。取值：'."\n" + ."\n" + .'- **IPS**：入侵防御事件。'."\n" + ."\n" + .'- **offline**：离线事件。', + 'type' => 'string', + 'example' => 'IPS', + ], + 'PrivateIP' => [ + 'title' => '私网IP', + 'description' => '受影响资产的私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AssetsInstanceName' => [ + 'title' => '资产名称', + 'description' => '受影的响资产名称。', + 'type' => 'string', + 'example' => 'ECS_test', + ], + 'LastTime' => [ + 'title' => '最近一次时间', + 'description' => '失陷感知事件最近一次出现的时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1656837360', + ], + 'PublicIpType' => [ + 'title' => '公开类型', + 'description' => '受影响的资产类型。取值：'."\n" + ."\n" + .'- **BastionHostIP**：堡垒机出口IP。'."\n" + .'- **BastionHostIngressIP**：堡垒机入口IP。'."\n" + .'- **EcsEIP**：ECS EIP。'."\n" + .'- **EcsPublicIP**：ECS公网IP。'."\n" + .'- **EIP**：弹性公网IP。'."\n" + .'- **EniEIP**：弹性网卡EIP。'."\n" + .'- **NatEIP**：NAT EIP。'."\n" + .'- **SlbEIP**：SLB EIP。'."\n" + .'- **SlbPublicIP**：SLB公网IP。'."\n" + .'- **NatPublicIP**：NAT公网IP。'."\n" + .'- **HAVIP**：高可用虚拟IP。', + 'type' => 'string', + 'example' => 'EcsPublicIp', + ], + 'IsIgnore' => [ + 'title' => '是否忽略', + 'description' => '是否忽略失陷感知事件。取值：'."\n" + ."\n" + .'- **true**：已忽略。'."\n" + ."\n" + .'- **false**：未忽略。'."\n", + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'false', + ], + 'PublicIP' => [ + 'title' => '公网IP', + 'description' => '受影响资产的公网IP。', + 'type' => 'string', + 'example' => '198.51.XX.XX', + ], + 'ProcessStatus' => [ + 'title' => '处理状态', + 'description' => '失陷感知事件的处理状态。取值：'."\n" + ."\n" + .'- **0**：未处理。'."\n" + .'- **20**：已解决。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AssetsInstanceId' => [ + 'title' => '资产实例ID', + 'description' => '受影响的资产实例ID。', + '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' => '查询云防火墙失陷感知事件的信息', + ], + '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' => '访问者源IP地址。', + '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' => '请求ID。', + '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"}]', + 'title' => '获取漏洞名称列表', + ], + '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' => '访问者源IP地址。', + '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' => '请求ID。', + '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"}]', + 'title' => '获取漏洞事件统计', + ], + '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' => '访问者源IP', + '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' => '资产ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp135d2rmbwpt****', + ], + ], + [ + 'name' => 'EventUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '失陷感知事件UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '92498578-7c42-4845-8c73-7e824782****', + ], + ], + [ + 'name' => 'PublicIP', + 'in' => 'query', + 'schema' => [ + 'description' => '公网IP。', + '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' => '事件Key。', + 'type' => 'string', + 'example' => 'C&CActivity', + ], + 'EventName' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'event_test', + ], + 'EventDetail' => [ + 'description' => '事件详情。', + 'type' => 'string', + 'example' => 'test', + ], + 'EventUuid' => [ + 'description' => '失陷感知事件UUID。', + 'type' => 'string', + 'example' => 'aa6e786c-5034-457a-8e05-1c63fab****', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FirstTime' => [ + 'description' => '首次发生时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1735006706', + ], + 'Reference' => [ + 'description' => '参考信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'PrivateIP' => [ + 'description' => '私网IP。', + 'type' => 'string', + 'example' => '10.21.186.XXX', + ], + 'LastTime' => [ + 'description' => '最近发生时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1740104108', + ], + 'AssetsInstanceName' => [ + 'description' => '资产名称。', + 'type' => 'string', + 'example' => 'ECS_test', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '公网IP。', + 'type' => 'string', + 'example' => '106.15.185.XXX', + ], + 'ProcessStatus' => [ + 'description' => '处理状态。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '未处理', + 10 => '已防御', + 20 => '已处理', + ], + 'example' => '1', + ], + 'AssetsInstanceId' => [ + 'description' => '资产实例ID。', + '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"}]', + 'title' => '获取失陷感知事件详情', + ], + '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' => '源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.0.XXX', + ], + ], + [ + 'name' => 'DstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '目的IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.102.XXX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '唯一标识ID。', + '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' => '只有AI事件。', + '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' => '结果的请求ID。', + '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' => '资产私有IP。', + 'type' => 'string', + 'example' => '47.100.102.XXX', + ], + 'AssetType' => [ + 'description' => '资产类型。', + 'type' => 'string', + 'example' => 'EIP', + ], + 'CategoryName' => [ + 'description' => '类型名称。', + 'type' => 'string', + 'example' => 'Trusted', + ], + 'CategoryClassId' => [ + 'description' => '情报标签的分类。取值：'."\n" + ."\n" + .'- **Suspicious**：可疑'."\n" + .'- **Malicious**：恶意'."\n" + .'- **Trusted**：信任', + 'type' => 'string', + 'example' => 'Trusted', + ], + 'CityId' => [ + 'description' => '城市ID。', + 'type' => 'string', + 'example' => '000', + ], + 'CountryId' => [ + 'description' => '国家ID。', + 'type' => 'string', + 'example' => 'cn', + ], + 'DstIp' => [ + 'description' => '目的IP。', + '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' => '目的IP所属地区名。', + 'type' => 'string', + 'example' => '浙江省杭州市余杭区', + ], + 'Payload' => [ + 'description' => '入侵防御事件的攻击Payload。', + 'type' => 'string', + 'example' => '3082002f02010004067075626c6963a082002002044c33a756020100020100308200103082000c06082b060102010105000500', + ], + 'ProtoList' => [ + 'description' => '协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'RegionId' => [ + 'description' => '地域ID。', + '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' => '源IP。', + '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' => '资源ID。', + '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"}]', + 'title' => '查询数据泄露事件列表', + ], + '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' => '源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.0.XXX', + ], + ], + [ + 'name' => 'DstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '目的IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.102.XXX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '唯一标识ID。', + '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' => '返回结果的请求ID。', + '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' => '源IP。', + '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"}]', + 'title' => '查询数据泄露的敏感数据列表', + ], + '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' => '源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '121.40.84.XXX', + ], + ], + [ + 'name' => 'DstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '目的IP。', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.102.XXX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '唯一标识ID。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询数据泄露事件详情', + ], + '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' => '返回结果的请求ID。', + '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' => '总流量数据，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AiSensitiveDataCount' => [ + 'description' => 'AI相关泄露风险数。', + '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"}]', + 'title' => '查询数据泄露事件统计数据', + ], + 'DescribeSdlStatistic' => [ + 'summary' => '查询敏感数据详情。', + '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' => '返回结果的请求ID。', + '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' => '公网IP。', + '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' => '公网IP。', + '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"}]', + 'title' => '查询敏感数据详情', + ], + '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' => '返回结果请求ID。', + '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"}]', + 'title' => '查询敏感数据开关', + ], + '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' => '语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '状态。取值：'."\n" + .'- **1**：开启。'."\n" + .'- **0**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果的请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '6169C0A4-B91A-5D48-AE4D-B9432D15****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6169C0A4-B91A-5D48-AE4D-B9432D15****\\"\\n}","type":"json"}]', + 'title' => '修改敏感数据开关', + ], + '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' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IpList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'IP资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP资产列表。', + 'type' => 'string', + 'required' => false, + 'example' => '47.99.108.XX', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '开启资产数据泄露保护', + ], + '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' => 'IP资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP资产列表。', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'F93A490D-9E92-5AA4-BA79-600FFC09****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F93A490D-9E92-5AA4-BA79-600FFC09****\\"\\n}","type":"json"}]', + 'title' => '关闭资产敏感数据发现防护', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + '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' => 'ACL类型：'."\n" + .'- **Internet** '."\n" + .'- **NAT**'."\n" + .'- **VPC**'."\n" + .'- **All**', + 'type' => 'string', + 'required' => true, + 'example' => 'VPC', + 'enum' => [ + 'Internet', + 'NAT', + 'VPC', + 'All', + ], + ], + ], + [ + 'name' => 'Popular', + 'in' => 'query', + 'schema' => [ + 'description' => '是否常见。取值：'."\n" + ."\n" + .'- 1：常见'."\n" + ."\n" + .'- 0：不常见'."\n" + ."\n" + .'- 不输入（默认值）：查询所有', + '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' => '协议类型。'."\n" + ."\n" + .'- **TCP**：TCP协议'."\n" + ."\n" + .'- **UDP**：UDP协议', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '9063AB86-6FFA-5B2D-A16D-697C966D****', + ], + 'AclApps' => [ + 'description' => '访问控制应用列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1.0', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RiskLevel' => [ + 'description' => '风险评估等级，取值：'."\n" + ."\n" + .'- **1**：低危'."\n" + .'- **2**：中危'."\n" + .'- **3**：高危', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Popular' => [ + 'description' => '是否常见。取值：'."\n" + ."\n" + .'- 1：常见'."\n" + ."\n" + .'- 0：不常见'."\n" + ."\n" + .'- 不输入（默认值）：查询所有', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Protocols' => [ + 'description' => '协议类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '协议类型。'."\n" + ."\n" + .'- **TCP**：TCP协议'."\n" + ."\n" + .'- **UDP**：UDP协议', + 'type' => 'string', + 'example' => '['."\n" + .' "TCP",'."\n" + .' "UDP"'."\n" + .']', + ], + ], + 'SupportFqdn' => [ + 'description' => '是否支持 **Fqdn** 。'."\n" + ."\n" + .'- **0**：不支持'."\n" + ."\n" + .'- **1**：支持', + '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"}]', + 'title' => '批量查询访问控制应用', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '101.36.65.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainGroupUseDns' => [ + 'description' => '是否已开启白名单。取值：'."\n" + .'- **true**：已开启'."\n" + .'- **false**：未开启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SupportMessageType' => [ + 'description' => '是否支持消息类型。取值：'."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '7D45133B-DBC0-506B-9DF9-AB0735D3****', + ], + 'NatDomainGroupUseDns' => [ + 'description' => 'NAT 场景下是否支持域名 DNS。取值：'."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VpcDomainGroupUseDns' => [ + 'description' => 'VPC 场景下是否支持域名 DNS。取值：'."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + '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"}]', + 'title' => '获取ACL白名单', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '27.151.85.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '27936D6C-1B7A-5A5A-B9E4-FBEBBDAA****', + ], + 'InternetOutAclCount' => [ + 'description' => '互联网边界出向策略数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'VpcAclCount' => [ + 'description' => 'VPC边界策略数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NatInAclCount' => [ + 'description' => 'NAT边界入向策略数。><notice>废弃字段></notice>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NatOutAclCount' => [ + 'description' => 'NAT边界内到外策略数。', + '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"}]', + 'title' => '获取总ACL配置数', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeControlPolicy' => [ + 'summary' => '获取所有访问控制策略的信息。', + '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' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '访问控制策略控制的流量方向。取值：'."\n" + .'- **in**：外对内方向的流量访问控制。'."\n" + .'- **out**：内对外方向的流量访问控制。', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + 'enum' => [ + 'out', + 'in', + ], + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。'."\n" + ."\n" + .'默认值为1。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的访问源地址。支持使用模糊查询的方式进行查询。SourceType（源类型）不同，访问源地址的取值也不同。'."\n" + ."\n" + .'- 当SourceType为`net`时，访问源为CIDR格式的IP地址段。例如：192.0.XX.XX/24。'."\n" + ."\n" + .'- 当SourceType为`group`时，访问源为源地址簿名称。例如：db_group为空（表示查询所有访问控制源）。'."\n" + ."\n" + .'- 当SourceType为`location`时，访问源为源区域。例如：北京或beijing（支持使用中文或英文进行查询）。'."\n" + ."\n" + .'> 不设置该参数表示查询所有类型的访问源。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址。支持模糊查询。DestinationType（目的类型）不同，目的地址的取值也不同。'."\n" + ."\n" + .'- 当DestinationType为`net`时，目的地址为CIDR格式的IP地址段。例如：10.0.3.0/24。'."\n" + ."\n" + .'- 当DestinationType为`domain`时，目的地址为域名。例如：aliyun。'."\n" + ."\n" + .'- 当DestinationType为`group`时，目的地址为地址簿的名称。例如：db_group。'."\n" + ."\n" + .'- 当DestinationType为`location`时，目的地址为区域名称（具体区域位置编码请参见AddControlPolicy。例如：["BJ11", "ZB"]。'."\n" + ."\n" + .'> 不设置该参数表示查询所有类型的目的地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的描述信息。支持模糊查询。'."\n" + ."\n" + .'> 不设置该参数表示查询所有策略的描述信息。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中访问流量的协议类型。取值：'."\n" + ."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + .'- **ANY**（表示所有协议类型）'."\n" + .'> 不设置该参数表示查询所有协议类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中设置的流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + ."\n" + .'- **drop**：拒绝'."\n" + ."\n" + .'- **log**：观察'."\n" + ."\n" + .'> 不设置该参数表示查询所有的动作类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + ."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。', + 'type' => 'string', + 'required' => false, + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '支持的IP地址版本。取值：'."\n" + ."\n" + .'- **4**（默认）：代表IPv4地址'."\n" + ."\n" + .'- **6**：代表IPv6地址', + 'type' => 'string', + 'required' => false, + 'example' => '6', + 'enum' => [ + '4', + '6', + ], + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****', + ], + 'TotalCount' => [ + 'description' => '访问控制策略的总数量。', + 'type' => 'string', + 'example' => '100', + ], + 'Policys' => [ + 'description' => '访问控制策略的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '无', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '访问控制策略的流量方向。取值：'."\n" + ."\n" + .'- **in**：外对内流量访问控制'."\n" + .'- **out**：内对外流量访问控制', + 'type' => 'string', + 'example' => 'in', + ], + 'Order' => [ + 'description' => '访问控制策略生效的优先级。'."\n" + ."\n" + .'优先级数字从1开始顺序递增，优先级数字越小，优先级越高。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SourceType' => [ + 'description' => '访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR地址）'."\n" + .'- **group**：源地址簿'."\n" + .'- **location**：源区域', + 'type' => 'string', + 'example' => 'net', + ], + 'ApplicationName' => [ + 'description' => '访问控制策略支持的应用类型，推荐使用ApplicationNameList。取值：'."\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**（表示所有应用类型）', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'HitTimes' => [ + 'description' => '访问控制策略的命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Description' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'SourceGroupType' => [ + 'description' => '访问控制策略中的源地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿，包含一个或多个ECS标签下的IP地址。'."\n" + ."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。'."\n" + ."\n" + .'- **threat**：威胁地址簿，包含一个或多个恶意IP或域名地址。'."\n" + ."\n" + .'- **backsrc**：回源地址簿，包含一个或多个DDoS防护实例或WAF实例的回源地址。'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'DnsResultTime' => [ + 'description' => 'DNS解析的时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DnsResult' => [ + 'description' => 'DNS解析结果。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '192.0.XX.XX,192.0.XX.XX', + ], + 'Proto' => [ + 'description' => '访问控制策略中流量访问的安全协议类型。取值：'."\n" + ."\n" + .'- **ANY**'."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**', + 'type' => 'string', + 'example' => 'TCP', + ], + 'DestinationGroupType' => [ + 'description' => '访问控制策略中的目的地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿，包含一个或多个ECS标签下的IP地址。'."\n" + ."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。'."\n" + ."\n" + .'- **threat**：威胁地址簿，包含一个或多个恶意IP或域名地址。'."\n" + ."\n" + .'- **backsrc**：回源地址簿，包含一个或多个DDoS防护实例或WAF实例的回源地址。'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'Destination' => [ + 'description' => '访问控制策略中的目的地址。DestinationType（目的类型）不同，目的地址的取值也不同。取值：'."\n" + ."\n" + .'- 当**DestinationType**为**net**时，目的地址为CIDR格式的IP地址段。例如：192.0.XX.XX/24。'."\n" + .'- 当**DestinationType**为**domain**时，目的地址为域名。例如：aliyuncs.com。'."\n" + .'- 当**DestinationType**为**group**时，目的地址为地址簿的名称。例如：db_group。'."\n" + .'- 当**DestinationType**为**location**时，目的地址为区域名称（具体区域位置编码请参见AddControlPolicy。例如： \\["BJ11", "ZB"\\]。', + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'HitLastTime' => [ + 'description' => '最新命中时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DestPortGroup' => [ + 'description' => '访问控制策略中流量访问的目的端口地址簿名称。', + 'type' => 'string', + 'example' => 'my_port_group', + ], + 'AclUuid' => [ + 'description' => '访问控制策略的唯一标识ID。', + 'type' => 'string', + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + 'DestPortType' => [ + 'description' => '访问控制策略中流量访问的目的端口类型。取值：'."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => '访问控制策略中的访问源地址。取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，访问源为CIDR格式的IP地址段。例如：192.0.XX.XX/24。'."\n" + .'- 当**SourceType**为`group`时，访问源地址为源地址簿名称。例如：db_group。'."\n" + .'- 当**SourceType**为`location`时，访问源地址为区域（具体区域位置编码请参见[AddControlPolicy](~~138867~~)）。例如： \\["BJ11", "ZB"\\]。'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'DestinationType' => [ + 'description' => '访问控制策略中的目的地址类型。取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n" + .'- **location**：目的区域', + 'type' => 'string', + 'example' => 'net', + ], + 'DestPort' => [ + 'description' => '访问控制策略中访问流量的目的端口。', + 'type' => 'string', + 'example' => '80', + ], + 'IpVersion' => [ + 'description' => '支持的IP地址版本。取值：'."\n" + ."\n" + .'- **4**：代表IPv4地址'."\n" + .'- **6**：代表IPv6地址', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'AclAction' => [ + 'description' => '访问控制策略中设置的流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'example' => 'accept', + ], + 'Release' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + ."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'example' => 'true', + ], + 'ApplicationId' => [ + 'description' => '访问控制策略中设置访问流量的应用ID。', + 'type' => 'string', + 'example' => '10***', + ], + 'DestinationGroupCidrs' => [ + 'description' => '访问控制策略中的目的地址簿中的网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略中的目的地址簿中的网段。', + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + ], + 'DestPortGroupPorts' => [ + 'description' => '目的端口地址簿中包含的端口列表。', + 'type' => 'array', + 'items' => [ + 'description' => '目的端口地址簿中包含的端口。', + 'type' => 'string', + 'example' => '80/80', + ], + ], + 'SourceGroupCidrs' => [ + 'description' => '访问控制策略中的源地址簿中的网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略中的源地址簿中的网段。', + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + ], + 'ApplicationNameList' => [ + 'description' => '应用名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略支持的应用类型列表。取值：'."\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**（表示所有应用类型）', + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + 'SpreadCnt' => [ + 'description' => '占用访问控制策略的规格数，即每条策略占用规格数的累加值。'."\n" + .'单条策略占用的规格数 = 源地址个数（IP地址段个数或区域个数）\\* 目的地址个数（IP地址段个数或区域个数或域名个数）\\* 端口段个数 \\* 应用数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'CreateTime' => [ + 'description' => '创建策略的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ModifyTime' => [ + 'description' => '修改策略的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'RepeatType' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + 'RepeatDays' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'RepeatStartTime' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'example' => '08:00', + ], + 'RepeatEndTime' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694761200', + ], + 'EndTime' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694764800', + ], + 'DomainResolveType' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'* **FQDN**：基于FQDN'."\n" + .'* **DNS**：基于DNS动态解析'."\n" + .'* **FQDN_AND_DNS**：基于FQDN与DNS动态解析', + 'type' => 'string', + 'example' => 'FQDN', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取所有访问控制策略的信息', + 'description' => '本接口一般用于分页查询访问控制策略的信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeACLProtectTrend' => [ + 'summary' => '查询互联网访问控制拦截趋势图。', + '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' => '本参数已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => '223.95.87.130', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询开始时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => false, + 'example' => '1677050306', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询结束时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => false, + 'example' => '1670397599', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => '9063AB86-6FFA-5B2D-A16D-697C966DECA3', + ], + 'Interval' => [ + 'description' => '返回数据的步长，单位为秒，即每隔多少秒返回一个结果。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '86400', + ], + 'TotalProtectCnt' => [ + 'description' => '互联网访问控制总拦截数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'InProtectCnt' => [ + 'description' => '互联网访问控制外对内拦截次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'InterVPCProtectCnt' => [ + 'description' => '本参数已废弃。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OutProtectCnt' => [ + 'description' => '互联网访问控制内对外拦截次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'TrendList' => [ + 'description' => '互联网访问控制拦截趋势数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '每天0点的时间戳，单位为秒，表示当天的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1697299200', + ], + 'ProtectCnt' => [ + 'description' => '互联网访问控制当天拦截数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询互联网访问控制拦截趋势图', + ], + 'DescribePolicyAdvancedConfig' => [ + 'summary' => '查询访问控制策略严格模式的开启状态。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InternetSwitch' => [ + 'description' => '访问控制策略严格模式的开启状态。取值：'."\n" + .'- **on**：严格模式已开启。'."\n" + .'- **off**：严格模式已关闭。', + 'type' => 'string', + 'example' => 'off', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '查询访问控制策略严格模式的开启状态', + 'description' => '本接口一般用于查询访问控制策略严格模式的开启状态。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePolicyPriorUsed' => [ + 'summary' => '查询访问控制策略优先级生效范围。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的流量方向。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **in**：外对内流量。'."\n" + .'- **out**：内对外流量。', + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙防护的资产的IP版本。'."\n" + ."\n\n" + .'取值：'."\n" + ."\n" + .'- **4**（默认）：IpV4'."\n" + ."\n" + .'- **6**：IpV6', + 'type' => 'string', + 'required' => false, + 'example' => '6', + 'enum' => [ + '4', + '6', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '您已创建的访问控制策略的最低优先级。'."\n" + ."\n" + .'> -1表示最低优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'Start' => [ + 'description' => '您已创建的访问控制策略的最高优先级。'."\n" + ."\n" + .'> 0表示最高优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + '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' => '查询访问控制策略优先级使用范围', + 'description' => '本接口一般用于查询外对内流量或内对外流量访问控制策略优先级生效范围。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + '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' => '地域ID。', + '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' => '支持的IP地址版本。', + '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' => '支持的IP地址版本。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 4 => '4', + 6 => '6', + ], + 'example' => '4', + ], + 'IpAddrList' => [ + 'description' => 'IP地址列表参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '['."\n" + .' "10.10.10.1"'."\n" + .']', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询访问控制策略的域名解析结果', + ], + 'AddControlPolicy' => [ + 'summary' => '添加访问控制策略。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中设置的流量通过云防火墙的方式。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => true, + 'example' => 'accept', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略支持的应用类型。取值：'."\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" + .'> 支持的应用类型取值与协议类型（Proto）取值存在依赖关系。Proto为TCP协议时，ApplicationName支持选择以上所有应用类型中的任意一种；Proto为UDP、ICMP或ANY协议类型时，ApplicationName仅支持选择ANY。ApplicationNameList和ApplicationName二选一，必须传其中一个，不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANY', + 'deprecated' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'required' => true, + 'example' => '放行流量', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中流量访问的目的端口。取值：'."\n" + ."\n" + .'- 当协议类型为ICMP时，DestPort取值为空。'."\n" + .' '."\n" + .'> 协议类型为ICMP时，不支持对目的端口进行访问控制。'."\n" + ."\n" + .'- 当协议类型为TCP、UDP或ANY时，并且目的端口类型（DestPortType）为group时，DestPort取值为空。'."\n" + ."\n" + .'> 访问控制策略目的端口类型选择group（目的端口地址簿）时，您无需设置具体的目的端口号。需要该访问控制策略管控的所有端口会包含在目的端口地址簿中。'."\n" + ."\n" + .'- 当协议类型为TCP、UDP或ANY时，并且目的端口类型（DestPortType）为port时，DestPort取值为目的端口号。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址段。'."\n" + ."\n" + .'取值：'."\n" + .'- 当DestinationType为net时，Destination为目的CIDR。'."\n" + .' '."\n" + .' 例如：1.2.XX.XX/24'."\n" + ."\n" + .'- 当DestinationType为group时，Destination为目的地址簿名称。'."\n" + ."\n" + .' 例如：db_group'."\n" + ."\n" + .'- 当DestinationType为domain时，Destination为目的域名。'."\n" + ."\n" + .' 例如：*.aliyuncs.com'."\n" + ."\n" + .'- 当DestinationType为location时，Destination为目的区域。'."\n" + ."\n" + .' 例如： \\["BJ11", "ZB"\\]'."\n" + ."\n" + .'> 当Destination为目的区域时，更多信息，请参见 [地区编号](~~2854161~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址类型。取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR地址）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n" + .'- **location**：目的区域', + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的流量方向。取值：'."\n" + ."\n" + .'- **in**：外对内流量访问控制'."\n" + .'- **out**：内对外流量访问控制', + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中流量访问的协议类型。取值：'."\n" + ."\n" + .'- **ANY**（任何协议）'."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + ."\n" + .'> 流量方向为出向时，访问的目的地址为域名类型的威胁情报地址簿或云服务地址簿时，只允许配置TCP协议，应用可选HTTP/HTTPS/SMTP/SMTPS/SSL五种。', + 'type' => 'string', + 'required' => true, + 'example' => 'ANY', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址。取值：'."\n" + ."\n" + .'- 当SourceType为net时，Source为源CIDR地址。'."\n" + ."\n" + .' 例如：1.1.XX.XX/24'."\n" + ."\n" + .'- 当SourceType为group时，Source为源地址簿名称。'."\n" + ."\n" + .' 例如：db_group'."\n" + ."\n" + .'- 当SourceType为location时，Source为源区域。'."\n" + ."\n" + .' 例如\\["BJ11", "ZB"\\]'."\n" + ."\n" + .'> 当Source为源区域时，更多信息，请参见 [地区编号](~~2854161~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址类型。取值：'."\n" + .'- **net**：源网段（CIDR）'."\n" + .'- **group**：源地址簿'."\n" + .'- **location**：源区域', + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略生效的优先级。优先级数字从1开始顺序递增，优先级数字越小，优先级越高。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中流量访问的目的端口类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中访问流量的目的端口地址簿名称。'."\n" + ."\n\n" + .'> DestPortType设置为group时，您需要设置目的端口地址簿名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + .'- **true**：启用访问控制策略'."\n" + ."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '支持的IP地址版本。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **4**：表示IPv4地址'."\n" + ."\n" + .'- **6**：表示IPv6地址', + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '访问控制策略支持的应用类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略支持的应用类型。取值：'."\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" + .'> 支持的应用类型取值与协议类型（Proto）取值存在依赖关系。Proto为TCP协议时，ApplicationNameList支持选择以上所有应用类型，使用`["HTTP","HTTPS",……]`格式表示；Proto为UDP、ICMP或ANY协议类型时，ApplicationNameList仅支持选择ANY。ApplicationNameList和ApplicationName二选一，必须传其中一个，不能同时为空。当ApplicationNameList和ApplicationName同时传值时，以ApplicationNameList为准。', + 'type' => 'string', + 'required' => false, + 'example' => '["ANY"]', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'* **FQDN**：基于FQDN'."\n" + .'* **DNS**：基于DNS动态解析'."\n" + .'* **FQDN_AND_DNS**：基于FQDN与DNS动态解析', + 'type' => 'string', + 'required' => false, + 'example' => 'FQDN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AclUuid' => [ + 'description' => '互联网边界防火墙访问控制策略的唯一标识ID。', + 'type' => 'string', + 'example' => '00281255-d220-4db1-8f4f-c4df221ad84c', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + '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' => '添加访问控制策略', + 'description' => '您可以使用本接口创建一条对经过云防火墙流量放行、拒绝或观察的策略。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + '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' => '地域ID。', + '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' => '本次请求的ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + '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"}]', + 'title' => '创建域名解析实时任务', + ], + 'ModifyControlPolicy' => [ + 'summary' => '修改安全访问控制策略的配置信息。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量通过云防火墙的方式。取值：'."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略支持的应用类型。支持的应用类型有以下几种：'."\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" + .'> **ANY**表示策略应用在所有类型的应用中。'."\n" + ."\n" + .'> ApplicationNameList和ApplicationName二选一，必须传其中一个，不能同时为空。当ApplicationNameList和ApplicationName同时传值时，以ApplicationNameList为准。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量访问的目的端口。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中的目的地址。'."\n" + ."\n" + .'- 当**DestinationType**为net时，**Destination**为目的CIDR。例如：1.2.XX.XX/24'."\n" + .'- 当**DestinationType**为group时，**Destination**为目的地址簿名称。例如：db_group'."\n" + .'- 当**DestinationType**为domain时，**Destination**为目的域名。例如：*.aliyuncs.com'."\n" + .'- 当**DestinationType**为location时，**Destination**为目的区域（具体区域位置编码见后文）。例如： \\["BJ11", "ZB"\\]', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中的目的地址类型。取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n" + .'- **location**：目的区域', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略的流量方向。取值：'."\n" + ."\n" + .'- **in**：外对内流量访问控制'."\n" + .'- **out**：内对外流量访问控制', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量访问的安全协议类型。支持的应用类型有以下几种：'."\n" + ."\n" + .'- **ANY**'."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + ."\n" + .'> **ANY**表示策略应用在所有类型的应用中。'."\n" + ."\n" + .'> 流量方向为出向时，访问的目的地址为域名类型的威胁情报地址簿或云服务地址簿时，可选配置TCP/ANY协议。选择TCP时，应用可选HTTP/HTTPS/SMTP/SMTPS/SSL五种，选择ANY时，应用可选ANY。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中的源地址。'."\n" + ."\n" + .'- 当**SourceType**为net时，**Source**为源CIDR。例如：1.2.XX.XX/24'."\n" + .'- 当**SourceType**为group时，**Source**为源地址簿名称。例如：db_group'."\n" + .'- 当**SourceType**为location时，**Source**为源区域（具体区域位置编码见后文）。例如\\["BJ11", "ZB"\\]', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略的唯一标识ID。'."\n" + ."\n" + .'> 修改安全访问控制策略，需要提供该策略的唯一标识ID，该ID可调用[DescribeControlPolicy](~~138866~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df221ad84c', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR）'."\n" + .'- **group**：源地址簿'."\n" + ."\n" + .'- **location**：源区域', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量访问的目的端口类型。取值：'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量访问的目的端口地址簿名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略的状态。取值：'."\n" + ."\n" + .'- true：策略开启状态'."\n" + .'- false：策略关闭状态', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用名称列表。'."\n" + ."\n" + .'> ApplicationNameList和ApplicationName二选一，必须传其中一个，不能同时为空。当ApplicationNameList和ApplicationName同时传值时，以ApplicationNameList为准。', + 'type' => 'array', + 'items' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'* **FQDN**：基于FQDN'."\n" + .'* **DNS**：基于DNS动态解析'."\n" + .'* **FQDN_AND_DNS**：基于FQDN与DNS动态解析', + 'type' => 'string', + 'required' => false, + 'example' => 'FQDN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + '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' => '修改安全访问控制策略的配置信息', + 'description' => '本接口一般用于修改流量通过云防火墙方式为放行、拒绝或观察的访问控制策略的配置信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyControlPolicyPriority' => [ + 'summary' => '修改访问控制策略的优先级。', + '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' => '访问控制策略唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '3770d603-3534-4878-b845-f00095ee****', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略生效的优先级。', + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求id。', + 'type' => 'string', + 'example' => '586F34E8-3F16-4C08-9FFC-8FFDC64B****', + ], + ], + ], + ], + ], + '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' => '修改访问控制策略的优先级', + 'description' => '本接口一般用于修改流量通过云防火墙方式为放行、拒绝或观察的访问控制策略的配置信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyPolicyAdvancedConfig' => [ + 'summary' => '开启或关闭访问控制策略严格模式。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'InternetSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '修改访问控制策略严格模式的开关状态。取值：'."\n" + ."\n" + .'- **on**：开启严格模式。'."\n" + .'- **off**：关闭严格模式。', + 'type' => 'string', + 'required' => true, + 'example' => 'off', + ], + ], + [ + 'name' => 'Eips', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'IP列表，多个IP的协议版本需要保持一致，数量最多100个。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '开启或关闭访问控制策略严格模式', + 'description' => '本接口一般用于开启或关闭访问控制策略严格模式。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteControlPolicy' => [ + 'summary' => '删除访问控制策略。', + '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' => '流量的源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。'."\n" + ."\n" + .'删除安全访问控制策略，需要提供该策略的唯一标识ID。您可调用[DescribeControlPolicy](~~138866~~)接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df221ad84c', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略管控的流量方向。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **in**：流量从外到内。'."\n" + .'- **out**：流量从内到外。', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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' => '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' => '删除访问控制策略', + 'description' => '本接口一般用于删除流量方向为外对内或内对外的访问控制策略。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteControlPolicyTemplate' => [ + 'summary' => '删除ACL模板。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '61.178.12.52', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '719ce620-ae23-4e42-9f93-9191b4400b55', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '4E7F94C7-781F-5192-86CF-DB085013C810', + ], + ], + ], + ], + ], + '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' => '删除ACL模板', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '112.64.126.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '重置规则命中数', + 'description' => '本接口一般用于将指定的VPC防火墙策略组访问控制策略的命中计数清零。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeNatAclPageStatus' => [ + 'summary' => '查询NAT防火墙分页状态。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NatAclPageEnable' => [ + 'description' => '是否支持NAT ACL独立页面支持。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'B97F9AD7-A2DB-5F8F-9206-DF89DE0AC9E8', + ], + 'Detail' => [ + 'description' => '异常详细信息。', + 'type' => 'string', + 'example' => 'proxy_not_exist', + ], + ], + ], + ], + ], + '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' => '查询NAT防火墙分页状态', + ], + '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' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'F06DE24D-6EB9-5F55-B588-7BB946DF****', + ], + 'NatFirewalls' => [ + 'description' => 'NAT防火墙列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'NAT防火墙列表。', + 'type' => 'object', + 'properties' => [ + 'NatGatewayId' => [ + 'description' => 'NAT网关ID。', + 'type' => 'string', + 'example' => 'ngw-2zed6z6qkd7ogc****', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关名称', + 'type' => 'string', + 'example' => 'ngw-test', + ], + 'IsDefault' => [ + 'description' => '是否默认NAT防火墙。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'AclRuleCount' => [ + 'description' => 'NAT边界防火墙访问控制策略组的策略数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + '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"}]', + 'title' => '查询NAT防火墙分组列表', + ], + 'DescribeNatFirewallControlPolicy' => [ + 'summary' => '获取所有NAT防火墙访问控制策略的信息。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的NAT网关的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页的页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为10.', + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的访问源地址。支持使用模糊查询的方式进行查询。SourceType（源类型）不同，访问源地址的取值也不同。'."\n" + ."\n" + .'- 当SourceType为`net`时，访问源为CIDR格式的IP地址段。例如：192.0.XX.XX/24。'."\n" + ."\n" + .'- 当SourceType为`group`时，访问源为源地址簿名称。例如：db_group为空（表示查询所有访问控制源）。'."\n" + ."\n" + .'- 当SourceType为`location`时，访问源为源区域。例如：北京或beijing（支持使用中文或英文进行查询）。'."\n" + ."\n" + .'> 不设置该参数表示查询所有类型的访问源。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1/32', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址。支持模糊查询。DestinationType（目的类型）不同，目的地址的取值也不同。'."\n" + ."\n" + .'- 当DestinationType为`net`时，目的地址为CIDR格式的IP地址段。例如：10.0.3.0/24。'."\n" + ."\n" + .'- 当DestinationType为`domain`时，目的地址为域名。例如：aliyun。'."\n" + ."\n" + .'- 当DestinationType为`group`时，目的地址为地址簿的名称。例如：db_group。'."\n" + ."\n" + .'- 当DestinationType为`location`时，目的地址为区域名称（具体区域位置编码请参见[AddControlPolicy](~~474128~~)）。例如：["BJ11", "ZB"]。'."\n" + ."\n" + .'> 不设置该参数表示查询所有类型的目的地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'x.x.x.x/32', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的描述信息。支持模糊查询。'."\n" + ."\n" + .'> 不设置该参数表示查询所有策略的描述信息。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '描述信息', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中访问流量的协议类型。取值：'."\n" + ."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + .'- **ANY**（表示所有协议类型）'."\n" + .'> 不设置该参数表示查询所有协议类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANY', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中访问流量通过云防火墙的方式（动作）。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。', + 'type' => 'string', + 'required' => false, + 'example' => '323f0697-2a21-4e43-b142-*****', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + ."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略控制的流量方向。取值：'."\n" + .'- **out**：内对外方向的流量访问控制。', + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'string', + 'example' => '28', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'F283567D-8A52-5BAE-9472-*****', + ], + 'Policys' => [ + 'description' => 'NAT防火墙访问控制策略的信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'NAT防火墙访问控制策略的信息。', + 'type' => 'object', + 'properties' => [ + 'Destination' => [ + 'description' => '访问控制策略中的目的地址。DestinationType（目的类型）不同，目的地址的取值也不同。取值：'."\n" + ."\n" + .'- 当**DestinationType**为**net**时，目的地址为CIDR格式的IP地址段。例如：192.0.XX.XX/24。'."\n" + ."\n" + .'- 当**DestinationType**为**domain**时，目的地址为域名。例如：aliyuncs.com。'."\n" + ."\n" + .'- 当**DestinationType**为**group**时，目的地址为地址簿的名称。例如：db_group。'."\n" + ."\n" + .'- 当**DestinationType**为**location**时，目的地址为区域名称（具体区域位置编码请参见[AddControlPolicy](~~138867~~)）。例如： \\["BJ11", "ZB"\\]。'."\n" + ."\n" + .' ', + 'type' => 'string', + 'example' => 'x.x.x.x/32', + ], + 'Order' => [ + 'description' => '访问控制策略生效的优先级。'."\n" + ."\n" + .'优先级数字从1开始顺序递增，优先级数字越小，优先级越高。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DestPortGroup' => [ + 'description' => '访问控制策略中流量访问的目的端口地址簿名称。', + 'type' => 'string', + 'example' => 'my_port_group', + ], + 'SourceType' => [ + 'description' => '访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR地址）'."\n" + .'- **group**：源地址簿'."\n" + .'- **location**：源区域', + 'type' => 'string', + 'example' => 'net', + ], + 'DnsResultTime' => [ + 'description' => 'DNS解析的时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DnsResult' => [ + 'description' => 'DNS解析结果。', + 'type' => 'string', + 'example' => '111.0.XX.XX,112.0.XX.XX', + ], + 'ApplicationNameList' => [ + 'description' => '应用名称，支持多选。', + 'type' => 'array', + 'items' => [ + 'description' => '应用名称，支持多选。', + 'type' => 'string', + 'example' => '[\'HTTP\', \'HTTPS\']', + ], + ], + 'AclUuid' => [ + 'description' => '访问控制策略的唯一标识ID。', + 'type' => 'string', + 'example' => '01281255-d220-4db1-8f4f-c4df221a****', + ], + 'DestPortType' => [ + 'description' => '访问控制策略中流量访问的目的端口类型。取值：'."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => '访问控制策略中的访问源地址。取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，访问源为CIDR格式的IP地址段。例如：192.0.XX.XX/24。'."\n" + .'- 当**SourceType**为`group`时，访问源地址为源地址簿名称。例如：db_group。'."\n" + .'- 当**SourceType**为`location`时，访问源地址为区域（具体区域位置编码请参见[AddControlPolicy](~~138867~~)）。例如： \\["BJ11", "ZB"\\]。'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'DestinationType' => [ + 'description' => '访问控制策略中的目的地址类型。取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n" + .'- **location**：目的区域', + 'type' => 'string', + 'example' => 'net', + ], + 'HitTimes' => [ + 'description' => '访问控制策略的命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'HitLastTime' => [ + 'description' => '最新命中时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DestPort' => [ + 'description' => '访问控制策略中访问流量的目的端口。', + 'type' => 'string', + 'example' => '80', + ], + 'Description' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'example' => '描述信息', + ], + 'AclAction' => [ + 'description' => '访问控制策略中设置的流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'example' => 'accept', + ], + 'Proto' => [ + 'description' => '访问控制策略中流量访问的安全协议类型。取值：'."\n" + ."\n" + .'- **ANY**'."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**', + 'type' => 'string', + 'example' => 'TCP', + ], + 'DestinationGroupCidrs' => [ + 'description' => '访问控制策略中的目的地址簿中的网段列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略中的目的地址簿中的网段列表。'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "112.0.XX.XX/24",'."\n" + .' "112.0.XX.XX/32"'."\n" + .']', + ], + ], + 'DestPortGroupPorts' => [ + 'description' => '目的端口地址簿中包含的端口列表。', + 'type' => 'array', + 'items' => [ + 'description' => '目的端口地址簿中包含的端口列表。', + 'type' => 'string', + 'example' => '[80,443]', + ], + ], + 'SourceGroupCidrs' => [ + 'description' => '访问控制策略中的源地址簿中的网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略中的源地址簿中的网段列表。', + 'type' => 'string', + 'example' => '[\'192.0.XX.XX/24\', \'192.0.XX.XX/32\']', + ], + ], + 'Release' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + ."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'example' => 'true', + ], + 'SourceGroupType' => [ + 'description' => '访问控制策略中的源地址簿类型。唯一取值： **ip**。表示IP地址簿，包含一个或多个IP地址段。', + 'type' => 'string', + 'example' => 'ip', + ], + 'DestinationGroupType' => [ + 'description' => '访问控制策略中的目的地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + ."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。', + 'type' => 'string', + 'example' => 'ip', + ], + 'NatGatewayId' => [ + 'description' => '要查询的NAT网关的ID。', + 'type' => 'string', + 'example' => 'ngw-xxxxxx', + ], + 'DomainResolveType' => [ + 'description' => '访问控制策略的域名解析方式。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **0**：基于FQDN'."\n" + .'- **1**：基于DNS动态解析'."\n" + .'- **2**：基于FQDN与DNS动态解析', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SpreadCnt' => [ + 'description' => '占用访问控制策略的规格数，即每条策略占用规格数的累加值。'."\n" + .'单条策略占用访问控制策略的规格数=访问源地址段个数 \\* 目的地址个数（IP地址段个数或区域个数或域名个数）\\* 应用数 \\* 端口段个数。', + 'type' => 'string', + 'example' => '10,000', + ], + 'CreateTime' => [ + 'description' => '创建策略的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ModifyTime' => [ + 'description' => '修改策略的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'RepeatType' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + 'RepeatDays' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'RepeatStartTime' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'example' => '08:00', + ], + 'RepeatEndTime' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694761200', + ], + 'EndTime' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694764800', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取所有NAT防火墙访问控制策略的信息', + 'description' => '本接口一般用于分页查询NAT防火墙访问控制策略的信息。', + ], + 'DescribeNatFirewallPolicyPriorUsed' => [ + 'summary' => '查询NAT防火墙访问控制策略优先级生效范围。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的流量方向。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **out**：内对外流量。', + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '支持的IP地址版本。取值：'."\n" + ."\n" + .'- **4**（默认）：代表IPv4地址', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '访问控制策略生效的优先级最低值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + 'Start' => [ + 'description' => '访问控制策略生效的优先级最高值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'BCDF3907-1011-5504-B015-CC7603C0E6B6', + ], + ], + ], + ], + ], + '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' => '查询NAT防火墙访问控制策略优先级使用范围', + 'description' => '本接口一般用于查询NAT防火墙内对外流量访问控制策略优先级生效范围。', + ], + 'CreateNatFirewallControlPolicy' => [ + 'summary' => '添加NAT防火墙访问控制策略。', + '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' => '接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**：（默认）中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中访问流量通过云防火墙的方式（动作）。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => true, + 'example' => 'log', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '访问控制策略支持的应用类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略支持的应用类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANY', + ], + 'required' => true, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'required' => true, + 'example' => '放行流量', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中流量访问的目的端口。取值：'."\n" + ."\n" + .'- 当协议类型为ICMP时，DestPort取值为空。'."\n" + .' '."\n" + .'> 协议类型为ICMP时，不支持对目的端口进行访问控制。'."\n" + ."\n" + .'- 当协议类型为TCP、UDP或ANY时，并且目的端口类型（DestPortType）为group时，DestPort取值为空。'."\n" + ."\n" + .'> 访问控制策略目的端口类型选择group（目的端口地址簿）时，您无需设置具体的目的端口号。需要该访问控制策略管控的所有端口会包含在目的端口地址簿中。'."\n" + ."\n" + .'- 当协议类型为TCP、UDP或ANY时，并且目的端口类型（DestPortType）为port时，DestPort取值为目的端口号。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址段。'."\n" + ."\n" + .'取值：'."\n" + .'- 当DestinationType为net时，Destination为目的CIDR。'."\n" + .' '."\n" + .' 例如：1.2.XX.XX/24'."\n" + ."\n" + .'- 当DestinationType为group时，Destination为目的地址簿名称。'."\n" + ."\n" + .' 例如：db_group'."\n" + ."\n" + .'- 当DestinationType为domain时，Destination为目的域名。'."\n" + ."\n" + .' 例如：*.aliyuncs.com'."\n" + ."\n" + .'- 当DestinationType为location时，Destination为目的区域。'."\n" + ."\n" + .' 例如： \\["BJ11", "ZB"\\]', + 'type' => 'string', + 'required' => true, + 'example' => 'XX.XX.XX.XX/24', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR地址）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名', + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-2vc2ustolqn6sr0******', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中流量访问的安全协议类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- ANY（表示查询所有协议类型）'."\n" + .'- TCP'."\n" + .'- UDP'."\n" + .'- ICMP'."\n" + ."\n" + .'> 访问的目的地址为域名类型的威胁情报地址簿或云服务地址簿时，只允许配置TCP协议，应用可选HTTP/HTTPS/SMTP/SMTPS/SSL五种。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'ANY', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，Source为源CIDR地址。'."\n" + ."\n" + .' 例如：10.2.4.0/24'."\n" + ."\n" + .'- 当**SourceType**为`group`时，Source为源地址簿名称。'."\n" + ."\n" + .' 例如：db_group', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.25/32', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR地址）'."\n" + .'- **group**：源地址簿'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略生效的优先级。优先级数字从1开始顺序递增，优先级数字越小，优先级越高。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中访问流量的目的端口类型。'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中访问流量的目的端口地址簿名称。'."\n" + ."\n\n" + .'> DestPortType设置为group时，您需要设置目的端口地址簿名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'- **0**：基于FQDN'."\n" + .'- **1**：基于DNS动态解析'."\n" + .'- **2**：基于FQDN与DNS动态解析', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '支持的IP地址版本。取值：'."\n" + ."\n" + .'- **4**（默认）：代表IPv4地址', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的流量方向。取值：'."\n" + ."\n" + .'- **out**：内对外流量访问控制', + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AclUuid' => [ + 'description' => '安全访问控制策略的唯一标识ID。'."\n" + ."\n" + .'> 修改安全访问控制策略，需要提供该策略的唯一标识ID，该ID可调用DescribeNatFirewallControlPolicy接口获取。', + 'type' => 'string', + 'example' => '6504d2fb-ab36-49c3-92a6-*****', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '0DC783F1-B3A7-578D-8A63-*****', + ], + ], + ], + ], + ], + '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' => '添加NAT防火墙访问控制策略', + 'description' => '使用本接口创建一条对经过NAT防火墙流量放行、拒绝或观察的策略。', + ], + 'ModifyNatFirewallControlPolicy' => [ + 'summary' => '修改NAT防火墙安全访问控制策略的配置信息。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量通过云防火墙的方式。取值：'."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => false, + 'example' => 'log', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的描述信息。支持模糊查询。'."\n" + ."\n" + .'> 不设置该参数表示查询所有策略的描述信息。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '描述信息', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中流量访问的目的端口。'."\n" + ."\n" + .'> 当**DestPortType**为`port`时，设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中的目的地址。'."\n" + ."\n" + .'- 当**DestinationType**为net时，**Destination**为目的CIDR。例如：1.2.3.4/24'."\n" + .'- 当**DestinationType**为group时，**Destination**为目的地址簿名称。例如：db_group'."\n" + .'- 当**DestinationType**为domain时，**Destination**为目的域名。例如：*.aliyuncs.com'."\n" + .'- 当**DestinationType**为location时，**Destination**为目的区域（具体区域位置编码见后文）。例如： \\["BJ11", "ZB"\\]', + 'type' => 'string', + 'required' => false, + 'example' => 'x.x.x.x/32', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中的目的地址类型。取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n" + .'- **location**：目的区域', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量访问的安全协议类型。支持的应用类型有以下几种：'."\n" + ."\n" + .'- **ANY**'."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + ."\n" + .'> **ANY**表示策略应用在所有类型的应用中。'."\n" + ."\n" + .'> 访问的目的地址为域名类型的威胁情报地址簿或云服务地址簿时，可选配置TCP协议。选择TCP时，应用可选HTTP/HTTPS/SMTP/SMTPS/SSL五种。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址。取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，Source为源CIDR地址，例如：10.2.XX.XX/24'."\n" + ."\n" + .'- 当**SourceType**为`group`时，Source为源地址簿名称，例如：db_group。', + 'type' => 'string', + 'required' => false, + 'example' => '10.2.XX.XX/24', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。'."\n" + ."\n" + .'删除安全访问控制策略，需要提供该策略的唯一标识ID。您可调用DescribeNatFirewallControlPolicy接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => '63ab1c02-926a-4d1b-9ef7-*****', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的流量方向。取值：'."\n" + .'- **out**：内对外流量。', + 'type' => 'string', + 'required' => false, + 'example' => 'out', + 'default' => 'out', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR地址）'."\n" + .'- **group**：源地址簿', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中访问流量的目的端口类型。'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中访问流量的目的端口地址簿名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_dest_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略的状态。取值：'."\n" + ."\n" + .'- **true**：策略开启状态'."\n" + ."\n" + .'- **false**：策略关闭状态', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用名称', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略支持的应用类型列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANY', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'- **0**：基于FQDN'."\n" + .'- **1**：基于DNS动态解析'."\n" + .'- **2**：基于FQDN与DNS动态解析', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '3768197C-E6E8-52CD-8358-*****', + ], + ], + ], + ], + ], + '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' => '修改NAT防火墙访问控制策略的配置信息', + 'description' => '本接口一般用于修改流量通过NAT防火墙方式为放行、拒绝或观察的访问控制策略的配置信息。', + ], + 'ModifyNatFirewallControlPolicyPosition' => [ + 'summary' => '修改NAT防火墙访问控制策略的优先级。', + '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' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => ' NAT网关的ID。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的流量方向。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **out**：内对外流量。', + 'type' => 'string', + 'required' => false, + 'example' => 'out', + 'default' => 'out', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '为NAT防火墙IPv4访问控制策略设置一个新的优先级。'."\n" + .'优先级使用数字表示，输入数字1表示优先级最高，数字越大优先级越低。'."\n" + ."\n" + .'> 新的优先级数字不能超出您已创建的NAT防火墙IPv4策略优先级的范围，否则会导致调用该接口时出错。'."\n" + ."\n" + .'建议您在调用该接口前，先调用DescribeNatFirewallPolicyPriorUsed查询NAT防火墙指定流量方向的IPv4策略优先级范围。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略的唯一标识ID。', + 'type' => 'string', + 'required' => true, + 'example' => '66461eea-e659-4225-84c9-*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '68617208-F5F7-5B44-BB1E-*****', + ], + ], + ], + ], + ], + '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' => '修改NAT防火墙访问控制策略的优先级', + ], + 'ResetNatFirewallRuleHitCount' => [ + 'summary' => '重置NAT防火墙命中数。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '3de3aed5-6de7-4ecd-9106-cfe994b9c49f', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-zm0h3c1exm5bifuorg8c5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '5CAA0FFD-4B94-5BB9-8B0A-ECFC86A0E666', + ], + ], + ], + ], + ], + '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' => '重置NAT防火墙命中数', + ], + 'DeleteNatFirewallControlPolicy' => [ + 'summary' => '删除NAT防火墙访问控制策略。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。'."\n" + ."\n" + .'删除安全访问控制策略，需要提供该策略的唯一标识ID。您可调用DescribeNatFirewallControlPolicy接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'b6c8f905-2eb6-442a-ba35-9416e9dbb2c5', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-xxxxxx', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略管控的流量方向。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **out**：流量从内到外。', + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '31306819-C4BC-56F3-BBE6-*****', + ], + ], + ], + ], + ], + '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' => '删除NAT防火墙访问控制策略', + 'description' => '本接口一般用于删除NAT防火墙流量方向为内对外的访问控制策略。', + ], + 'DeleteNatFirewallControlPolicyBatch' => [ + 'summary' => '批量删除NAT防火墙策略。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'ACL uuid 列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACL uuid。', + 'type' => 'string', + 'required' => true, + 'example' => '6fb052a4-baad-4d86-8e2e-b79cc060535c', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ngw-uf6j0426ap74vd6vrb676', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的流量方向。取值：'."\n" + .'- **out**：内对外流量。', + 'type' => 'string', + 'required' => false, + 'example' => 'out', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '450D47F5-956E-543E-8502-2F71C8C54E72', + ], + ], + ], + ], + ], + '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' => '批量删除NAT防火墙策略', + ], + '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' => '成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。', + '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' => '结果的请求ID。', + '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"}]', + 'title' => '查询VPC防火墙资产已开墙地域', + ], + 'DescribeVpcFirewallAclGroupList' => [ + 'summary' => '获取VPC防火墙所有访问控制策略组信息。', + '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' => '接收消息的语言类型。'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'FirewallConfigureStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC防火墙的配置状态。'."\n" + .'- **configured**：VPC边界防火墙已配置（即已创建了防火墙）。'."\n" + .'- 不填：表示查询所有VPC边界防火墙的访问控制策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'configured', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。'."\n" + .'默认值为1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。'."\n" + .'可设置值最大为50。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'FirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-5b202e7f0be64611****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'VPC防火墙访问控制策略组的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + 'AclGroupList' => [ + 'description' => 'VPC防火墙访问控制策略组的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '无', + 'type' => 'object', + 'properties' => [ + 'AclGroupId' => [ + 'description' => 'VPC边界防火墙的访问控制策略组ID。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网时，策略组ID使用云企业网实例ID。'."\n" + ."\n" + .' 例如：cen-ervw0g12b5jbw*\\*\\*\\*'."\n" + ."\n" + .'- VPC边界防火墙防护高速通道时，策略组ID使用VPC边界防火墙实例ID。'."\n" + ."\n" + .' 例如：vfw-a42bbb7b887148c9*\\*\\*\\*', + 'type' => 'string', + 'example' => 'vfw-a42bbb7b887148c9****', + ], + 'AclGroupName' => [ + 'description' => 'VPC边界防火墙的访问控制策略组名称。'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网时，策略组名称使用云企业网名称。'."\n" + .'- VPC边界防火墙防护高速通道时，策略组名称使用VPC边界防火墙名称。', + 'type' => 'string', + 'example' => 'group_test', + ], + 'MemberUid' => [ + 'description' => '当前阿里云账号的成员账号ID。', + 'type' => 'string', + 'example' => '258039427902****', + ], + 'AclRuleCount' => [ + 'description' => 'VPC边界防火墙访问控制策略组的策略数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'IsDefault' => [ + 'description' => '是否是默认防火墙。取值：'."\n" + .'- **true**：是默认防火墙。'."\n" + .'- **false**：不是默认防火墙。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是默认防火墙', + 'false' => '不是默认防火墙', + ], + 'example' => 'true', + ], + 'AclConfig' => [ + 'description' => 'ACL引擎模式。', + 'type' => 'object', + 'properties' => [ + 'StrictMode' => [ + 'description' => '是否启用严格模式'."\n" + ."\n" + .'- 1：启用严格模式 '."\n" + .'- 0：禁用严格模式', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取VPC防火墙所有访问控制策略组信息', + 'description' => '本接口一般用于查询VPC防火墙所有访问控制策略组信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVpcFirewallControlPolicy' => [ + 'summary' => '查询指定的VPC边界防火墙的所有访问控制策略信息。', + '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' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + ."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。取值：'."\n" + ."\n" + .'- 当VPC边界防火墙防护通过云企业网连接的两个VPC之间的流量时，该参数值使用云企业网实例ID。'."\n" + ."\n" + .'- 当VPC边界防火墙防护通过高速通道连接的两个VPC之间的流量时，该参数值使用VPC边界防火墙实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcFirewallAclGroupList](~~159760~~)接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页的页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置每页包含VPC边界防火墙的访问控制策略数量。'."\n" + ."\n" + .'可设置值最大为50。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中的访问源地址。支持使用模糊查询。'."\n" + ."\n" + .'> Source可以是单个CIDR地址或地址簿名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中的目的地址。支持模糊查询。'."\n" + ."\n" + .'> Destination可以是单个CIDR地址或域名，也可以是地址薄名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略的描述信息。支持模糊查询。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中访问流量的协议类型。取值：'."\n" + ."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + .'- **ANY**（查询所有协议类型）'."\n" + ."\n" + .'> 不设置该参数表示查询所有协议类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中设置的访问流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察'."\n" + ."\n" + .'> 不设置该参数表示查询所有动作。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略的唯一标识ID。', + 'type' => 'string', + 'required' => false, + 'example' => '4037fbf7-3e39-4634-92a4-d0155247****', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'VPC边界防火墙访问控制策略的总数量。', + 'type' => 'string', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + 'Policys' => [ + 'description' => 'VPC边界防火墙访问控制策略的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Destination' => [ + 'description' => 'VPC边界防火墙访问控制策略中的目的地址。取值：'."\n" + ."\n" + .'- 当**DestinationType**为`net`时，Destination为目的CIDR地址。'."\n" + ."\n" + .'- 当**DestinationType**为`domain`时，Destination为目的域名。'."\n" + ."\n" + .'- 当**DestinationType**为`group`时，Destination为目的地址簿名称。'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'Order' => [ + 'description' => 'VPC边界防火墙访问控制策略生效的优先级。'."\n" + ."\n" + .'优先级数字从1开始顺序递增，优先级数字越小，表示优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DestPortGroup' => [ + 'description' => 'VPC边界防火墙访问控制策略中访问流量的目的端口地址簿名称。', + 'type' => 'string', + 'example' => 'my_port_group', + ], + 'SourceType' => [ + 'description' => 'VPC边界防火墙访问控制策略中源地址类型。取值：'."\n" + ."\n" + .'- **net**：源CIDR地址'."\n" + .'- **group**：源地址簿'."\n", + 'type' => 'string', + 'example' => 'net', + ], + 'ApplicationName' => [ + 'description' => 'VPC边界防火墙访问控制策略支持的应用类型，推荐使用ApplicationNameList。取值：'."\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**（表示查询访问控制策略所有的应用类型）', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'AclUuid' => [ + 'description' => 'VPC边界防火墙访问控制策略的唯一标识ID。', + 'type' => 'string', + 'example' => '4037fbf7-3e39-4634-92a4-d0155247****', + ], + 'DestPortType' => [ + 'description' => 'VPC边界防火墙访问控制策略中访问流量的目的端口类型。取值：'."\n" + .'- **port**：单个端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => 'VPC边界防火墙访问控制策略中的访问源地址。取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，Source为访问源CIDR地址。'."\n" + ."\n" + .'- 当**SourceType**为`group`时，Source为地址簿名称。'."\n" + ."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'DestinationType' => [ + 'description' => 'VPC边界防火墙访问控制策略中目的地址的类型。取值：'."\n" + ."\n" + .'- **net**：目的CIDR地址'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n", + 'type' => 'string', + 'example' => 'net', + ], + 'HitTimes' => [ + 'description' => 'VPC边界防火墙访问控制策略的命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DestPort' => [ + 'description' => 'VPC边界防火墙访问控制策略中访问流量的目的端口。', + 'type' => 'string', + 'example' => '80', + ], + 'Description' => [ + 'description' => 'VPC边界防火墙访问控制策略的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'AclAction' => [ + 'description' => 'VPC边界防火墙访问控制策略中设置的访问流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'example' => 'accept', + ], + 'ApplicationId' => [ + 'description' => 'VPC边界防火墙访问控制策略中设置访问流量的应用的ID。', + 'type' => 'string', + 'example' => '10**', + ], + 'Proto' => [ + 'description' => 'VPC边界防火墙访问控制策略中访问流量的协议类型。取值：'."\n" + ."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + .'- **ANY**（表示查询所有协议类型）', + 'type' => 'string', + 'example' => 'TCP', + ], + 'DestinationGroupCidrs' => [ + 'description' => 'VPC边界防火墙访问控制策略中目的地址簿中的网段信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙访问控制策略中目的地址簿中的网段列表。', + 'type' => 'string', + 'example' => '["192.0.XX.XX/24", "192.0.XX.XX/32"]', + ], + ], + 'DestPortGroupPorts' => [ + 'description' => 'VPC边界防火墙访问控制策略中目的端口地址簿的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙访问控制策略中目的端口地址簿中包含的端口列表。', + 'type' => 'string', + 'example' => '[80,443]', + ], + ], + 'SourceGroupCidrs' => [ + 'description' => 'VPC边界防火墙访问控制策略中源地址簿的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙访问控制策略中，源地址簿中的网段列表。', + 'type' => 'string', + 'example' => '["192.0.XX.XX/24", "198.51.XX.XX/32"]', + ], + ], + 'MemberUid' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'example' => '258039427902****', + ], + 'Release' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'example' => 'true', + ], + 'SourceGroupType' => [ + 'description' => '访问控制策略中的源地址簿类型。唯一取值： **ip**。表示IP地址簿，包含一个或多个IP地址段。', + 'type' => 'string', + 'example' => 'ip', + ], + 'DestinationGroupType' => [ + 'description' => '访问控制策略中的目的地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。', + 'type' => 'string', + 'example' => 'ip', + ], + 'HitLastTime' => [ + 'description' => '最新命中时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'ModifyTime' => [ + 'description' => '修改策略的时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'SpreadCnt' => [ + 'description' => '占用访问控制策略的规格数，即每条策略占用规格数的累加值。'."\n" + .'单条策略占用访问控制策略的规格数=访问源地址段个数 \\* 目的地址个数（IP地址段个数或域名个数）\\* 应用数 \\* 端口段个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10,000', + ], + 'CreateTime' => [ + 'description' => '创建策略的时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ApplicationNameList' => [ + 'description' => '应用名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙访问控制策略支持的应用类型列表。取值：'."\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**（表示查询访问控制策略所有的应用类型）', + 'type' => 'string', + 'example' => '['."\n" + .' "HTTPS", '."\n" + .' "SMTPS", '."\n" + .' "SSL"'."\n" + .']', + ], + ], + 'RepeatType' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + 'RepeatDays' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'RepeatStartTime' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'example' => '08:00', + ], + 'RepeatEndTime' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694761200', + ], + 'EndTime' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694764800', + ], + 'DomainResolveType' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'* **FQDN**：基于FQDN'."\n" + .'* **DNS**：基于DNS动态解析'."\n" + .'* **FQDN_AND_DNS**：基于FQDN与DNS动态解析', + 'type' => 'string', + 'example' => 'FQDN', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询指定的VPC边界防火墙的所有访问控制策略信息', + 'description' => '本接口一般用于查询VPC边界防火墙的访问控制策略。VPC边界防火墙防护通过云企业网连接的两个VPC之间的流量或防护通过高速通道连接的两个VPC之间的流量时，使用不同的访问控制策略。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVpcFirewallPolicyPriorUsed' => [ + 'summary' => '查询指定VPC防火墙策略组访问控制策略优先级生效范围。', + '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' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的访问控制策略组ID。您可调用[DescribeVpcFirewallAclGroupList](~~159760~~)接口获取该ID。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网时，策略组ID使用云企业网实例ID。'."\n" + ."\n" + .' 例如cen-ervw0g12b5jbw*\\*\\*\\*'."\n" + ."\n" + .'- VPC边界防火墙防护高速通道时，策略组ID使用VPC边界防火墙实例ID。'."\n" + ."\n" + .' 例如vfw-a42bbb7b887148c9*\\*\\*\\*', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '访问控制策略生效的优先级最低值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'Start' => [ + 'description' => '访问控制策略生效的优先级最高值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + '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' => '查询VPC防火墙策略组访问控制策略优先级生效范围', + 'description' => '本接口一般用于查询指定VPC防火墙策略组访问控制策略优先级生效范围。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateVpcFirewallControlPolicy' => [ + 'summary' => '为指定VPC防火墙策略组添加访问控制策略。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中设置的流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => true, + 'example' => 'accept', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略支持的应用类型。取值：'."\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**（表示支持所有的应用类型）'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略的描述信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中流量访问的目的端口。'."\n" + ."\n" + .'> 当**DestPortType**为`port`时，设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中流量访问的目的地址。取值：'."\n" + ."\n" + .'- 当**DestinationType**为`net`时，**Destination**为目的CIDR地址。'."\n" + ."\n" + .'- 当**DestinationType**为`group`时，**Destination**为目的地址簿名称。'."\n" + ."\n" + .'- 当**DestinationType**为`domain`时，**Destination**为目的域名。', + 'type' => 'string', + 'required' => true, + 'example' => '10.2.XX.XX/24', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中的目的地址类型。取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略组ID。'."\n" + .'- 当VPC边界防火墙防护通过云企业网连接的两个VPC之间的流量时，策略组ID使用云企业网实例ID。'."\n" + .' '."\n" + .'- 当VPC边界防火墙防护通过高速通道连接的两个VPC之间的流量时，策略组ID使用VPC边界防火墙实例ID。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcFirewallAclGroupList](~~159760~~)接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中流量访问的安全协议类型。取值：'."\n" + ."\n" + .'- **ANY**（不确定具体协议类型时可设置为ANY）'."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**', + 'type' => 'string', + 'required' => true, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中的源地址。'."\n" + ."\n" + .'- 当SourceType为`net`时，Source为源CIDR。'."\n" + .'- 当SourceType为`group`时，Source为源地址簿名称。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10.2.XX.XX/24', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR）'."\n" + ."\n" + .'- **group**：源地址簿'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略生效的优先级。'."\n" + ."\n" + .'优先级数字从1开始顺序递增，优先级数字越小，优先级越高。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中流量访问的目的端口类型。取值：'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略中流量访问的目的端口地址簿名称。'."\n" + ."\n" + .'> 当**DestPortType**为`group`时，设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '访问控制策略支持的应用类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略支持的应用类型。取值：'."\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" + .'> 支持的应用类型取值与协议类型（Proto）取值存在依赖关系。Proto为TCP协议时，ApplicationNameList支持选择以上所有应用类型，使用`["HTTP","HTTPS",……]`格式表示；Proto为UDP、ICMP或ANY协议类型时，ApplicationNameList仅支持选择ANY。ApplicationNameList和ApplicationName二选一，必须传其中一个，不能同时为空。当ApplicationNameList和ApplicationName同时传值时，以ApplicationNameList为准。', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "ANY"'."\n" + .']', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'* **FQDN**：基于FQDN'."\n" + .'* **DNS**：基于DNS动态解析'."\n" + .'* **FQDN_AND_DNS**：基于FQDN与DNS动态解析', + 'type' => 'string', + 'required' => false, + 'example' => 'FQDN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AclUuid' => [ + 'description' => '安全访问控制策略的唯一标识ID。', + 'type' => 'string', + 'example' => '00281255-d220-4db1-8f4f-c4df221ad84c', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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' => '为指定VPC防火墙策略组添加访问控制策略', + 'description' => '本接口一般用于为指定VPC边界防火墙策略组添加访问控制策略。VPC边界防火墙防护通过云企业网连接的两个VPC之间的流量或防护通过高速通道连接的两个VPC之间的流量时，使用不同的访问控制策略。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyVpcFirewallControlPolicy' => [ + 'summary' => '修改指定VPC防火墙策略组的访问控制策略的配置信息。', + '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' => '接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**：（默认）中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中访问流量通过云防火墙的方式（动作）。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'ApplicationName', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略支持的应用类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- ANY（表示查询所有类型的应用）'."\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', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DestPort', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中访问流量的目的端口。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址。'."\n" + ."\n" + .'- 当**DestinationType**为`net`时，Destination为目的CIDR地址。'."\n" + .' '."\n" + .' 例如：10.2.3.0/24'."\n" + ."\n" + .'- 当**DestinationType**为`group`时，Destination为目的地址簿名称。'."\n" + ."\n" + .' 例如：db_group'."\n" + ."\n" + .'- 当**DestinationType**为`domain`时，Destination为目的域名。'."\n" + ."\n" + .' 例如：*.aliyuncs.com'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10.2.X.X/XX', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR地址）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。您可调用[DescribeVpcFirewallAclGroupList](~~159760~~)接口获取该ID。'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网时，该参数值使用云企业网实例ID。'."\n" + ."\n" + .' 例如cen-ervw0g12b5jbw*\\*\\*\\*'."\n" + ."\n" + .'- VPC边界防火墙防护高速通道时，该参数值使用VPC边界防火墙实例ID。'."\n" + .' '."\n" + .' 例如vfw-a42bbb7b887148c9*\\*\\*\\*', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'Proto', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中流量访问的安全协议类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- ANY（表示查询所有协议类型）'."\n" + .'- TCP'."\n" + .'- UDP'."\n" + .'- ICMP', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，Source为源CIDR地址。'."\n" + ."\n" + .' 例如：10.2.4.0/24'."\n" + ."\n" + .'- 当**SourceType**为`group`时，Source为源地址簿名称。'."\n" + ."\n" + .' 例如：db_group', + 'type' => 'string', + 'required' => false, + 'example' => '10.2.X.X/XX', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。'."\n" + ."\n" + .'修改访问控制策略时，需要提供该策略的唯一标识ID。您可调用[DescribeVpcFirewallControlPolicy](~~159758~~)接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR地址）'."\n" + .'- **group**：源地址簿'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'DestPortType', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中访问流量的目的端口类型。'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'required' => false, + 'example' => 'port', + ], + ], + [ + 'name' => 'DestPortGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中访问流量的目的端口地址簿名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_port_group', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => '["ANY"]', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'RepeatType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Daily' => '每天', + 'Monthly' => '每月', + 'Permanent' => '总是', + 'Weekly' => '每周', + 'None' => '指定单次时间', + ], + 'example' => 'Permanent', + ], + ], + [ + 'name' => 'RepeatDays', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RepeatEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '23:30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694761200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1694764800', + ], + ], + [ + 'name' => 'DomainResolveType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'* **FQDN**：基于FQDN'."\n" + .'* **DNS**：基于DNS动态解析'."\n" + .'* **FQDN_AND_DNS**：基于FQDN与DNS动态解析', + 'type' => 'string', + 'required' => false, + 'example' => 'FQDN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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' => '修改VPC防火墙策略组的访问控制策略', + 'description' => '本接口一般用于修改指定VPC防火墙策略组的访问控制策略的配置信息。防护每个云企业网的VPC防火墙实例和防护每个高速通道的VPC防火墙实例使用不同的访问控制策略。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyVpcFirewallControlPolicyPosition' => [ + 'summary' => '修改指定VPC防火墙策略组访问控制策略的优先级。', + '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' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的访问控制策略组ID。您可调用[DescribeVpcFirewallAclGroupList](~~159760~~)接口获取该ID。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网时，策略组ID使用云企业网实例ID。'."\n" + .' '."\n" + .' 例如cen-ervw0g12b5jbw*\\*\\*\\*'."\n" + ."\n" + .'- VPC边界防火墙防护高速通道时，策略组ID使用VPC边界防火墙实例ID。'."\n" + ."\n" + .' 例如vfw-a42bbb7b887148c9*\\*\\*\\*', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略优先级修改后，该策略的新优先级。'."\n" + .'> 新优先级的取值范围，请参见[查询优先级生效范围API](~~474145~~)', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'OldOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略优先级修改前，该策略的原优先级。'."\n" + ."\n" + .'> 此参数不推荐使用, 建议使用AclUuid参数指定要修改的策略。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。'."\n" + ."\n" + .'修改访问控制策略时，需要提供该策略的唯一标识ID。您可调用[DescribeVpcFirewallControlPolicy](~~159758~~)接口获取该ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2746d9ff-5d7c-449d-a2a9-ccaa15fe****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125EEB1', + ], + ], + ], + ], + ], + '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' => '修改VPC防火墙策略组访问控制策略优先级', + 'description' => '本接口一般用于修改指定VPC防火墙策略组访问控制策略的优先级。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + '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' => '云防火墙成员账号的UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'StrictMode', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '是否启用严格模式'."\n" + ."\n" + .'- 1：严格模式'."\n" + .'- 0：宽松模式', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '修改VPC防火墙ACL引擎模式', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'ResetVpcFirewallRuleHitCount' => [ + 'summary' => '将指定的VPC防火墙策略组访问控制策略的命中计数清零。', + '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' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的唯一标识ID。'."\n" + ."\n" + .'重置访问控制策略时，需要提供该策略的唯一标识ID。您可调用[DescribeVpcFirewallControlPolicy](~~159758~~)接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df221a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + ], + ], + ], + ], + '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' => '将VPC防火墙问控制策略命中计数清零', + 'description' => '本接口一般用于将指定的VPC防火墙策略组访问控制策略的命中计数清零。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVpcFirewallControlPolicy' => [ + 'summary' => '删除指定VPC防火墙策略组的访问控制策略。', + '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' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙访问控制策略的唯一标识ID。'."\n" + ."\n" + .'删除安全访问控制策略时，需要提供该策略的唯一标识ID。您可调用[DescribeVpcFirewallControlPolicy](~~159758~~)接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df2214****', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的访问控制策略组ID。您可调用[DescribeVpcFirewallAclGroupList](~~159760~~)接口获取该ID。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网时，策略组ID使用云企业网实例ID。'."\n" + ."\n" + .' 例如：cen-ervw0g12b5jbw*\\*\\*\\*'."\n" + ."\n" + .'- VPC边界防火墙防护高速通道时，策略组ID使用VPC边界防火墙实例ID。'."\n" + .' '."\n" + .' 例如：vfw-a42bbb7b887148c9*\\*\\*\\*', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c91****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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' => '删除VPC防火墙策略组访问控制策略', + 'description' => '本接口一般用于删除指定VPC防火墙策略组的访问控制策略。防护每个云企业网的VPC防火墙实例和防护每个高速通道的VPC防火墙实例使用不同的访问控制策略。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchDeleteVpcFirewallControlPolicy' => [ + 'summary' => '批量删除VPC防火墙访问控制策略。', + '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' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'AclUuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'ACL UUID 列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACL UUID 列表。', + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + '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' => '批量删除VPC防火墙访问控制策略', + ], + 'DescribeVpcListLite' => [ + 'summary' => '获取VPC列表。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '58.34.174.194', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-shanghai', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC所在的地域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '55E56A55-D93A-5614-AE00-BE2F8077F891', + ], + 'VpcList' => [ + 'description' => 'VPC信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC信息列表。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-wz9dqhljd10fk0b4eh885', + ], + 'VpcName' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'example' => 'Cloud_Firewall_VPC', + ], + 'RegionNo' => [ + 'description' => 'VPC所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取VPC列表', + ], + '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' => '访问者源ip地址。', + 'type' => 'string', + 'required' => false, + 'example' => '140.205.118.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。默认值为1。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '本次查询获取的数量。', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNS边界防火墙访问控制策略中的访问源地址。支持使用模糊查询。'."\n" + ."\n" + .'> Source可以是单个CIDR地址或地址簿名称。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/24', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNS边界防火墙访问控制策略中的目的地址。支持模糊查询。'."\n" + ."\n" + .'> Destination可以是单个CIDR地址或域名，也可以是地址薄名称。', + 'type' => 'string', + 'required' => false, + 'example' => '10.2.XX.XX/24', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNS边界防火墙策略的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNS边界防火墙访问控制策略中设置的访问流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察'."\n" + ."\n" + .'> 不设置该参数表示查询所有动作。', + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + ."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙规则的唯一标识id。', + 'type' => 'string', + 'required' => false, + 'example' => 'b6c8f905-2eb6-442a-ba35-9416e****', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '支持的IP地址版本。取值：'."\n" + ."\n" + .'- **4**：代表IPv4地址'."\n" + .'- **6**：代表IPv6地址', + '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' => '结果的请求id。', + 'type' => 'string', + 'example' => '0A4ACDE9-9F9F-56C1-B3B7-60971BA1****', + ], + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'string', + 'example' => '10', + ], + 'Policys' => [ + 'description' => 'DNS防火墙访问控制策略的信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'DNS防火墙访问控制策略的信息。', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '访问控制策略的流量方向。取值：'."\n" + ."\n" + .'- **in**：外对内流量访问控制'."\n" + .'- **out**：内对外流量访问控制', + 'type' => 'string', + 'example' => 'in', + ], + 'DestinationGroupType' => [ + 'description' => '访问控制策略中的目的地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。', + 'type' => 'string', + 'example' => 'ip', + ], + 'HitLastTime' => [ + 'description' => '最新命中时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'Destination' => [ + 'description' => 'DNS边界防火墙访问控制策略中的目的地址。取值：'."\n" + ."\n" + .'- 当**DestinationType**为`net`时，Destination为目的CIDR地址。'."\n" + ."\n" + .'- 当**DestinationType**为`domain`时，Destination为目的域名。'."\n" + ."\n" + .'- 当**DestinationType**为`group`时，Destination为目的地址簿名称。', + 'type' => 'string', + 'example' => 'x.x.x.x/32', + ], + 'SourceType' => [ + 'description' => 'DNS边界防火墙访问控制策略中源地址类型。取值：'."\n" + ."\n" + .'- **net**：源CIDR地址'."\n" + .'- **group**：源地址簿', + 'type' => 'string', + 'example' => 'net', + ], + 'AclUuid' => [ + 'description' => '访问控制策略的唯一标识id。', + 'type' => 'string', + 'example' => '01281255-d220-4db1-8f4f-c4df221a****', + ], + 'Priority' => [ + 'description' => '访问控制策略优先级。数字越小，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '110', + ], + 'Source' => [ + 'description' => '访问控制策略中的访问源地址。取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，访问源为CIDR格式的IP地址段。例如：192.0.XX.XX/24。'."\n" + .'- 当**SourceType**为`group`时，访问源地址为源地址簿名称。例如：db_group。'."\n" + .'- 当**SourceType**为`location`时，访问源地址为区域（具体区域位置编码请参见[AddControlPolicy](~~138867~~)）。例如： \\["BJ11", "ZB"\\]。', + 'type' => 'string', + 'example' => '192.0.XX.XX/24', + ], + 'DestinationType' => [ + 'description' => '访问控制策略中的目的地址类型。取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n" + .'- **location**：目的区域', + 'type' => 'string', + 'example' => 'net', + ], + 'HitTimes' => [ + 'description' => '访问控制策略的命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'IpVersion' => [ + 'description' => '支持的IP地址版本。取值：'."\n" + ."\n" + .'- **4**：代表IPv4地址'."\n" + .'- **6**：代表IPv6地址', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Description' => [ + 'description' => 'DNS边界防火墙访问控制策略的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'SourceGroupType' => [ + 'description' => '访问控制策略中的源地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿，包含一个或多个ECS标签下的IP地址。'."\n" + ."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。'."\n" + ."\n" + .'- **threat**：威胁地址簿，包含一个或多个恶意IP或域名地址。'."\n" + ."\n" + .'- **backsrc**：回源地址簿，包含一个或多个DDoS防护实例或WAF实例的回源地址。', + 'type' => 'string', + 'example' => 'ip', + ], + 'AclAction' => [ + 'description' => '访问控制策略中设置的流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'example' => 'accept', + ], + 'Release' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + ."\n" + .'- **false**：不启用访问控制策略', + '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"}]', + 'title' => '获取DNS防火墙ACL列表', + ], + 'DescribePrefixLists' => [ + 'summary' => '查询前缀列表。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '47.100.XX.XX', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shenzhen', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '67FD76C2-C493-5815-8107-643FD7AB77C7', + ], + 'PrefixList' => [ + 'description' => '前缀列表信息组成的数组。', + 'type' => 'array', + 'items' => [ + 'description' => '前缀列表信息组成的数组。', + 'type' => 'object', + 'properties' => [ + 'PrefixListId' => [ + 'description' => '前缀列表ID。', + 'type' => 'string', + 'example' => 'pl-uf64nco3ujjqchx6aaji', + ], + 'PrefixListName' => [ + 'description' => '前缀列表的名称。', + 'type' => 'string', + 'example' => 'participant-name', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'TCP_14900-14911', + ], + 'CreationTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-10-16T08:31:06Z', + ], + 'AssociationCount' => [ + 'description' => '关联资源的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'MaxEntries' => [ + 'description' => '前缀列表支持的最大条目容量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AddressFamily' => [ + 'description' => '前缀列表的地址族。可能值：'."\n" + ."\n" + .'- IPv4。'."\n" + .'- IPv6。', + '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' => '查询前缀列表', + ], + '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' => '访问者源ip地址。', + 'type' => 'string', + 'required' => false, + 'example' => '140.205.118.97', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量通过云防火墙的方式。取值：'."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => true, + 'example' => 'log', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中的目的地址。'."\n" + ."\n" + .'- 当**DestinationType**为net时，**Destination**为目的CIDR。例如：1.2.3.4/24'."\n" + .'- 当**DestinationType**为group时，**Destination**为目的地址簿名称。例如：db_group'."\n" + .'- 当**DestinationType**为domain时，**Destination**为目的域名。例如：*.aliyuncs.com'."\n" + .'- 当**DestinationType**为location时，**Destination**为目的区域（具体区域位置编码见后文）。例如： \\["BJ11", "ZB"\\]', + 'type' => 'string', + 'required' => true, + 'example' => 'db_group', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR地址）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名', + 'type' => 'string', + 'required' => true, + 'example' => 'domain', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的流量方向。取值：'."\n" + ."\n" + .'- **in**：外对内流量访问控制'."\n" + .'- **out**：内对外流量访问控制', + 'type' => 'string', + 'required' => false, + 'example' => 'out', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址。取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，Source为源CIDR地址，例如：10.2.XX.XX/24'."\n" + ."\n" + .'- 当**SourceType**为`group`时，Source为源地址簿名称，例如：db_group。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.223/32', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR）'."\n" + ."\n" + .'- **group**：源地址簿', + 'type' => 'string', + 'required' => true, + 'example' => 'net', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略优先级修改前，该策略的优先级。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '支持的IP地址版本。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **4**：表示IPv4地址'."\n" + ."\n" + .'- **6**：表示IPv6地址', + 'type' => 'string', + 'required' => true, + 'example' => '4', + 'enum' => [ + '4', + '6', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AclUuid' => [ + 'description' => '安全访问控制策略的唯一标识ID。', + 'type' => 'string', + 'example' => 'f88dae6f-XXX-XXX-613de9ab2be8', + ], + 'RequestId' => [ + 'description' => '结果的请求id。', + '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"}]', + 'title' => '添加DNS防火墙ACL', + 'description' => '使用本接口创建一条对经过NAT防火墙流量放行、拒绝或观察的策略。', + ], + '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' => '访问者源ip地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclAction', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中流量通过云防火墙的方式。取值：'."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'required' => false, + 'example' => 'log', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Destination', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略中的目的地址。'."\n" + ."\n" + .'- 当**DestinationType**为net时，**Destination**为目的CIDR。例如：1.2.3.4/24'."\n" + .'- 当**DestinationType**为group时，**Destination**为目的地址簿名称。例如：db_group'."\n" + .'- 当**DestinationType**为domain时，**Destination**为目的域名。例如：*.aliyuncs.com'."\n" + .'- 当**DestinationType**为location时，**Destination**为目的区域（具体区域位置编码见后文）。例如： \\["BJ11", "ZB"\\]', + 'type' => 'string', + 'required' => false, + 'example' => 'db_group', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的目的地址类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR地址）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址。取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，Source为源CIDR地址，例如：10.2.21.**/24'."\n" + ."\n" + .'- 当**SourceType**为`group`时，Source为源地址簿名称，例如：db_group。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.21.**/24', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略的唯一标识ID。', + 'type' => 'string', + 'required' => true, + 'example' => '00281255-d220-4db1-8f4f-c4df22****', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR）'."\n" + ."\n" + .'- **group**：源地址簿', + 'type' => 'string', + 'required' => false, + 'example' => 'net', + ], + ], + [ + 'name' => 'Release', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + .'- **false**：不启用访问控制策略', + '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' => '结果的请求id。', + '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"}]', + 'title' => '修改DNS防火墙规则', + 'description' => '使用本接口创建一条对经过NAT防火墙流量放行、拒绝或观察的策略。', + ], + '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' => '访问者源ip地址。', + 'type' => 'string', + 'required' => false, + 'example' => '140.210.39.***', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AclUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '安全访问控制策略的唯一标识ID。', + 'type' => 'string', + 'required' => true, + 'example' => '498946f4-c98a-45c0-9038-635c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求id。', + '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"}]', + 'title' => '删除DNS防火墙规则', + 'description' => '使用本接口创建一条对经过NAT防火墙流量放行、拒绝或观察的策略。', + ], + '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' => '威胁情报分类ID。', + 'type' => 'string', + 'example' => '3000037', + ], + 'CategoryName' => [ + 'description' => '类型名称。', + 'type' => 'string', + 'example' => 'Tor出口恶意IP'."\n", + ], + 'CategoryDescribe' => [ + 'description' => '类别描述。', + 'type' => 'string', + 'example' => 'Tor出口恶意IP'."\n", + ], + 'CategoryParentId' => [ + 'description' => '威胁情报父级分类 ID。', + 'type' => 'string', + 'example' => '123', + ], + 'Action' => [ + 'description' => '规则动作。取值：'."\n" + ."\n" + .' **alert**：观察.'."\n" + ."\n" + .' **drop**：拦截.', + 'type' => 'string', + 'example' => 'alert', + ], + 'EnableStatus' => [ + 'description' => '开关状态。取值：'."\n" + ."\n" + .' **1**：开启。'."\n" + ."\n" + .' **0**：关闭。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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"}]', + 'title' => '查询威胁情报配置的信息', + 'description' => '本接口一般用于分页查询NAT防火墙访问控制策略的信息。', + ], + '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' => '威胁情报分类ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'IpOutThreatTorExit', + ], + 'Action' => [ + 'description' => '规则动作。取值：'."\n" + .'- **alert**：观察'."\n" + .'- **drop**：拦截', + 'type' => 'string', + 'required' => false, + 'example' => 'alert', + ], + 'EnableStatus' => [ + 'description' => '开关状态。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-0009012****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6-0DE4-4797-A1E8-0009012****\\"\\n}","type":"json"}]', + 'title' => '修改威胁情报配置的信息', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '140.205.118.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。 取值：'."\n" + .'- **basicRule**'."\n" + .'- **customize**', + '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' => '云防火墙类型。取值：'."\n" + .'- **VpcFirewall**：表示VPC边界防火墙。'."\n" + .'- **InternetFirewall**（默认）：表示互联网边界防火墙。', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewall', + 'default' => 'InternetFirewall', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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"}]', + 'title' => '修改IPS规则为默认', + ], + 'DescribeSignatureLibVersion' => [ + 'summary' => '查询特征库版本信息。', + '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' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '9C50C2A9-4BBB-5504-8ADA-C41A79B8C946', + ], + 'Version' => [ + 'description' => '版本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '版本号。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => '类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ips' => '基础防御和虚拟补丁', + 'intelligence' => '威胁情报', + ], + 'example' => 'ips', + ], + 'Version' => [ + 'title' => '版本', + 'description' => '版本。', + 'type' => 'string', + 'example' => 'IPS-2307-02', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741067915', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询特征库版本信息', + ], + 'DescribeDefaultIPSConfig' => [ + 'summary' => '互联网IPS防护功能。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '133173B9-8010-5DF5-8B93-********', + ], + 'RuleClass' => [ + 'description' => 'IPS规则组。取值：'."\n" + ."\n" + .'- **1**：宽松规则组。'."\n" + ."\n" + .'- **2**：中等规则组。'."\n" + ."\n" + .'- **3**：严格规则组。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CtiRules' => [ + 'description' => '威胁情报。取值：'."\n" + ."\n" + .'- **1**：开启。'."\n" + ."\n" + .'- **0**：关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PatchRules' => [ + 'description' => '虚拟补丁开关。取值：'."\n" + .'- **1**：开启。'."\n" + ."\n" + .'- **0**：关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RunMode' => [ + 'description' => 'IPS防御模式。取值：'."\n" + ."\n" + .'- **1**：拦截模式。'."\n" + ."\n" + .'- **0**：观察模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BasicRules' => [ + 'description' => '基础规则开关。取值：'."\n" + ."\n" + .'- **1**：开启。'."\n" + ."\n" + .'- **0**：关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxSdl' => [ + 'description' => '敏感数据检测每日检测流量上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + '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' => '互联网IPS防护功能', + ], + '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' => '访问者源IP地址。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '04F788A5-6A47-5EA9-AC30-CA4DB98AD520', + ], + 'Whitelists' => [ + 'description' => '互联网边界IPv4的入侵防御系统白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '互联网边界IPv4的入侵防御系统白名单。', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '互联网边界的IPv4流量方向。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 1 => '入向', + '出向', + ], + 'example' => '1', + ], + 'WhiteType' => [ + 'description' => '互联网边界IPv4白名单生效的源或目的类型。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 1 => '目的IP白名单', + '源IP白名单', + ], + 'example' => '1', + ], + 'ListValue' => [ + 'description' => '互联网边界IPv4白名单的值。'."\n" + ."\n" + .'- 当白名单类型为`自定义输入`时：地址簿名称。'."\n" + ."\n" + .'- 当白名单类型为`地址簿引用`时：IPv4。', + 'type' => 'string', + 'example' => '10.10.200.4/32,10.10.200.25/32', + ], + 'ListType' => [ + 'description' => '互联网IPv4白名单地址的类型。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '暂不设置', + '自定义输入', + '地址簿引用', + ], + 'example' => '1', + ], + 'WhiteListValue' => [ + 'description' => '互联网IPv4白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '互联网IPv4白名单。'."\n" + ."\n" + .'- 当白名单类型为`自定义输入`时：地址簿名称。'."\n" + ."\n" + .'- 当白名单类型为`地址簿引用`时：IPv4。', + 'type' => 'string', + 'example' => '10.10.200.4/32', + ], + ], + ], + ], + ], + 'Ipv6Whitelists' => [ + 'description' => '互联网边界IPv6的入侵防御系统白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '互联网边界IPv6的入侵防御系统白名单。', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '互联网边界的IPv6流量方向。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 1 => '入向', + '出向', + ], + 'example' => '1', + ], + 'WhiteType' => [ + 'description' => '互联网边界IPv6白名单生效的源或目的类型。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 1 => '目的IP白名单', + '源IP白名单', + ], + 'example' => '2', + ], + 'ListValue' => [ + 'description' => '互联网边界IPv6白名单的值。'."\n" + ."\n" + .'- 当白名单类型为`自定义输入`时：地址簿名称。'."\n" + ."\n" + .'- 当白名单类型为`地址簿引用`时：IPv6。', + 'type' => 'string', + 'example' => '2408:400a:81a:7900:a77d:ea36:fcbf:de40/128', + ], + 'ListType' => [ + 'description' => '互联网IPv6白名单地址的类型。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '暂不设置', + '自定义输入', + '地址簿引用', + ], + 'example' => '0', + ], + 'WhiteListValue' => [ + 'description' => '互联网IPv6白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '互联网IPv6白名单。'."\n" + ."\n" + .'- 当白名单类型为`自定义输入`时：地址簿名称。'."\n" + ."\n" + .'- 当白名单类型为`地址簿引用`时：IPv6。', + '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"}]', + 'title' => '获取用户IPS白名单', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP地址。', + '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' => 'VPC边界', + 'InternetFirewall' => '互联网边界', + ], + 'example' => 'VpcFirewall', + 'default' => 'InternetFirewall', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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"}]', + 'title' => '修改IPS规则', + ], + 'ModifyDefaultIPSConfig' => [ + 'summary' => '修改默认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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CtiRules', + 'in' => 'query', + 'schema' => [ + 'description' => '威胁情报开关。取值：'."\n" + ."\n" + .'- **1**：开启。'."\n" + ."\n" + .'- **0**：关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BasicRules', + 'in' => 'query', + 'schema' => [ + 'description' => '基础规则开关。取值：'."\n" + ."\n" + .'- **1**：开启。'."\n" + ."\n" + .'- **0**：关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PatchRules', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟补丁开关。取值：'."\n" + ."\n" + .'- **1**：开启。'."\n" + ."\n" + .'- **0**：关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RunMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPS防御模式。取值：'."\n" + ."\n" + .'- **1**：拦截模式。'."\n" + ."\n" + .'- **0**：观察模式。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPS规则组。取值：'."\n" + ."\n" + .'- **1**：宽松规则组。'."\n" + ."\n" + .'- **2**：中等规则组。'."\n" + ."\n" + .'- **3**：严格规则组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxSdl', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感数据检测每日检测流量上限。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '65885B52-00EC-5728-96******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65885B52-00EC-5728-96******\\"\\n}","type":"json"}]', + 'title' => '修改默认IPS配置', + ], + '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' => '访问者源IP地址。', + '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 => '目的IP白名单', + '源IP白名单', + ], + 'example' => '2', + ], + ], + [ + 'name' => 'ListType', + 'in' => 'query', + 'schema' => [ + 'description' => '互联网I白名单地址的类型。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + '暂不设置', + '自定义输入', + '地址簿引用', + ], + 'example' => '2', + ], + ], + [ + 'name' => 'ListValue', + 'in' => 'query', + 'schema' => [ + 'description' => '互联网边界白名单的值。'."\n" + ."\n" + .'- 当白名单类型为`自定义输入`时：地址簿名称。'."\n" + ."\n" + .'- 当白名单类型为`地址簿引用`时：IPv4。', + 'type' => 'string', + 'required' => false, + 'example' => '115.236.36.114/32', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP版本。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ipv4' => 'IPv4', + 'ipv6' => 'IPv6', + ], + 'example' => 'ipv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '修改用户IPS白名单', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。', + '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' => '实例的公网IP。', + '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' => '资源所属aliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IpsPrivateAssoc' => [ + 'description' => 'IPS私网溯源列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPS私网溯源。', + 'type' => 'object', + 'properties' => [ + 'AssocInfoStatus' => [ + 'description' => '私网溯源状态。', + 'type' => 'string', + 'example' => 'close', + ], + 'ErrorMsg' => [ + 'description' => '报错信息。', + 'type' => 'string', + 'example' => 'aliuid:1096080848305847 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole', + ], + 'ProtectedIpList' => [ + 'description' => '已保护的IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已保护的IP。', + 'type' => 'string', + 'example' => '123.56.18.XX', + ], + ], + 'ResourceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'cba48ec510bb640559c6f5161cde58014', + ], + 'ResourceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'job-0000000061279FB000001BBB31F9D673', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'closed', + ], + 'UnprotectedIpList' => [ + 'description' => '未保护的IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '未保护的IP。', + 'type' => 'string', + 'example' => '60.205.197.X', + ], + ], + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-wz92dxepli2pgnut796tf', + ], + 'VpcName' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'example' => 'vpc-uf62vdtifj7kffpxrydqd', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'MemberUid' => [ + 'description' => '资源所属aliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1507956024994407', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '结果的请求id。', + 'type' => 'string', + 'example' => 'B2841452-CB8D-4F7D-B247-38E1CF7334F8', + ], + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'TotalOpenCount' => [ + 'description' => '开启IPS私网溯源的总数。', + '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"}]', + 'title' => '查询IPS私网溯源列表', + 'description' => '本接口一般用于分页查询云防火墙防护的资产的信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-c5vhmjdfp5t****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '99A65AA0-C5B5-5092-BFCF-8111B436****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99A65AA0-C5B5-5092-BFCF-8111B436****\\"\\n}","type":"json"}]', + 'title' => '创建IPS私网溯源', + ], + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-c5vhmjdfp5t****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '133173B9-8010-5DF5*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"133173B9-8010-5DF5*****\\"\\n}","type":"json"}]', + 'title' => '创建IPS私网关联信息', + ], + 'DescribeVfwIPSConfigList' => [ + 'summary' => '查询VPC防火墙IPS配置列表。', + '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' => 'VPC边界防火墙实例ID。', + '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' => '结果的请求ID。', + 'type' => 'string', + 'example' => '15FCCC52-1E23-57AE-B5EF-3E00A3******', + ], + 'VfwIpsSwitchConfigList' => [ + 'description' => '配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置列表。', + 'type' => 'object', + 'properties' => [ + 'MemberUid' => [ + 'description' => '成员账号UID。', + 'type' => 'string', + 'example' => '134646920647****', + ], + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'example' => 'cen-h678sl4wv3yd5v****', + ], + 'VpcFirewallName' => [ + 'description' => 'VPC边界防火墙实例名称。', + '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' => 'VPC边界防火墙的实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙的实例ID列表。', + '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"}]', + 'title' => '查询VPC防火墙IPS配置列表', + ], + 'DescribeVpcFirewallDefaultIPSConfig' => [ + 'summary' => '获取指定VPC边界防火墙的入侵防御配置信息。', + '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' => 'VPC 边界防火墙的实例 ID。取值：'."\n" + ."\n" + .'- VPC 边界防火墙防护云企业网内的网络实例时，实例 ID 使用云企业网实例 ID。云企业网基础版通过调用[DescribeVpcFirewallCenList](~~345777~~) 接口，查询云企业网的实例 ID。云企业网企业版通过调用 [DescribeTrFirewallsV2List ](~~2384695~~) 接口，查询云企业网的实例 ID。'."\n" + .'- VPC 边界防火墙防护通过高速通道连接的两个 VPC 之间的流量时，实例 ID 使用 VPC 边界防火墙实例 ID。您可以通过调用 [DescribeVpcFirewallList](~~342932~~) 接口，查询 VPC 边界防火墙的实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cen-****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '850A84D6-****-00090125adf1', + ], + 'RunMode' => [ + 'description' => 'IPS防御模式。取值：'."\n" + ."\n" + .'- **1**：拦截模式。'."\n" + ."\n" + .'- **0**：观察模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EnableAllPatch' => [ + 'description' => '虚拟补丁开关。取值：'."\n" + ."\n" + .'- **1**：开。'."\n" + ."\n" + .'- **0**：关。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BasicRules' => [ + 'description' => '基础规则开关。取值：'."\n" + ."\n" + .'- **1**：开。'."\n" + ."\n" + .'- **0**：关。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleClass' => [ + 'description' => 'IPS规则组。取值：'."\n" + ."\n" + .'- **1**：宽松规则组。'."\n" + ."\n" + .'- **2**：中等规则组。'."\n" + ."\n" + .'- **3**：严格规则组。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + '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' => '获取指定VPC边界防火墙的入侵防御配置信息', + 'description' => '本接口用于获取指定VPC边界防火墙的入侵防御配置信息，需要先完成创建VPC防火墙实例。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DescribeVpcFirewallIPSWhitelist' => [ + 'summary' => '获取VPC防火墙IPS白名单。', + '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' => '请求和接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + ."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '176618****104675', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC 边界防火墙的实例 ID。取值：'."\n" + ."\n" + .'- VPC 边界防火墙防护云企业网内的网络实例时，实例 ID 使用云企业网实例 ID。云企业网基础版通过调用[DescribeVpcFirewallCenList](~~345777~~) 接口，查询云企业网的实例 ID。云企业网企业版通过调用 [DescribeTrFirewallsV2List ](~~2384695~~) 接口，查询云企业网的实例 ID。'."\n" + .'- VPC 边界防火墙防护通过高速通道连接的两个 VPC 之间的流量时，实例 ID 使用 VPC 边界防火墙实例 ID。您可以通过调用 [DescribeVpcFirewallList](~~342932~~) 接口，查询 VPC 边界防火墙的实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cen-***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'B5EE02F9****AA49****F9F8D69483C1', + ], + 'Whitelists' => [ + 'description' => 'VPC边界防火墙IPS白名单的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙IPS白名单的详细信息。', + 'type' => 'object', + 'properties' => [ + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'example' => 'cen-l6t5yj5fi762******', + ], + 'WhiteType' => [ + 'description' => '白名单类型。取值：'."\n" + .' - **1**：目的类型'."\n" + .'- **2**：源类型', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ListValue' => [ + 'description' => '对应列表类型的值。', + 'type' => 'string', + 'example' => '10.10.200.4/32,10.10.200.25/32', + ], + 'ListType' => [ + 'description' => '列表类型。取值：'."\n" + .' - **1**：用户自定义类型'."\n" + .'- **2**：地址簿类型', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'WhiteListValue' => [ + 'description' => '列表类型数组的内容。', + 'type' => 'array', + 'items' => [ + 'description' => '列表类型数组的内容。', + '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' => '获取VPC防火墙IPS白名单', + ], + 'ModifyVpcFirewallDefaultIPSConfig' => [ + 'summary' => '修改VPC边界防火墙的入侵防御配置信息。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。取值：'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量时，实例ID使用云企业网实例ID。您可以通过调用[DescribeVpcFirewallCenList](~~345777~~)接口，查询云企业网的实例ID。'."\n" + ."\n" + .'- VPC边界防火墙防护通过高速通道连接的两个VPC之间的互访流量时，实例ID使用VPC边界防火墙实例ID。您可以通过调用[DescribeVpcFirewallList](~~342932~~)接口，查询VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-m5e7dbc4y****', + ], + ], + [ + 'name' => 'BasicRules', + 'in' => 'query', + 'schema' => [ + 'description' => '基础规则开关。取值：'."\n" + ."\n" + .'- **1**：开。'."\n" + ."\n" + .'- **0**：关。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'EnableAllPatch', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟补丁开关。取值：'."\n" + ."\n" + .'- **1**：开。'."\n" + ."\n" + .'- **0**：关。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'RunMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPS防御模式。取值：'."\n" + ."\n" + .'- **1**：拦截模式。'."\n" + ."\n" + .'- **0**：观察模式。', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + [ + 'name' => 'RuleClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPS规则组。取值：'."\n" + ."\n" + .'- **1**：宽松规则组。'."\n" + ."\n" + .'- **2**：中等规则组。'."\n" + ."\n" + .'- **3**：严格规则组。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '3B51B5BF-3C26-5009-ADAB-190E58DE4D6E', + ], + ], + ], + ], + ], + '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' => '修改VPC边界防火墙的入侵防御配置信息', + 'description' => '本接口一般用于修改VPC边界防火墙的入侵防御配置信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'ModifyVpcFirewallIPSWhitelist' => [ + 'summary' => '修改VPC防火墙IPS白名单。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1415189284827022', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-d7b8ce273791475b9b0b', + ], + ], + [ + 'name' => 'WhiteType', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单类型。取值：'."\n" + .' - **1**：目的类型'."\n" + .'- **2**：源类型', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ListType', + 'in' => 'query', + 'schema' => [ + 'description' => '列表类型。取值：'."\n" + .' - **1**：用户自定义类型'."\n" + .'- **2**：地址簿类型', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ListValue', + 'in' => 'query', + 'schema' => [ + 'description' => '对应列表类型的值。', + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + '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' => '修改VPC防火墙IPS白名单', + ], + 'ListTlsInspectCACertificates' => [ + 'summary' => '此接口用于查询TLS检查CA证书。', + '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' => 'CA证书ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'C3E91391-16CD-1BFC-A133-******D429', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-******837D', + ], + 'Certificates' => [ + 'description' => '证书列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CaCertId' => [ + 'description' => 'CA证书ID。', + 'type' => 'string', + 'example' => '2732BB48-2969-5716-B5D9-******CA85', + ], + 'ExpirationTime' => [ + 'description' => '到期的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1934***149', + ], + 'CaCertType' => [ + 'description' => 'CA 证书的类型，取值：'."\n" + ."\n" + .'- **ROOT**：表示根 CA 证书。'."\n" + .'- **SUB_ROOT**：表示子 CA 证书。', + 'type' => 'string', + 'example' => 'ROOT', + ], + 'AliasName' => [ + 'description' => '证书别名。', + 'type' => 'string', + 'example' => 'rsa_ml_***_root', + ], + 'Algorithm' => [ + 'description' => 'CA 证书的加密算法类型, 取值:'."\n" + .'- **RSA**：表示 RSA 算法。'."\n" + .'- **ECC**：表示 ECC 算法。'."\n" + .'- **SM2**：表示 SM2（国密）算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'Status' => [ + 'description' => '证书状态，取值：'."\n" + .'- **ISSUE**：启用。'."\n" + .'- **REVOKE**：已吊销。', + 'type' => 'string', + 'example' => 'ISSUE', + ], + 'KeySize' => [ + 'description' => 'CA证书的密钥长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2048', + ], + 'SignAlgorithm' => [ + 'description' => 'CA证书的签名算法。', + 'type' => 'string', + 'example' => 'SHA256WITHRSA', + ], + 'ParentCaCertId' => [ + 'description' => '父CA证书ID。', + '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"}]', + 'title' => '查询TLS检查CA证书', + ], + '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' => 'CA证书ID。'."\n" + ."\n" + .'> 可通过ListTlsInspectCACertificates接口查询已有CA证书', + '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' => '返回结果的请求ID。', + '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' => [ + 'description' => 'CA证书ID。', + 'type' => 'string', + 'example' => '1f07c104-99ed-6b9a-b0bb-2938c9b8****', + ], + ], + ], + ], + ], + '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"}]', + 'title' => '获取TLS检查策略证书下载路径', + 'description' => '接口返回的是CA证书临时下载链接，链接有效时间为1分钟。超时链接失效，需要重新使用此接口获取下载链接。', + ], + 'DescribeAclCheckQuota' => [ + 'summary' => '查询ACL检查额度。', + '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' => '请求ID。', + '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"}]', + 'title' => '查询ACL检查额度', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => 'ACL检查类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'NAT' => 'NAT边界', + 'AddressBook' => '地址簿', + 'VPC' => 'VPC边界', + 'Internet' => '互联网边界', + ], + 'example' => 'VPC', + 'enum' => [ + 'Internet', + 'NAT', + 'VPC', + 'AddressBook', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9AABB1B7-C81F-5158-9EF9-B2DD5D3D****', + ], + 'CheckRecords' => [ + 'description' => 'ACL检查记录列表。', + 'type' => 'object', + 'properties' => [ + 'AclType' => [ + 'description' => 'ACL检查类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'NAT' => 'NAT边界', + 'AddressBook' => '地址簿', + 'VPC' => 'VPC边界', + 'Internet' => '互联网边界', + ], + 'example' => 'Internet', + ], + 'Records' => [ + 'description' => 'ACL检查记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACL检查记录。', + 'type' => 'object', + 'properties' => [ + 'CheckName' => [ + 'description' => 'ACL检查名称。', + 'type' => 'string', + 'enumValueTitles' => [ + 'PolicyDuplicate' => '重复冗余策略', + 'PolicyConflict' => '业务冲突策略', + 'AddressBookIpSeparated' => 'IP地址簿重复、重叠、分散', + 'DefaultPolicyNotDeny' => '默认兜底策略不是Deny All白名单机制', + 'PolicySourceDestinationSame' => '源和目的对象相同无效策略', + 'PolicyPortHighRisk' => '高风险端口放行风险策略', + 'PolicyTooLoose' => '管控策略过于宽松', + 'PolicyHitCountZero' => '无流量命中策略', + 'AddressBookPortSeparated' => '端口地址簿重复、重叠、分散', + 'AddressBookDomainValid' => '域名地址簿合法性校验', + ], + 'example' => 'AddressBookDomainValid', + ], + 'CheckStatus' => [ + 'description' => 'ACL检查项状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Checked' => '已检查', + 'Unchecked' => '待检查', + 'Checking' => '检查中', + ], + 'example' => 'Checked', + ], + 'CheckType' => [ + 'description' => 'ACL检查类型。', + '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' => 'ACL检查任务待处理的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AclTotalCount' => [ + 'description' => 'ACL检查总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TaskId' => [ + 'description' => 'ACK检查任务ID。', + '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"}]', + 'title' => '批量查询ACL检查列表', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '任务ID。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '25E655B0-CAED-53D4-8054-F983126****', + ], + 'CheckRecord' => [ + 'description' => '检查记录。', + 'type' => 'object', + 'properties' => [ + 'AclTotalCount' => [ + 'description' => '检查时的ACL策略总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RecordAssessmentDetail' => [ + 'description' => 'ACL检查的研判详情。', + 'type' => 'string', + 'example' => '建议删除无效策略，同时可帮助节省规格。', + ], + 'CheckName' => [ + 'description' => 'ACL检查名称。', + 'type' => 'string', + 'example' => 'PolicyHitCountZero', + ], + 'Description' => [ + 'description' => 'ACL检查项说明。', + 'type' => 'string', + 'example' => '由于业务下线或其它原因等，导致对象策略一段时间命中次数为0。', + ], + 'LastCheckTime' => [ + 'description' => '最近检查时间戳，单位：秒。', + 'type' => 'string', + 'example' => '1724982259', + ], + 'Level' => [ + 'description' => '风险等级。', + 'type' => 'string', + 'example' => 'High', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'task-c92d4544ef7b6a42', + ], + 'Acls' => [ + 'description' => 'ACL检查结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACL检查结果。', + 'type' => 'object', + 'properties' => [ + 'Acl' => [ + 'description' => 'ACL检查结果。', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '互联网流量方向。取值：'."\n" + ."\n" + .'- **in**：外对内流量访问控制'."\n" + .'- **out**：内对外流量访问控制', + 'type' => 'string', + 'example' => 'out', + ], + 'Order' => [ + 'description' => '访问控制策略生效的优先级。'."\n" + ."\n" + .'优先级数字从1开始顺序递增，优先级数字越小，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SourceType' => [ + 'description' => '访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR地址）'."\n" + .'- **group**：源地址簿'."\n" + .'- **location**：源区域', + 'type' => 'string', + 'example' => 'group', + ], + 'ApplicationName' => [ + 'description' => 'VPC边界防火墙访问控制策略支持的应用类型，推荐使用ApplicationNameList。取值：'."\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**（表示查询访问控制策略所有的应用类型）', + 'type' => 'string', + 'example' => 'ANY', + ], + 'HitTimes' => [ + 'description' => '访问控制策略的命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Description' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'example' => 'test_policy', + ], + 'SourceGroupType' => [ + 'description' => '访问控制策略中的源地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿，包含一个或多个ECS标签下的IP地址。'."\n" + ."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。'."\n" + ."\n" + .'- **threat**：威胁地址簿，包含一个或多个恶意IP或域名地址。'."\n" + ."\n" + .'- **backsrc**：回源地址簿，包含一个或多个DDoS防护实例或WAF实例的回源地址。'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'DnsResultTime' => [ + 'description' => 'DNS解析的时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DnsResult' => [ + 'description' => 'DNS解析结果。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'Proto' => [ + 'description' => '访问控制策略中访问流量的协议类型。取值：'."\n" + ."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + .'- **ANY**（表示所有协议类型）'."\n" + .'> 不设置该参数表示查询所有协议类型。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'DestinationGroupType' => [ + 'description' => '访问控制策略中的目的地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿，包含一个或多个ECS标签下的IP地址。'."\n" + ."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。'."\n" + ."\n" + .'- **threat**：威胁地址簿，包含一个或多个恶意IP或域名地址。'."\n" + ."\n" + .'- **backsrc**：回源地址簿，包含一个或多个DDoS防护实例或WAF实例的回源地址。'."\n", + 'type' => 'string', + 'example' => 'domain', + ], + 'Destination' => [ + 'description' => '访问控制策略中的目的地址。支持模糊查询。DestinationType（目的类型）不同，目的地址的取值也不同。'."\n" + ."\n" + .'- 当DestinationType为`net`时，目的地址为CIDR格式的IP地址段。例如：10.0.3.0/24。'."\n" + ."\n" + .'- 当DestinationType为`domain`时，目的地址为域名。例如：aliyun。'."\n" + ."\n" + .'- 当DestinationType为`group`时，目的地址为地址簿的名称。例如：db_group。'."\n" + ."\n" + .'- 当DestinationType为`location`时，目的地址为区域名称（具体区域位置编码请参见AddControlPolicy。例如：["BJ11", "ZB"]。'."\n" + ."\n" + .'> 不设置该参数表示查询所有类型的目的地址。', + 'type' => 'string', + 'example' => 'kms.cn-shanghai.aliyuncs.com', + ], + 'HitLastTime' => [ + 'description' => '最新命中时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DestPortGroup' => [ + 'description' => '访问控制策略中流量访问的目的端口类型。取值：'."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'example' => 'my_port_group'."\n", + ], + 'AclUuid' => [ + 'description' => '访问控制策略的唯一标识ID。', + 'type' => 'string', + 'example' => '997b38e0-01fa-4db7-8d30-02ebf6fdb747', + ], + 'DestPortType' => [ + 'description' => '访问控制策略中流量访问的目的端口类型。取值：'."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => '访问控制策略中的访问源地址。取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，访问源为CIDR格式的IP地址段。例如：192.0.XX.XX/24。'."\n" + .'- 当**SourceType**为`group`时，访问源地址为源地址簿名称。例如：db_group。'."\n" + .'- 当**SourceType**为`location`时，访问源地址为区域（具体区域位置编码请参见[AddControlPolicy](~~138867~~)）。例如： \\["BJ11", "ZB"\\]。'."\n", + 'type' => 'string', + 'example' => '172.28.7.167', + ], + 'DestinationType' => [ + 'description' => '访问控制策略中的目的地址类型。取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名'."\n" + .'- **location**：目的区域', + 'type' => 'string', + 'example' => 'domain', + ], + 'DestPort' => [ + 'description' => '访问控制策略中访问流量的目的端口。', + 'type' => 'string', + 'example' => '80/80', + ], + 'IpVersion' => [ + 'description' => '支持的IP地址版本。取值：'."\n" + ."\n" + .'- **4**：代表IPv4地址'."\n" + .'- **6**：代表IPv6地址', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'AclAction' => [ + 'description' => '访问控制策略中设置的流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'example' => 'log', + ], + 'Release' => [ + 'description' => '访问控制策略的启用状态。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + ."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'example' => 'true', + ], + 'ApplicationId' => [ + 'description' => '访问控制策略中设置访问流量的应用ID。', + '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' => '访问控制策略支持的应用类型列表。取值：'."\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**（表示所有应用类型）', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC边界防火墙访问控制策略支持的应用类型列表。取值：'."\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**（表示查询访问控制策略所有的应用类型）', + 'type' => 'string', + 'example' => 'ANY', + ], + ], + 'SpreadCnt' => [ + 'description' => '占用访问控制策略的规格数，即每条策略占用规格数的累加值。'."\n" + .'单条策略占用的规格数 = 源地址个数（IP地址段个数或区域个数）\\* 目的地址个数（IP地址段个数或区域个数或域名个数）\\* 端口段个数 \\* 应用数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CreateTime' => [ + 'description' => '创建策略的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ModifyTime' => [ + 'description' => '修改策略的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'RepeatType' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'example' => 'Permanent', + ], + 'RepeatDays' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期。'."\n" + .'> RepeatType设置为Weekly时，取值范围：0~6，每周开始于周日。'."\n" + .'> RepeatType设置为Monthly时，取值范围：1~31。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + ], + 'RepeatStartTime' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'example' => '08:00'."\n", + ], + 'RepeatEndTime' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + 'type' => 'string', + 'example' => '23:30', + ], + 'StartTime' => [ + 'description' => '设置查询开始时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730318400', + ], + 'EndTime' => [ + 'description' => '访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1758334822', + ], + 'AddressListCount' => [ + 'description' => '地址簿中包含地址的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupUuid' => [ + 'description' => '地址簿的唯一标识ID。'."\n" + ."\n" + .'删除安全访问控制的地址簿，需要提供该地址簿的唯一标识ID，该ID可调用[DescribeAddressBook](~~138869~~)接口获取。', + 'type' => 'string', + 'example' => 'b91d86c3-2b52-4534-aae9-8d0339b12a48', + ], + 'AutoAddTagEcs' => [ + 'description' => '是否自动添加新匹配标签的ECS（新购且完成标签设置的ECS或修改标签的ECS）公网IP到地址簿。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GroupName' => [ + 'description' => '地址簿的名称。', + 'type' => 'string', + 'example' => '钟馗开门白名单', + ], + 'ReferenceCount' => [ + 'description' => '地址簿被引用次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupType' => [ + 'description' => '地址簿的类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿。'."\n" + ."\n" + .'- **domain**：域名地址簿。'."\n" + ."\n" + .'- **port**：端口地址簿。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿。'."\n" + ."\n" + .'- **allCloud**：云服务地址簿。'."\n" + ."\n" + .'- **threat**：威胁情报地址簿。', + 'type' => 'string', + 'example' => 'ip', + ], + 'TagRelation' => [ + 'description' => '多个ECS标签间的关系。取值：'."\n" + ."\n" + .'- **and**：多个标签间为“与”关系，即同时匹配多个标签的ECS公网IP才会被加入地址簿。'."\n" + ."\n" + .'- **or**：多个标签间为“或”关系，即只要匹配一个标签的ECS公网IP就会被加入地址簿。', + 'type' => 'string', + 'example' => 'or', + ], + 'TagList' => [ + 'description' => 'ECS标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS标签。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'ECS标签值。', + 'type' => 'string', + 'example' => 'tfTestAcc0', + ], + 'TagKey' => [ + 'description' => 'ECS标签键。', + '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' => 'NAT网关的ID。', + 'type' => 'string', + 'example' => 'ngw-2ze4w62zbdkwjmoqeokgl', + ], + 'DomainResolveType' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'* **FQDN**：基于FQDN'."\n" + .'* **DNS**：基于DNS动态解析'."\n" + .'* **FQDN_AND_DNS**：基于FQDN与DNS动态解析', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'FQDN', + ], + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙的实例ID。', + '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' => 'ACL检查状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Pending' => '待处理', + 'Ignored' => '已忽略', + 'Processed' => '已处理', + ], + 'example' => 'Pending', + ], + 'AclAssessmentDetail' => [ + 'description' => '该条ACL策略的研判详情。', + '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"}]', + 'title' => '查询ACL检查详情', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => 'ACL检查类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'NAT' => 'NAT边界', + 'AddressBook' => '地址簿', + 'VPC' => 'VPC边界', + 'Internet' => '互联网边界', + ], + 'example' => 'Internet', + 'enum' => [ + 'Internet', + 'NAT', + 'VPC', + 'AddressBook', + ], + ], + ], + [ + 'name' => 'CheckNames', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'ACL检查名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACL检查名称。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PolicyDuplicate' => '重复冗余策略', + 'PolicyConflict' => '业务冲突策略', + 'AddressBookIpSeparated' => 'IP地址簿重复、重叠、分散', + 'DefaultPolicyNotDeny' => '默认兜底策略不是Deny All白名单机制', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '4FB718F0-CC04-5A12-B17B-188CFC3F****', + ], + 'TaskIds' => [ + 'description' => '任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + '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"}]', + 'title' => '创建ACL检查', + ], + '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' => 'ACL检查任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'task-c92d4544ef7b6a42', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACL检查详情中的ACL策略唯一标识ID。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '850A84D6************00090125EEB1', + ], + 'CheckRecord' => [ + 'description' => 'ACL检查记录。', + 'type' => 'object', + 'properties' => [ + 'Acls' => [ + 'description' => 'ACL检查结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACL检查结果。', + 'type' => 'object', + 'properties' => [ + 'Acl' => [ + 'description' => 'ACL检查结果。', + 'type' => 'object', + 'properties' => [ + 'Direction' => [ + 'description' => '安全访问控制策略管控的流量方向。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **in**：流量从外到内。'."\n" + .'- **out**：流量从内到外。', + 'type' => 'string', + 'example' => 'in', + ], + 'Order' => [ + 'description' => '访问控制策略生效的优先级。'."\n" + ."\n" + .'优先级数字从1开始顺序递增，优先级数字越小，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'desc', + ], + 'SourceType' => [ + 'description' => '访问控制策略中的源地址类型。取值：'."\n" + ."\n" + .'- **net**：源网段（CIDR地址）'."\n" + .'- **group**：源地址簿'."\n" + .'- **location**：源区域', + 'type' => 'string', + 'example' => 'net', + ], + 'ApplicationName' => [ + 'description' => '访问控制策略支持的应用类型。取值：'."\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" + .'> 支持的应用类型取值与协议类型（Proto）取值存在依赖关系。Proto为TCP协议时，ApplicationNameList支持选择以上所有应用类型。当ApplicationNameList和ApplicationName同时传值时，以ApplicationNameList为准。'."\n", + 'type' => 'string', + 'example' => 'ANY', + ], + 'HitTimes' => [ + 'description' => '访问控制策略的命中次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Description' => [ + 'description' => '访问控制策略的描述信息。', + 'type' => 'string', + 'example' => 'test_policy', + ], + 'SourceGroupType' => [ + 'description' => '访问控制策略中的源地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿，包含一个或多个ECS标签下的IP地址。'."\n" + ."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。'."\n" + ."\n" + .'- **threat**：威胁地址簿，包含一个或多个恶意IP或域名地址。'."\n" + ."\n" + .'- **backsrc**：回源地址簿，包含一个或多个DDoS防护实例或WAF实例的回源地址。', + 'type' => 'string', + 'example' => 'ip', + ], + 'DnsResultTime' => [ + 'description' => 'DNS解析的时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DnsResult' => [ + 'description' => 'DNS解析结果。', + 'type' => 'string', + 'example' => '192.168.0.1/32', + ], + 'Proto' => [ + 'description' => '访问控制策略中访问流量的协议类型。取值：'."\n" + ."\n" + .'- **TCP**'."\n" + .'- **UDP**'."\n" + .'- **ICMP**'."\n" + .'- **ANY**（表示所有协议类型）'."\n" + .'> 不设置该参数表示查询所有协议类型。', + 'type' => 'string', + 'example' => 'ANY', + ], + 'DestinationGroupType' => [ + 'description' => '访问控制策略中的目的地址簿类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿，包含一个或多个IP地址段。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿，包含一个或多个ECS标签下的IP地址。'."\n" + ."\n" + .'- **domain**：域名地址簿，包含一个或多个域名地址。'."\n" + ."\n" + .'- **threat**：威胁地址簿，包含一个或多个恶意IP或域名地址。'."\n" + ."\n" + .'- **backsrc**：回源地址簿，包含一个或多个DDoS防护实例或WAF实例的回源地址。', + 'type' => 'string', + 'example' => 'domain', + ], + 'Destination' => [ + 'description' => '访问控制策略中的目的地址。支持模糊查询。DestinationType（目的类型）不同，目的地址的取值也不同。'."\n" + ."\n" + .'- 当DestinationType为`net`时，目的地址为CIDR格式的IP地址段。例如：10.0.3.0/24。'."\n" + ."\n" + .'- 当DestinationType为`domain`时，目的地址为域名。例如：aliyun。'."\n" + ."\n" + .'- 当DestinationType为`group`时，目的地址为地址簿的名称。例如：db_group。'."\n" + ."\n" + .'- 当DestinationType为`location`时，目的地址为区域名称（具体区域位置编码请参见AddControlPolicy。例如：["BJ11", "ZB"]。'."\n" + ."\n" + .'> 不设置该参数表示查询所有类型的目的地址。', + 'type' => 'string', + 'example' => 'kms.cn-shanghai.aliyuncs.com', + ], + 'HitLastTime' => [ + 'description' => '最新命中时间戳。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579261141', + ], + 'DestPortGroup' => [ + 'description' => '访问控制策略中流量访问的目的端口类型。取值：'."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'example' => '所有端口', + ], + 'AclUuid' => [ + 'description' => '安全访问控制策略的唯一标识ID。', + 'type' => 'string', + 'example' => '1e8ed1b2-cebc-4b95-a9cc-0cb7ce2c0c2c', + ], + 'DestPortType' => [ + 'description' => '访问控制策略中流量访问的目的端口类型。取值：'."\n" + .'- **port**：端口'."\n" + .'- **group**：端口地址簿', + 'type' => 'string', + 'example' => 'port', + ], + 'Source' => [ + 'description' => '访问控制策略中的源地址。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- 当**SourceType**为`net`时，Source为源CIDR地址。'."\n" + ."\n" + .' 例如：10.2.4.0/24'."\n" + ."\n" + .'- 当**SourceType**为`group`时，Source为源地址簿名称。'."\n" + ."\n" + .' 例如：db_group', + 'type' => 'string', + 'example' => '10.71.94.24', + ], + 'DestinationType' => [ + 'description' => '访问控制策略中的目的地址类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **net**：目的网段（CIDR地址）'."\n" + .'- **group**：目的地址簿'."\n" + .'- **domain**：目的域名', + 'type' => 'string', + 'example' => 'group', + ], + 'DestPort' => [ + 'description' => '访问控制策略中访问流量的目的端口。', + 'type' => 'string', + 'example' => '22/22', + ], + 'IpVersion' => [ + 'description' => '云防火墙防护的资产的IP版本。取值：'."\n" + ."\n" + .'- **4**（默认）：IPv4。'."\n" + .'- **6**：IPv6。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'AclAction' => [ + 'description' => '访问控制策略中设置的流量通过云防火墙的方式（动作）。取值：'."\n" + ."\n" + .'- **accept**：放行'."\n" + .'- **drop**：拒绝'."\n" + .'- **log**：观察', + 'type' => 'string', + 'example' => 'log', + ], + 'Release' => [ + 'description' => '访问控制策略的启用状态。策略创建后默认启用该策略。取值：'."\n" + ."\n" + .'- **true**：启用访问控制策略'."\n" + .'- **false**：不启用访问控制策略', + 'type' => 'string', + 'example' => 'true', + ], + 'ApplicationId' => [ + 'description' => '访问控制策略中设置访问流量的应用ID。', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'DestinationGroupCidrs' => [ + 'description' => '访问控制策略中的目的地址簿中的网段列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略中的目的地址簿中的网段列表。'."\n", + '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' => '占用访问控制策略的规格数，即每条策略占用规格数的累加值。'."\n" + .'单条策略占用访问控制策略的规格数=访问源地址段个数 \\* 目的地址个数（IP地址段个数或区域个数或域名个数）\\* 应用数 \\* 端口段个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CreateTime' => [ + 'description' => '创建策略的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'ModifyTime' => [ + 'description' => '修改策略的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761062400', + ], + 'RepeatType' => [ + 'description' => '访问控制策略的策略有效期的重复类型。取值：'."\n" + .'- **Permanent**（默认）：总是'."\n" + .'- **None**：指定单次时间'."\n" + .'- **Daily**：每天'."\n" + .'- **Weekly**：每周'."\n" + .'- **Monthly**：每月', + 'type' => 'string', + 'example' => 'None', + ], + 'RepeatDays' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略的策略有效期的重复日期集合。'."\n" + .'- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。'."\n" + .' 例如：[]'."\n" + .'- 当RepeatType为Weekly时，RepeatDays不能为空。'."\n" + .' 例如：[0, 6]'."\n" + .'> RepeatType设置为Weekly时，RepeatDays不允许重复。'."\n" + .'- 当RepeatType为`Monthly`时，RepeatDays不能为空。'."\n" + .' 例如：[1, 31]'."\n" + .'> RepeatType设置为Monthly时，RepeatDays不允许重复。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'RepeatStartTime' => [ + 'description' => '访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。', + 'type' => 'string', + 'example' => '08:00', + ], + 'RepeatEndTime' => [ + 'description' => '访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。'."\n" + .'> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。', + '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' => '地址簿的唯一标识ID。'."\n" + ."\n" + .'>取值来源：[批量查询地址簿列表](~~DescribeAddressBook~~)。', + 'type' => 'string', + 'example' => '5a96a798-9b73-47f7-831e-1d7aa3c987a9', + ], + 'AutoAddTagEcs' => [ + 'description' => '是否自动添加新匹配标签的ECS（新购且完成标签设置的ECS或修改标签的ECS）公网IP到地址簿。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GroupName' => [ + 'description' => '地址簿的名称。', + 'type' => 'string', + 'example' => 'subscribe', + ], + 'ReferenceCount' => [ + 'description' => '地址簿被引用次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupType' => [ + 'description' => '地址簿的类型。取值：'."\n" + ."\n" + .'- **ip**：IP地址簿。'."\n" + ."\n" + .'- **domain**：域名地址簿。'."\n" + ."\n" + .'- **port**：端口地址簿。'."\n" + ."\n" + .'- **tag**：ECS标签地址簿。'."\n" + ."\n" + .'- **allCloud**：云服务地址簿。'."\n" + ."\n" + .'- **threat**：威胁情报地址簿。', + 'type' => 'string', + 'example' => 'port', + ], + 'TagRelation' => [ + 'description' => '多个ECS标签间的关系。', + 'type' => 'string', + 'example' => 'and', + ], + 'TagList' => [ + 'description' => 'ECS标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS标签。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'ECS标签键。', + 'type' => 'string', + 'example' => 'tfTestAcc0', + ], + 'TagKey' => [ + 'description' => 'ECS标签键。', + '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' => 'NAT网关的ID。', + 'type' => 'string', + 'example' => 'ngw-gw85zno51npz7lgc04z89', + ], + 'DomainResolveType' => [ + 'description' => '访问控制策略的域名解析方式。取值：'."\n" + ."\n" + .'* **FQDN**：基于FQDN'."\n" + .'* **DNS**：基于DNS动态解析'."\n" + .'* **FQDN_AND_DNS**：基于FQDN与DNS动态解析', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'example' => 'cen-cw4z051hr8x53qniv5', + ], + ], + ], + 'AclStatus' => [ + 'description' => 'ACL检查状态。', + 'type' => 'string', + 'example' => 'configuring', + ], + 'AclAssessmentDetail' => [ + 'description' => '该条ACL策略的研判详情。', + 'type' => 'string', + 'example' => '无流量命中策略。', + ], + ], + ], + ], + 'RecordAssessmentDetail' => [ + 'description' => '该条ACL检查研判详情。', + 'type' => 'string', + 'example' => '由于业务下线或其它原因等，导致对象策略一段时间命中次数为0。', + ], + 'CheckName' => [ + 'description' => 'ACL检查名称。取值：'."\n" + ."\n" + .'- **PolicyHitCountZero**：无流量命中策略'."\n" + ."\n" + .'- **PolicySourceDestinationSame**：源和目的对象相同无效策略'."\n" + ."\n" + .'- **PolicyDuplicate**：重复冗余策略'."\n" + ."\n" + .'- **PolicyConflict**：业务冲突策略'."\n" + ."\n" + .'- **DefaultPolicyNotDeny**：默认兜底策略不是Deny All白名单机制'."\n" + ."\n" + .'- **PolicyPortHighRisk**：高风险端口放行风险策略'."\n" + ."\n" + .'- **PolicyTooLoose**： 管控策略过于宽松'."\n" + ."\n" + .'- **AddressBookIpSeparated**：IP地址簿重复、重叠、分散'."\n" + ."\n" + .'- **AddressBookPortSeparated**：端口地址簿重复、重叠、分散'."\n" + ."\n" + .'- **AddressBookDomainValid**：域名地址簿合法性校验', + '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' => 'ACL检查任务ID。', + '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"}]', + 'title' => '修改ACL检查详情状态', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeAddressBook' => [ + 'summary' => '批量查询地址簿列表。', + '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' => '地址簿描述的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文（默认）', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页面的页码。'."\n" + ."\n" + .'默认值为1，表示返回第1页数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置每页包含的地址簿的数量。'."\n" + ."\n" + .'默认值为10，表示每页包含10条结果。最大值为50。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索条件，输入待查询地址簿信息。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的类型。'."\n" + ."\n" + .'> 不设置该参数表示查询IP地址簿和ECS标签地址簿。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'allCloud' => '云服务地址簿', + 'port' => '端口地址簿', + 'ipv6' => 'IPv6地址簿', + 'ip' => 'IPv4地址簿（默认）', + 'domain' => '域名地址簿', + 'ack' => 'ACK地址簿', + 'tag' => 'ECS标签地址簿', + 'threat' => '情报地址簿', + ], + 'example' => 'ip', + ], + ], + [ + 'name' => 'ContainPort', + 'in' => 'query', + 'schema' => [ + 'description' => '查询包含指定端口的地址簿。仅当**GroupType**参数的值为**port**时，该参数才会作为本次查询的条件。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '当前页面的页码。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页包含的地址簿的数量。', + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'B36F150A-1E27-43AA-B72C-D2AC712F09DA', + ], + 'TotalCount' => [ + 'description' => '地址簿的总数量。', + 'type' => 'string', + 'example' => '100', + ], + 'Acls' => [ + 'description' => '地址簿列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地址簿信息。', + 'type' => 'object', + 'properties' => [ + 'AddressListCount' => [ + 'description' => '地址簿中包含地址的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GroupUuid' => [ + 'description' => '地址簿的唯一标识ID。', + 'type' => 'string', + 'example' => 'f04ac7ce-628b-4cb7-be61-310222b7****', + ], + 'AutoAddTagEcs' => [ + 'description' => '是否自动添加新匹配标签的ECS（新购且完成标签设置的ECS或修改标签的ECS）公网IP到地址簿。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '不自动添加', + '自动添加', + ], + 'example' => '1', + ], + 'Description' => [ + 'description' => '地址簿的描述信息。', + 'type' => 'string', + 'example' => 'DEMO地址簿', + ], + 'GroupName' => [ + 'description' => '地址簿的名称。', + 'type' => 'string', + 'example' => 'demo_address_book', + ], + 'ReferenceCount' => [ + 'description' => '地址簿被引用次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'GroupType' => [ + 'description' => '地址簿的类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'allCloud' => '云服务地址簿', + 'port' => '端口地址簿', + 'ipv6' => 'IPv6地址簿', + 'ip' => 'IPv4地址簿', + 'ack' => 'ACK地址簿', + 'tag' => 'ECS标签地址簿', + 'threat' => '情报地址簿', + ], + 'example' => 'ip', + ], + 'TagRelation' => [ + 'description' => '多个ECS标签间的关系。', + 'type' => 'string', + 'enumValueTitles' => [ + 'or' => '多个标签间为“或”关系，即只要匹配一个标签的ECS公网IP就会被加入地址簿。', + 'and' => '多个标签间为“与”关系，即同时匹配多个标签的ECS公网IP才会被加入地址簿。', + ], + 'example' => 'and', + ], + 'TagList' => [ + 'description' => 'ECS标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS标签。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'ECS标签值。', + 'type' => 'string', + 'example' => '全部VALUE', + ], + 'TagKey' => [ + 'description' => 'ECS标签键。', + 'type' => 'string', + 'example' => 'company', + ], + ], + ], + ], + 'AddressList' => [ + 'description' => '地址簿的地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地址簿的地址信息。', + 'type' => 'string', + 'example' => '[ "192.168.XX.XX/32", "192.168.XX.XX/32" ]', + ], + ], + 'Addresses' => [ + 'description' => '地址簿的含单地址描述的地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地址簿的含单地址描述的地址。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '地址簿的地址信息。', + 'type' => 'string', + 'example' => '192.168.0.1/32', + ], + 'Note' => [ + 'description' => '单地址描述。', + 'type' => 'string', + 'example' => '单地址描述', + ], + ], + ], + ], + 'AckClusterConnectorId' => [ + 'title' => 'ACK集群连接器ID。', + 'description' => 'ACK集群连接器ID。', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + 'AckClusterConnectorName' => [ + 'title' => 'ACK集群连接器名称。', + 'description' => 'ACK集群连接器名称。', + 'type' => 'string', + 'example' => 'ack-cluster-connector-name', + ], + 'AckLabels' => [ + 'title' => 'ACK集群容器组标签列表。', + 'description' => 'ACK集群容器组标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组标签。', + 'description' => 'ACK集群容器组标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'ACK集群容器组标签的键。', + 'description' => 'ACK集群容器组标签的键。', + 'type' => 'string', + 'example' => 'app', + ], + 'Value' => [ + 'title' => 'ACK集群容器组标签的值。', + 'description' => 'ACK集群容器组标签的值。', + 'type' => 'string', + 'example' => 'storage-operator', + ], + ], + ], + ], + 'AckNamespaces' => [ + 'title' => 'ACK集群容器组命名空间列表。', + 'description' => 'ACK集群容器组命名空间列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组命名空间。', + 'description' => 'ACK集群容器组命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + ], + 'RegionNo' => [ + 'title' => '当GroupType是ACK地址簿时，地址簿仅在该地域的ACL策略生效。', + 'description' => '当GroupType是ACK地址簿时，地址簿所属的ACK集群连接器的地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '批量查询地址簿列表', + 'description' => '本接口一般用于查询访问控制策略地址簿的详细信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddAddressBook' => [ + 'summary' => '创建地址簿，包括IPv4地址簿、ECS标签地址簿、IPv6地址簿、域名地址簿、ACK地址簿。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿描述的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文（默认）', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'AddressList', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的地址列表，多个地址间用英文逗号分隔，一个地址元素用空格分隔地址和描述。'."\n" + ."\n" + .'> 当GroupType为`ip`、`port`或`domain`时必须设置。'."\n" + ."\n" + .'- 当GroupType为`ip`时，地址列表中填写IP地址。例如：192.0.XX.XX/32 开发网段，10.0.0.X/24,192.0.XX.XX/24 测试网段。'."\n" + ."\n" + .'- 当GroupType为`port`时，地址列表中填写端口或端口范围。例如：80 HTTP端口，100/200,3306 数据库端口。'."\n" + ."\n" + .'- 当GroupType为`domain`时，地址列表中填写域名。例如：example.com 测试域名，aliyundoc.com,www.aliyun.com 阿里云官网。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/32 开发网段,192.0.XX.XX/24 测试网段', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的描述信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'sz-001', + 'maxLength' => 256, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'sz-001', + 'maxLength' => 128, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'port' => '端口', + 'ackLabel' => 'ACK集群容器组标签', + 'ipv6' => 'IPv6', + 'ip' => 'IPv4', + 'domain' => '域名', + 'ackNamespace' => 'ACK集群容器组命名空间', + 'tag' => 'ECS标签', + ], + 'example' => 'ip', + ], + ], + [ + 'name' => 'AutoAddTagEcs', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动添加新匹配标签的ECS公网IP到地址簿。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '不自动添加（默认）', + '自动添加', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'TagRelation', + 'in' => 'query', + 'schema' => [ + 'description' => '待匹配的多个ECS标签间的关系。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'or' => '或。多个标签间为“或”关系，即只要匹配一个标签的ECS公网IP就会被加入地址簿。', + 'and' => '与（默认），多个标签间为“与”关系，即同时匹配多个标签的ECS公网IP才会被加入地址簿。', + ], + 'example' => 'and', + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'ECS标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS标签。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'ECS标签值。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'TagKey' => [ + 'description' => 'ECS标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TXY', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AckClusterConnectorId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ACK集群连接器ID。', + 'description' => 'ACK集群连接器ID。取值来源：'."\n" + .'- [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~)：批量查询ACK集群连接器列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ac-7c1bad6c3cc84c33baab1 ', + ], + ], + [ + 'name' => 'AckNamespaces', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'ACK集群容器组命名空间列表。', + 'description' => 'ACK集群容器组命名空间列表。'."\n" + .'> 数量最多10个。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组命名空间。', + 'description' => 'ACK集群容器组命名空间。取值来源：'."\n" + .'- [DescribeAckClusterNamespaces](~~DescribeAckClusterNamespaces~~)：批量查询ACK集群命名空间。'."\n" + ."\n" + .'> 当**GroupType**为**ackNamespace**时，必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'kube-system', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AckLabels', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'ACK集群容器组标签列表。', + 'description' => 'ACK集群容器组标签列表。'."\n" + ."\n" + .'> 数量最多10个。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组标签。', + 'description' => 'ACK集群容器组标签。取值来源：'."\n" + .'- [DescribeAckClusterPodLabels](~~DescribeAckClusterPodLabels~~)：批量查询ACK集群容器标签。'."\n" + ."\n" + .'> 当**GroupType**为**ackLabel**时，必填。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'ACK集群容器组标签的键。', + 'description' => 'ACK集群容器组标签的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + 'Value' => [ + 'title' => 'ACK集群容器组标签的值。', + 'description' => 'ACK集群容器组标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'storage-operator', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GroupUuid' => [ + 'description' => '添加成功后返回的地址簿唯一标识ID。', + 'type' => 'string', + 'example' => 'f04ac7ce-628b-4cb7-be61-310222b7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****', + ], + ], + ], + ], + ], + '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' => '创建地址簿', + 'description' => '本接口一般用于创建地址簿，包括IPv4地址簿、ECS标签地址簿、IPv6地址簿、域名地址簿、ACK地址簿。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见[公共参数](~~94763~~)。 '."\n" + .'调用API的请求格式，请参见本文**示例**中的请求示例。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAddressBook' => [ + 'summary' => '修改地址簿。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文（默认）', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'AddressList', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿中的地址列表，多个地址间用英文逗号分隔，一个地址元素用空格分隔地址和描述。当GroupType为**ip**、**port**或**domain**时，您必须配置此参数。'."\n" + ."\n" + .'- 当GroupType为**ip**时，地址列表中填写IP地址，例如：1.2.XX.XX/32 开发网段，10.0.0.X/24,1.2.XX.XX/24 测试网段。'."\n" + ."\n" + .'- 当GroupType为**port**时，地址列表中填写端口或端口范围，例如：80/80 HTTP端口，100/200,3306 数据库端口。'."\n" + ."\n" + .'- 当GroupType为**domain**时，地址列表中填写域名，例如：demo1.aliyun.com 测试域名，demo2.aliyun.com,www.aliyun.com 阿里云官网。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX/32 开发网段,192.0.XX.XX/24 测试网段', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的描述信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'bj-001', + 'maxLength' => 256, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'bj-001', + 'maxLength' => 128, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GroupUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的唯一标识ID。'."\n" + ."\n" + .'>取值来源：[批量查询地址簿列表](~~DescribeAddressBook~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '0657ab9d-fe8b-4174-b2a6-6baf358e****', + ], + ], + [ + 'name' => 'AutoAddTagEcs', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动添加新匹配标签的ECS公网IP到地址簿。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '不自动添加', + '自动添加', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'TagRelation', + 'in' => 'query', + 'schema' => [ + 'description' => '多个ECS标签间的关系。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'or' => '多个标签间为“或”关系，即只要匹配一个标签的ECS公网IP就会被加入地址簿。', + 'and' => '多个标签间为“与”关系，即同时匹配多个标签的ECS公网IP才会被加入地址簿。', + ], + 'example' => 'and', + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'ECS标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS标签。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'ECS标签值。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'TagKey' => [ + 'description' => 'ECS标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TXY', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '修改方式。'."\n" + ."\n" + .'>当 GroupType 为 **ip**、**ipv6**、**port** 或 **domain** 时，不配置该参数时，默认采用**Cover**方式修改地址簿。'."\n" + .'><notice>当 GroupType 为 **tag** 时，该参数必须为空。></notice>', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Delete' => '在地址簿中删除使用AddressList参数的值。', + 'Cover' => '使用AddressList参数的值覆盖原地址簿。', + 'Append' => '在原地址簿后，使用AddressList参数的值追加修改的地址。', + ], + 'example' => 'Cover', + 'enum' => [ + 'Cover', + 'Append', + 'Delete', + ], + ], + ], + [ + 'name' => 'AckNamespaces', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'ACK集群容器组命名空间列表。', + 'description' => 'ACK集群容器组命名空间列表。'."\n" + .'> 数量最多10个。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组命名空间。', + 'description' => 'ACK集群容器组命名空间。取值来源：'."\n" + .'- [DescribeAckClusterNamespaces](~~DescribeAckClusterNamespaces~~)：批量查询ACK集群命名空间。'."\n" + ."\n" + .'> 当**GroupType**为**ackNamespace**时，必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AckLabels', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'ACK集群容器组标签列表。', + 'description' => 'ACK集群容器组标签列表。'."\n" + ."\n" + .'> 数量最多10个。', + 'type' => 'array', + 'items' => [ + 'title' => 'ACK集群容器组标签。', + 'description' => 'ACK集群容器组标签。取值来源：'."\n" + .'- [DescribeAckClusterPodLabels](~~DescribeAckClusterPodLabels~~)：批量查询ACK集群容器标签。'."\n" + ."\n" + .'> 当**GroupType**为**ackLabel**时，必填。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'ACK集群容器组标签的键。', + 'description' => 'ACK集群容器组标签的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + 'Value' => [ + 'title' => 'ACK集群容器组标签的值。', + 'description' => 'ACK集群容器组标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'storage-operator', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '修改地址簿', + 'description' => '本接口一般用于修改地址簿。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见[公共参数](~~94763~~)。 '."\n" + .'调用API的请求格式，请参见本文**示例**中的请求示例。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAddressBook' => [ + 'summary' => '删除地址簿。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文（默认）', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'GroupUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '地址簿的唯一标识ID。'."\n" + ."\n" + .'>取值来源：[批量查询地址簿列表](~~DescribeAddressBook~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '0657ab9d-fe8b-4174-b2a6-6baf358e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '删除地址簿', + 'description' => '本接口一般用于删除访问控制中的地址簿。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见[公共参数](~~94763~~)。 '."\n" + .'调用API的请求格式，请参见本文**示例**中的请求示例。', + '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' => '同步节点类型。取值：'."\n" + ."\n" + .'- **PrivateDns**：私有DNS。'."\n" + ."\n" + .'- **AckClusterConnector**：ACK集群连接器。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AckClusterConnector' => 'ACK集群连接器', + 'PrivateDns' => '私有DNS', + ], + 'example' => 'AckClusterConnector', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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"}]', + 'title' => '查询同步节点地域列表', + ], + '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' => '同步节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pdi-3bc2f91695ee48bd9377', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + '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' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'task-c92d4544ef7b6a42', + ], + ], + [ + 'name' => 'AccessInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '同步节点类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AckClusterConnector' => 'ACK集群连接器', + 'PrivateDNS' => '私有DNS', + ], + 'example' => 'AckClusterConnector', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '创建ACK集群连接器', + ], + 'TaskId' => [ + 'description' => '任务ID。', + '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' => '获取ACK集群信息', + ], + '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"}]', + 'title' => '查询同步节点任务进度', + ], + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属的阿里云UID。', + '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' => '请求ID。', + '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' => 'VPC列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC列表。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-2ze1t4irqj0fljlbb****'."\n", + ], + 'VpcName' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'example' => 'Cloud_Firewall_VPC', + ], + 'FirewallVpc' => [ + 'description' => '是否防火墙托管VPC。', + '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"}]', + 'title' => '查询同步节点VPC列表', + ], + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-qzeaol304m***', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属的阿里云UID。', + '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' => '请求ID。', + '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' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'VSwitchList' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '交换机所属的VPC ID。', + 'type' => 'string', + 'example' => 'vpc-uf6b5lyul0x******', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-qzeaol304m***', + ], + 'VSwitchName' => [ + 'description' => '交换机的名称。', + 'type' => 'string', + 'example' => 'ManagedVSW', + ], + 'CidrBlock' => [ + 'description' => '交换机的IPv4网段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'AvailableIpAddressCount' => [ + 'description' => '交换机中可用的IP地址数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '254', + ], + 'FirewallVSwitch' => [ + 'description' => '是否防火墙托管VPC。', + '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"}]', + 'title' => '查询同步节点交换机列表', + ], + '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' => 'ACK集群连接器', + 'PrivateDNS' => '私有DNS', + ], + 'example' => 'AckClusterConnector', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '北京 可用区G', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + '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"}]', + 'title' => '查询同步节点可用区列表', + ], + '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' => 'ACK集群地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群资源所属的阿里云UID。', + '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' => 'ACK集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cb0f5640b1b2d404cad6ba21509d7847b', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-cluster-name', + ], + ], + [ + 'name' => 'ClusterSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群规格。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ack.pro.small' => '集群 Pro 版', + ], + 'example' => 'ack.pro.small', + ], + ], + [ + 'name' => 'ConnectorStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器实例状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'ready', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Clusters' => [ + 'description' => 'ACK集群列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACK集群。', + 'type' => 'object', + 'properties' => [ + 'MemberUid' => [ + 'description' => 'ACK集群资源所属的阿里云UID。', + 'type' => 'string', + 'example' => '135809047715****', + ], + 'RegionId' => [ + 'description' => 'ACK集群地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ClusterId' => [ + 'description' => 'ACK集群ID。', + 'type' => 'string', + 'example' => 'cb0f5640b1b2d404cad6ba21509d7847b', + ], + 'ClusterName' => [ + 'description' => 'ACK集群名称。', + 'type' => 'string', + 'example' => 'ack-cluster-name', + ], + 'ClusterType' => [ + 'description' => 'ACK集群类型。取值来源：'."\n" + .'- [DescribeClustersV1](~~DescribeClustersV1~~)：查看本账号下符合条件的ACK集群（例如指定集群类型、集群规格）列表信息。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ExternalKubernetes' => '注册集群。', + 'ManagedKubernetes' => 'ACK 托管类的集群，包括 ACK 托管集群（Pro 版、基础版）、ACK Serverless 集群（Pro 版、基础版）、ACK Edge 集群（Pro 版、基础版）、ACK 灵骏集群（Pro 版）。', + 'Kubernetes' => 'ACK 专有集群。', + ], + 'example' => 'ManagedKubernetes', + ], + 'Profile' => [ + 'description' => '当您选择`cluster_type`为`ManagedKubernetes`时，即 ACK 托管类的集群时，您可以进一步指定集群的子类型。取值来源：'."\n" + .'- [DescribeClustersV1](~~DescribeClustersV1~~)：查看本账号下符合条件的ACK集群（例如指定集群类型、集群规格）列表信息。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Lingjun' => 'ACK 灵骏集群，提供 Pro 版。', + 'Serverless' => 'ACK Serverless 集群，包括 ACK Serverless 集群 Pro 版和 ACK Serverless 集群基础版。', + 'Default' => 'ACK 托管集群，包括 ACK 集群 Pro 版和 ACK 集群基础版。', + 'Edge' => 'ACK Edge 集群，包括 ACK Edge 集群 Pro 版和 ACK Edge 集群基础版。', + ], + 'example' => 'Default', + ], + 'VpcId' => [ + 'description' => 'ACK集群所属VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-2vcg932hsxsxuqbgl****', + ], + 'Network' => [ + 'description' => 'ACK集群网络插件。取值来源：'."\n" + .'- [DescribeClustersV1](~~DescribeClustersV1~~)：查看本账号下符合条件的ACK集群（例如指定集群类型、集群规格）列表信息。', + 'type' => 'string', + 'enumValueTitles' => [ + 'terway-eniip' => 'Terway-eniip', + 'Flannel' => 'Flannel', + ], + 'example' => 'terway-eniip', + ], + 'ClusterSpec' => [ + 'description' => 'ACK集群规格。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ack.pro.small' => '集群 Pro 版', + ], + 'example' => 'ack.pro.small', + ], + 'State' => [ + 'description' => 'ACK集群运行状态。取值来源：'."\n" + .'- [DescribeClustersV1](~~DescribeClustersV1~~)：查看本账号下符合条件的ACK集群（例如指定集群类型、集群规格）列表信息。', + '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' => '请求ID。', + '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"}]', + 'title' => '批量查询ACK集群', + ], + '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' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器地域ID。取值来源：'."\n" + .'- [DescribeAccessInstanceRegionList](~~DescribeAccessInstanceRegionList~~)：查询同步节点地域列表。'."\n" + ."\n" + .'> 关于云防火墙支持ACK集群连接器地域的详细信息，请参见[ACK集群同步节点](~~2865120~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'ConnectorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群所属的VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => '0E0C30C977463****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '显示ACK集群连接器健康状态错误原因的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文（默认）', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AckClusterConnectors' => [ + 'description' => 'ACK集群连接器列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACK集群连接器。', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => 'ACK集群连接器ID。', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + 'ConnectorName' => [ + 'description' => 'ACK集群连接器名称。', + 'type' => 'string', + 'example' => 'ack-cluster-connector-name', + ], + 'MemberUid' => [ + 'description' => '阿里云成员账号的UID。', + 'type' => 'string', + 'example' => '159663371500****', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ClusterId' => [ + 'description' => 'ACK集群ID。', + 'type' => 'string', + 'example' => 'f9b9815a5280****', + ], + 'ClusterName' => [ + 'description' => 'ACK集群名称。', + 'type' => 'string', + 'example' => 'TestClusterA', + ], + 'VpcId' => [ + 'description' => 'ACK集群所属VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + 'PrimaryVswitchId' => [ + 'description' => '主交换机。', + 'type' => 'string', + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + 'PrimaryVswitchZoneId' => [ + 'description' => '主交换机可用区。', + 'type' => 'string', + 'example' => 'cn-beijing-g', + ], + 'PrimaryVswitchIp' => [ + 'description' => '主交换机IP。', + 'type' => 'string', + 'example' => '10.100.2.XXX', + ], + 'StandbyVswitchId' => [ + 'description' => '备交换机。', + 'type' => 'string', + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + 'StandbyVswitchZoneId' => [ + 'description' => '备交换机可用区。', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + 'StandbyVswitchIp' => [ + 'description' => '备交换机IP。', + 'type' => 'string', + 'example' => '10.100.1.XXX'."\n", + ], + 'Ttl' => [ + 'description' => 'ACK集群连接器同步容器周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ConnectorStatus' => [ + 'description' => 'ACK集群连接器实例状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '初始化中', + 'deleting' => '删除中', + 'ready' => '正常', + ], + 'example' => 'ready', + ], + 'ConnectorHealthCheckStatus' => [ + 'description' => 'ACK集群连接器的健康检查状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '初始化中', + 'healthy' => '健康', + 'unhealthy' => '不健康', + ], + 'example' => 'healthy', + ], + 'UnhealthyReason' => [ + 'description' => 'ACK集群连接器不健康的原因。', + 'type' => 'string', + 'example' => '指定的ACK集群不存在', + ], + 'GroupUuids' => [ + 'description' => '创建于ACK集群连接器的地址簿UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '创建于ACK集群连接器的地址簿UUID。', + 'type' => 'string', + 'example' => '["b84dec36-c4fc-458e-98b8-f1b5dd23****","8015d9eb-8382-4388-b965-b92d806d****"]', + ], + ], + 'CreateTime' => [ + 'description' => 'ACK集群连接器创建时间。', + 'type' => 'string', + 'example' => '1760493347', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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"}]', + 'title' => '批量查询ACK集群连接器列表', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => 'ACK集群连接器ID。取值来源：'."\n" + .'- [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~)：批量查询ACK集群连接器列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '显示ACK集群连接器健康状态错误原因的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文（默认）', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckClusterConnector' => [ + 'description' => 'ACK集群连接器。', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => 'ACK集群连接器ID。取值来源：'."\n" + .'- [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~)：批量查询ACK集群连接器列表。', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + 'ConnectorName' => [ + 'description' => 'ACK集群连接器名称。长度为1~64个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'example' => 'ack-cluster-connector-name', + ], + 'MemberUid' => [ + 'description' => 'ACK集群资源所属的阿里云UID。', + 'type' => 'string', + 'example' => '135809047715****'."\n", + ], + 'RegionNo' => [ + 'description' => 'ACK集群连接器地域ID。取值来源：'."\n" + .'- [DescribeAccessInstanceRegionList](~~DescribeAccessInstanceRegionList~~)：查询同步节点地域列表。'."\n" + ."\n" + .'> 关于云防火墙支持ACK集群连接器地域的详细信息，请参见[ACK集群同步节点](~~2865120~~)。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ClusterId' => [ + 'description' => 'ACK集群ID。取值来源：'."\n" + .'- [DescribeAckClusters](~~DescribeAckClusters~~)：批量查询ACK集群列表。', + 'type' => 'string', + 'example' => 'c857d908016794125883a9ee8196cba17', + ], + 'ClusterName' => [ + 'description' => 'ACK集群名称。', + 'type' => 'string', + 'example' => 'ack-cluster-name', + ], + 'VpcId' => [ + 'description' => 'ACK集群所属VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + 'Ttl' => [ + 'description' => 'ACK集群连接器同步周期间隔。范围：2~60秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PrimaryVswitchId' => [ + 'description' => 'ACK集群连接器主交换机。取值来源：'."\n" + .'- [DescribeAccessInstanceVSwitchList](~~DescribeAccessInstanceVSwitchList~~)：批量查询同步节点交换机列表。', + 'type' => 'string', + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + 'PrimaryVswitchZoneId' => [ + 'description' => 'ACK集群连接器主交换机可用区。取值来源：'."\n" + .'- [DescribeAccessInstanceZoneList](~~DescribeAccessInstanceZoneList~~)：批量查询同步节点交换机可用区列表。', + 'type' => 'string', + 'example' => 'cn-beijing-g', + ], + 'PrimaryVswitchIp' => [ + 'description' => 'ACK集群连接器主交换机IP。', + 'type' => 'string', + 'example' => '10.100.1.1', + ], + 'StandbyVswitchId' => [ + 'description' => 'ACK集群连接器备交换机。取值来源：'."\n" + .'- [DescribeAccessInstanceVSwitchList](~~DescribeAccessInstanceVSwitchList~~)：批量查询同步节点交换机列表。', + 'type' => 'string', + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + 'StandbyVswitchZoneId' => [ + 'description' => 'ACK集群连接器备交换机可用区。取值来源：'."\n" + .'- [DescribeAccessInstanceZoneList](~~DescribeAccessInstanceZoneList~~)：批量查询同步节点交换机可用区列表。', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + 'StandbyVswitchIp' => [ + 'description' => 'ACK集群连接器备交换机IP。', + 'type' => 'string', + 'example' => '10.100.2.1', + ], + 'ConnectorStatus' => [ + 'description' => 'ACK集群连接器实例状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '初始化中', + 'deleting' => '删除中', + 'ready' => '正常', + ], + 'example' => 'ready', + ], + 'ConnectorHealthCheckStatus' => [ + 'description' => 'ACK集群连接器的健康检查状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '初始化中', + 'healthy' => '健康', + 'unhealthy' => '不健康', + ], + 'example' => 'healthy', + ], + 'UnhealthyReason' => [ + 'description' => 'ACK集群连接器不健康的原因。', + 'type' => 'string', + 'example' => 'The ACK cluster status is unavailable.', + ], + 'CreateTime' => [ + 'description' => '创建ACK集群连接器的时间戳，单位：秒。', + 'type' => 'string', + 'example' => '1724982259', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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"}]', + 'title' => '查询ACK集群连接器详情', + ], + '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' => 'ACK集群连接器ID。取值来源：'."\n" + .'- [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~)：批量查询ACK集群连接器列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckNamespaces' => [ + 'description' => 'ACK集群命名空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACK集群命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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"}]', + 'title' => '批量查询ACK集群命名空间', + ], + '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' => 'ACK集群连接器ID。取值来源：'."\n" + .'- [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~)：批量查询ACK集群连接器列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckLabels' => [ + 'description' => 'ACK标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ACK标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'app', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'storage-operator', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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"}]', + 'title' => '批量查询ACK集群容器标签', + ], + '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' => 'ACK集群资源所属的阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '135809047715****', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器地域ID。取值来源：'."\n" + .'- [DescribeAccessInstanceRegionList](~~DescribeAccessInstanceRegionList~~)：查询同步节点地域列表。'."\n" + ."\n" + .'> 关于云防火墙支持ACK集群连接器地域的详细信息，请参见[ACK集群同步节点](~~2865120~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ConnectorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器名称。长度为1~64个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'ack-cluster-connector-name', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群ID。取值来源：'."\n" + .'- [DescribeAckClusters](~~DescribeAckClusters~~)：批量查询ACK集群列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'cb0f5640b1b2d404cad6ba21509d7847b', + ], + ], + [ + 'name' => 'PrimaryVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器主交换机。取值来源：'."\n" + .'- [DescribeAccessInstanceVSwitchList](~~DescribeAccessInstanceVSwitchList~~)：批量查询同步节点交换机列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + ], + [ + 'name' => 'PrimaryVswitchIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器主交换机IP。', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.1.1', + ], + ], + [ + 'name' => 'StandbyVswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器备交换机。取值来源：'."\n" + .'- [DescribeAccessInstanceVSwitchList](~~DescribeAccessInstanceVSwitchList~~)：批量查询同步节点交换机列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + ], + [ + 'name' => 'StandbyVswitchIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器备交换机IP。', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.2.1', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器同步周期间隔。范围：2~60秒。', + 'type' => 'string', + 'required' => true, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckClusterConnector' => [ + 'description' => 'ACK集群连接器返回体。', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => 'ACK集群连接器唯一标识ID。', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + 'ConnectorName' => [ + 'description' => 'ACK集群连接器名称。长度为1~64个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'example' => 'ack-cluster-connector-name', + ], + 'MemberUid' => [ + 'description' => 'ACK集群资源所属的阿里云UID。', + 'type' => 'string', + 'example' => '135809047715****', + ], + 'RegionNo' => [ + 'description' => 'ACK集群连接器地域ID。取值来源：'."\n" + .'- [DescribeAccessInstanceRegionList](~~DescribeAccessInstanceRegionList~~)：查询同步节点地域列表。'."\n" + ."\n" + .'> 关于云防火墙支持ACK集群连接器地域的详细信息，请参见[ACK集群同步节点](~~2865120~~)。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ClusterId' => [ + 'description' => 'ACK集群ID。取值来源：'."\n" + .'- [DescribeAckClusters](~~DescribeAckClusters~~)：批量查询ACK集群列表。', + 'type' => 'string', + 'example' => 'cb0f5640b1b2d404cad6ba21509d7847b', + ], + 'ClusterName' => [ + 'description' => 'ACK集群名称。', + 'type' => 'string', + 'example' => 'ack-cluster-name', + ], + 'VpcId' => [ + 'description' => 'ACK集群所属VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + 'PrimaryVswitchId' => [ + 'description' => 'ACK集群连接器主交换机。取值来源：'."\n" + .'- [DescribeAccessInstanceVSwitchList](~~DescribeAccessInstanceVSwitchList~~)：批量查询同步节点交换机列表。', + 'type' => 'string', + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + 'PrimaryVswitchZoneId' => [ + 'description' => 'ACK集群连接器主交换机可用区。取值来源：'."\n" + .'- [DescribeAccessInstanceZoneList](~~DescribeAccessInstanceZoneList~~)：批量查询同步节点交换机可用区列表。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'PrimaryVswitchIp' => [ + 'description' => 'ACK集群连接器主交换机IP。', + 'type' => 'string', + 'example' => '10.100.1.1', + ], + 'StandbyVswitchId' => [ + 'description' => 'ACK集群连接器备交换机。取值来源：'."\n" + .'- [DescribeAccessInstanceVSwitchList](~~DescribeAccessInstanceVSwitchList~~)：批量查询同步节点交换机列表。', + 'type' => 'string', + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + 'StandbyVswitchZoneId' => [ + 'description' => 'ACK集群连接器备交换机可用区。取值来源：'."\n" + .'- [DescribeAccessInstanceZoneList](~~DescribeAccessInstanceZoneList~~)：批量查询同步节点交换机可用区列表。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'StandbyVswitchIp' => [ + 'description' => 'ACK集群连接器备交换机IP。', + 'type' => 'string', + 'example' => '10.100.2.1', + ], + 'Ttl' => [ + 'description' => 'ACK集群连接器同步周期间隔。范围：2~60秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ConnectorStatus' => [ + 'description' => 'ACK集群连接器实例状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '初始化中', + 'deleting' => '删除中', + 'ready' => '正常', + ], + 'example' => 'ready', + ], + 'ConnectorHealthCheckStatus' => [ + 'description' => 'ACK集群连接器的健康检查状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '初始化中', + 'healthy' => '健康', + 'unhealthy' => '不健康', + ], + 'example' => 'healthy', + ], + 'AckClientHostIp' => [ + 'description' => 'ACK集群连接器，通过内网访问ACK集群的上车点IP。', + 'type' => 'string', + 'example' => '10.40.32.240', + ], + 'TaskId' => [ + 'description' => '创建ACK集群连接器的任务唯一标识ID。', + 'type' => 'string', + 'example' => 'task-c92d4544ef7b6a42', + ], + 'CreateTime' => [ + 'description' => '创建ACK集群连接器的时间戳，单位：秒。', + 'type' => 'string', + 'example' => '1724982259', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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"}]', + 'title' => '创建ACK集群连接器', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => 'ACK集群连接器ID。取值来源：'."\n" + .'- [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~)：批量查询ACK集群连接器列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + [ + 'name' => 'ConnectorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器名称。长度为1~64个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-cluster-connector-name', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACK集群连接器同步周期间隔。范围：2~60秒。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AckClusterConnector' => [ + 'description' => 'ACK集群连接器。', + 'type' => 'object', + 'properties' => [ + 'ConnectorId' => [ + 'description' => 'ACK集群连接器ID。取值来源：'."\n" + .'- [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~)：批量查询ACK集群连接器列表。', + 'type' => 'string', + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + 'ConnectorName' => [ + 'description' => 'ACK集群连接器名称。长度为1~64个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'example' => 'ack-cluster-connector-name', + ], + 'MemberUid' => [ + 'description' => 'ACK集群资源所属的阿里云UID。', + 'type' => 'string', + 'example' => '135809047715****'."\n", + ], + 'RegionNo' => [ + 'description' => 'ACK集群连接器地域ID。取值来源：'."\n" + .'- [DescribeAccessInstanceRegionList](~~DescribeAccessInstanceRegionList~~)：查询同步节点地域列表。'."\n" + ."\n" + .'> 关于云防火墙支持ACK集群连接器地域的详细信息，请参见[ACK集群同步节点](~~2865120~~)。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ClusterId' => [ + 'description' => 'ACK集群ID。取值来源：'."\n" + .'- [DescribeAckClusters](~~DescribeAckClusters~~)：批量查询ACK集群列表。', + 'type' => 'string', + 'example' => 'c57ecf39ff32c415e8549a7df27a7e947', + ], + 'ClusterName' => [ + 'description' => 'ACK集群名称。', + 'type' => 'string', + 'example' => 'ack-cluster-name', + ], + 'VpcId' => [ + 'description' => 'ACK集群所属VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-j6cvhdscntzuvr0x****', + ], + 'PrimaryVswitchId' => [ + 'description' => 'ACK集群连接器主交换机。取值来源：'."\n" + .'- [DescribeAccessInstanceVSwitchList](~~DescribeAccessInstanceVSwitchList~~)：批量查询同步节点交换机列表。', + 'type' => 'string', + 'example' => 'vsw-2zerfbbje7dvnbii2****', + ], + 'PrimaryVswitchZoneId' => [ + 'description' => 'ACK集群连接器主交换机可用区。取值来源：'."\n" + .'- [DescribeAccessInstanceZoneList](~~DescribeAccessInstanceZoneList~~)：批量查询同步节点交换机可用区列表。', + 'type' => 'string', + 'example' => 'cn-beijing-g', + ], + 'PrimaryVswitchIp' => [ + 'description' => 'ACK集群连接器主交换机IP。', + 'type' => 'string', + 'example' => '10.100.1.1', + ], + 'StandbyVswitchId' => [ + 'description' => 'ACK集群连接器备交换机。取值来源：'."\n" + .'- [DescribeAccessInstanceVSwitchList](~~DescribeAccessInstanceVSwitchList~~)：批量查询同步节点交换机列表。', + 'type' => 'string', + 'example' => 'vsw-2ze2gtlfozrab01cfo****', + ], + 'StandbyVswitchZoneId' => [ + 'description' => 'ACK集群连接器备交换机可用区。取值来源：'."\n" + .'- [DescribeAccessInstanceZoneList](~~DescribeAccessInstanceZoneList~~)：批量查询同步节点交换机可用区列表。', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + 'StandbyVswitchIp' => [ + 'description' => 'ACK集群连接器备交换机IP。', + 'type' => 'string', + 'example' => '10.100.2.1', + ], + 'Ttl' => [ + 'description' => 'ACK集群连接器同步周期间隔。范围：2~60秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ConnectorStatus' => [ + 'description' => 'ACK集群连接器实例状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '初始化中', + 'deleting' => '删除中', + 'ready' => '正常', + ], + 'example' => 'ready', + ], + 'ConnectorHealthCheckStatus' => [ + 'description' => 'ACK集群连接器的健康检查状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '初始化中', + 'healthy' => '健康', + 'unhealthy' => '不健康', + ], + 'example' => 'healthy', + ], + 'CreateTime' => [ + 'description' => '创建ACK集群连接器的时间戳，单位：秒。', + 'type' => 'string', + 'example' => '1724982259', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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"}]', + 'title' => '修改ACK集群连接器', + ], + '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' => 'ACK集群连接器ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ac-7c1bad6c3cc84c33baab', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '删除ACK集群连接器', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'AccessInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '私有实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'FirewallType', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙类型。取值：'."\n" + .'- **internet**'."\n" + .'- **vpc**'."\n" + .'- **nat**', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '实例状态。取值：'."\n" + ."\n" + .'- **creating**：创建中。'."\n" + .'- **deleting**：删除中。'."\n" + .'- **normal**：正常。'."\n" + .'- **updating**：更新中。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '成员账号UID。', + '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' => '返回结果的请求ID。', + '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' => '云防火墙账号的AliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1379490574415****', + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1844802493****', + ], + 'RegionNo' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FirewallType' => [ + 'description' => '云防火墙类型。取值：'."\n" + .'- **internet**'."\n" + .'- **vpc**'."\n" + .'- **nat**', + 'type' => 'array', + 'items' => [ + 'description' => '云防火墙类型。取值：'."\n" + .'- **internet**'."\n" + .'- **vpc**'."\n" + .'- **nat**', + 'type' => 'string', + 'example' => '['."\n" + .' "internet",'."\n" + .' "vpc",'."\n" + .' "nat"'."\n" + .']', + ], + ], + 'AccessInstanceId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'example' => '123', + ], + 'AccessInstanceName' => [ + 'description' => '私有实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'PrivateDnsType' => [ + 'description' => '私有DNS类型。取值：'."\n" + .'- **PrivateZone**'."\n" + .'- **Custom**（默认）', + 'type' => 'string', + 'example' => 'Custom', + ], + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-2zelphbaourpun****', + ], + 'PrimaryDns' => [ + 'description' => '主DNS。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'StandbyDns' => [ + 'description' => '备DNS。', + 'type' => 'string', + 'example' => '1.1.1.2', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + 'IpProtocol' => [ + 'description' => 'IP协议。取值：'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'tcp', + ], + 'Status' => [ + 'description' => '实例状态。取值：'."\n" + ."\n" + .'- **creating**：创建中。'."\n" + .'- **deleting**：删除中。'."\n" + .'- **normal**：正常。'."\n" + .'- **updating**：更新中。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'normal', + ], + 'DomainNameCount' => [ + 'description' => '域名数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'TaskId' => [ + 'description' => '任务Id，任务的唯一标识。', + '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"}]', + 'title' => '查询私网DNS终端节点列表', + ], + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域ID。', + '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' => '结果的请求ID。', + 'type' => 'string', + 'example' => '4E7F94C7-781F-5192-86CF-DB0850****', + ], + 'AliUid' => [ + 'description' => '云防火墙账号的AliUid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '119898001566xxxx', + ], + 'MemberUid' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '258039427902****', + ], + 'RegionNo' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FirewallType' => [ + 'description' => '云防火墙类型。取值：'."\n" + .'- **internet**'."\n" + .'- **vpc**'."\n" + .'- **nat**', + 'type' => 'array', + 'items' => [ + 'description' => '云防火墙类型。取值：'."\n" + .'- **internet**'."\n" + .'- **vpc**'."\n" + .'- **nat**', + 'type' => 'string', + 'example' => '['."\n" + .' "internet",'."\n" + .' "vpc",'."\n" + .' "nat"'."\n" + .']', + ], + ], + 'AccessInstanceId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'pd-12345', + ], + 'AccessInstanceName' => [ + 'description' => '私有实例名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'PrivateDnsType' => [ + 'description' => '私有DNS类型。取值：'."\n" + .'- **PrivateZone**'."\n" + .'- **Custom**（默认）', + 'type' => 'string', + 'example' => 'Custom', + ], + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-uf6b5lyul0x******', + ], + 'PrimaryVSwitchId' => [ + 'description' => '主交换机id。', + 'type' => 'string', + 'example' => 'vsw-8vbno9zxz8j9qiot****', + ], + 'PrimaryZoneId' => [ + 'description' => '主vswitch可用区。', + 'type' => 'string', + 'example' => 'cn-shenzhen-d', + ], + 'PrimaryVSwitchIp' => [ + 'description' => '主交换机ip。', + 'type' => 'string', + 'example' => '10.1.1.1', + ], + 'StandbyVSwitchId' => [ + 'description' => '备交换机id。', + 'type' => 'string', + 'example' => 'vsw-8vb6jk75wfcwnuq****', + ], + 'StandbyZoneId' => [ + 'description' => '备vswitch可用区。', + 'type' => 'string', + 'example' => 'cn-shenzhen-e', + ], + 'StandbyVSwitchIp' => [ + 'description' => '备交换机ip。', + 'type' => 'string', + 'example' => '10.1.1.2', + ], + 'PrimaryDns' => [ + 'description' => '主DNS。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'StandbyDns' => [ + 'description' => '备DNS。', + 'type' => 'string', + 'example' => '1.1.1.2', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'IpProtocol' => [ + 'description' => 'IP协议。取值：'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + 'type' => 'string', + 'example' => 'tcp', + ], + 'Status' => [ + 'description' => '实例状态。取值：'."\n" + ."\n" + .'- **creating**：创建中。'."\n" + .'- **deleting**：删除中。'."\n" + .'- **normal**：正常。'."\n" + .'- **updating**：更新中。', + 'type' => 'string', + 'example' => 'normal', + ], + 'EndpointId' => [ + 'description' => '终端节点ID。', + 'type' => 'string', + 'example' => 'ep-1nmi412c28c374****', + ], + 'TaskId' => [ + 'description' => '任务Id，任务的唯一标识。', + '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"}]', + 'title' => '查询私网DNS终端节点详情', + 'description' => '接口用于查询已创建的私有DNS终端节点详情。', + ], + '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' => '状态异常的私有DNS实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'CreatedPrivateDnsCount' => [ + 'description' => '已创建私有DNS实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'DomainNameTotalCount' => [ + 'description' => '已配置的域名总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'NewDomainNameTotalCount' => [ + 'description' => '已配置的域名中，所选时间范围内创建的域名数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NormalPrivateDnsCount' => [ + 'description' => '状态正常的私有DNS实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'PrivateDnsRegionList' => [ + 'description' => 'DNS区域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'DNS区域列表。', + 'type' => 'object', + 'properties' => [ + 'DomainNameCount' => [ + 'description' => '当前地域私有DNS已配置的域名数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'NewDomainNameCount' => [ + 'description' => '当前地域，已配置的域名中，所选时间范围内创建的域名数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PrivateDnsCount' => [ + 'description' => '当前地域私有DNS实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RegionNo' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '查询私有DNS的统计信息', + ], + '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' => '私有DNS类型。取值：'."\n" + .'- **PrivateZone**'."\n" + .'- **Custom**（默认）', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-uf6b5lyul0x******', + ], + ], + [ + 'name' => 'PrimaryVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '主交换机id。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6b0dkyryer8******'."\n", + ], + ], + [ + 'name' => 'StandbyVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '备交换机id。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-8vb6jk75wfcwn******'."\n", + ], + ], + [ + 'name' => 'PrimaryVSwitchIp', + 'in' => 'query', + 'schema' => [ + 'description' => '主交换机ip。', + 'type' => 'string', + 'required' => false, + 'example' => '10.1.1.1'."\n", + ], + ], + [ + 'name' => 'StandbyVSwitchIp', + 'in' => 'query', + 'schema' => [ + 'description' => '备交换机ip。', + 'type' => 'string', + 'required' => false, + 'example' => '10.2.2.2', + ], + ], + [ + 'name' => 'IpProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP协议。取值：'."\n" + .'- **TCP**'."\n" + .'- **UDP**', + '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' => '云防火墙类型。取值：'."\n" + .'- **internet**'."\n" + .'- **vpc**'."\n" + .'- **nat**', + 'type' => 'array', + 'items' => [ + 'description' => '云防火墙类型。取值：'."\n" + .'- **internet**'."\n" + .'- **vpc**'."\n" + .'- **nat**', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "internet",'."\n" + .' "vpc",'."\n" + .' "nat"'."\n" + .']', + ], + 'required' => true, + 'maxItems' => 3, + 'minItems' => 1, + ], + ], + [ + 'name' => 'PrimaryDns', + 'in' => 'query', + 'schema' => [ + 'description' => '主DNS。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1', + ], + ], + [ + 'name' => 'StandbyDns', + 'in' => 'query', + 'schema' => [ + 'description' => '备DNS。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.2', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云成员账号的UID。', + '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' => '实例ID', + 'type' => 'string', + 'example' => 'pd-12345', + ], + 'TaskId' => [ + 'description' => '任务Id，任务的唯一标识。', + '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"}]', + 'title' => '创建私网DNS终端节点', + 'description' => '使用本接口创建一条对经过NAT防火墙流量放行、拒绝或观察的策略。', + ], + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'PrivateDnsType', + 'in' => 'query', + 'schema' => [ + 'description' => '私有DNS类型。取值：'."\n" + .'- **PrivateZone**'."\n" + .'- **Custom**', + 'type' => 'string', + 'required' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'PrimaryDns', + 'in' => 'query', + 'schema' => [ + 'description' => '主DNS。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1', + ], + ], + [ + 'name' => 'StandbyDns', + 'in' => 'query', + 'schema' => [ + 'description' => '备DNS。', + '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' => '实例所在的地域ID。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '修改私网DNS终端节点', + ], + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域ID。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '删除私网DNS终端节点', + 'description' => '使用本接口创建一条对经过NAT防火墙流量放行、拒绝或观察的策略。', + ], + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '822B9125-6E1A-551C-8EAF-6E7AE74****', + ], + 'TotalCount' => [ + 'description' => '私网DNS域名列表总数。', + '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"}]', + 'title' => '查询私网DNS域名列表', + 'description' => '接口用于查询需要使用私有DNS终端节点进行域名解析的域名列表。', + ], + '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' => '私有 DNS 解析实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cfw-xxx', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的区域ID。'."\n" + ."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + '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"}]', + 'title' => '添加私网DNS域名', + 'description' => '本接口一般用于获取域名DNS的解析结果。当前仅支持从阿里云云解析DNS获取解析结果。要查询的域名必须使用云解析DNS，才能查询到其解析结果。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域ID。', + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '删除私网DNS域名', + 'description' => '本接口用于删除需要进行私有DNS解析的域名。', + ], + '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' => '实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pd-12345', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域ID。', + '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' => '本次调用请求的ID。', + '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"}]', + 'title' => '清空私网DNS域名', + 'description' => '本接口一般用于获取域名DNS的解析结果。当前仅支持从阿里云云解析DNS获取解析结果。要查询的域名必须使用云解析DNS，才能查询到其解析结果。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLogStoreInfo' => [ + 'summary' => '获取日志服务信息。', + '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' => [ + 'title' => '日志存储时长。单位：天。', + 'description' => '日志存储时长。单位：天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'title' => '本次请求的id。', + 'description' => '本次请求的 ID。', + 'type' => 'string', + 'example' => 'C6C3B72B********E95FB0A161', + ], + 'Quota' => [ + 'title' => '存储容量阈值,单位字节。', + 'description' => '可用的日志存储容量。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000000', + ], + 'ProjectName' => [ + 'title' => '日志服务project的名称。', + 'description' => '日志服务的Project名称。', + 'type' => 'string', + 'example' => 'project-xxx-cn-hangzhou', + ], + 'LogStoreName' => [ + 'title' => '日志服务的logStore名称。', + 'description' => '日志服务SLS日志库LogStore的名称。', + 'type' => 'string', + 'example' => 'xxx-logstore', + ], + 'Used' => [ + 'title' => '已使用的日志分析容量。', + 'description' => '已经使用的存储容量。单位：Byte。'."\n" + ."\n" + .'> 日志服务的统计结果约有两个小时的延迟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RegionId' => [ + 'title' => '日志投递的地域ID。', + 'description' => '日志投递的地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'InfoList' => [ + 'title' => '信息列表。', + 'description' => '信息列表。', + 'type' => 'array', + 'items' => [ + 'title' => '信息列表。', + 'description' => '信息列表。', + 'type' => 'object', + 'properties' => [ + 'Ttl' => [ + 'title' => '日志存储时长。单位：天。', + 'description' => '日志存储时长。单位：天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'Quota' => [ + 'title' => '存储容量阈值,单位字节。', + 'description' => '存储容量阈值,单位字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000000', + ], + 'ProjectName' => [ + 'title' => '日志服务的Project名称。', + 'description' => '日志服务的Project名称。', + 'type' => 'string', + 'example' => 'cloudfirewall-project-14151892848****-cn-hangzhou', + ], + 'LogStoreName' => [ + 'title' => '日志服务的logStore名称。', + 'description' => '日志服务的logStore名称。', + 'type' => 'string', + 'example' => 'xxx-logstore', + ], + 'Used' => [ + 'title' => '已存储的日志量，单位：Byte（字节）。', + 'description' => '已存储的日志量，单位：Byte（字节）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21852955752', + ], + 'MaxSplitShard' => [ + 'title' => '弹性扩展shard数目可以支持的最大值。', + 'description' => '弹性扩展shard数目可以支持的最大值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Shard' => [ + 'title' => '当前已经使用的shard数目。', + 'description' => '当前已经使用的shard数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RegionId' => [ + 'title' => '地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'Site' => [ + 'title' => '该logStore所属的站点。cn：中国内地、intl：非中国内地。', + 'description' => '该logStore所属的站点。cn：中国内地、intl：非中国内地。', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + 'LogVersion' => [ + 'title' => '日志版本。1:代表有1个logStore，2:代表有两个logStore。', + 'description' => '日志版本。1:代表有1个logStore，2:代表有两个logStore。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalQuota' => [ + 'title' => '用户购买的日志存储的总容量。', + 'description' => '用户购买的日志存储的总容量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000000', + ], + 'LogModifyQuota' => [ + 'title' => '用户可以进行日志模式切换的次数。', + 'description' => '用户可以进行日志模式切换的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TaskId' => [ + 'title' => '任务ID。', + 'description' => '任务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' => '获取日志服务信息', + ], + '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' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '139.217.234.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + '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' => '应用ID。', + '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' => '规则ID。', + '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' => '目标IP。', + 'type' => 'string', + 'required' => false, + 'example' => '182.92.206.XXX', + ], + ], + [ + 'name' => 'SrcIP', + 'in' => 'query', + 'schema' => [ + 'description' => '源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '10.68.60.XXX', + ], + ], + [ + 'name' => 'SrcPrivateIP', + 'in' => 'query', + 'schema' => [ + 'description' => '私网源IP地址。', + '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' => '地域id。', + '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 => '基础防御', + '虚拟补丁', + '基础ACL', + '威胁情报', + ], + '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' => '访问源或目的IP的地区。', + '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' => 'DNS防火墙', + 'VpcFirewall' => 'vpc边界防火墙', + 'InternetFirewall' => '互联网边界防火墙', + ], + 'example' => 'VpcFirewall', + ], + ], + [ + 'name' => 'VpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'SrcVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '源VpcId。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9309pkwe06lv****tk4', + ], + ], + [ + 'name' => 'DstVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '目的VpcId。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz95m1aq9b0h****vk1yb', + ], + ], + [ + 'name' => 'SrcVpcRegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '源Vpc资产地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DstVpcRegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '目的Vpc资产地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'DomainUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '流日志的URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP版本。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 4 => 'IPv4', + 6 => 'IPv6', + ], + 'example' => '4', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '成员账号UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '128599825273****', + ], + ], + [ + 'name' => 'NatFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vfw-tr-7a9c8901ed394****', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-2zew6yn017hhzbm****', + ], + ], + [ + 'name' => 'AclPreState', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACL预匹配状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'AclPreRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACL预匹配规则ID。', + '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' => 'TLS检查范围ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'tis-98fd64c5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求id。', + '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' => '流量方向。取值：'."\n" + .'- **in**：表示进方向。'."\n" + .'- **out**：表示出方向。', + 'type' => 'string', + 'example' => 'in', + ], + 'AttackType' => [ + 'description' => '入侵防御事件的攻击类型。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 1 => '异常连接', + '命令执行', + '暴力破解', + '扫描', + '其它', + ], + 'example' => '0', + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'string', + 'example' => '14151892****7022', + ], + 'CountryId' => [ + 'description' => '国家ID。', + 'type' => 'string', + 'example' => 'US', + ], + 'DstPort' => [ + 'description' => '目标端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'SrcPrivateIP' => [ + 'description' => '私网源IP地址。', + 'type' => 'string', + 'example' => '172.16.101.7', + ], + 'IpProtocol' => [ + 'description' => '协议类型。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'aliyun.com', + ], + 'RuleId' => [ + 'description' => '命中的规则ID。', + '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' => '应用ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RuleResult' => [ + 'description' => '流量最终结果。取值：'."\n" + .'- **pass**：表示放行。'."\n" + .'- **alert**：表示告警。'."\n" + .'- **drop**：表示丢弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'pass', + ], + 'Ext' => [ + 'description' => '其他扩展数据。', + 'type' => 'string', + 'example' => '无', + ], + 'DstIP' => [ + 'description' => '查询到的目的ip。表示入侵防御事件中包含了这条目的ip。', + 'type' => 'string', + 'example' => '2.2.2.2', + ], + 'PacketBytes' => [ + 'description' => '包字节数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '355', + ], + 'InBytes' => [ + 'description' => '流入流量。', + 'type' => 'string', + 'example' => '125', + ], + 'IspId' => [ + 'description' => '运营商ID。', + 'type' => 'string', + 'example' => '50075069', + ], + 'Isp' => [ + 'description' => '运营商。', + 'type' => 'string', + 'example' => 'FOP Dmytro Nedilskyi', + ], + 'RegionId' => [ + 'description' => '地域ID。', + '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' => 'VPC边界防火墙实例ID。', + 'type' => 'string', + 'example' => 'vfw-4045ca7***', + ], + 'CityId' => [ + 'description' => '城市ID。', + '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' => '本次命中的检测规则来源。取值：'."\n" + .'- **0**：表示无。'."\n" + .'- **1**：表示基础防御。'."\n" + .'- **2**：表示虚拟补丁。'."\n" + .'- **3**：表示访问控制。'."\n" + .'- **4**：表示威胁情报。', + 'type' => 'string', + 'example' => '0', + ], + 'OutPackets' => [ + 'description' => '流出报文数。', + 'type' => 'string', + 'example' => '11', + ], + 'InPackets' => [ + 'description' => '流入报文数。', + 'type' => 'string', + 'example' => '12', + ], + 'SrcIP' => [ + 'description' => '源IP。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'Location' => [ + 'description' => '访问源或目的IP的地区。', + 'type' => 'string', + 'example' => '杭州', + ], + 'DomainUrl' => [ + 'description' => '流日志的URL。', + 'type' => 'string', + 'example' => 'xxx.com', + ], + 'CloudInstanceId' => [ + 'description' => '云服务实例ID。', + 'type' => 'string', + 'example' => 'ngw-*', + ], + 'AclPreState' => [ + 'description' => 'ACL预匹配状态。取值：'."\n" + ."\n" + .'**app_unknown**: 应用未识别'."\n" + ."\n" + .'**domain_unknown**: 域名未识别'."\n" + ."\n" + .'**normal**:正常', + 'type' => 'string', + 'example' => 'normal', + ], + 'AclPreRuleId' => [ + 'description' => 'ACL预匹配的策略ID'."\n" + .'不填表示所有。', + 'type' => 'string', + 'example' => '2', + ], + 'AclPreRuleName' => [ + 'description' => 'ACL预匹配的策略名。', + 'type' => 'string', + 'example' => 'test', + ], + 'AppDpiState' => [ + 'description' => 'API状态。取值：'."\n" + ."\n" + .'**none**: 初始状态'."\n" + ."\n" + .'**policy_discard**:连接建立失败，被用户acl或威胁情报拦截'."\n" + ."\n" + .'**tcp_not_establish**:tcp建立失败'."\n" + ."\n" + .'**no_payload**: 连接已经建立，但dpi已经分析0个payload'."\n" + ."\n" + .'**analysing**: 识别中'."\n" + ."\n" + .'**unknown_loose**: 宽松模式，识别失败，继续识别'."\n" + ."\n" + .'**unknown_strict**: 严格模式，识别失败'."\n" + ."\n" + .'**success**: 识别成功', + 'type' => 'string', + 'example' => 'success', + ], + 'Rules' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则列表。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'sharepoint', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => '17', + ], + ], + ], + ], + 'SrcVpc' => [ + 'description' => '源VPC信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '源VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vba1c1em97h0ji71****', + ], + 'VpcName' => [ + 'description' => '源VPC的实例名称。', + 'type' => 'string', + 'example' => 'yi-vpc', + ], + 'RegionNo' => [ + 'description' => '源VPC所属地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + 'DstVpc' => [ + 'description' => 'dstvpc信息列表。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vba1c1em97h0ji71b****', + ], + 'VpcName' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'example' => 'yi-vpc', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'PrivateIp' => [ + 'description' => '私有IP。', + 'type' => 'string', + 'example' => '172.21.234.XXX', + ], + 'PrivatePort' => [ + 'description' => '私有端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'TlsRuleId' => [ + 'description' => '命中tls检查的规则ID。', + 'type' => 'string', + 'example' => 'tir-xxx', + ], + 'TlsRuleName' => [ + 'description' => '命中tls检查的规则名。', + 'type' => 'string', + 'example' => 'test', + ], + 'TlsScopeId' => [ + 'description' => 'TLS检查范围ID。', + '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"}]', + 'title' => '查询日志流量信息', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OpenStatus' => [ + 'description' => 'SLS开启状态。取值：'."\n" + ."\n" + .'**true**：开启。'."\n" + ."\n" + .'**false**：关闭。', + 'type' => 'string', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '获取SLS开启状态', + ], + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '获取清空授权信息', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => '访问者源IP。', + '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' => '返回结果的请求ID。', + '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' => '地区Id。', + 'type' => 'string', + 'example' => 'US', + ], + 'LocName' => [ + 'description' => '地区名。', + 'type' => 'string', + 'example' => '美国', + ], + ], + ], + ], + 'CnList' => [ + 'description' => '国内地区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '国内地区列表。', + 'type' => 'object', + 'properties' => [ + 'LocId' => [ + 'description' => '地区Id。', + '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' => '地区Id。', + '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"}]', + 'title' => '查询地理位置信息', + ], + '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' => '访问者源IP地址。', + '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' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'DataList' => [ + 'description' => '运营商列表。', + 'type' => 'array', + 'items' => [ + 'description' => '运营商列表。', + 'type' => 'object', + 'properties' => [ + 'IspId' => [ + 'description' => '运营商ID', + '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"}]', + 'title' => '查询ISP信息', + ], + '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' => '访问者源IP', + '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' => '返回结果的请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '072B5287-8A85-529E-BD47-F8AC2DB1****', + ], + 'CreatedNatFirewalls' => [ + 'description' => '创建NAT防火墙列表。', + 'type' => 'array', + 'items' => [ + 'description' => '创建NAT防火墙列表。', + 'type' => 'object', + 'properties' => [ + 'NatFirewallId' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'example' => 'cfw-adk2ad45sf4t8****', + ], + 'NatGatewayId' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'example' => 'ngw-uf6i0zkjtz4t2sttf****', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关的名称', + '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"}]', + 'title' => '获取已经创建的NAT防火墙', + ], + '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' => [ + 'title' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + 'description' => '接收消息的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '请求和接收消息的语言类型。取值：-**zh**：中文-**en**：英文', + 'description' => '接收消息的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '返回结果的请求id。', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '7036EBAB-F85F-5AAE-976F-C75AEE59****', + ], + 'LogstoreName' => [ + 'title' => '日志服务的logStore名称。', + 'description' => '日志服务的日志库名称。', + 'type' => 'string', + 'example' => 'rs-stats', + ], + 'ProjectName' => [ + 'title' => '日志服务的project。', + 'description' => '日志服务的Project名称。', + 'type' => 'string', + 'example' => 'cloudfirewallnew-project-199053910542****-cn-hangzhou', + ], + 'ItemList' => [ + 'title' => '日志投递配置详情。', + 'description' => '日志服务列表。', + 'type' => 'array', + 'items' => [ + 'title' => '日志投递配置详情。', + 'description' => '日志服务列表。', + 'type' => 'object', + 'properties' => [ + 'DispatchName' => [ + 'title' => '投递类型中文名称。', + 'description' => '投递名称。', + 'type' => 'string', + 'example' => '互联网流量日志', + ], + '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**。', + 'description' => '投递日志的值。', + 'type' => 'string', + 'example' => 'internet_log', + ], + 'SearchName' => [ + 'title' => '固定为log_type，无需关注。', + 'description' => '搜索类型的名称。', + 'type' => 'string', + 'example' => 'log_type', + ], + 'Enable' => [ + 'title' => '该投递类型开关情况。', + 'description' => '投递状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConfigStatus' => [ + 'title' => '配置状态。', + 'description' => '投递配置状态。', + 'type' => 'string', + 'example' => 'success_finished', + ], + 'FilterKeys' => [ + 'title' => '互联网和VPC的详细投递配置。', + 'description' => '支持的过滤条件。', + 'type' => 'array', + 'items' => [ + 'title' => '具体字段名称。attack代表攻击事件日志，acl代表访问控制日志，other代表除这两种情况之外的其他日志。', + 'description' => '支持的过滤条件。', + 'type' => 'string', + 'enumValueTitles' => [ + 'other' => '其他', + 'attack' => '攻击', + 'acl' => 'ACL', + ], + 'example' => 'attack', + ], + ], + ], + ], + ], + 'LogVersion' => [ + 'title' => '日志版本，1代表只有1个logStore，2代表有2个。', + 'description' => '日志版本，1代表只有1个logStore，2代表有2个。', + 'type' => 'string', + 'example' => '1', + ], + 'InfoList' => [ + 'title' => 'logStore的详细信息列表', + 'description' => 'logStore的详细信息列表', + 'type' => 'array', + 'items' => [ + 'title' => '信息列表。', + 'description' => '信息列表。', + 'type' => 'object', + 'properties' => [ + 'LogstoreName' => [ + 'title' => '日志服务的logStore名称。', + 'description' => '日志服务的logStore名称。', + 'type' => 'string', + 'example' => 'cloudfirewall-logstore', + ], + 'ProjectName' => [ + 'title' => '日志服务的Project名称。', + 'description' => '日志服务的Project名称。', + 'type' => 'string', + 'example' => 'cloudfirewall-project-1204872307283650-cn-hangzhou', + ], + 'ItemList' => [ + 'title' => '日志投递配置详情。', + 'description' => '日志投递配置详情。', + 'type' => 'array', + 'items' => [ + 'title' => '日志投递配置详情。', + 'description' => '日志投递配置详情。', + 'type' => 'object', + 'properties' => [ + 'DispatchName' => [ + 'title' => '投递类型中文名称。', + 'description' => '投递类型中文名称。', + '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**', + 'description' => '分类日志的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，无需关注。', + 'description' => '固定为log_type，无需关注。', + 'type' => 'string', + 'example' => 'log_type', + ], + 'Enable' => [ + 'title' => '该投递类型开关情况。', + 'description' => '该投递类型开关情况。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConfigStatus' => [ + 'title' => '配置状态。', + 'description' => '配置状态。', + 'type' => 'string', + 'example' => 'success_finished', + ], + 'FilterKeys' => [ + 'title' => '互联网和VPC的详细投递配置。', + 'description' => '互联网和VPC的详细投递配置。', + 'type' => 'array', + 'items' => [ + 'title' => '具体字段名称。attack代表攻击事件日志，acl代表访问控制日志，other代表除这两种情况之外的其他日志。', + 'description' => '具体字段名称。attack代表攻击事件日志，acl代表访问控制日志，other代表除这两种情况之外的其他日志。', + 'type' => 'string', + 'example' => 'attack,other', + ], + ], + ], + ], + ], + 'Site' => [ + 'title' => 'cn代表中国内地，intl代表非中国内地，global代表全球。', + 'description' => '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"}]', + 'title' => '查询日志投递状态状态', + ], + 'CreateSlsLogDispatch' => [ + 'summary' => '创建云防火墙SLS日志投递。', + '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' => 'SLS地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'formData', + 'schema' => [ + 'description' => '日志存储时长，单位：天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"850A84D6************00090125EEB1\\"\\n}","type":"json"}]', + 'title' => '创建云防火墙SLS日志投递', + ], + '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' => [ + 'title' => '投递： true:有效，false:不投递。', + 'description' => '是否投递： true:有效，false:不投递。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DispatchValue', + 'in' => 'query', + 'schema' => [ + 'title' => '分类日志的key'."\n" + .'共有以下取值：'."\n" + .'['."\n" + .'"internet_log",'."\n" + .'"vpc_firewall_log",'."\n" + .'"nat_firewall_log",'."\n" + .'"ipv6_firewall_log",'."\n" + .'"dns_firewall_log"'."\n" + .']', + 'description' => '分类日志的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', + 'required' => false, + 'example' => 'internet_log', + ], + ], + [ + 'name' => 'FilterKeys', + 'in' => 'query', + 'schema' => [ + 'title' => '查询指定过滤条件的场景。用 ","拼接'."\n" + .'['."\n" + .'"attack.acl,other",'."\n" + .'"attack",'."\n" + .'"acl",'."\n" + .'"other",'."\n" + .'"acl,other"'."\n" + .']。', + 'description' => '支持的过滤条件。取值：'."\n" + ."\n" + .'**attack**'."\n" + ."\n" + .'**acl**'."\n" + ."\n" + .'**other**。', + 'type' => 'string', + 'required' => false, + 'example' => 'attack,acl', + ], + ], + [ + 'name' => 'NewRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '区域。', + 'description' => '区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Site', + 'in' => 'query', + 'schema' => [ + 'title' => '这个字段用来指示修改哪个站点，如果日志版本为1，这个字段可以不填，或者global,如果日志版本为2，这个字段必须填，cn或者intl', + 'description' => '这个字段用来指示修改哪个站点，如果日志版本为1，这个字段可以不填，或者global,如果日志版本为2，这个字段必须填，cn或者intl。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '返回结果的请求id。', + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CE901E31-4AE9-579D-AC37-D2F1BB43****', + ], + ], + ], + ], + ], + '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"}]', + 'title' => '修改SLS投递状态', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + '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' => [ + 'title' => '云防火墙的id。', + 'description' => '实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vipcloudfw-cn-uqm3fz****', + ], + ], + [ + 'name' => 'StorageTime', + 'in' => 'query', + 'schema' => [ + 'title' => '日志存储时间（单位：天）。可选值：-**0**：最近一天-**30**：最近30天', + 'description' => '需要指定的存储时长（单位：天）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '180', + ], + ], + [ + 'name' => 'LogVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '日志版本，主要有1（1个logStore）和2（2个logStore）', + 'description' => '日志版本，主要有1（1个logStore）和2（2个logStore）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'SlsRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'SLS地域ID。', + 'description' => 'SLS地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '本次请求的id。', + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '337A4DBA-8A01-5E9C-99CA-84293E13****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"337A4DBA-8A01-5E9C-99CA-84293E13****\\"\\n}","type":"json"}]', + 'title' => '修改用户日志存储时间', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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。', + 'description' => '代表要清空的站点名称，如果只有1个logStore，可以不填，如果有2个logStore，需要填cn或者intl。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'title' => 'http状态码。', + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'title' => '本次请求的id。', + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '21C27710-2DB1-5F2A-8588-72D0541B****', + ], + 'Success' => [ + 'title' => '返回结果。取值：-**true**：表示成功-**false**：表示失败', + 'description' => '本次请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + 'title' => '清空防火墙日志', + ], + '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' => '访问者源IP地址。', + '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' => '请求ID。', + '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' => '消息通知配置。取值：-**0**：关闭-**1**：开启', + 'type' => 'string', + 'example' => '0', + ], + 'NotifyType' => [ + 'description' => '通知类型。', + 'type' => 'string', + 'example' => 'mail', + ], + ], + ], + ], + 'ContactConfig' => [ + 'description' => '联系人信息。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '报警状态。取值：-**0**：关闭-**1**：开启', + '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' => '日志存储状态。取值：-**normal**：正常-**disable**：禁用', + '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"}]', + 'title' => '获取用户告警配置', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP', + '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', + '24小时', + ], + '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' => '返回结果的请求ID。', + '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"}]', + 'title' => '修改用户告警配置', + ], + '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' => '访问者源IP。', + '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' => '成员账号UID。', + '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' => '返回结果的请求ID。', + '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' => '成员账号ID。', + '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"}]', + 'title' => '获取实例RD账号', + ], + 'DescribeInstanceMembers' => [ + 'summary' => '获取云防火墙成员账号信息。', + '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' => '分页查询时，返回第几页数据。'."\n" + .'默认值为**1**，表示返回第1页数据。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页包含多少条结果。'."\n" + ."\n" + .'默认值为**20**，表示每页包含20条结果。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙成员账号的UID。', + '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' => '云防火墙成员账号的备注信息，长度为1~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'renewal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'A531AE1A-FBA2-48B6-BAB8-84D02BD409EE', + ], + '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' => '20', + ], + ], + ], + 'Members' => [ + 'description' => '云防火墙成员账号的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MemberDesc' => [ + 'description' => '云防火墙成员账号的备注信息。', + 'type' => 'string', + 'example' => 'renewal', + ], + 'MemberDisplayName' => [ + 'description' => '云防火墙成员账号的名称。', + 'type' => 'string', + 'example' => 'cloudfirewall_2', + ], + 'CreateTime' => [ + 'description' => '云防火墙成员账号的加入时间。使用时间戳格式，单位：秒。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1615189819', + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '258039427902****', + ], + 'MemberStatus' => [ + 'description' => '云防火墙成员账号的状态。取值：'."\n" + .'- **normal**：正常'."\n" + .'- **deleting**：删除中', + 'type' => 'string', + 'example' => 'normal', + ], + 'ModifyTime' => [ + 'description' => '云防火墙成员账号的最近修改时间。使用时间戳格式，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1615189819', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取云防火墙成员账号信息', + 'description' => '本接口一般用于查询云防火墙成员账号信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddInstanceMembers' => [ + 'summary' => '添加云防火墙成员账号。', + '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' => '云防火墙成员账号。', + 'type' => 'array', + 'items' => [ + 'description' => '无', + 'type' => 'object', + 'properties' => [ + 'MemberDesc' => [ + 'description' => '云防火墙成员账号的备注信息，长度为1~256个字符。最多可添加20个成员账号。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'renewal', + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。最多可添加20个成员账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '258039427902****', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'B40A54DF-C142-44F7-8441-B31C1EADB36E', + ], + ], + ], + ], + ], + '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' => '添加云防火墙成员账号', + 'description' => '本接口一般用于添加云防火墙成员账号。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceMemberAttributes' => [ + 'summary' => '更新云防火墙成员账号信息。', + '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' => '云防火墙成员账号。', + 'type' => 'array', + 'items' => [ + 'description' => '无', + 'type' => 'object', + 'properties' => [ + 'MemberDesc' => [ + 'description' => '云防火墙成员账号的备注信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'renewal', + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123412341234****', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + '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' => '更新云防火墙成员账号信息', + 'description' => '本接口一般用于更新云防火墙成员账号信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteInstanceMembers' => [ + 'summary' => '删除云防火墙成员账号。', + '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' => '云防火墙成员账号的UID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云防火墙成员账号的UID列表。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '258039427902****', + ], + 'required' => true, + 'example' => '1234123412341234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '03E8AA70-0CC9-42EA-97AA-EA68377930B4', + ], + ], + ], + ], + ], + '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' => '删除云防火墙成员账号', + 'description' => '调用DeleteInstanceMembers接口一次最多可删除20个云防火墙成员账号，多个成员账号之间使用用英文逗号（,）分隔。成员账号被删除后，云防火墙无法访问被删除成员账号的云资源，请谨慎操作。删除前，调用[DescribeInstanceMembers](~~271704~~)接口获取云防火墙成员账号信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDownloadTask' => [ + 'summary' => '查询文件下载任务，包括任务信息以及下载地址。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数, 不得超过100, 超过100会设置为100', + 'description' => '分页查询时，显示的每页数据的最大条数。默认为10。'."\n" + .'可设置值最大为50。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页', + 'description' => '分页查询时，设置当前页的页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => '任务类型，枚举值。可填枚举值见接口：查询文件下载任务类型。不填默认查询所有文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewallAsset', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '任务总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '3F2BED13-F3D0-5984-80D6-D5F298CFEA88', + ], + 'Tasks' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id。', + 'type' => 'string', + 'example' => '1111', + ], + 'TaskName' => [ + 'title' => '名称', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => '互联网边界防火墙资产-IPv4', + ], + 'Status' => [ + 'title' => '', + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **finish**：任务完成。'."\n" + .'- **start**：任务开始。'."\n" + .'- **error**：任务失败。'."\n" + .'- **expire**：任务过期。即任务文件已经失效，无法下载。', + 'type' => 'string', + 'example' => 'finish', + ], + 'FileURL' => [ + 'description' => 'OSS文件地址。', + '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' => '文件大小。', + 'type' => 'string', + 'example' => '24.04KB', + ], + 'CreateTime' => [ + 'description' => '创建任务的时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706595827', + ], + 'ExpireTime' => [ + 'description' => '任务过期的时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714371828', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'InternetFirewallAsset', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询文件下载任务', + ], + 'DescribeDownloadTaskType' => [ + 'summary' => '查询下载任务类型。对应下载任务相关接口中的TaskType字段。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数, 不得超过100, 超过100会设置为100', + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为10。可设置的最大值为50。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，返回第几页数据。'."\n" + .'默认值为**1**，表示返回第1页数据。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewallAsset', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'B835494C-D093-5524-BBDE-BD272077B40E', + ], + 'TaskTypeArray' => [ + 'description' => '任务类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务类型信息。', + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'title' => '名称', + 'description' => '任务类型名称。', + 'type' => 'string', + 'example' => '互联网边界防火墙资产', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'InternetFirewallAsset', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询文件下载任务类型', + ], + 'CreateDownloadTask' => [ + 'summary' => '创建文件下载任务。', + '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' => '接收消息的语言类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **zh**：（默认）中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，枚举值。可填枚举值见接口：查询文件下载任务类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'InternetFirewallAsset', + ], + ], + [ + 'name' => 'TaskData', + 'in' => 'query', + 'schema' => [ + 'description' => '下载任务的请求查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"SearchItem\\":\\"\\",\\"UserType\\":\\"buy\\",\\"IpVersion\\":\\"4\\"}', + ], + ], + [ + 'name' => 'TimeZone', + 'in' => 'query', + 'schema' => [ + 'description' => '下载文件中时间信息的时区，使用IANA时区标识符。默认为北京时间，即Asia/Shanghai。', + 'type' => 'string', + 'required' => false, + 'example' => 'Asia/Shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务Id，任务的唯一标识。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'E7F333E0-7B70-54DA-A307-4B2B49DEE923', + ], + 'TaskName' => [ + 'title' => '', + 'description' => '文件下载任务的名称。', + 'type' => 'string', + 'example' => '互联网边界防火墙资产-IPv4', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'finish：任务完成。即任务已经完成，可以通过查询任务，获取任务文件下载链接。'."\n" + ."\n" + .'start：任务开始。'."\n" + ."\n" + .'error：任务失败。'."\n" + ."\n" + .'expire：任务过期。即任务文件已经失效，无法下载。', + 'type' => 'string', + 'example' => 'start', + ], + ], + ], + ], + ], + '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' => '创建文件下载任务', + ], + 'DeleteDownloadTask' => [ + 'summary' => '删除文件下载任务。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件下载任务的任务 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '4376', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => '064022A8-F415-572C-B3C1-657152833F11', + ], + ], + ], + ], + ], + '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' => '删除文件下载任务', + 'description' => '调用该接口会立即删除文件下载任务，并删除下载文件。'."\n" + .'><danger>删除操作会删除对应任务及文件。**对应文件无法再使用已有下载链接下载。此操作不可逆，请谨慎操作。**></danger>', + 'responseParamsDescription' => '成功返回即表明任务已经删除完成。', + ], + 'DescribeAclBackupList' => [ + 'summary' => '查询访问控制备份列表。', + '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' => '访问源IP地址。', + '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' => '返回结果的请求ID。', + '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' => 'ACL数量。', + '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"}]', + 'title' => '查询访问控制备份列表', + ], + 'AddAclBackupData' => [ + 'summary' => '创建访问控制备份。', + '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' => '访问者源ip地址。', + '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' => '结果的请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + '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"}]', + 'title' => '创建访问控制备份', + ], + 'UseAclBackupData' => [ + 'summary' => '恢复访问控制备份。', + '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' => '访问源的IP地址。', + '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' => '返回结果的请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + '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"}]', + 'title' => '恢复访问控制备份', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + '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' => '返回结果的请求id。', + '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"}]', + 'title' => '删除ACL备份', + 'description' => '本接口一般用于删除访问控制中的地址簿。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '218.108.54.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '应用模块', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'sg_server', + ], + 'SecurityMode' => [ + 'description' => '安全模式。取值：'."\n" + ."\n" + .'**0**：关闭。'."\n" + ."\n" + .'**1**：开启。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '获取安全模式', + 'description' => '本接口一般用于分页查询云防火墙防护的资产的信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '访问者源IP', + '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' => '请求ID。', + '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"}]', + 'title' => '查看页面常见问题（废弃）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeDomainResolve' => [ + 'summary' => '获取域名DNS的解析结果。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。'."\n" + ."\n" + .'取值包括：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。'."\n" + ."\n" + .'取值包括：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '待解析的域名地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙防护的资产的IP版本。取值：'."\n" + ."\n" + .'- **4**（默认）：IPV4'."\n" + .'- **6**：IPV6', + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D', + ], + 'ResolveResult' => [ + 'description' => '域名解析结果。', + 'type' => 'object', + 'properties' => [ + 'IpAddrs' => [ + 'description' => '域名解析结果，多个IP地址用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '11.1.X.X,12.1.X.X', + ], + 'UpdateTime' => [ + 'description' => '解析时间戳。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579091739', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取域名DNS的解析结果', + 'description' => '本接口一般用于获取域名DNS的解析结果。当前仅支持从阿里云云解析DNS获取解析结果。要查询的域名必须使用云解析DNS，才能查询到其解析结果。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + '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' => 'IPS 防护数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalDropCnt' => [ + 'description' => '总防护数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA1D173-D5DB-582E-9637-438D5CE3****', + ], + 'VulnDropCnt' => [ + 'description' => '漏洞防护数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AclDropCnt' => [ + 'description' => 'ACL策略拦截数。', + '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"}]', + 'title' => '获取防火墙DROP数据统计（废弃）', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'DescribeUserAssetIPTrafficInfo' => [ + 'summary' => '查询用户指定资产的流量信息。', + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + [ + 'name' => 'AssetIP', + 'in' => 'query', + 'schema' => [ + 'title' => '资产IP', + 'description' => '目标资产的IP。', + 'type' => 'string', + 'required' => true, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'TrafficTime', + 'in' => 'query', + 'schema' => [ + 'title' => '时间', + 'description' => '设置查询时间。使用秒级时间戳格式表示。', + 'type' => 'string', + 'required' => true, + 'example' => '1656923760', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '查询开始时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656837360', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '查询结束时间。使用秒级时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656923760', + ], + 'InBps' => [ + 'description' => '入方向的网络吞吐率（每秒发送多少字节）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4520', + ], + 'OutBps' => [ + 'description' => '出方向的网络吞吐率（每秒发送多少字节）。单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4180', + ], + 'InPps' => [ + 'description' => '入方向的网络吞吐率（每秒发送多少个分组数据包）。单位：pps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '233', + ], + 'OutPps' => [ + 'description' => '出方向的网络吞吐率（每秒发送多少个分组数据包）。单位：pps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '224', + ], + 'SessionCount' => [ + 'description' => '请求次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'NewConn' => [ + 'description' => '新建连接数。', + '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' => '查询用户指定资产的流量信息（废弃）', + ], + 'DescribeCfwRiskLevelSummary' => [ + 'summary' => '查询防火墙风险等级。', + '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' => '接收消息的语言类型。'."\n" + ."\n" + .'取值包括：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙所在的地域ID。'."\n" + .'> 关于云防火墙支持地域的详细信息，请参见[支持的地域](~~195657~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型。可选值：'."\n" + .'- **ecs**', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'EcsEIP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'F1F30435-FA0A-52DA-A5DE-C16FD6C171DA', + ], + 'RiskList' => [ + 'description' => '风险列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '类型。', + 'type' => 'string', + 'example' => 'ResourceNotProtected', + ], + 'Num' => [ + 'description' => '风险ECS数量。', + 'type' => 'string', + 'example' => '50', + ], + 'Level' => [ + 'description' => '风险等级。取值包括：'."\n" + .'- **medium**：中等', + 'type' => 'string', + 'example' => 'medium', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询防火墙风险等级（废弃）', + ], + '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' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '220.189.117.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '规则uuid。', + 'type' => 'string', + 'required' => false, + 'example' => '3b1adf8d-1949-4c8e-809b-fb92ee11****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '安全组实例ID。', + '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' => '地域ID。', + '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' => '请求ID。', + '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' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-8vbuzirdl3w1r7exw****', + ], + 'RiskLevel' => [ + 'description' => '规则风险等级。', + 'type' => 'string', + 'example' => 'high', + ], + 'RegionNo' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai'."\n", + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test-instance-name', + ], + 'EcsCount' => [ + 'description' => '关联ECS数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InstanceId' => [ + 'description' => '安全组实例ID。', + 'type' => 'string', + 'example' => 'sg-2vc0p803vgxumn6r****', + ], + 'EcsInfo' => [ + 'description' => 'ECS信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS信息。', + 'type' => 'object', + 'properties' => [ + 'PublicIp' => [ + 'description' => 'ECS公网IP。', + 'type' => 'string', + 'example' => '47.107.141.XXX', + ], + 'EcsInstanceName' => [ + 'description' => 'ECS实例名称。', + 'type' => 'string', + 'example' => 'tyf_test', + ], + 'PrivateIp' => [ + 'description' => 'ECS私网IP。', + 'type' => 'string', + 'example' => '172.24.121.XXX', + ], + 'EcsInstanceId' => [ + 'description' => 'ECS实例ID。', + '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' => '规则uuid。', + '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"}]', + 'title' => '获取风险安全组详情（废弃）', + ], + 'DescribeSecurityProxy' => [ + 'summary' => '获取NAT防火墙。', + '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' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ProxyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy-nat80d763eb0dee4eacaec9', + ], + ], + [ + 'name' => 'ProxyName', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT防火墙名称。支持大小写英文字母、中文、数字、下划线（_）、长度为[4,50]个字符,且不能以下划线开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'nat-idmp-fir', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC所在的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'NatGatewayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-zm0h3c1exm5bifuorg8c5', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙状态。取值：'."\n" + ."\n" + .'- **configuring**：创建中。'."\n" + .'- **deleting**：删除中。'."\n" + .'- **normal**：正常。'."\n" + .'- **abnormal**：异常。'."\n" + .'- **opening**：开启中。'."\n" + .'- **closing**：关闭中。'."\n" + .'- **closed**：已关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页面的页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。支持最大取值为50。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前阿里云账号的成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'F0F82705-CFC7-5F83-86C8-A063892F****', + ], + 'ProxyList' => [ + 'description' => 'NAT防火墙列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'NAT防火墙的列表信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-wz9xn35tq33hunzvpu0se', + ], + 'Status' => [ + 'description' => '云防火墙状态。取值：'."\n" + .'- **configuring**：创建中。'."\n" + .'- **deleting**：删除中。'."\n" + .'- **normal**：正常。'."\n" + .'- **abnormal**：异常。'."\n" + .'- **opening**：开启中。'."\n" + .'- **closing**：关闭中。'."\n" + .'- **closed**：已关闭。', + 'type' => 'string', + 'example' => 'normal', + ], + 'RegionNo' => [ + 'description' => 'VPC所在的地域ID。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'NatGatewayName' => [ + 'description' => 'NAT网关的名称', + 'type' => 'string', + 'example' => 'ecs-slb-eip-waf', + ], + 'MemberUid' => [ + 'description' => '云防火墙成员账号的UID。', + 'type' => 'string', + 'example' => '1797733170015112', + ], + 'ProxyId' => [ + 'description' => 'NAT防火墙ID。', + 'type' => 'string', + 'example' => 'proxy-nat4921f192b6cf438d93f8', + ], + 'ProxyName' => [ + 'description' => 'NAT防火墙名称。', + 'type' => 'string', + 'example' => 'nat-idmp-fir', + ], + 'VpcName' => [ + 'description' => 'VPC的实例名称。', + 'type' => 'string', + 'example' => 'vpc-bp1kw9igsq0yyzeanqamx', + ], + 'VSwitchId' => [ + 'description' => '云防火墙接口所属的vSwitch ID。', + 'type' => 'string', + 'example' => 'vsw-5gu2qqfmjmwl8ktzgfekl', + ], + 'CidrBlock' => [ + 'description' => 'VPC的IPv4网段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'NatGatewayId' => [ + 'description' => 'NAT网关的ID。', + 'type' => 'string', + 'example' => 'ngw-2zex8sf4s5vus8rq3rjqo', + ], + 'Detail' => [ + 'description' => '异常详细信息。', + 'type' => 'string', + 'example' => '“”', + ], + 'SnatIpList' => [ + 'description' => 'SNAT IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SNAT IP列表。', + 'type' => 'string', + 'example' => '""', + ], + ], + 'StrictMode' => [ + 'description' => '是否启用严格模式 1 - 启用严格模式 0 - 禁用严格模式', + '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' => '获取NAT防火墙（废弃）', + ], + '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' => '请求和接收的语言类型。取值：'."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VpcFirewallName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC边界防火墙的实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => '测试用实例', + ], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => [ + 'description' => '云企业网实例的id。', + 'type' => 'string', + 'required' => true, + 'example' => 'cen-37nddhri7jf0d2****', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-8vbwbo90rq0anm6t****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定云防火墙接口所属的vSwitch ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-qzeaol304m***', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '云防火墙成员账号的uid。', + 'type' => 'string', + 'required' => false, + 'example' => '258039427902****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VpcFirewallId' => [ + 'description' => 'VPC边界防火墙的实例ID。', + 'type' => 'string', + 'example' => 'vfw-m5e7dbc4y****', + ], + 'RequestId' => [ + 'description' => '返回结果的请求id。', + '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"}]', + 'title' => '创建VPC防火墙手动配置（废弃）', + 'description' => '本接口一般用于为云企业网内的VPC实例创建VPC边界防火墙。该VPC边界防火墙可以防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量，不支持防护VBR与VBR、CCN与CCN、VBR与CCN之间的互访流量。更多信息，请参见[VPC边界防火墙限制说明](~~172295~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'BatchCopyVpcFirewallControlPolicy' => [ + 'summary' => '从源VPC边界防火墙策略组拷贝所有策略到目标VPC边界防火墙策略组。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文。'."\n" + ."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceVpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '该操作的源VPC边界防火墙的访问控制策略组ID。取值：'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量时，策略组ID使用云企业网实例ID。'."\n" + ."\n" + .'- VPC边界防火墙防护通过高速通道连接的两个VPC之间的流量时，策略组ID使用VPC边界防火墙实例ID。'."\n" + ."\n" + .'> 您可以通过调用[DescribeVpcFirewallAclGroupList](~~159760~~)接口获取该ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vfw-a42bbb7b887148c9****', + ], + ], + [ + 'name' => 'TargetVpcFirewallId', + 'in' => 'query', + 'schema' => [ + 'description' => '该操作的目标VPC边界防火墙的访问控制策略组ID。取值：'."\n" + ."\n" + .'- VPC边界防火墙防护云企业网内的网络实例（网络实例包含VPC、VBR和CCN）和指定VPC之间的互访流量时，策略组ID使用云企业网实例ID。'."\n" + ."\n" + .'- VPC边界防火墙防护通过高速通道连接的两个VPC之间的流量时，策略组ID使用VPC边界防火墙实例ID。'."\n" + ."\n" + .'> 您可以通过调用[DescribeVpcFirewallAclGroupList](~~159760~~)接口获取该ID。', + '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' => '本次请求的ID。', + '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' => '从源VPC边界防火墙策略组拷贝所有策略到目标VPC边界防火墙策略组（废弃）', + 'description' => '本接口一般用于从一个VPC边界防火墙策略组拷贝所有策略到目标VPC边界防火墙策略组。'."\n" + ."\n" + .'进行该操作之前，建议您先进行策略备份。关于策略备份的详细信息，请参见[策略备份](~~170363~~)。'."\n" + ."\n" + .'该操作完成后，目标VPC边界防火墙策略组内的策略会完全替换成源VPC边界防火墙策略组内的策略。'."\n" + ."\n" + .'源VPC边界防火墙策略组和目标VPC边界防火墙策略组必须属于同一个阿里云账号。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。', + ], + 'ModifyControlPolicyPosition' => [ + 'summary' => '修改互联网边界防火墙IPv4访问控制策略（表示访问控制策略中的访问源IP、目的IP使用IPv4格式）的优先级。', + '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' => '访问者源IP地址。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- zh（默认）：中文。'."\n" + .'- en：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '互联网边界防火墙IPv4访问控制策略的流量方向。取值：'."\n" + ."\n" + .'- in：外对内流量。'."\n" + .'- out：内对外流量。', + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + [ + 'name' => 'NewOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '为互联网边界防火墙IPv4访问控制策略设置一个新的优先级。'."\n" + .'优先级使用数字表示，输入数字1表示优先级最高，数字越大优先级越低。'."\n" + ."\n" + .'> 新的优先级数字不能超出您已创建的互联网边界防火墙IPv4策略优先级的范围，否则会导致调用该接口时出错。'."\n" + .'> 建议您在调用该接口前，先调用[DescribePolicyPriorUsed](~~138862~~)查询互联网边界防火墙指定流量方向的IPv4策略优先级范围。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'OldOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的互联网边界防火墙IPv4访问控制策略当前的优先级。', + 'type' => 'string', + 'required' => true, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '850A84D6-0DE4-4797-A1E8-00090125EEB1', + ], + ], + ], + ], + ], + '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' => '修改访问控制策略的优先级（废弃）', + 'description' => '本接口一般用于修改互联网边界防火墙IPv4访问控制策略的优先级。暂不支持以调用接口的方式修改互联网边界防火墙IPv6访问控制策略的优先级。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '接收消息的语言类型。取值：'."\n" + ."\n" + .'- **zh**（默认）：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间,Unix timestamp, 精确到秒', + 'description' => '开始时间,Unix timestamp, 精确到秒。', + 'type' => 'string', + 'required' => true, + 'example' => '1656664560', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间,Unix timestamp, 精确到秒', + 'description' => '结束时间,Unix timestamp, 精确到秒。', + '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' => '资产IP。', + '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' => '顺序, 枚举值, 可选:asc, desc。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段, 枚举值.'."\n" + .'默认值: SessionCount'."\n" + .'可选值: InBytes, OutBytes,TotalBytes,SessionCount', + 'description' => '排序字段, 枚举值。'."\n" + ."\n" + .'默认值: TotalBytes。'."\n" + ."\n" + .'可选值: '."\n" + ."\n" + .'TotalBytes：根据总流量排序。'."\n" + ."\n" + .'SessionCount：根据会话数排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'SessionCount', + 'enum' => [], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产所在的VPC。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-m5ewlqkuf7orclr1****', + ], + ], + [ + 'name' => 'IsAITraffic', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅统计访问AI服务的流量。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '132', + ], + 'RequestId' => [ + 'description' => '返回结果的请求ID。', + 'type' => 'string', + 'example' => 'C5BE1AA4-934A-5085-89CC-9AD1CAC3****', + ], + 'DataList' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据列表。', + 'type' => 'object', + 'properties' => [ + 'IP' => [ + 'title' => '域名', + 'description' => '资产IP。', + 'type' => 'string', + 'example' => 'a.com', + ], + 'VpcId' => [ + 'title' => '域名', + 'description' => '资产所在的VPC。', + 'type' => 'string', + 'example' => 'a.com', + ], + 'TotalBytes' => [ + 'description' => '总流量。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '253023143', + ], + 'SessionCount' => [ + 'title' => '会话数', + 'description' => '会话数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'IpsHitCnt' => [ + 'description' => 'IPS命中数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'VpcName' => [ + 'description' => '资产所在的VPC的名称。', + '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"}]', + 'title' => '查询经过VPC防火墙访问域名的资产列表', + ], + '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' => '访问者源ip地址。', + 'type' => 'string', + 'required' => false, + 'example' => '60.182.79.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值：-**zh**（默认值）：中文-**en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AutoProtect', + 'in' => 'query', + 'schema' => [ + 'description' => '设置是否开启自动引流。取值：-**true**：开启。-**false**：不开启。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '防火墙模块。', + 'type' => 'string', + 'example' => 'api_server', + ], + 'RequestId' => [ + 'description' => '结果的请求id。', + '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"}]', + 'title' => '开启自动保护新入资产', + 'description' => '每个云防火墙实例最多支持创建100个TLS检查策略的关联关系。', + ], + '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"}]', + 'title' => '查询地域资产类型默认引流', + 'description' => '本接口一般用于获取域名DNS的解析结果。当前仅支持从阿里云云解析DNS获取解析结果。要查询的域名必须使用云解析DNS，才能查询到其解析结果。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + ], + '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', + ], + ], +]; |