From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/esa/2024-09-10/api-docs.php | 105609 ++++++++++++++++++++++++++++++ 1 file changed, 105609 insertions(+) create mode 100644 data/zh_cn/esa/2024-09-10/api-docs.php (limited to 'data/zh_cn/esa/2024-09-10/api-docs.php') diff --git a/data/zh_cn/esa/2024-09-10/api-docs.php b/data/zh_cn/esa/2024-09-10/api-docs.php new file mode 100644 index 0000000..d3ff72d --- /dev/null +++ b/data/zh_cn/esa/2024-09-10/api-docs.php @@ -0,0 +1,105609 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ESA', + 'version' => '2024-09-10', + ], + 'directories' => [ + [ + 'children' => [ + [ + 'children' => [ + 'CreateSite', + 'CheckSiteName', + 'VerifySite', + 'GetSiteCurrentNS', + ], + 'type' => 'directory', + 'title' => '添加、校验站点', + 'id' => 349979, + ], + [ + 'children' => [ + 'GetSite', + 'ListSites', + ], + 'type' => 'directory', + 'title' => '查询站点', + 'id' => 349984, + ], + [ + 'children' => [ + 'DeleteSite', + 'UpdateSiteAccessType', + 'UpdateSiteCoverage', + 'UpdateSiteVanityNS', + ], + 'type' => 'directory', + 'title' => '更新、删除站点', + 'id' => 349987, + ], + [ + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + ], + 'type' => 'directory', + 'title' => '标签管理', + 'id' => 349992, + ], + ], + 'type' => 'directory', + 'title' => '站点管理', + 'id' => 349978, + ], + [ + 'children' => [ + [ + 'children' => [ + [ + 'children' => [ + 'UpdateSitePause', + 'GetSitePause', + ], + 'type' => 'directory', + 'title' => '站点暂停', + 'id' => 350362, + ], + [ + 'children' => [ + 'UpdateSiteNameExclusive', + 'GetSiteNameExclusive', + ], + 'type' => 'directory', + 'title' => '站点名称独占', + 'id' => 350365, + ], + ], + 'type' => 'directory', + 'title' => '站点状态', + 'id' => 350361, + ], + [ + 'children' => [ + 'DeactivateVersionManagement', + 'ActivateVersionManagement', + ], + 'type' => 'directory', + 'title' => '版本管理', + 'id' => 350249, + ], + [ + 'children' => [ + [ + 'children' => [ + 'CreateCustomHostname', + 'DeleteCustomHostname', + 'UpdateCustomHostname', + 'VerifyCustomHostname', + 'GetCustomHostname', + 'ListCustomHostnames', + 'ApplyCustomHostnameCertificate', + ], + 'type' => 'directory', + 'title' => 'SaaS域名', + 'id' => 374461, + ], + [ + 'children' => [ + 'CreateRecord', + 'BatchCreateRecords', + 'DeleteRecord', + 'UpdateRecord', + 'ListRecords', + 'GetRecord', + 'ListEdgeRoutineRecords', + 'ListEdgeContainerRecords', + 'ExportRecords', + ], + 'type' => 'directory', + 'title' => 'DNS记录', + 'id' => 350085, + ], + [ + 'children' => [ + 'UpdateCnameFlattening', + 'GetCnameFlattening', + ], + 'type' => 'directory', + 'title' => 'CNAME拉平', + 'id' => 350095, + ], + ], + 'type' => 'directory', + 'title' => 'DNS', + 'id' => 350084, + ], + [ + 'children' => [ + [ + 'children' => [ + 'ApplyCertificate', + 'SetCertificate', + 'GetCertificate', + 'DeleteCertificate', + 'ListCertificates', + 'ListCertificatesByRecord', + 'GetCertificateQuota', + 'ListCiphers', + ], + 'type' => 'directory', + 'title' => '站点证书', + 'id' => 350169, + ], + [ + 'children' => [ + 'UploadClientCaCertificate', + 'GetClientCaCertificate', + 'DeleteClientCaCertificate', + 'ListClientCaCertificates', + 'CreateClientCertificate', + 'GetClientCertificate', + 'DeleteClientCertificate', + 'ListClientCertificates', + 'ActivateClientCertificate', + 'RevokeClientCertificate', + 'SetClientCertificateHostnames', + 'GetClientCertificateHostnames', + ], + 'type' => 'directory', + 'title' => '客户端证书', + 'id' => 350177, + ], + [ + 'children' => [ + 'UploadOriginCaCertificate', + 'GetOriginCaCertificate', + 'DeleteOriginCaCertificate', + 'ListOriginCaCertificates', + 'UploadSiteOriginClientCertificate', + 'GetSiteOriginClientCertificate', + 'DeleteSiteOriginClientCertificate', + 'ListSiteOriginClientCertificates', + 'UploadOriginClientCertificate', + 'GetOriginClientCertificate', + 'DeleteOriginClientCertificate', + 'ListOriginClientCertificates', + 'SetOriginClientCertificateHostnames', + 'GetOriginClientCertificateHostnames', + ], + 'type' => 'directory', + 'title' => '源站证书', + 'id' => 350198, + ], + ], + 'type' => 'directory', + 'title' => 'SSL/TLS', + 'id' => 350168, + ], + [ + 'children' => [ + [ + 'children' => [ + 'CreateWafRule', + 'CreateWafRuleset', + 'BatchCreateWafRules', + 'GetWafRule', + 'GetWafRuleset', + 'ListWafRules', + 'ListWafRulesets', + 'UpdateWafRule', + 'UpdateWafRuleset', + 'BatchUpdateWafRules', + 'DeleteWafRule', + 'DeleteWafRuleset', + 'ListWafPhases', + 'ListWafTemplateRules', + 'ListWafManagedRules', + 'ListManagedRulesGroups', + 'ListWafUsageOfRules', + 'GetWafQuota', + 'GetWafFilter', + 'GetWafBotAppKey', + 'GetSiteWafSettings', + 'EditSiteWafSettings', + 'BatchGetExpressionFields', + ], + 'type' => 'directory', + 'title' => 'WAF', + 'id' => 350206, + ], + [ + 'children' => [ + 'SetHttpDDoSAttackRuleStatus', + 'SetHttpDDoSAttackRuleAction', + 'DescribeHttpDDoSAttackRules', + 'SetHttpDDoSAttackProtection', + 'DescribeHttpDDoSAttackProtection', + 'DescribeDDoSBpsList', + 'DescribeDDoSL7QpsList', + 'DescribeDDoSAllEventList', + 'SetDdosMaxBurstGbps', + 'DescribeDdosMaxBurstGbps', + 'SetHttpDDoSAttackIntelligentProtection', + 'DeleteHttpDDoSIntelligentRule', + 'DescribeHttpDDoSAttackIntelligentProtection', + 'DescribeHttpDDoSIntelligentRateLimitRules', + 'DescribeHttpDDoSIntelligentAclRules', + ], + 'type' => 'directory', + 'title' => 'DDoS', + 'id' => 350236, + ], + [ + 'children' => [ + 'GetApiSchemaUsage', + ], + 'type' => 'directory', + 'title' => 'API 安全', + 'id' => 350244, + ], + [ + 'children' => [ + 'CreateOriginProtection', + 'DeleteOriginProtection', + 'UpdateOriginProtection', + 'UpdateOriginProtectionIpWhiteList', + 'GetOriginProtection', + ], + 'type' => 'directory', + 'title' => '源站防护', + 'id' => 350230, + ], + ], + 'type' => 'directory', + 'title' => '安全防护', + 'id' => 350205, + ], + [ + 'children' => [ + [ + 'children' => [ + 'UpdateDevelopmentMode', + 'GetDevelopmentMode', + ], + 'type' => 'directory', + 'title' => '开发模式', + 'id' => 350127, + ], + [ + 'children' => [ + 'PurgeCaches', + 'DescribePurgeTasks', + 'GetPurgeQuota', + ], + 'type' => 'directory', + 'title' => '刷新缓存', + 'id' => 350099, + ], + [ + 'children' => [ + 'UpdateCacheTag', + 'GetCacheTag', + ], + 'type' => 'directory', + 'title' => '缓存标签', + 'id' => 350130, + ], + [ + 'children' => [ + 'UploadFile', + 'GetUploadTask', + 'ListUploadTasks', + ], + 'type' => 'directory', + 'title' => '批量刷新预热', + 'id' => 350106, + ], + [ + 'children' => [ + 'PreloadCaches', + 'DescribePreloadTasks', + ], + 'type' => 'directory', + 'title' => '预热缓存', + 'id' => 350103, + ], + [ + 'children' => [ + 'CreateScheduledPreloadJob', + 'CreateScheduledPreloadExecutions', + 'StartScheduledPreloadExecution', + 'StopScheduledPreloadExecution', + 'DeleteScheduledPreloadExecution', + 'DeleteScheduledPreloadJob', + 'UpdateScheduledPreloadExecution', + 'ResetScheduledPreloadJob', + 'GetScheduledPreloadJob', + 'ListScheduledPreloadJobs', + 'ListScheduledPreloadExecutions', + ], + 'type' => 'directory', + 'title' => '定时预热', + 'id' => 350115, + ], + [ + 'children' => [ + 'BlockObject', + ], + 'type' => 'directory', + 'title' => '内容封禁', + 'id' => 350110, + ], + [ + 'children' => [ + 'UpdateTieredCache', + 'GetTieredCache', + ], + 'type' => 'directory', + 'title' => '多级缓存', + 'id' => 350112, + ], + [ + 'children' => [ + 'GetCacheReserveSpecification', + 'ListCacheReserveInstances', + 'PurchaseCacheReserve', + 'UpdateCacheReserveSpec', + ], + 'type' => 'directory', + 'title' => '缓存保持', + 'id' => 350133, + ], + ], + 'type' => 'directory', + 'title' => '缓存', + 'id' => 350098, + ], + [ + 'children' => [ + [ + 'children' => [ + 'CreateHttpsBasicConfiguration', + 'UpdateHttpsBasicConfiguration', + 'GetHttpsBasicConfiguration', + 'ListHttpsBasicConfigurations', + 'DeleteHttpsBasicConfiguration', + ], + 'type' => 'directory', + 'title' => 'SSL/TLS规则', + 'id' => 350253, + ], + [ + 'children' => [ + 'CreateHttpsApplicationConfiguration', + 'UpdateHttpsApplicationConfiguration', + 'GetHttpsApplicationConfiguration', + 'ListHttpsApplicationConfigurations', + 'DeleteHttpsApplicationConfiguration', + ], + 'type' => 'directory', + 'title' => 'HTTPS规则', + 'id' => 350301, + ], + [ + 'children' => [ + 'CreateRedirectRule', + 'UpdateRedirectRule', + 'GetRedirectRule', + 'ListRedirectRules', + 'DeleteRedirectRule', + ], + 'type' => 'directory', + 'title' => '重定向规则', + 'id' => 350259, + ], + [ + 'children' => [ + 'CreateRewriteUrlRule', + 'UpdateRewriteUrlRule', + 'GetRewriteUrlRule', + 'ListRewriteUrlRules', + 'DeleteRewriteUrlRule', + ], + 'type' => 'directory', + 'title' => '重写URL', + 'id' => 350265, + ], + [ + 'children' => [ + 'CreateHttpRequestHeaderModificationRule', + 'UpdateHttpRequestHeaderModificationRule', + 'GetHttpRequestHeaderModificationRule', + 'ListHttpRequestHeaderModificationRules', + 'DeleteHttpRequestHeaderModificationRule', + ], + 'type' => 'directory', + 'title' => '修改出站请求头（ESA到源站）', + 'id' => 350271, + ], + [ + 'children' => [ + 'CreateHttpIncomingRequestHeaderModificationRule', + 'UpdateHttpIncomingRequestHeaderModificationRule', + 'GetHttpIncomingRequestHeaderModificationRule', + 'ListHttpIncomingRequestHeaderModificationRules', + 'DeleteHttpIncomingRequestHeaderModificationRule', + ], + 'type' => 'directory', + 'title' => '修改入站请求头（客户端到ESA）', + 'id' => 350328, + ], + [ + 'children' => [ + 'CreateHttpResponseHeaderModificationRule', + 'UpdateHttpResponseHeaderModificationRule', + 'GetHttpResponseHeaderModificationRule', + 'ListHttpResponseHeaderModificationRules', + 'DeleteHttpResponseHeaderModificationRule', + ], + 'type' => 'directory', + 'title' => '修改出站响应头（ESA到客户端）', + 'id' => 350277, + ], + [ + 'children' => [ + 'CreateHttpIncomingResponseHeaderModificationRule', + 'UpdateHttpIncomingResponseHeaderModificationRule', + 'GetHttpIncomingResponseHeaderModificationRule', + 'ListHttpIncomingResponseHeaderModificationRules', + 'DeleteHttpIncomingResponseHeaderModificationRule', + ], + 'type' => 'directory', + 'title' => '修改入站响应头（源站到ESA）', + 'id' => 350334, + ], + [ + 'children' => [ + 'CreateCustomResponseCodeRule', + 'UpdateCustomResponseCodeRule', + 'DeleteCustomResponseCodeRule', + 'GetCustomResponseCodeRule', + 'ListCustomResponseCodeRules', + ], + 'type' => 'directory', + 'title' => '自定义响应码', + 'id' => 391775, + ], + [ + 'children' => [ + 'UpdateManagedTransform', + 'GetManagedTransform', + ], + 'type' => 'directory', + 'title' => '托管转换', + 'id' => 350319, + ], + [ + 'children' => [ + 'CreateCacheRule', + 'UpdateCacheRule', + 'GetCacheRule', + 'ListCacheRules', + 'DeleteCacheRule', + ], + 'type' => 'directory', + 'title' => '缓存规则', + 'id' => 350283, + ], + [ + 'children' => [ + 'CreateNetworkOptimization', + 'UpdateNetworkOptimization', + 'GetNetworkOptimization', + 'ListNetworkOptimizations', + 'DeleteNetworkOptimization', + ], + 'type' => 'directory', + 'title' => '网络优化规则', + 'id' => 350307, + ], + [ + 'children' => [ + 'CreateCompressionRule', + 'UpdateCompressionRule', + 'GetCompressionRule', + 'ListCompressionRules', + 'DeleteCompressionRule', + ], + 'type' => 'directory', + 'title' => '文件压缩', + 'id' => 350289, + ], + [ + 'children' => [ + 'CreateImageTransform', + 'UpdateImageTransform', + 'GetImageTransform', + 'ListImageTransforms', + 'DeleteImageTransform', + ], + 'type' => 'directory', + 'title' => '图像处理', + 'id' => 350313, + ], + [ + 'children' => [ + 'CreateVideoProcessing', + 'UpdateVideoProcessing', + 'GetVideoProcessing', + 'ListVideoProcessings', + 'DeleteVideoProcessing', + ], + 'type' => 'directory', + 'title' => '视频处理', + 'id' => 350322, + ], + [ + 'children' => [ + 'CreateOriginRule', + 'UpdateOriginRule', + 'GetOriginRule', + 'ListOriginRules', + 'DeleteOriginRule', + ], + 'type' => 'directory', + 'title' => '回源规则', + 'id' => 350295, + ], + ], + 'type' => 'directory', + 'title' => '规则', + 'id' => 350252, + ], + [ + 'children' => [ + [ + 'children' => [ + 'UpdateIPv6', + 'GetIPv6', + ], + 'type' => 'directory', + 'title' => 'IPv6', + 'id' => 350343, + ], + [ + 'children' => [ + 'CreateUrlObservation', + 'UpdateUrlObservation', + 'DescribeUrlObservationData', + 'ListUrlObservations', + 'DeleteUrlObservation', + ], + 'type' => 'directory', + 'title' => '网页监测', + 'id' => 350349, + ], + [ + 'children' => [ + 'GetCrossBorderOptimization', + 'UpdateCrossBorderOptimization', + ], + 'type' => 'directory', + 'title' => '中国大陆网络-接入优化', + 'id' => 350346, + ], + ], + 'type' => 'directory', + 'title' => '速度和网络', + 'id' => 350342, + ], + [ + 'children' => [ + [ + 'children' => [ + 'CreateWaitingRoom', + 'UpdateWaitingRoom', + 'ListWaitingRooms', + 'DeleteWaitingRoom', + 'CreateWaitingRoomRule', + 'UpdateWaitingRoomRule', + 'ListWaitingRoomRules', + 'DeleteWaitingRoomRule', + 'CreateWaitingRoomEvent', + 'UpdateWaitingRoomEvent', + 'ListWaitingRoomEvents', + 'DeleteWaitingRoomEvent', + 'UpdateSeoBypass', + 'GetSeoBypass', + ], + 'type' => 'directory', + 'title' => '等候室', + 'id' => 350139, + ], + [ + 'children' => [ + 'CreateOriginPool', + 'UpdateOriginPool', + 'GetOriginPool', + 'ListOriginPools', + 'DeleteOriginPool', + ], + 'type' => 'directory', + 'title' => '源地址池', + 'id' => 350162, + ], + [ + 'children' => [ + 'CreateLoadBalancer', + 'UpdateLoadBalancer', + 'GetLoadBalancer', + 'ListLoadBalancers', + 'DeleteLoadBalancer', + 'ListLoadBalancerRegions', + 'ListLoadBalancerOriginStatus', + ], + 'type' => 'directory', + 'title' => '负载均衡', + 'id' => 350154, + ], + ], + 'type' => 'directory', + 'title' => '流量', + 'id' => 350138, + ], + [ + 'children' => [ + 'CreateTransportLayerApplication', + 'UpdateTransportLayerApplication', + 'GetTransportLayerApplication', + 'ListTransportLayerApplications', + 'DeleteTransportLayerApplication', + ], + 'type' => 'directory', + 'title' => '四层代理', + 'id' => 350355, + ], + [ + 'children' => [ + 'ListSiteRoutes', + ], + 'type' => 'directory', + 'title' => '函数路由', + 'id' => 350340, + ], + ], + 'type' => 'directory', + 'title' => '站点配置', + 'id' => 350083, + ], + [ + 'children' => [ + [ + 'children' => [ + 'OpenErService', + 'GetErService', + 'ListUserRoutines', + 'CreateRoutine', + 'GetRoutine', + 'DeleteRoutine', + 'CreateRoutineRoute', + 'UpdateRoutineRoute', + 'GetRoutineRoute', + 'ListRoutineRoutes', + 'DeleteRoutineRoute', + 'CreateRoutineCodeDeployment', + 'CommitRoutineStagingCode', + 'GetRoutineCodeVersion', + 'ListRoutineCodeVersions', + 'GetRoutineStagingCodeUploadInfo', + 'DeleteRoutineCodeVersion', + 'UpdateRoutineConfigDescription', + 'CreateRoutineRelatedRecord', + 'ListRoutineRelatedRecords', + 'DeleteRoutineRelatedRecord', + ], + 'type' => 'directory', + 'title' => '边缘函数', + 'id' => 350051, + ], + [ + 'children' => [ + [ + 'children' => [ + 'CreateEdgeContainerApp', + 'GetEdgeContainerApp', + 'ListEdgeContainerApps', + 'DeleteEdgeContainerApp', + 'UpdateEdgeContainerAppResourceReserve', + 'GetEdgeContainerAppResourceReserve', + 'GetEdgeContainerTerminal', + 'GetEdgeContainerAppStatus', + 'DescribeEdgeContainerAppStats', + 'GetEdgeContainerAppResourceStatus', + 'GetEdgeContainerAppResourceCapacity', + ], + 'type' => 'directory', + 'title' => '容器应用', + 'id' => 349998, + ], + [ + 'children' => [ + 'CreateEdgeContainerAppImageSecret', + 'ListEdgeContainerAppImageSecrets', + 'DeleteEdgeContainerAppImageSecret', + ], + 'type' => 'directory', + 'title' => '容器应用镜像密钥', + 'id' => 350028, + ], + [ + 'children' => [ + 'UpdateEdgeContainerAppLogRiver', + 'GetEdgeContainerAppLogRiver', + 'GetEdgeContainerLogs', + ], + 'type' => 'directory', + 'title' => '日志', + 'id' => 350010, + ], + [ + 'children' => [ + 'CreateEdgeContainerAppRecord', + 'DeleteEdgeContainerAppRecord', + 'ListEdgeContainerAppRecords', + ], + 'type' => 'directory', + 'title' => '触发器', + 'id' => 350014, + ], + [ + 'children' => [ + 'CreateEdgeContainerAppVersion', + 'DeleteEdgeContainerAppVersion', + 'ListEdgeContainerAppVersions', + 'GetEdgeContainerDeployRegions', + 'GetEdgeContainerAppVersion', + 'GetEdgeContainerStagingDeployStatus', + 'PublishEdgeContainerAppVersion', + 'RebuildEdgeContainerAppStagingEnv', + 'RollbackEdgeContainerAppVersion', + ], + 'type' => 'directory', + 'title' => '版本管理', + 'id' => 350018, + ], + ], + 'type' => 'directory', + 'title' => '边缘容器', + 'id' => 349997, + ], + [ + 'children' => [ + [ + 'children' => [ + 'DescribeKvAccountStatus', + 'GetKvAccount', + ], + 'type' => 'directory', + 'title' => '服务状态查询', + 'id' => 350037, + ], + [ + 'children' => [ + 'GetKvDetail', + 'ListKvs', + 'GetKv', + 'PutKv', + 'DeleteKv', + 'BatchPutKv', + 'BatchDeleteKv', + 'PutKvWithHighCapacity', + 'BatchPutKvWithHighCapacity', + 'BatchDeleteKvWithHighCapacity', + ], + 'type' => 'directory', + 'title' => '键值对设置', + 'id' => 350040, + ], + [ + 'children' => [ + 'CreateKvNamespace', + 'DeleteKvNamespace', + 'GetKvNamespace', + ], + 'type' => 'directory', + 'title' => '存储空间', + 'id' => 350033, + ], + ], + 'type' => 'directory', + 'title' => '边缘存储', + 'id' => 350032, + ], + ], + 'type' => 'directory', + 'title' => '边缘计算', + 'id' => 349996, + ], + [ + 'children' => [ + [ + 'children' => [ + 'DescribeSiteTimeSeriesData', + 'DescribeSiteTopData', + ], + 'type' => 'directory', + 'title' => '数据分析', + 'id' => 350390, + ], + [ + 'children' => [ + 'CreateSiteDeliveryTask', + 'DeleteSiteDeliveryTask', + 'UpdateSiteDeliveryTask', + 'UpdateSiteDeliveryTaskStatus', + 'UpdateUserDeliveryTaskStatus', + 'CheckSiteProjectName', + 'CheckUserProjectName', + 'ListSiteDeliveryTasks', + 'GetRealtimeDeliveryField', + 'GetUserLogDeliveryQuota', + 'GetSiteLogDeliveryQuota', + 'CreateSiteCustomLog', + 'UpdateSiteCustomLog', + 'GetSiteCustomLog', + 'CreateUserDeliveryTask', + 'DeleteUserDeliveryTask', + 'UpdateUserDeliveryTask', + 'ListUserDeliveryTasks', + 'GetUserDeliveryTask', + 'GetSiteDeliveryTask', + ], + 'type' => 'directory', + 'title' => '实时日志', + 'id' => 350369, + ], + [ + 'children' => [ + 'DescribeSiteLogs', + ], + 'type' => 'directory', + 'title' => '离线日志', + 'id' => 350393, + ], + ], + 'type' => 'directory', + 'title' => '分析和日志', + 'id' => 350368, + ], + [ + 'children' => [ + [ + 'children' => [ + 'CreateUserWafRuleset', + 'DeleteUserWafRuleset', + 'GetUserWafRuleset', + 'ListUserWafRulesets', + 'UpdateUserWafRuleset', + ], + 'type' => 'directory', + 'title' => '全局WAF', + 'id' => 350417, + ], + [ + 'children' => [ + 'CreateList', + 'UpdateList', + 'GetList', + 'ListLists', + 'DeleteList', + ], + 'type' => 'directory', + 'title' => '分组', + 'id' => 350398, + ], + [ + 'children' => [ + 'CreateCustomScenePolicy', + 'UpdateCustomScenePolicy', + 'DisableCustomScenePolicy', + 'EnableCustomScenePolicy', + 'DescribeCustomScenePolicies', + 'DeleteCustomScenePolicy', + ], + 'type' => 'directory', + 'title' => '场景策略', + 'id' => 350404, + ], + [ + 'children' => [ + 'CreatePage', + 'UpdatePage', + 'GetPage', + 'ListPages', + 'DeletePage', + ], + 'type' => 'directory', + 'title' => '自定义页面', + 'id' => 350411, + ], + ], + 'type' => 'directory', + 'title' => '全局配置', + 'id' => 350397, + ], + [ + 'children' => [ + 'ListESAIPInfo', + ], + 'type' => 'directory', + 'title' => '工具', + 'id' => 350395, + ], + [ + 'children' => [ + [ + 'children' => [ + 'PurchaseRatePlan', + 'UpdateRatePlanSpec', + 'DescribeRatePlanInstanceStatus', + 'ListEdgeRoutinePlans', + 'ListUserRatePlanInstances', + 'ListInstanceQuotas', + ], + 'type' => 'directory', + 'title' => '套餐管理', + 'id' => 350074, + ], + [ + 'children' => [ + 'ListInstanceQuotasWithUsage', + ], + 'type' => 'directory', + 'title' => '用量查询', + 'id' => 350081, + ], + ], + 'type' => 'directory', + 'title' => '计费管理', + 'id' => 350073, + ], + ], + 'components' => [ + 'schemas' => [ + 'WafBatchRuleShared' => [ + 'title' => 'WAF批量规则共享', + 'description' => 'WAF批量规则共享。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'title' => '防护目标类型：web/app', + 'description' => '防护目标类型：web/app。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'web', + 'backendName' => 'target', + ], + 'Mode' => [ + 'title' => 'web sdk 集成方式：自动集成(automatic)/手动集成(manual)', + 'description' => 'web sdk 集成方式：自动集成(automatic)/手动集成(manual)。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'automatic', + 'backendName' => 'mode', + ], + 'CrossSiteId' => [ + 'title' => '指定跨域站点id', + 'description' => '指定跨域站点id。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + 'backendName' => 'crossSiteId', + ], + 'Name' => [ + 'title' => '规则集名称', + 'description' => '规则集名称。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'example', + 'backendName' => 'name', + ], + 'Match' => [ + 'title' => '匹配引擎', + 'description' => '匹配引擎。', + 'visibility' => 'Public', + 'backendName' => 'match', + '$ref' => '#/components/schemas/WafRuleMatch2', + ], + 'Action' => [ + 'title' => '动作', + 'description' => '动作。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'deny', + 'backendName' => 'action', + ], + 'Actions' => [ + 'title' => '动作扩展', + 'description' => '动作扩展。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'title' => '自定义响应', + 'description' => '自定义响应。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '自定义响应页面id', + 'description' => '自定义响应页面id。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000001', + 'backendName' => 'id', + ], + 'Code' => [ + 'title' => '自定义响应码', + 'description' => '自定义响应码。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '403', + 'backendName' => 'code', + ], + ], + 'backendName' => 'response', + ], + ], + 'backendName' => 'actions', + ], + 'Expression' => [ + 'title' => '表达式', + 'description' => '表达式。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ip.src eq 1.1.1.1', + 'backendName' => 'expression', + ], + ], + ], + 'WafQuotaInteger' => [ + 'title' => 'a integer', + 'description' => '对integer类型值进行校验的quota结构。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Equal' => [ + 'title' => 'equal', + 'description' => '等于。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'eq', + ], + 'GreaterThan' => [ + 'title' => 'greater than', + 'description' => '大于。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'gt', + ], + 'GreaterThanOrEqual' => [ + 'title' => 'greater than or equal', + 'description' => '大于等于。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'ge', + ], + 'LessThan' => [ + 'title' => 'less than', + 'description' => '小于。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'lt', + ], + 'LessThanOrEqual' => [ + 'title' => 'less than or equal', + 'description' => '小于等于。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'le', + ], + ], + ], + 'WafQuotaString' => [ + 'title' => 'A short description of struct', + 'description' => '对string类型值进行校验的quota结构。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Regexp' => [ + 'title' => '正则表达式', + 'description' => '正则表达式。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '^\\d+$', + 'backendName' => 'regex', + ], + ], + ], + 'WafRuleConfig' => [ + 'title' => 'A short description of struct', + 'description' => 'WAF规则配置', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '规则状态', + 'description' => 'WAF规则的状态。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'on', + 'backendName' => 'status', + ], + 'Action' => [ + 'title' => '执行动作', + 'description' => 'WAF规则匹配命中后执行的动作。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'deny', + 'backendName' => 'action', + ], + 'Actions' => [ + 'title' => '扩展动作', + 'description' => '扩展动作', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'title' => '自定义响应页面', + 'description' => '自定义响应页面。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '自定义响应页面ID', + 'description' => '自定义响应页面的ID，可通过调用[ListPages](~~2850223~~)接口获取。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000001', + 'backendName' => 'id', + ], + 'Code' => [ + 'title' => '自定义响应码', + 'description' => '自定义响应码。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '403', + 'backendName' => 'code', + ], + ], + 'backendName' => 'response', + ], + 'Bypass' => [ + 'title' => '跳过模块', + 'description' => '白名单规则指定的跳过模块。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Skip' => [ + 'title' => '跳过模块类型', + 'description' => '跳过模块类型。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'part', + 'backendName' => 'skip', + ], + 'RegularRules' => [ + 'title' => '托管规则id列表', + 'description' => '托管规则id列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '托管规则ID。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + 'extendType' => 'true', + ], + 'backendName' => 'regularRules', + ], + 'CustomRules' => [ + 'title' => '自定义规则id列表', + 'description' => '自定义规则ID列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '自定义规则ID。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000001', + 'extendType' => 'true', + ], + 'backendName' => 'customRules', + ], + 'RegularTypes' => [ + 'title' => '托管规则类型列表', + 'description' => '托管规则类型列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '托管规则类型。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'sqli', + 'extendType' => 'true', + ], + 'backendName' => 'regularTypes', + ], + 'Tags' => [ + 'title' => '跳过模块列表', + 'description' => '跳过模块阶段列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '跳过模块阶段。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'http_custom', + 'extendType' => 'true', + ], + 'backendName' => 'tags', + ], + ], + 'backendName' => 'bypass', + ], + ], + 'backendName' => 'actions', + ], + 'ManagedList' => [ + 'title' => '名单名字', + 'description' => '托管名单。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'intelligence_crawler', + 'backendName' => 'managedList', + ], + 'ManagedRulesets' => [ + 'title' => '托管规则集列表', + 'description' => '托管规则集列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '托管规则集。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ProtectionLevel' => [ + 'title' => '防护等级', + 'description' => '防护等级。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'backendName' => 'protectionLevel', + ], + 'Action' => [ + 'title' => '执行动作', + 'description' => '执行动作。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'deny', + 'backendName' => 'action', + ], + 'ManagedRules' => [ + 'title' => '托管规则列表', + 'description' => '托管规则列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '托管规则。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '托管规则状态', + 'description' => '托管规则状态。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'on', + 'backendName' => 'status', + ], + 'Action' => [ + 'title' => '托管规则动作', + 'description' => '托管规则动作。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'deny', + 'backendName' => 'action', + ], + 'Id' => [ + 'title' => '托管规则ID', + 'description' => '托管规则ID。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + 'backendName' => 'id', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'managedRules', + ], + 'AttackType' => [ + 'title' => '攻击类型', + 'description' => '攻击类型。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + 'backendName' => 'attackType', + ], + 'NumberTotal' => [ + 'title' => '规则总数', + 'description' => '规则总数。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'backendName' => 'numberTotal', + ], + 'NumberEnabled' => [ + 'title' => '已开启规则数', + 'description' => '已开启规则数。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + 'backendName' => 'numberEnabled', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'managedRulesets', + ], + 'Sigchl' => [ + 'title' => '令牌校验', + 'description' => '令牌校验配置。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '令牌校验配置项。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'sig', + 'extendType' => 'true', + ], + 'backendName' => 'sigchl', + ], + 'Name' => [ + 'title' => '规则名称', + 'description' => 'WAF规则的名称。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'example', + 'backendName' => 'name', + ], + 'AppSdk' => [ + 'title' => 'app sdk', + 'description' => 'APP SDK 配置。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CustomSign' => [ + 'title' => '自定义加签字段', + 'description' => '自定义加签字段。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '字段值', + 'description' => '字段值。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'examplesignvalue', + 'backendName' => 'value', + ], + 'Key' => [ + 'title' => '字段名', + 'description' => '字段名。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'sign', + 'backendName' => 'key', + ], + ], + 'backendName' => 'customSign', + ], + 'CustomSignStatus' => [ + 'title' => '自定义加签字段开关', + 'description' => '自定义加签字段开关。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'on', + 'backendName' => 'customSignStatus', + ], + 'FeatureAbnormal' => [ + 'title' => '特征异常', + 'description' => 'APP特征异常。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'APP特征异常。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'wxbb_invalid_sign', + 'extendType' => 'true', + ], + 'backendName' => 'featureAbnormal', + ], + ], + 'backendName' => 'appSdk', + ], + 'RateLimit' => [ + 'title' => '频次控制', + 'description' => '频次控制规则相关配置。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Characteristics' => [ + 'title' => '统计对象', + 'description' => '指定频次统计对象。', + 'visibility' => 'Public', + 'backendName' => 'characteristics', + '$ref' => '#/components/schemas/WafRuleMatch2', + ], + 'OnHit' => [ + 'title' => '在命中缓存的请求上应用', + 'description' => '在命中缓存的请求上应用。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'onHit', + ], + 'TTL' => [ + 'title' => '超时时间', + 'description' => '超时时间。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'ttl', + ], + 'Threshold' => [ + 'title' => '阈值', + 'description' => '统计阈值。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ManagedRulesBlocked' => [ + 'title' => '托管规则命中阈值', + 'description' => '托管规则命中阈值。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'managedRulesBlocked', + ], + 'DistinctManagedRules' => [ + 'title' => '不同的托管规则个数阈值', + 'description' => '不同的托管规则个数阈值。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'distinctManagedRules', + ], + 'ResponseStatus' => [ + 'title' => '响应码阈值', + 'description' => '响应码阈值。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Ratio' => [ + 'title' => '响应码百分比', + 'description' => '响应码百分比。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'ratio', + ], + 'Count' => [ + 'title' => '响应码次数阈值', + 'description' => '响应码次数阈值。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'count', + ], + 'Code' => [ + 'title' => 'HTTP响应码', + 'description' => 'HTTP响应码。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '404', + 'backendName' => 'code', + ], + ], + 'backendName' => 'responseStatus', + ], + 'Traffic' => [ + 'title' => '流量阈值', + 'description' => '流量阈值，已废弃。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '10Gb', + 'backendName' => 'traffic', + ], + 'Request' => [ + 'title' => '请求阈值', + 'description' => '请求阈值。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'request', + 'parseType' => 'struct', + ], + ], + 'backendName' => 'threshold', + ], + 'Interval' => [ + 'title' => '统计时长', + 'description' => '统计时长。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'backendName' => 'interval', + ], + ], + 'backendName' => 'rateLimit', + ], + 'Type' => [ + 'title' => '规则类型', + 'description' => 'WAF规则的类型。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'http_custom', + 'backendName' => 'type', + ], + 'AppPackage' => [ + 'title' => '二次打包检测', + 'description' => '二次打包检测配置。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'PackageSigns' => [ + 'title' => '二次打包检测', + 'description' => '二次打包检测。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '二次打包检测。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Sign' => [ + 'title' => '包签名', + 'description' => '包签名。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'sign', + 'backendName' => 'sign', + ], + 'Name' => [ + 'title' => '指定合法包名', + 'description' => '指定合法包名。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'name', + 'backendName' => 'name', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'packageSigns', + ], + ], + 'backendName' => 'appPackage', + ], + 'ManagedGroupId' => [ + 'title' => '托管规则组id', + 'description' => '托管规则组id，已废弃。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30000001', + 'backendName' => 'managedGroupId', + ], + 'Timer' => [ + 'title' => '定时器', + 'description' => '定时器。', + 'visibility' => 'Public', + 'backendName' => 'timer', + '$ref' => '#/components/schemas/WafTimer', + ], + 'Expression' => [ + 'title' => '表达式', + 'description' => '匹配表达式。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ip.src eq 10.0.0.1', + 'backendName' => 'expression', + ], + 'SecurityLevel' => [ + 'title' => '安全级别', + 'description' => '安全级别', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '安全级别的值', + 'description' => '安全级别的值：'."\n" + ."\n" + .'* off：关闭'."\n" + .'* essentially_off：基本关闭'."\n" + .'* low：低'."\n" + .'* medium：中等'."\n" + .'* high：高'."\n" + .'* under_attack：我正在遭受攻击', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'low', + 'backendName' => 'value', + ], + ], + 'backendName' => 'securityLevel', + ], + 'Value' => [ + 'title' => 'IP访问控制值', + 'description' => 'IP访问控制值', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '10.0.0.1', + 'backendName' => 'value', + ], + 'Id' => [ + 'title' => '规则id', + 'description' => 'WAF规则的ID。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000001', + 'backendName' => 'id', + ], + 'Notes' => [ + 'title' => '备注', + 'description' => '备注', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'example notes', + 'backendName' => 'notes', + ], + ], + ], + 'WafRuleMatch' => [ + 'description' => 'WAF规则匹配结构。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Logic' => [ + 'title' => '逻辑关系', + 'description' => '逻辑关系。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'and', + 'backendName' => 'logic', + ], + 'Criteria' => [ + 'title' => '逻辑列表', + 'description' => '逻辑列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则匹配结构。', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/WafRuleMatch', + ], + 'backendName' => 'criteria', + ], + 'MatchType' => [ + 'title' => '匹配域', + 'description' => '匹配域。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ip.src', + 'backendName' => 'type', + ], + 'MatchOperator' => [ + 'title' => '匹配符', + 'description' => '匹配符。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'eq', + 'backendName' => 'operator', + ], + 'MatchValue' => [ + 'title' => '匹配值', + 'description' => '匹配值。', + 'visibility' => 'Public', + 'type' => 'any', + 'example' => '1.1.1.1', + 'backendName' => 'value', + ], + 'Negate' => [ + 'title' => '匹配结果取反', + 'description' => '匹配结果取反。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'negate', + ], + 'ConvertToLower' => [ + 'title' => '值大小写不敏感', + 'description' => '值大小写不敏感。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'convertToLower', + ], + ], + ], + 'WafRuleMatch2' => [ + 'description' => 'WAF规则匹配项。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Logic' => [ + 'title' => '逻辑关系', + 'description' => '逻辑关系。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'and', + 'backendName' => 'logic', + ], + 'Criteria' => [ + 'title' => '逻辑列表', + 'description' => '逻辑列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Logic' => [ + 'title' => '逻辑关系', + 'description' => '逻辑关系。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'and', + 'backendName' => 'logic', + ], + 'Criteria' => [ + 'title' => '逻辑列表', + 'description' => '逻辑列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Logic' => [ + 'title' => '逻辑关系', + 'description' => '逻辑关系。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'and', + 'backendName' => 'logic', + ], + 'Criteria' => [ + 'title' => '逻辑列表', + 'description' => '逻辑列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'MatchType' => [ + 'title' => '匹配域', + 'description' => '匹配域。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ip.src', + 'backendName' => 'type', + ], + 'MatchOperator' => [ + 'title' => '匹配符', + 'description' => '匹配符。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'eq', + 'backendName' => 'operator', + ], + 'MatchValue' => [ + 'title' => '匹配值', + 'description' => '匹配值。', + 'visibility' => 'Public', + 'type' => 'any', + 'example' => '1.1.1.1', + 'backendName' => 'value', + ], + 'Negate' => [ + 'title' => '匹配结果取反', + 'description' => '匹配结果取反。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'negate', + ], + 'ConvertToLower' => [ + 'title' => '值大小写不敏感', + 'description' => '值大小写不敏感。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'convertToLower', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'criteria', + ], + 'MatchType' => [ + 'title' => '匹配域', + 'description' => '匹配域。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ip.src', + 'backendName' => 'type', + ], + 'MatchOperator' => [ + 'title' => '匹配符', + 'description' => '匹配符。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'eq', + 'backendName' => 'operator', + ], + 'MatchValue' => [ + 'title' => '匹配值', + 'description' => '匹配值。', + 'visibility' => 'Public', + 'type' => 'any', + 'example' => '1.1.1.1', + 'backendName' => 'value', + ], + 'Negate' => [ + 'title' => '匹配结果取反', + 'description' => '匹配结果取反。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'negate', + ], + 'ConvertToLower' => [ + 'title' => '值大小写不敏感', + 'description' => '值大小写不敏感。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'convertToLower', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'criteria', + ], + 'MatchType' => [ + 'title' => '匹配域', + 'description' => '匹配域。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ip.src', + 'backendName' => 'type', + ], + 'MatchOperator' => [ + 'title' => '匹配符', + 'description' => '匹配符。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'eq', + 'backendName' => 'operator', + ], + 'MatchValue' => [ + 'title' => '匹配值', + 'description' => '匹配值。', + 'visibility' => 'Public', + 'type' => 'any', + 'example' => '1.1.1.1', + 'backendName' => 'value', + ], + 'Negate' => [ + 'title' => '匹配结果取反', + 'description' => '匹配结果取反。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'negate', + ], + 'ConvertToLower' => [ + 'title' => '值大小写不敏感', + 'description' => '值大小写不敏感。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'convertToLower', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'criteria', + ], + 'MatchType' => [ + 'title' => '匹配域', + 'description' => '匹配域。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ip.src', + 'backendName' => 'type', + ], + 'MatchOperator' => [ + 'title' => '匹配符', + 'description' => '匹配符。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'eq', + 'backendName' => 'operator', + ], + 'MatchValue' => [ + 'title' => '匹配值', + 'description' => '匹配值。', + 'visibility' => 'Public', + 'type' => 'any', + 'example' => '1.1.1.1', + 'backendName' => 'value', + ], + 'Negate' => [ + 'title' => '匹配结果取反', + 'description' => '匹配结果取反。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'negate', + ], + 'ConvertToLower' => [ + 'title' => '值大小写不敏感', + 'description' => '值大小写不敏感。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'convertToLower', + ], + ], + ], + 'WafSiteSettings' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ClientIpIdentifier' => [ + 'title' => '客户端IP识别', + 'description' => '客户端IP识别。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Headers' => [ + 'title' => '指定header', + 'description' => '指定headers。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '指定header。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'X-Forwarded-For', + 'extendType' => 'true', + ], + 'backendName' => 'headers', + ], + 'Mode' => [ + 'title' => '识别模式', + 'description' => '识别模式。', + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'headers' => '指定headers', + 'connection_ip' => '建连IP', + ], + 'example' => 'headers', + 'backendName' => 'mode', + ], + ], + 'backendName' => 'client_ip_identifier', + ], + 'AddBotProtectionHeaders' => [ + 'title' => '添加BOT保护标头', + 'description' => '添加BOT保护标头。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '开关', + 'description' => '开关。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'enable', + ], + ], + 'backendName' => 'add_bot_protection_headers', + ], + 'AddSecurityHeaders' => [ + 'title' => '添加安全标头', + 'description' => '添加安全标头。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '开关', + 'description' => '开关。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'enable', + ], + ], + 'backendName' => 'add_security_headers', + ], + 'SecurityLevel' => [ + 'title' => '安全级别', + 'description' => '安全级别。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '安全级别值', + 'description' => '安全级别值。', + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'high' => '高', + 'low' => '低', + 'under_attack' => '我正在遭受攻击', + 'medium' => '中等', + 'essentially_off' => '基本关闭', + 'off' => '彻底关闭', + ], + 'example' => 'low', + 'backendName' => 'value', + ], + ], + 'backendName' => 'security_level', + ], + 'BotManagement' => [ + 'title' => 'Bot管理', + 'description' => 'Bot管理。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'DefiniteBots' => [ + 'title' => '绝对是Bot', + 'description' => '绝对是Bot。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'title' => '动作', + 'description' => '动作。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'captcha', + 'backendName' => 'action', + ], + 'Id' => [ + 'title' => '规则ID', + 'description' => '规则ID。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000001', + 'backendName' => 'id', + ], + ], + 'backendName' => 'definite_bots', + ], + 'LikelyBots' => [ + 'title' => '可能是Bot', + 'description' => '可能是Bot。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'title' => '动作', + 'description' => '动作。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'deny', + 'backendName' => 'action', + ], + 'Id' => [ + 'title' => '规则ID', + 'description' => '规则ID。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000002', + 'backendName' => 'id', + ], + ], + 'backendName' => 'likely_bots', + ], + 'JSDetection' => [ + 'title' => 'JavaScript探测', + 'description' => 'JavaScript探测。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '开关', + 'description' => '开关。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'enable', + ], + ], + 'backendName' => 'js_detection', + ], + 'VerifiedBots' => [ + 'title' => '已通过验证的Bot', + 'description' => '已通过验证的Bot。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'title' => '动作', + 'description' => '动作。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'bypass', + 'backendName' => 'action', + ], + 'Id' => [ + 'title' => '规则ID', + 'description' => '规则ID。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000003', + 'backendName' => 'id', + ], + ], + 'backendName' => 'verified_bots', + ], + 'EffectOnStatic' => [ + 'title' => '对静态资源请求生效', + 'description' => '对静态资源请求生效。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '开关', + 'description' => '开关。', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'enable', + ], + ], + 'backendName' => 'effect_on_static', + ], + ], + 'backendName' => 'bot_management', + ], + 'BandwidthAbuseProtection' => [ + 'title' => '防盗刷。', + 'description' => '防盗刷。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '防盗刷规则的开关状态。', + 'description' => '防盗刷规则的开关状态。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'on', + 'backendName' => 'status', + ], + 'Action' => [ + 'title' => '防盗刷规则的执行动作。', + 'description' => '防盗刷规则的执行动作。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'deny', + 'backendName' => 'action', + ], + 'Id' => [ + 'title' => '防盗刷规则的ID。', + 'description' => '防盗刷规则的ID。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + 'backendName' => 'id', + ], + ], + 'backendName' => 'bandwidth_abuse_protection', + ], + 'DisableSecurityModule' => [ + 'title' => '禁用安全模块', + 'description' => '禁用安全模块', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '禁用安全模块的状态开关', + 'description' => '禁用安全模块的状态开关', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'on', + 'backendName' => 'status', + ], + ], + 'backendName' => 'disable_security_module', + ], + ], + ], + 'WafTimer' => [ + 'title' => 'WAF定时器', + 'description' => 'WAF定时器', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Scopes' => [ + 'title' => '定时类型：永久生效(permanent/<空>)/时间段生效(periods)/weekly(周期生效)', + 'description' => '定时类型：永久生效（permanent/<空>）/时间段生效（periods）/weekly（周期生效）。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'permanent', + 'backendName' => 'scopes', + ], + 'Zone' => [ + 'title' => '时区，不填则默认为UTC+00:00。
例：8表示东8区，-8表示西8区
范围：-12 - +14', + 'description' => '时区，不填则默认为UTC+00:00。
例：8表示东8区，-8表示西8区
范围：-12 - +14。', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + 'backendName' => 'zone', + ], + 'Periods' => [ + 'title' => '生效时间段', + 'description' => '生效时间段。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => '起始时间，值为RFC3339格式的UTC时间', + 'description' => '起始时间，值为RFC3339格式的UTC时间。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2025-01-01T00:00:00Z', + 'backendName' => 'start', + ], + 'End' => [ + 'title' => '结束时间，值为RFC3339格式的UTC时间', + 'description' => '结束时间，值为RFC3339格式的UTC时间。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2025-01-01T01:00:00Z', + 'backendName' => 'end', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'periods', + ], + 'WeeklyPeriods' => [ + 'title' => '每周生效时间段', + 'description' => '每周生效时间段。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Days' => [ + 'title' => '周期，多个使用逗号分隔，1-7分别代表周一-周日。
例：周一，周三值为"1,3"', + 'description' => '周期，多个使用逗号分隔，1-7分别代表周一-周日。
例：周一，周三值为"1,3"。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1', + 'backendName' => 'days', + ], + 'DailyPeriods' => [ + 'title' => '该周期内的生效时间', + 'description' => '该周期内的生效时间。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => '起始时间，格式为HH:mm:ss', + 'description' => '起始时间，格式为HH:mm:ss。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '00:00:00', + 'backendName' => 'start', + ], + 'End' => [ + 'title' => '结束时间，格式为HH:mm:ss', + 'description' => '结束时间，格式为HH:mm:ss。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '01:00:00', + 'backendName' => 'end', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'dailyPeriods', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'weeklyPeriods', + ], + ], + ], + ], + ], + 'apis' => [ + 'ActivateClientCertificate' => [ + 'summary' => '根据证书ID激活客户端。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238804', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。可通过[ListClientCertificates](~~2852848~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaded901474b9693acf530e0fb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '激活客户端证书', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-23T02:15:35.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ActivateClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:ActivateClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Id\\": \\"babaded901474b9693acf530e0fb****\\",\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'ActivateVersionManagement' => [ + 'summary' => '开启版本管理。使站点支持多个配置版本与多个部署环境，可以更灵活地管理站点的流量与配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239166', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11223***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D2***', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'The current plan\'s quota of version management is insufficient. Please try to upgrade the plan.', + 'description' => '当前套餐的版本管理配额不足，请尝试升级套餐版本。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '开启站点版本管理', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ActivateVersionManagement', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:ActivateVersionManagement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D2***\\"\\n}","type":"json"}]', + ], + 'ApplyCertificate' => [ + 'summary' => '申请免费证书。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238947', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Domains', + 'in' => 'query', + 'schema' => [ + 'description' => '域名列表，多个域名用逗号分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com,blog.example.com', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '证书类型。可能值：lets_encrypt：Let\'s Encrypt证书；digicert_single：Digicert单域名证书；digicert_wildcard：Digicert泛域名证书。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'digicert_wildcard' => 'digicert_wildcard', + 'lets_encrypt' => 'lets_encrypt', + 'digicert_single' => 'digicert_single', + ], + 'example' => 'lets_encrypt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'TotalCount' => [ + 'description' => '申请的证书个数，和输入的域名个数相同。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Result' => [ + 'description' => '免费证书申请详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '免费证书申请详情。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '证书域名。', + 'type' => 'string', + 'example' => '*.example.com ', + ], + 'Status' => [ + 'description' => '证书申请状态。', + 'type' => 'string', + 'example' => 'Applying', + ], + 'Id' => [ + 'description' => '证书Id。', + 'type' => 'string', + 'example' => '30000478', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The specified site is not found.', + 'description' => '您指定的站点不存在，请检查输入的站点是否正确。', + ], + [ + 'errorCode' => 'SiteNotActivated', + 'errorMessage' => 'The site is not activated, the process is not allowed.', + 'description' => '站点未激活，不支持该操作。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.Domains', + 'errorMessage' => 'You have already submitted a certificate application for the domain name.', + 'description' => '您已提交该域名证书申请任务，请勿重复提交。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'QuotaCheckFailed', + 'errorMessage' => 'Failed to check free certificate Quota, please try again later.', + 'description' => '检查免费证书Quota失败，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.Type', + 'errorMessage' => 'The specified Type parameter is invalid, please check and try again.', + 'description' => '您配置的Type参数有误，请您检查后重试。证书申请Type支持lets_encrypt，digicert_single，digicert_wildcard。', + ], + [ + 'errorCode' => 'QuotaExceed.RecordCount', + 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', + 'description' => '记录数量已达上限，请删除部分记录后重试或升级套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + [ + 'errorCode' => 'QuotaExceeded', + 'errorMessage' => 'The quota is exceeded.', + 'description' => '额度不足', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '申请免费证书', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ApplyCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:ApplyCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteName\\": \\"example.com \\",\\n \\"TotalCount\\": 2,\\n \\"Result\\": [\\n {\\n \\"Domain\\": \\"*.example.com \\",\\n \\"Status\\": \\"Applying\\",\\n \\"Id\\": \\"30000478\\"\\n }\\n ],\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\"\\n}","type":"json"}]', + ], + 'ApplyCustomHostnameCertificate' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239650', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4DMKZ4', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'HostnameId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '自定义主机名ID。', + 'description' => 'SaaS 域名的 ID，可通过调用[ListCustomHostnames](~~3018667~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + ], + 404 => [ + [ + 'errorCode' => 'CustomHostname.NotFound', + 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', + 'description' => '该自定义主机名不存在，请调整后重试。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '重新申请 SaaS 域名的免费证书', + 'summary' => '重新申请 SaaS 域名的免费证书，仅支持当前免费证书申请失败、即将过期、已过期时调用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\"\\n}","type":"json"}]', + ], + 'BatchCreateRecords' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239587', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'RecordList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待创建的DNS记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个记录对象，包含记录的具体配置信息。', + 'type' => 'object', + 'properties' => [ + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + 'Type' => [ + 'description' => '记录的DNS类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'A/AAAA', + ], + 'Proxied' => [ + 'description' => '记录是否开启代理加速。只有CNAME记录与A/AAAA记录可以开启代理加速。取值：'."\n" + .'- **true**：开启代理。'."\n" + .'- **false**：关闭代理加速。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'SourceType' => [ + 'description' => 'CNAME记录的源站类型。添加CNAME记录时，需要填写此参数。取值：'."\n" + ."\n" + .'- **OSS**：OSS源站。'."\n" + .'- **S3**：S3源站。'."\n" + .'- **LB**：负载均衡器源站。'."\n" + .'- **OP**：源地址池源站。'."\n" + .'- **Domain**：普通域名源站。'."\n" + ."\n" + .'该参数不传或传空时，则默认为Domain，即普通域名源站类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + 'BizName' => [ + 'description' => '记录加速时的业务场景，取值：'."\n" + .'- **image_video**：视频图片。'."\n" + .'- **api**：api接口。'."\n" + .'- **web**：web网页。', + 'type' => 'string', + 'required' => false, + 'example' => 'web', + ], + 'Data' => [ + 'description' => '记录的DNS信息，根据记录类型填写不同的字段。', + 'type' => 'object', + 'properties' => [ + 'Usage' => [ + 'description' => '记录的用途标识，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Fingerprint' => [ + 'description' => '记录的公钥指纹值。适用于SSHFP记录。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef1234567890', + ], + 'Priority' => [ + 'description' => '记录的优先级，范围为**0~65535**。数值越小，优先级越高。添加MX、SRV、URI记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Port' => [ + 'description' => '记录的端口，范围为**0~65535**。仅适用于SRV记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Flag' => [ + 'description' => 'CAA记录的标志位，指示其优先级和处理方式，取值范围为**0~255**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '128', + ], + 'Algorithm' => [ + 'description' => '记录所采用的加密算法，范围为**0~255**。适用于CERT、SSHFP记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Weight' => [ + 'description' => '记录的权重，范围为**0~65535**。适用于SRV、URI记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Type' => [ + 'description' => '记录的证书类型（CERT记录）或公钥类型（SSHFP记录）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MatchingType' => [ + 'description' => '记录用于匹配或验证证书的算法策略，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Value' => [ + 'description' => '记录值或部分内容。'."\n" + .'- **A/AAAA**：IP。'."\n" + .'- **CNAME**：指向的目标域名。'."\n" + .'- **MX**: 有效的目标邮件服务器域名。'."\n" + .'- **TXT**：有效的文本字符串。'."\n" + .'- **CAA**：有效的证书颁发机构域名。'."\n" + .'- **SRV**：有效的目标主机域名。'."\n" + .'- **URI**: 有效的 URI 字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'KeyTag' => [ + 'description' => '记录的公钥标识，范围为**0~65535**。适用于CERT记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Tag' => [ + 'description' => 'CAA记录的标签，表示其具体类型和用途，如issue、issuewild、iodef等。', + 'type' => 'string', + 'required' => false, + 'example' => 'issue', + ], + 'Certificate' => [ + 'description' => '记录的公钥证书信息。适用于CERT、SMIMEA和TLSA记录。', + 'type' => 'string', + 'required' => false, + 'example' => 'dGVzdGFkYWxrcw==', + ], + 'Selector' => [ + 'description' => '记录所使用的证书或公钥的类型，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => true, + 'example' => '{'."\n" + .' "value":"2.2.2.2"'."\n" + .'}', + ], + 'Ttl' => [ + 'description' => '记录的过期时间，单位秒。当取值为1时，表示记录的过期时间为自动。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '60', + ], + 'AuthConf' => [ + 'description' => 'CNAME记录的源站鉴权信息。', + 'type' => 'object', + 'properties' => [ + 'SecretKey' => [ + 'description' => '源站所属账号的SecretKey，当源站类型为OSS且源站鉴权类型为私有跨账号读，或者源站类型为S3且源站鉴权类型为私有读时，需要填写此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'VIxuvJSA2S03f******kp208dy5w7'."\n", + ], + 'Version' => [ + 'description' => '签名算法版本，当源站类型为S3且源站鉴权类型为私有读时有该参数，支持以下两种：'."\n" + .'- **v2**'."\n" + .'- **v4**'."\n" + ."\n" + .'不传时，默认为v4。', + 'type' => 'string', + 'required' => false, + 'example' => 'v4', + ], + 'Region' => [ + 'description' => '源站所属区域，当源站类型为S3时，需要填写此值，源站所属的区域需要在S3的官方网站上获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'us-east-1'."\n", + ], + 'AuthType' => [ + 'description' => '源站鉴权类型，不同的源站类型，支持的鉴权类型不同，源站类型是指本接口中的SourceType参数，现在源站类型为OSS和S3时，需要填写源站鉴权类型，可选值：'."\n" + .'- **public**：公共读，当源站类型为OSS或S3，且源站为公共读时，选此值。'."\n" + .'- **private**: 私有读，当源站类型为S3，且源站为私有读时，选此值。'."\n" + .'- **private_same_account**: 私有同账号读，当源站类型为OSS，在同一个阿里云账号下，且源站为私有读时，选此值。'."\n" + .'- **private_cross_account**: 私有跨账号读，当源站类型为OSS，不在同一个阿里云账号下，且源站为私有读时，选此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'private', + ], + 'AccessKey' => [ + 'description' => '源站所属账号的AccessKey，当源站类型为OSS且源站鉴权类型为私有跨账号读，或者源站类型为S3且源站鉴权类型为私有读时，需要填写此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt'."\n", + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '批量创建记录操作的响应结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', + ], + 'RecordResultList' => [ + 'description' => '记录创建结果列表，包含成功和失败的记录详情。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '成功的记录列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'Proxied' => [ + 'description' => '记录是否开启代理加速。只有CNAME记录与A/AAAA记录可以开启代理加速。取值：'."\n" + .'- **true**：开启代理。'."\n" + .'- **false**：关闭代理加速。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Description' => [ + 'description' => '创建结果的信息描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'RecordType' => [ + 'description' => '记录的DNS类型。如**A/AAAA、CNAME、TXT**等。', + 'type' => 'string', + 'example' => 'A/AAAA', + ], + 'SourceType' => [ + 'description' => 'CNAME记录的源站类型，其他类型记录此字段为空。源站类型取值：'."\n" + .'- **OSS**：OSS源站。'."\n" + .'- **S3**：S3源站。'."\n" + .'- **LB**：负载均衡器源站。'."\n" + .'- **OP**：源地址池源站。'."\n" + .'- **Domain**：普通域名源站。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Data' => [ + 'description' => '记录的DNS信息。', + 'type' => 'object', + 'properties' => [ + 'Usage' => [ + 'description' => '记录的用途标识，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Fingerprint' => [ + 'description' => '记录的公钥指纹值。适用于SSHFP记录。', + 'type' => 'string', + 'example' => 'abcdef1234567890', + ], + 'Priority' => [ + 'description' => '记录的优先级，范围为**0~65535**。数值越小，优先级越高。适用于MX、SRV、URI记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Port' => [ + 'description' => '记录的端口，范围为**0~65535**。仅适用于SRV记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Flag' => [ + 'description' => '记录的标志位。指示其优先级和处理方式，使用于CAA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + 'Algorithm' => [ + 'description' => '记录所采用的加密算法，范围为**0~255**。适用于CERT、SSHFP记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Weight' => [ + 'description' => '记录的权重，范围为**0~65535**。适用于SRV、URI记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Type' => [ + 'description' => '记录的证书类型（CERT记录）或公钥类型（SSHFP记录）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MatchingType' => [ + 'description' => '记录用于匹配或验证证书的算法策略，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Value' => [ + 'description' => '记录值或部分内容。A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI记录中含有该参数。在不同类型的记录中，分别表示不同的含义：'."\n" + ."\n" + .'- **A/AAAA**：IP。多个IP时，用","分隔。至少需要有一个ipv4地址。'."\n" + .'- **CNAME**：指向的目标域名。'."\n" + .'- **NS**：指定域名的名称服务器。'."\n" + .'- **MX**: 有效的目标邮件服务器域名。'."\n" + .'- **TXT**：有效的文本字符串。'."\n" + .'- **CAA**：有效的证书颁发机构域名。'."\n" + .'- **SRV**：有效的目标主机域名。'."\n" + .'- **URI**: 有效的 URI 字符串。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'KeyTag' => [ + 'description' => '记录的公钥标识，范围为**0~65535**。适用于CERT记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Tag' => [ + 'description' => 'CAA记录的Tag表示其具体类型和用途，如issue、issuewild、iodef。', + 'type' => 'string', + 'example' => 'issue', + ], + 'Certificate' => [ + 'description' => '记录的公钥证书信息。适用于CERT、SMIMEA和TLSA记录。', + 'type' => 'string', + 'example' => 'dGVzdGFkYWxrcw==', + ], + 'Selector' => [ + 'description' => '记录所使用的证书或公钥的类型，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'example' => '{"value":"1.1.1.1"}'."\n", + ], + 'BizName' => [ + 'description' => '记录加速时的业务场景，取值：'."\n" + .'- **image_video**：视频图片。'."\n" + .'- **api**：api接口。'."\n" + .'- **web**：web网页。', + 'type' => 'string', + 'example' => 'web', + ], + 'RecordId' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'Ttl' => [ + 'description' => '记录的过期时间，单位秒。当取值为1时，表示记录的过期时间为自动。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + ], + 'description' => '', + ], + ], + 'Failed' => [ + 'description' => '创建失败的记录列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'a.example.com', + ], + 'Proxied' => [ + 'description' => '记录是否开启代理加速。只有CNAME记录与A/AAAA记录可以开启代理加速。取值：'."\n" + ."\n" + .'- **true**：开启代理。'."\n" + .'- **false**：关闭代理加速。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Description' => [ + 'description' => '结果描述。', + 'type' => 'string', + 'example' => '记录的名称非法', + ], + 'RecordType' => [ + 'description' => '记录的DNS类型。如**A/AAAA、CNAME、TXT**等。', + 'type' => 'string', + 'example' => 'A/AAAA', + ], + 'SourceType' => [ + 'description' => 'CNAME记录的源站类型，其他类型记录此字段为空。源站类型取值：'."\n" + .'- **OSS**：OSS源站。'."\n" + .'- **S3**：S3源站。'."\n" + .'- **LB**：负载均衡器源站。'."\n" + .'- **OP**：源地址池源站。'."\n" + .'- **Domain**：普通域名源站。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Data' => [ + 'description' => '记录的DNS信息，包含各种类型的记录值及其相关属性。', + 'type' => 'object', + 'properties' => [ + 'Usage' => [ + 'description' => '记录的用途标识，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Fingerprint' => [ + 'description' => '记录的公钥指纹值。适用于SSHFP记录。', + 'type' => 'string', + 'example' => 'abcdef1234567890', + ], + 'Priority' => [ + 'description' => '记录的优先级，范围为 **0~65535**。数值越小，优先级越高。适用于MX、SRV、URI记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Port' => [ + 'description' => '记录的端口号，与SRV记录关联。仅适用于SRV记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Flag' => [ + 'description' => '记录的标志位。指示其优先级和处理方式，使用于CAA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + 'Algorithm' => [ + 'description' => '记录所采用的加密算法，范围为**0~255**。适用于CERT、SSHFP记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Weight' => [ + 'description' => '记录的权重。适用于SRV、URI记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Type' => [ + 'description' => '记录的证书类型（CERT记录）或公钥类型（SSHFP记录）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MatchingType' => [ + 'description' => '记录用于匹配或验证证书的算法策略，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'RSA', + ], + 'Value' => [ + 'description' => '记录值或部分内容。A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI记录中含有该参数。在不同类型的记录中，分别表示不同的含义：'."\n" + ."\n" + .'- **A/AAAA**：指向的ip地址。多个ip时，用半角逗号,分隔。至少需要有一个ipv4地址。'."\n" + .'- **CNAME**：指向的目标域名。'."\n" + .'- **NS**：指定域名的名称服务器。'."\n" + .'- **MX**: 有效的目标邮件服务器域名。'."\n" + .'- **TXT**：有效的文本字符串。'."\n" + .'- **CAA**：有效的证书颁发机构域名。'."\n" + .'- **SRV**：有效的目标主机域名。'."\n" + .'- **URI**: 有效的 URI 字符串。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'KeyTag' => [ + 'description' => '记录的公钥标识，范围为**0~65535**。适用于CERT记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Tag' => [ + 'description' => 'CAA记录的标签，表示其具体类型和用途，如issue、issuewild、iodef。', + 'type' => 'string', + 'example' => 'issue', + ], + 'Certificate' => [ + 'description' => '记录的公钥证书信息。适用于CERT、SMIMEA和TLSA记录。', + 'type' => 'string', + 'example' => 'dGVzdGFkYWxrcw==', + ], + 'Selector' => [ + 'description' => '记录所使用的证书或公钥的类型，范围为**0~255**。适用于SMIMEA和TLSA记录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'example' => '{"value":"2.2.2.2"}', + ], + 'BizName' => [ + 'description' => '记录加速时的业务场景，取值：'."\n" + .'- **image_video**：视频图片。'."\n" + .'- **api**：api接口。'."\n" + .'- **web**：web网页。', + 'type' => 'string', + 'example' => 'web', + ], + 'RecordId' => [ + 'description' => '创建的记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'Ttl' => [ + 'description' => '记录的过期时间，单位秒。当取值为1时，表示记录的过期时间为自动。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + ], + 'description' => '', + ], + ], + 'TotalCount' => [ + 'description' => '创建操作的记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'QuotaExceed.RecordCount', + 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', + 'description' => '记录数量已达上限，请删除部分记录后重试或升级套餐。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'Record.Conflict', + 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordsExceedLimit', + 'errorMessage' => 'The number of incoming records exceeds the maximum limit.', + 'description' => '传入的记录数量超过了最大数量限制。', + ], + [ + 'errorCode' => 'QuotaExceed.WildcardRecordCount', + 'errorMessage' => 'The number of wildcard records added by your current site has reached the quota limit. Please delete useless wildcard records or upgrade to the plan and try again.', + 'description' => '您当前站点添加的泛记录数量已经达到配额上限，请删除无用的泛记录或者升级到套餐后进行重试。', + ], + [ + 'errorCode' => 'SameNameRecordsExceedLimit', + 'errorMessage' => 'The maximum number of records with the same name added in one batch exceeds 5. Add records with the same name in batches or reduce the number of records with the same name added in one batch.', + 'description' => '您批量添加的最大同名记录数超过了5条，请分批添加同名记录，或者减少批量添加的同名记录数。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidDSRecordName', + 'errorMessage' => 'Please add/import an NS record with the same name before adding this DS record.', + 'description' => '请先添加/导入同名的NS记录，再添加该DS记录。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidBiz', + 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', + 'description' => '业务类型的值为空或传入参数错误。', + ], + [ + 'errorCode' => 'Record.RecordValueContainSourceInBlacklist', + 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', + 'description' => '记录值包含黑名单地址，详情可提交工单咨询。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', + 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', + 'description' => '若添加站点同名记录，请将主机记录命名为@，若添加其他记录，主机记录后缀需要和站点名完全一致。请调整后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordNameExceedLimit', + 'errorMessage' => 'The length of the record name exceeds the maximum limit.', + 'description' => '记录名称不能超过200个字符。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidHostPolicy', + 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', + 'description' => '回源Host的参数错误。', + ], + [ + 'errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', + 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', + 'description' => 'CNAME方式接入的站点仅支持添加A/AAAA、CNAME类型记录。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordCommentExceedLimit', + 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', + 'description' => '记录的备注信息大于50个字符。', + ], + [ + 'errorCode' => 'QuotaExceed.WildCardRecord', + 'errorMessage' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', + 'description' => '泛域名记录的数量超限，请联系销售增加额度。', + ], + [ + 'errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', + 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', + 'description' => '创建或编辑A/AAAA记录时，记录值包含了无效IP。', + ], + [ + 'errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', + 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', + 'description' => '创建或编辑A/AAAA记录时，IP数量超限，一个主机记录仅支持8个IPv4和4个IPv6 IP，请调整后重试。', + ], + [ + 'errorCode' => 'Record.CAARecordFlagExceedLimit', + 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CAA记录的flag参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CAARecordTagExceedLimit', + 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', + 'description' => '创建或编辑CAA记录信息时，Tag值传入了issue、issuewild、iodef以外的非法字符。', + ], + [ + 'errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', + 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录的algorithm参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CERTRecordKeyTagExceedLimit', + 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录的keyTag参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CERTRecordTypeExceedLimit', + 'errorMessage' => 'The CERT record type is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录type参数超出了范围。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedIPASource', + 'errorMessage' => 'The CNAME record cannot be the origin of the added Layer 4 application. Check the values of other Layer 4 proxy records and try again.', + 'description' => 'CNAME记录不能是已经添加的四层应用的源站，请检查其他四层代理记录的记录值并重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', + 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', + 'description' => 'CNAME记录不能是已经添加的源地址池的源站，请检查后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedRecordSource', + 'errorMessage' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.', + 'description' => 'CNAME记录不能是已经添加的记录的源站，请检查其他记录的记录值并重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedIPARecord', + 'errorMessage' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.', + 'description' => 'CNAME记录的记录值不能与其他已经存在的四层代理记录名完全相同。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', + 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', + 'description' => 'CNAME记录的记录值不能与其他已经存在的CNAME记录名完全相同。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', + 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', + 'description' => 'CNAME记录的记录值不能和主机记录完全一样，请调整后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueExceedLimit', + 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', + 'description' => '记录值不能超过253个字符，请删减后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueInvalidDomainUnderline', + 'errorMessage' => 'Record values (DNS-only records) generally start with an underscore, a lowercase letter a-z, and the numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.', + 'description' => '记录值（仅DNS的记录）一般需以下划线 _、小写字母 a-z 、数字 0-9开头。记录中间部分可用小写字母、数字或连字符 -，长度在 0 到 61 个字符之间。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueInvalidRecordDomain', + 'errorMessage' => 'Record values (records with agent acceleration enabled) must start with a lowercase letter a-z and numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.', + 'description' => '记录值（开启代理加速的记录）一般需以小写字母 a-z 、数字 0-9开头。记录中间部分可用小写字母、数字或连字符 -，长度在 0 到 61 个字符之间。', + ], + [ + 'errorCode' => 'Record.EmptyRecordValue', + 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', + 'description' => '记录值为空，请正确填写后重试。', + ], + [ + 'errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', + 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', + 'description' => '创建或编辑CERT记录信息时，CERT记录的证书值不是base64编码后的值。', + ], + [ + 'errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', + 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', + 'description' => '创建或编辑SSHFP记录信息时，指纹fingerprint值不是16进制编码的。', + ], + [ + 'errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', + 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', + 'description' => '创建或编辑CAA记录信息时，CAA记录的标签Tag，只能是分号或分号分隔的合法域名。', + ], + [ + 'errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', + 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以mailto:为前缀时，后面必须接一个合法的email地址。', + ], + [ + 'errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', + 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', + 'description' => '创建或编辑SMIMEA记录信息时，SMIMEA记录的证书值不是base64编码后的值。', + ], + [ + 'errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', + 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', + 'description' => '创建或编辑TLSA记录信息时，传入的证书值不是16进制编码的。', + ], + [ + 'errorCode' => 'Record.InvalidURLWithURIRecord', + 'errorMessage' => 'The URI record value must be a valid URL address.', + 'description' => '创建或编辑URI记录信息时，记录值必须是一个合法的URL地址。', + ], + [ + 'errorCode' => 'Record.NoRecordNameConflictWithNSRecord', + 'errorMessage' => 'No record name can conflict with an NS record name.', + 'description' => '任何记录名不能和NS记录名冲突。', + ], + [ + 'errorCode' => 'Record.NSRecordCannotEqualSiteName', + 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', + 'description' => '不允许添加和站点名称完全同名的NS记录。', + ], + [ + 'errorCode' => 'Record.OSSSourceInvalidAuthType', + 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', + 'description' => '记录的OSS源站鉴权类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.ParseJSONRecordValueFailed', + 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', + 'description' => '记录值的JSON格式不正确，请调整后重试。', + ], + [ + 'errorCode' => 'Record.PoolSourceNotExistPool', + 'errorMessage' => 'If the source station type of the record is source address pool, the input source address pool does not exist.', + 'description' => '记录的源站类型为源地址池的情况下，输入的源地址池不存在。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', + 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', + 'description' => 'A/AAAA、CNAME记录之间不能重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithIPAName', + 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能和四层代理记录重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithLBName', + 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能与负载均衡记录重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithNSRecord', + 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', + 'description' => '创建或编辑DNS记录信息时，NS记录名不能和任何其他类型记录名重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithPoolName', + 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能和源地址池记录名重名。', + ], + [ + 'errorCode' => 'Record.RecordNameInBlacklist', + 'errorMessage' => 'The record name is in blacklist.', + 'description' => '记录名在黑名单中，无法添加。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthRegion', + 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', + 'description' => '记录的S3源站所属区域不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthType', + 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', + 'description' => '记录的S3源站鉴权类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthVersion', + 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', + 'description' => '记录的S3源站的鉴权签名算法版本不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.SourceAccessKeyExceedLimit', + 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', + 'description' => '记录源站的 AccessKey 参数值的字符长度超出了范围。', + ], + [ + 'errorCode' => 'Record.SourceEmptyAK', + 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', + 'description' => '记录的源站所属账号的 AccessKey 为空。', + ], + [ + 'errorCode' => 'Record.SourceEmptyAuthConf', + 'errorMessage' => 'The authentication information of the origin station is empty.', + 'description' => '记录的源站的鉴权信息为空。', + ], + [ + 'errorCode' => 'Record.SourceEmptySecretKey', + 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', + 'description' => '记录的源站所属账号的 SecretKey 为空。', + ], + [ + 'errorCode' => 'Record.SourceSecretKeyExceedLimit', + 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', + 'description' => '记录源站的 SecretKey 参数值的字符长度超出了范围。', + ], + [ + 'errorCode' => 'Record.SRVRecordInvalidRecordName', + 'errorMessage' => 'SRV host record name is not valid. The SRV host record name must begin with an underscore (-) followed by a lowercase letter (a-z), a number (0-9), and a hyphen (-), followed by 1 arbitrary character, followed by an underscore (-) and a lowercase letter, number, or hyphen.', + 'description' => 'SRV主机记录名称不合法。SRV主机记录名称必须以下划线（-）开头，后跟小写字母（a-z）、数字（0-9）、连字符（-），后接1个任意字符，再跟1个下划线（-）和小写字母、数字或连字符。', + ], + [ + 'errorCode' => 'Record.SRVRecordPortExceedLimit', + 'errorMessage' => 'The SRV record port is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的SRV记录端口超出了范围。', + ], + [ + 'errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', + 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', + 'description' => '创建或编辑DNS记录信息时，SSHFP记录的algorithm参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.TTLExceedLimit', + 'errorMessage' => 'The TTL parameter value for a record is out of range.', + 'description' => '创建或编辑DNS记录信息时，记录的TTL参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.TXTRecordValueExceedLimit', + 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', + 'description' => '创建或编辑DNS记录信息时，TXT记录值不能超过450个字符。', + ], + [ + 'errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', + 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', + 'description' => '创建或编辑DNS记录信息时，SSHFP记录Type参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', + 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', + 'description' => '主机记录名称非法。主机记录内不能包含连续的点号。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', + 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', + 'description' => '主机记录名称非法，SRV记录名称禁止使用星号。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidATChar', + 'errorMessage' => 'Illegal host record name. The at symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.', + 'description' => '主机记录名称非法。@符号只能出现在主机记录的首位，且后面只能跟.符号，不允许接其他字符串。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', + 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', + 'description' => '主机记录名称非法。主机记录值不能以点号、中划线开头或结尾。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidStartSymbol', + 'errorMessage' => 'Illegal host record name. The asterisk is only allowed in the first place of the host record, and only the following dot is allowed after the asterisk.', + 'description' => '主机记录名称非法。星号只允许在主机记录首位，并且星号后面只允许跟点。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', + 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', + 'description' => '主机记录名称非法。用\'.\'号分隔的每段字符数量不能超过63个。', + ], + [ + 'errorCode' => 'Record.UnsupportedSourceType', + 'errorMessage' => 'The recorded source station type is not in the supported range.', + 'description' => '记录的源站类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.UnsupportedType', + 'errorMessage' => 'The record type parameter is unsupported.', + 'description' => '记录类型错误，请检查记录类型参数。', + ], + [ + 'errorCode' => 'Record.ValidProxiedForSpecifedRecordType', + 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', + 'description' => '创建或编辑记录时，代理状态开启了代理加速，仅A/AAAA、CNAME类型支持开启代理加速。', + ], + [ + 'errorCode' => 'Record.RecordUsageExceedLimit', + 'errorMessage' => 'The usage parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的usage参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordSelectorExceedLimit', + 'errorMessage' => 'The selector parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的selector参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordMatchingTypeExceedLimit', + 'errorMessage' => 'The matchingType parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的matchingType参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordPriorityExceedLimit', + 'errorMessage' => 'The record priority parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的记录优先级参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordWeightExceedLimit', + 'errorMessage' => 'The record weight parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的记录权重参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithSameRecordType', + 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', + 'description' => '记录冲突，存在记录值相同的同名主机记录。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidUnderLine', + 'errorMessage' => 'The host record name contains an illegal underscore. The underscore is only supported at the beginning of the TXT, CNAME, MX, SRV, and NS records. Proxy acceleration cannot be enabled, and records can only be added in the DNS mode.', + 'description' => '主机记录名称包含了非法下划线。下划线仅可在TXT、CNAME、MX、SRV、NS的记录中的开头处支持，且不能开启代理加速，仅能以DNS方式添加记录。', + ], + [ + 'errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', + 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', + 'description' => '以CNAME方式接入的站点，提交了未开启加速的记录。', + ], + [ + 'errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', + 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', + 'description' => '创建或编辑CAA记录信息时，Tag值不能以mailto: http://或者mailto: https:// 开头。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameOnlyContainSymbol', + 'errorMessage' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.', + 'description' => '主机记录值不能以各类符号单独存在，可加入任何小写字母或数字。'."\n", + ], + [ + 'errorCode' => 'Record.WildcardConflictForSpecifiedRecordType', + 'errorMessage' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.', + 'description' => 'A/AAAA,CNAME记录不能同时添加all和星号前缀的记录。', + ], + [ + 'errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', + 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以http://或https://为前缀时，后面必须接一个合法的URL地址。'."\n", + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameOnlyRangeChars', + 'errorMessage' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, some special characters are supported as valid characters in host records.', + 'description' => '主机记录字符非法。主机记录值合法字符仅支持小写字母a-z、大写字母A-Z、数字0-9、\'-\' 、\'_\' 、\'.\'、\'*\'、\'@\'。'."\n", + ], + ], + ], + 'title' => '批量创建解析记录', + 'summary' => '批量添加DNS解析记录，支持多种记录类型。', + 'description' => '该API允许用户一次性创建或更新多个DNS记录条目，适用于需要管理大量DNS配置的场景。支持的记录类型包括但不限于A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI等，并提供了详细的配置项以满足特定需求，如优先级(Priority)、标志位(Flag)、标签(Tag)、权重(Weight)等。此外，对于特定类型的记录，如CERT、SSHFP、SMIMEA和TLSA，还支持证书信息、加密算法等高级设置。'."\n" + ."\n" + .'成功与失败的记录操作将在响应中分别列出，以便于用户了解哪些记录处理成功，哪些记录处理失败及其原因。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-10T08:19:05.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-02-18T05:59:13.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-11-12T05:57:29.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2024-10-11T06:13:39.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-24T08:28:18.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:42.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchCreateRecords', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:BatchCreateRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2430E05E-1340-5773-B5E1-B743929F46F2\\",\\n \\"RecordResultList\\": {\\n \\"Success\\": [\\n {\\n \\"RecordName\\": \\"www.example.com\\",\\n \\"Proxied\\": true,\\n \\"Description\\": \\"success\\",\\n \\"RecordType\\": \\"A/AAAA\\",\\n \\"SourceType\\": \\"OSS\\",\\n \\"Data\\": {\\n \\"Usage\\": 0,\\n \\"Fingerprint\\": \\"abcdef1234567890\\",\\n \\"Priority\\": 10,\\n \\"Port\\": 0,\\n \\"Flag\\": 128,\\n \\"Algorithm\\": 0,\\n \\"Weight\\": 0,\\n \\"Type\\": 0,\\n \\"MatchingType\\": 0,\\n \\"Value\\": \\"example.com\\",\\n \\"KeyTag\\": 0,\\n \\"Tag\\": \\"issue\\",\\n \\"Certificate\\": \\"dGVzdGFkYWxrcw==\\",\\n \\"Selector\\": 0\\n },\\n \\"BizName\\": \\"web\\",\\n \\"RecordId\\": 1234567890123,\\n \\"Ttl\\": 60\\n }\\n ],\\n \\"Failed\\": [\\n {\\n \\"RecordName\\": \\"a.example.com\\",\\n \\"Proxied\\": true,\\n \\"Description\\": \\"记录的名称非法\\",\\n \\"RecordType\\": \\"A/AAAA\\",\\n \\"SourceType\\": \\"OSS\\",\\n \\"Data\\": {\\n \\"Usage\\": 0,\\n \\"Fingerprint\\": \\"abcdef1234567890\\",\\n \\"Priority\\": 10,\\n \\"Port\\": 0,\\n \\"Flag\\": 128,\\n \\"Algorithm\\": 0,\\n \\"Weight\\": 0,\\n \\"Type\\": 0,\\n \\"MatchingType\\": 0,\\n \\"Value\\": \\"example.com\\",\\n \\"KeyTag\\": 0,\\n \\"Tag\\": \\"issue\\",\\n \\"Certificate\\": \\"dGVzdGFkYWxrcw==\\",\\n \\"Selector\\": 0\\n },\\n \\"BizName\\": \\"web\\",\\n \\"RecordId\\": 1234567890123,\\n \\"Ttl\\": 60\\n }\\n ],\\n \\"TotalCount\\": 20\\n }\\n}","type":"json"}]', + ], + 'BatchCreateWafRules' => [ + 'summary' => '该接口用于在指定的WAF运行阶段中批量创建规则。通过此接口，用户可以一次性创建多个规则，并为这些规则配置共享的设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239658', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'formData', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF规则类型，取值：'."\n" + ."\n" + .'- **http_anti_scan**：扫描防护。'."\n" + .'- **http_bot**：Bots。', + 'type' => 'string', + 'required' => false, + 'example' => 'http_anti_scan', + ], + ], + [ + 'name' => 'RulesetId', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000001', + 'minimum' => '1', + ], + ], + [ + 'name' => 'Shared', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '多规则共享配置', + 'description' => '多规则共享配置，指定多个规则的共有属性。', + 'required' => false, + '$ref' => '#/components/schemas/WafBatchRuleShared', + ], + ], + [ + 'name' => 'Configs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '各规则配置列表', + 'description' => '各规则配置列表，指定每个规则的详细配置。', + 'type' => 'array', + 'items' => [ + 'description' => '规则配置。', + 'required' => false, + '$ref' => '#/components/schemas/WafRuleConfig', + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'RulesetId' => [ + 'description' => 'WAF规则集的ID，可通过调用[ListWafRulesets](~~2878359~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'Ids' => [ + 'description' => 'WAF规则的ID，可通过调用[ListWafRules](~~2878257~~)接口获取。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则的ID，可通过调用[ListWafRules](~~2878257~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000001', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Rule.Config.Malformed', + 'errorMessage' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', + 'description' => '指定的规则配置格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致，并予以纠正，以符合预期的配置架构。', + ], + [ + 'errorCode' => 'Rule.Config.Noncompliance', + 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', + 'description' => '指定的规则配置未满足既定的合规性标准。请检查规则设置，查找任何不符合或违反预期标准的差异，并进行必要的调整，以确保所有规则均得到正确验证。', + ], + [ + 'errorCode' => 'Ruleset.Name.AlreadyExists', + 'errorMessage' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.', + 'description' => '指定的规则集名称在系统的规则管理架构中已存在。请选择一个独一无二的替代名称，以避免重复和与现有规则集潜在的冲突。如果是对现有规则集进行重命名，请确保新名称是独特的，并且不侵犯其他已建立规则集的标识符。', + ], + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + [ + 'errorCode' => 'Expression.Invalid', + 'errorMessage' => 'The specified expression is invalid: %s.', + 'description' => '指定的表达式是无效的。', + ], + [ + 'errorCode' => 'Ruleset.NotExist', + 'errorMessage' => 'The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system\'s rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect.', + 'description' => '指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确，并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体，请确保其创建和注册的必要步骤已经成功执行，以便其可用。', + ], + ], + ], + 'title' => '批量创建WAF规则', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-17T07:08:14.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:52.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:38.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchCreateWafRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:BatchCreateWafRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"RulesetId\\": 10000001,\\n \\"Ids\\": [\\n 20000001\\n ]\\n}","type":"json"}]', + ], + 'BatchDeleteKv' => [ + 'summary' => '根据指定的键名列表来批量删除指定KV存储空间的键值对。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239149', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'Keys', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '要批量删除的键名称列表， 最多删除10000个键。', + 'type' => 'array', + 'items' => [ + 'description' => '要删除的键名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_key1', + ], + 'required' => true, + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'FailKeys' => [ + 'description' => '删除失败的键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '删除失败的键名。', + 'type' => 'string', + 'example' => 'test_key1', + ], + ], + 'SuccessKeys' => [ + 'description' => '删除成功的键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '删除成功的键名。', + 'type' => 'string', + 'example' => 'test_key2', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '批量删除KV存储空间的键值对', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-20T13:49:27.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchDeleteKv', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:BatchDeleteKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"FailKeys\\": [\\n \\"test_key1\\"\\n ],\\n \\"SuccessKeys\\": [\\n \\"test_key2\\"\\n ]\\n}","type":"json"}]', + ], + 'BatchDeleteKvWithHighCapacity' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239122', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '存储有需要批量删除键值对的下载链接，此参数由调用SDK时自动生成，请使用SDK进行调用。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', + 'isFileTransferUrl' => true, + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'FailKeys' => [ + 'description' => '删除失败的键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '删除失败的键名。', + 'type' => 'string', + 'example' => 'test_key1', + ], + ], + 'SuccessKeys' => [ + 'description' => '删除成功的键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '删除成功的键名。', + 'type' => 'string', + 'example' => 'test_key1', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '批量删除KV存储空间的大容量的键值对', + 'summary' => '根据指定的键名列表批量删除指定KV存储空间下的键值对，最大允许上传100M的请求体。', + 'description' => '本接口与[BatchDeleteKv](~~2850204~~)的功能一样，只是允许上传更大请求体。当请求体较小时推荐直接使用[BatchDeleteKv](~~2850204~~)接口，从而减少服务端处理时间。本接口需要使用SDK进行调用。以golang SDK为例，需要使用BatchDeleteKvWithHighCapacityAdvance函数进行调用。'."\n" + .'```'."\n" + .'func TestBatchDeleteWithHighCapacity() error {'."\n" + .' // 配置初始化'."\n" + .' cfg := new(openapi.Config)'."\n" + .' cfg.SetAccessKeyId("xxxxxxxxx")'."\n" + .' cfg.SetAccessKeySecret("xxxxxxxxxx")'."\n" + .' cli, err := NewClient(cfg)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + .' runtime := &util.RuntimeOptions{}'."\n" + ."\n" + .' // 构造待批量删除的键值对请求'."\n" + .' namespace := "test_batch_put"'."\n" + .' rawReq := BatchDeleteKvRequest{'."\n" + .' Namespace: &namespace,'."\n" + .' }'."\n" + .' for i := 0; i < 10000; i++ {'."\n" + .' key := fmt.Sprintf("test_key_%d", i)'."\n" + .' rawReq.Keys = append(rawReq.Keys, &key)'."\n" + .' }'."\n" + .' payload, err := json.Marshal(rawReq)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + ."\n" + .' // 如果payload大于2M，则调用大容量接口进行删除'."\n" + .' reqHighCapacity := BatchDeleteKvWithHighCapacityAdvanceRequest{'."\n" + .' Namespace: &namespace,'."\n" + .' UrlObject: bytes.NewReader(payload),'."\n" + .' }'."\n" + .' resp, err := cli.BatchDeleteKvWithHighCapacityAdvance(&reqHighCapacity, runtime)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + .' return nil'."\n" + .'}', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-20T13:49:26.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchDeleteKvWithHighCapacity', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:BatchDeleteKvWithHighCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"FailKeys\\": [\\n \\"test_key1\\"\\n ],\\n \\"SuccessKeys\\": [\\n \\"test_key1\\"\\n ]\\n}","type":"json"}]', + ], + 'BatchGetExpressionFields' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239608', + 'abilityTreeNodes' => [ + 'FEATUREdcdnWQK30N', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'PlanNameEn', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Kind', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'formData', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF阶段', + 'type' => 'string', + 'required' => false, + 'example' => 'http_bot', + ], + ], + [ + 'name' => 'Expressions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '表达式的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表达式的详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '表达式的序号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Expression' => [ + 'description' => '表达式的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'ip.src eq 1.1.1.1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'http_bot', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Fields' => [ + 'description' => '匹配域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '匹配域详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '表达式的ID，与传入参数中的ID对应。', + 'type' => 'string', + 'example' => '1', + ], + 'Fields' => [ + 'description' => '单个表达式的匹配域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个表达式的匹配域值。', + 'type' => 'string', + 'example' => 'ip.src', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Expression.Invalid', + 'errorMessage' => 'Expression syntax error or data type mismatched.', + 'description' => '表达式语法错误或数据类型不匹配，请您检查表格式。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '批量获取表达式的匹配域', + 'summary' => '该接口用于批量获取表达式的匹配项。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:48.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:41.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchGetExpressionFields', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:BatchGetExpressionFields', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Fields\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Fields\\": [\\n \\"ip.src\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'BatchPutKv' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239368', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'KvList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '需要批量设置的键值对列表，总大小最大2MB(2\\*1000\\*1000)。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '需要设置的键名称，最长不超过512个字符，不能包含空格、反斜杠（/）。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_key', + ], + 'Value' => [ + 'description' => '键的内容。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_value', + ], + 'Expiration' => [ + 'description' => '过期时间（秒级时间戳，不能小于当前时间），同时设置Expiration和ExpirationTtl时，以ExpirationTtl为准。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1690081381', + ], + 'ExpirationTtl' => [ + 'description' => '过期时间（相对时间，单位：秒），同时设置Expiration和ExpirationTtl时，以ExpirationTtl为准。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + 'required' => true, + 'description' => '', + ], + 'required' => true, + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'FailKeys' => [ + 'description' => '写失败的键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '写失败的键名。', + 'type' => 'string', + 'example' => 'test_key1', + ], + ], + 'SuccessKeys' => [ + 'description' => '写成功的键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '写成功的键名。', + 'type' => 'string', + 'example' => 'test_key2', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '批量设置KV存储空间的键值对', + 'summary' => '根据指定的键名列表来批量设置指定KV存储空间的键值对。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-20T13:49:26.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchPutKv', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:BatchPutKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"FailKeys\\": [\\n \\"test_key1\\"\\n ],\\n \\"SuccessKeys\\": [\\n \\"test_key2\\"\\n ]\\n}","type":"json"}]', + ], + 'BatchPutKvWithHighCapacity' => [ + 'summary' => '根据指定的键名列表来批量设置指定KV存储空间的键值对，请求体最大支持100M。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239294', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '存储有需要批量设置的键值对的下载链接，此参数由调用SDK时自动生成，请使用SDK进行调用。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', + 'isFileTransferUrl' => true, + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'FailKeys' => [ + 'description' => '写失败的键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '写失败的键名。', + 'type' => 'string', + 'example' => 'test_key1', + ], + ], + 'SuccessKeys' => [ + 'description' => '写成功的键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '写成功的键名。', + 'type' => 'string', + 'example' => 'test_key2', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '批量设置KV存储空间的大容量键值对', + 'description' => '本接口与[BatchPutKv](~~2850203~~)的功能一样，只是允许上传更大请求体。当请求体较小时推荐直接使用[BatchPutKv](~~2850203~~)接口，从而减少服务端处理时间。本接口需要使用SDK进行调用。以golang SDK为例，需要使用BatchPutKvWithHighCapacityAdvance函数进行调用。'."\n" + .'```'."\n" + .'func TestBatchPutKvWithHighCapacity() error {'."\n" + .' // 配置初始化'."\n" + .' cfg := new(openapi.Config)'."\n" + .' cfg.SetAccessKeyId("xxxxxxxxx")'."\n" + .' cfg.SetAccessKeySecret("xxxxxxxxxx")'."\n" + .' cli, err := NewClient(cfg)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + .' runtime := &util.RuntimeOptions{}'."\n" + ."\n" + .' // 构造待批量上传的键值对请求'."\n" + .' namespace := "test_batch_put"'."\n" + .' numKv := 10000'."\n" + .' kvList := make([]*BatchPutKvRequestKvList, numKv)'."\n" + .' test_value := strings.Repeat("a", 10*1024)'."\n" + .' for i := 0; i < numKv; i++ {'."\n" + .' key := fmt.Sprintf("test_key_%d", i)'."\n" + .' value := test_value'."\n" + .' kvList[i] = &BatchPutKvRequestKvList{'."\n" + .' Key: &key,'."\n" + .' Value: &value,'."\n" + .' }'."\n" + .' }'."\n" + .' rawReq := BatchPutKvRequest{'."\n" + .' Namespace: &namespace,'."\n" + .' KvList: kvList,'."\n" + .' }'."\n" + ."\n" + .' payload, err := json.Marshal(rawReq)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + ."\n" + .' // 如果payload大于2M，则调用大容量接口进行上传'."\n" + .' reqHighCapacity := BatchPutKvWithHighCapacityAdvanceRequest{'."\n" + .' Namespace: &namespace,'."\n" + .' UrlObject: bytes.NewReader(payload),'."\n" + .' }'."\n" + .' resp, err := cli.BatchPutKvWithHighCapacityAdvance(&reqHighCapacity, runtime)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + .' return nil'."\n" + .'}', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-20T13:49:26.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchPutKvWithHighCapacity', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:BatchPutKvWithHighCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"FailKeys\\": [\\n \\"test_key1\\"\\n ],\\n \\"SuccessKeys\\": [\\n \\"test_key2\\"\\n ]\\n}","type":"json"}]', + ], + 'BatchUpdateWafRules' => [ + 'summary' => '该接口用于在指定的WAF规则集中批量修改规则。通过此接口，用户可以同时更新多个规则的配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239643', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'formData', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF规则类型。取值：'."\n" + ."\n" + .'- http_anti_scan：扫描防护'."\n" + .'- http_bot：Bots', + 'type' => 'string', + 'required' => false, + 'example' => 'http_anti_scan', + ], + ], + [ + 'name' => 'RulesetId', + 'in' => 'formData', + 'schema' => [ + 'title' => '规则集ID', + 'description' => 'WAF规则集的ID，可通过调用[ListWafRulesets](~~2878359~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000001', + ], + ], + [ + 'name' => 'Shared', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '多规则共享配置', + 'description' => '多规则共享配置，指定多个规则的共有属性。', + 'required' => false, + '$ref' => '#/components/schemas/WafBatchRuleShared', + ], + ], + [ + 'name' => 'Configs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '规则配置列表', + 'description' => '规则配置列表，指定每个规则的详细配置。', + 'type' => 'array', + 'items' => [ + 'title' => '规则配置', + 'description' => '规则配置。', + 'required' => false, + '$ref' => '#/components/schemas/WafRuleConfig', + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Rule.Config.Malformed', + 'errorMessage' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', + 'description' => '指定的规则配置格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致，并予以纠正，以符合预期的配置架构。', + ], + [ + 'errorCode' => 'Rule.Config.Noncompliance', + 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', + 'description' => '指定的规则配置未满足既定的合规性标准。请检查规则设置，查找任何不符合或违反预期标准的差异，并进行必要的调整，以确保所有规则均得到正确验证。', + ], + [ + 'errorCode' => 'Ruleset.Name.AlreadyExists', + 'errorMessage' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.', + 'description' => '指定的规则集名称在系统的规则管理架构中已存在。请选择一个独一无二的替代名称，以避免重复和与现有规则集潜在的冲突。如果是对现有规则集进行重命名，请确保新名称是独特的，并且不侵犯其他已建立规则集的标识符。', + ], + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + [ + 'errorCode' => 'Ruleset.NotExist', + 'errorMessage' => 'The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system\'s rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect.', + 'description' => '指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确，并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体，请确保其创建和注册的必要步骤已经成功执行，以便其可用。', + ], + [ + 'errorCode' => 'Expression.Invalid', + 'errorMessage' => 'The specified expression is invalid: %s.', + 'description' => '指定的表达式是无效的。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '批量修改WAF规则', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-17T07:08:14.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:52.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-23T06:19:49.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:37.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchUpdateWafRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:BatchUpdateWafRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'BlockObject' => [ + 'summary' => '对指定URL禁止访问。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238896', + 'abilityTreeNodes' => [ + 'FEATUREdcdnSU2QP6', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '类型，取值：'."\n" + ."\n" + .'- **block**：封禁。'."\n" + .'- **unblock**：解封。', + 'type' => 'string', + 'required' => true, + 'example' => 'block', + 'enum' => [ + 'block', + 'unblock', + ], + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '封禁内容。', + 'type' => 'array', + 'items' => [ + 'description' => 'URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.com/1.jpg', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Maxage', + 'in' => 'query', + 'schema' => [ + 'description' => '拦截生效时间（单位为秒，当类型为封禁时指定）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '864000', + 'minimum' => '600', + 'example' => '864000', + ], + ], + [ + 'name' => 'Extension', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '延长封禁时长，取值为2year（封禁时长为两年）。', + 'type' => 'string', + 'required' => false, + 'example' => '2year', + 'enum' => [ + '2year', + ], + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'TaskId' => [ + 'description' => '任务ID，当您创建封禁任务时，会返回任务ID。', + 'type' => 'string', + 'example' => '15940956620', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidStationParameter', + 'errorMessage' => 'The specified Station is invalid.', + 'description' => '指定的节点参数无效。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified taskId is invalid.', + 'description' => '指定的任务ID无效。', + ], + [ + 'errorCode' => 'InvalidParameters.InvalidUrls', + 'errorMessage' => 'The specified urls are invalid.', + 'description' => '请求的URL参数无效。', + ], + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The specified parameters are invalid.', + 'description' => '参数非法。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordNotBelongToSite', + 'errorMessage' => 'The record name passed in does not belong to the current site.', + 'description' => '传入的记录名不属于当前站点。', + ], + ], + ], + 'title' => 'URL封禁', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-13T07:58:30.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-24T06:04:31.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BlockObject', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:BlockObject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"TaskId\\": \\"15940956620\\"\\n}","type":"json"}]', + ], + 'CheckSiteName' => [ + 'summary' => '预校验一个站点名称是否可用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239613', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SiteName', + 'in' => 'query', + 'schema' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'Passed' => [ + 'description' => '校验是否通过。'."\n" + ."\n" + .'- **true**：通过。'."\n" + .'- **false**：不通过。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Messeage' => [ + 'description' => '校验信息。', + 'type' => 'string', + 'example' => '站点名称可用。', + ], + 'Description' => [ + 'description' => '校验结果的描述。取值：'."\n" + ."\n" + .'- **success**：成功。'."\n" + .'- **Site.AlreadyExist**: 该用户已添加过此站点。'."\n" + .'- **Site.InvalidName**：非法的站点名称。'."\n" + .'- **Site.SubSiteUnavailable**：子站点不可用。'."\n" + .'- **Site.InternalError**：其他错误。', + 'type' => 'string', + 'example' => 'success', + ], + 'IsSubSite' => [ + 'description' => '是否是一个子站点。取值：'."\n" + ."\n" + .'- **true**：是子站点。'."\n" + .'- **false**：不是子站点。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '校验站点名称是否可用', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T08:22:14.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CheckSiteName', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CheckSiteName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"Passed\\": true,\\n \\"Messeage\\": \\"站点名称可用。\\",\\n \\"Description\\": \\"success\\",\\n \\"IsSubSite\\": false\\n}","type":"json"}]', + ], + 'CheckSiteProjectName' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239055', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '实时日志项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'user_log', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可以通过调用[ListSites](~~2850189~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12312312213212', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + 'Check' => [ + 'description' => '取值：'."\n" + ."\n" + .'- **true**：可添加。'."\n" + .'- **false**：不可添加。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProjectName' => [ + 'description' => '实时日志项目名称。', + 'type' => 'string', + 'example' => 'dcdn_waf_userAccount_log', + ], + 'Description' => [ + 'description' => '结果描述。', + 'type' => 'string', + 'example' => 'project name pass the check', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RealtimeLogProjectExistError', + 'errorMessage' => 'Realtime-log project name already exist.', + 'description' => '实时日志项目名已存在', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '实时日志任务投递名检查', + 'summary' => '检查实时日志任务项目名称。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CheckSiteProjectName', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CheckSiteProjectName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"Check\\": true,\\n \\"ProjectName\\": \\"dcdn_waf_userAccount_log\\",\\n \\"Description\\": \\"project name pass the check\\"\\n}","type":"json"}]', + ], + 'CheckUserProjectName' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238730', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递的日志项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ali-dcdn-log-56', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '该条任务请求Id。', + 'type' => 'string', + 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + 'Check' => [ + 'description' => '检查结果。描述：'."\n" + ."\n" + .'- **true**：可添加。'."\n" + .'- **false**：不可添加。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProjectName' => [ + 'description' => '实时投递的日志项目名称。', + 'type' => 'string', + 'example' => 'ali-dcdn-log-56', + ], + 'Description' => [ + 'description' => '通过/失败的原因', + 'type' => 'string', + 'example' => 'project name pass the check', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RealtimeLogProjectExistError', + 'errorMessage' => 'Realtime-log project name already exist.', + 'description' => '实时日志项目名已存在', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '检查实时日志用户投递项目名', + 'summary' => '实时日志用户任务投递名检查。', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-18T01:07:11.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CheckUserProjectName', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CheckUserProjectName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"Check\\": true,\\n \\"ProjectName\\": \\"ali-dcdn-log-56\\",\\n \\"Description\\": \\"project name pass the check\\"\\n}","type":"json"}]', + ], + 'CommitRoutineStagingCode' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239216', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'CodeDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '代码版本描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'description of this code ver', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'CodeVersion' => [ + 'description' => '新生成的代码版本号。', + 'type' => 'string', + 'example' => '1710120201067203242', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'CodeVersionNumberExceedQuotaLimit', + 'errorMessage' => 'The maximum number of code versions in your plan has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'description' => '您的代码版本数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多的代码版本配额数量。', + ], + [ + 'errorCode' => 'ParameterNotExist', + 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', + 'description' => '输入参数不存在，请您核对后重试。', + ], + [ + 'errorCode' => 'DependedByOthers', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'errorCode' => 'UserOperationStatusIsLocked', + 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', + 'description' => '您正在调用其他操作函数相关的接口，请等待其他接口调用完成后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '提交边缘函数测试版本代码', + 'summary' => '提交边缘函数Routine的测试版本（unstable）代码，生成正式版本。', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-04T05:48:48.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-11-05T06:54:07.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CommitRoutineStagingCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"CodeVersion\\": \\"1710120201067203242\\"\\n}","type":"json"}]', + ], + 'CreateCacheRule' => [ + 'summary' => '新增站点缓存配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257996', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '340035003106221', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + ], + [ + 'name' => 'BypassCache', + 'in' => 'query', + 'schema' => [ + 'description' => '设置绕过缓存模式。取值范围：'."\n" + .'- cache_all：所有请求都缓存。'."\n" + .'- bypass_all：所有请求都绕过缓存。', + 'type' => 'string', + 'required' => false, + 'example' => 'cache_all', + ], + ], + [ + 'name' => 'BrowserCacheMode', + 'in' => 'query', + 'schema' => [ + 'description' => '浏览器缓存模式。取值范围：'."\n" + .'- no_cache：不缓存。'."\n" + .'- follow_origin：遵循源站缓存策略。'."\n" + .'- override_origin：代替源站缓存策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'follow_origin', + ], + ], + [ + 'name' => 'BrowserCacheTtl', + 'in' => 'query', + 'schema' => [ + 'description' => '浏览器缓存过期时间，单位是秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'EdgeCacheMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点缓存模式。取值范围：'."\n" + .'- follow_origin：遵循源站缓存策略（如果存在），否则使用默认缓存策略。'."\n" + .'- no_cache：不缓存。'."\n" + .'- override_origin：代替源站缓存策略。'."\n" + .'- follow_origin_bypass：遵循源站缓存策略（如果存在），否则不缓存。'."\n" + .'- follow_origin_override：遵循源站缓存策略（如果存在），否则使用自定义缓存TTL。', + 'type' => 'string', + 'required' => false, + 'example' => 'follow_origin', + ], + ], + [ + 'name' => 'EdgeCacheTtl', + 'in' => 'query', + 'schema' => [ + 'description' => '节点缓存过期时间，单位是秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'EdgeStatusCodeCacheTtl', + 'in' => 'query', + 'schema' => [ + 'description' => '状态码缓存过期时间，单位是秒。'."\n" + .'- 支持对指定状态码设置缓存过期时间，例如：404=10，表示对404状态码缓存10秒。'."\n" + .'- 支持对4xx、5xx系列状态码设置缓存过期时间，例如：4xx=10，表示对400系列的所有状态码都缓存10秒。', + 'type' => 'string', + 'required' => false, + 'example' => '4xx=10', + ], + ], + [ + 'name' => 'SortQueryStringForCache', + 'in' => 'query', + 'schema' => [ + 'description' => '查询字符串排序，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'QueryStringMode', + 'in' => 'query', + 'schema' => [ + 'description' => '在生成缓存键的时候，对查询字符串的处理模式。取值范围：'."\n" + .'- ignore_all：全部忽略。'."\n" + .'- exclude_query_string：删除指定查询字符串。'."\n" + .'- reserve_all：默认值，全部保留。'."\n" + .'- include_query_string：保留指定查询字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'reserve_all', + ], + ], + [ + 'name' => 'QueryString', + 'in' => 'query', + 'schema' => [ + 'description' => '需要保留或者删除的查询字符串，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'IncludeHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，加入指定的标头名称及其值，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'IncludeCookie', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，加入指定的cookie名称及其值，多个值用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cookie_exapmle', + ], + ], + [ + 'name' => 'CacheReserveEligibility', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存保持资格。用于控制用户请求在回源的时候是否绕过缓存保持节点。取值范围：'."\n" + .'- bypass_cache_reserve：请求绕过缓存保持。'."\n" + .'- eligible_for_cache_reserve：符合缓存保持资格。', + 'type' => 'string', + 'required' => false, + 'example' => 'bypass_cache_reserve', + ], + ], + [ + 'name' => 'CheckPresenceHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，检查header是否存在，如果存在，则在缓存键中加入header名称（header名称不区分大小写）。支持输入多个header名称，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'headername', + ], + ], + [ + 'name' => 'CheckPresenceCookie', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，检查cookie是否存在，如果存在，则在缓存键中加入cookie名称（cookie名称不区分大小写）。支持输入多个cookie名称，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cookiename', + ], + ], + [ + 'name' => 'UserDeviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，加入客户端设备类型。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'UserGeo', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，加入客户端地理位置。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'UserLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，加入客户端语言类型。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'ServeStale', + 'in' => 'query', + 'schema' => [ + 'description' => '响应过期缓存。开启之后，在源服务器不可用的情况下，节点依然可以使用已缓存的过期文件响应用户请求。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AdditionalCacheablePorts', + 'in' => 'query', + 'schema' => [ + 'description' => '在指定端口上开启缓存功能。取值范围：8880、2052、2082、2086、2095、2053、2083、2087、2096', + 'type' => 'string', + 'required' => false, + 'example' => '8880', + ], + ], + [ + 'name' => 'CacheDeceptionArmor', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存欺骗防御。用于防御Web缓存欺骗攻击，通过校验的缓存内容才会被缓存下来。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PostCache', + 'in' => 'query', + 'schema' => [ + 'title' => 'Post缓存功能开关。', + 'description' => 'Post缓存功能开关。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'PostBodySizeLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Body大小限制，值为数字，单位是KB，支持1～8KB大小的Body，值为空的时候，默认按8KB生效。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PostBodyCacheKey', + 'in' => 'query', + 'schema' => [ + 'title' => '缓存键的处理模式。', + 'description' => '缓存键的处理模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '添加站点缓存配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateCacheRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + ], + 'CreateClientCertificate' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239158', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'CSR', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书签名请求内容。', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE REQUEST-----', + ], + ], + [ + 'name' => 'PkeyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '私钥算法类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'RSA', + ], + ], + [ + 'name' => 'ValidityDays', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书有效期，单位：天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '365', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + 'Id' => [ + 'description' => '证书Id。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d95', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'active', + ], + 'Certificate' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----', + ], + 'PrivateKey' => [ + 'description' => '证书私钥。', + 'type' => 'string', + 'example' => '-----BEGIN PRIVATE KEY-----', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期的开始时间。', + 'type' => 'string', + 'example' => '2023-12-01T02:12:49Z', + ], + 'NotAfter' => [ + 'description' => '证书有效期的截止时间。', + 'type' => 'string', + 'example' => '2024-12-01T02:12:49Z', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'ESA CA', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1daa', + ], + 'FingerprintSha256' => [ + 'description' => '证书sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'ValidityDays' => [ + 'description' => '证书有效期。', + 'type' => 'string', + 'example' => '365', + ], + 'CACertificateId' => [ + 'description' => 'CA证书ID。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1dbb', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'title' => '创建客户端证书', + 'summary' => '使用ESA CA签发客户端证书。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"Id\\": \\"babaded901474b9693acf530e0fb1d95\\",\\n \\"Status\\": \\"active\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\",\\n \\"PrivateKey\\": \\"-----BEGIN PRIVATE KEY-----\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-12-01T02:12:49Z\\",\\n \\"NotAfter\\": \\"2024-12-01T02:12:49Z\\",\\n \\"Issuer\\": \\"ESA CA\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1daa\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"ValidityDays\\": \\"365\\",\\n \\"CACertificateId\\": \\"babaded901474b9693acf530e0fb1dbb\\"\\n}","type":"json"}]', + ], + 'CreateCompressionRule' => [ + 'summary' => '新增站点的压缩规则配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257663', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1231231221***', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'Gzip', + 'in' => 'query', + 'schema' => [ + 'description' => 'Gzip压缩。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Brotli', + 'in' => 'query', + 'schema' => [ + 'description' => 'Brotli压缩。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Zstd', + 'in' => 'query', + 'schema' => [ + 'description' => 'Zstd压缩。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建压缩规则配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-02-12T02:25:41.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateCompressionRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateCustomHostname' => [ + 'summary' => '在站点下创建一个 SaaS 域名。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239598', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4DMKZ4', + ], + ], + 'parameters' => [ + [ + 'name' => 'Hostname', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '自定义主机名。', + 'description' => 'SaaS 域名', + 'type' => 'string', + 'required' => true, + 'example' => 'custom.site.com', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '关联站点ID。', + 'description' => '站点 ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '绑定的源站记录ID。', + 'description' => '待绑定记录的ID，可以通过[ListRecords](~~2850265~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'SslFlag', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => 'SSL开关。', + 'description' => 'SSL开关。'."\n" + .'- **on**: 开启 SSL。'."\n" + .'- **off**: 关闭 SSL。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'CertType', + 'in' => 'query', + 'schema' => [ + 'title' => '证书类型。', + 'description' => '证书类型，SslFlag 为 on 时需要输入该参数。'."\n" + .'- **free**: 免费证书。'."\n" + .'- **upload**: 上传证书。'."\n" + .'- **cas**: 云盾证书。', + 'type' => 'string', + 'required' => false, + 'example' => 'free', + 'enum' => [ + 'free', + 'upload', + 'cas', + ], + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '证书公钥。', + 'description' => '证书内容，CertType 为 upload 时需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE-----', + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '证书私钥。', + 'description' => '证书私钥，CertType 为 upload 时需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN PRIVATE KEY-----', + ], + ], + [ + 'name' => 'CasId', + 'in' => 'query', + 'schema' => [ + 'title' => '云盾证书ID。', + 'description' => '云盾证书ID，CertType 为 cas 时需要输入该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30000478'."\n", + ], + ], + [ + 'name' => 'CasRegion', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '云盾证书所在地域。', + 'description' => '云盾证书地域，CertType 为 cas 时需要输入该参数。'."\n" + .'- 中国站账号传参数值：cn-hangzhou。'."\n" + .'- 国际站账号传参数值：ap-southeast-1。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'HostnameId' => [ + 'title' => '自定义主机名ID。', + 'description' => 'SaaS 域名的 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'Hostname' => [ + 'title' => '自定义主机名。', + 'description' => 'SaaS 域名。', + 'type' => 'string', + 'example' => 'custom.site.com', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'CustomHostname.ConflictWithExistingResource', + 'errorMessage' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.', + 'description' => '自定义主机名和已有资源冲突，例如站点、记录、负载均衡器、源地址池、自定义主机名和四层代理等', + ], + [ + 'errorCode' => 'QuotaExceed.CustomHostname', + 'errorMessage' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.', + 'description' => '自定义主机名的数量超限，请联系销售增加额度。', + ], + [ + 'errorCode' => 'CustomHostname.ApplyCertFailed', + 'errorMessage' => 'Fail to apply a free cert for custom hostname. Please try again later.', + 'description' => '申请自定义主机名的免费证书失败，请稍后重试。', + ], + [ + 'errorCode' => 'CustomHostname.SetCertFailed', + 'errorMessage' => 'Fail to deploy a cert for custom hostname. Please try again later.', + 'description' => '自定义主机名的证书部署失败，请稍后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建 SaaS 域名', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"HostnameId\\": 1234567890123,\\n \\"Hostname\\": \\"custom.site.com\\"\\n}","type":"json"}]', + ], + 'CreateCustomResponseCodeRule' => [ + 'summary' => '新增站点的修改响应码配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257646', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '805864735361584', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ReturnCode', + 'in' => 'query', + 'schema' => [ + 'description' => '响应码。', + 'type' => 'string', + 'required' => false, + 'example' => '400', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '响应页面。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C2B2F8CF-3074-5BBC-891A-AAD292E2624F', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3528160969****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'SiteFunction.WafPageNotExist', + 'errorMessage' => 'The custom page referenced in the custom response code configuration does not exist.', + 'description' => '自定义响应码配置中引用的自定义页面不存在。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建修改响应码配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2B2F8CF-3074-5BBC-891A-AAD292E2624F\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateCustomScenePolicy' => [ + 'summary' => '创建用户级别定制场景策略，关联站点后执行相对应的策略。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239252', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + 'maxLength' => 255, + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。取值：'."\n" + .'- **promotion**：重大活动', + 'type' => 'string', + 'required' => true, + 'example' => 'promotion', + 'enum' => [ + 'promotion', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '策略起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-11-07T17:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '策略结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-11-07T18:00:00Z', + ], + ], + [ + 'name' => 'Objects', + 'in' => 'query', + 'schema' => [ + 'description' => '要关联的站点ID信息，多个站点ID间使用英文逗号(,)分隔。'."\n" + ."\n" + .'> 该字段为待废弃字段，建议使用SiteIds字段替代。如果SiteIds字段有值，则接口操作以SiteIds字段内容为准，Objects字段内容不再生效。为避免接口调用更新操作歧义，SiteIds字段和Objects字段必须至少有一个有值。', + 'type' => 'string', + 'required' => false, + 'example' => '7096621098****,7096621099****'."\n", + ], + ], + [ + 'name' => 'SiteIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要关联的站点ID信息，多个站点ID间使用英文逗号(,)分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '7096621098****,7096621099****'."\n", + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Template' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'promotion', + ], + 'StartTime' => [ + 'description' => '策略起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2021-11-07T17:00:00Z', + ], + 'EndTime' => [ + 'description' => '策略结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2021-11-07T18:00:00Z', + ], + 'Objects' => [ + 'description' => '关联的站点ID信息列表。'."\n" + ."\n" + .'> 该字段为待废弃字段，建议读取SiteIds字段内容。', + 'type' => 'array', + 'items' => [ + 'description' => '站点ID。', + 'type' => 'string', + 'example' => '7096621098****', + ], + 'enumValueTitles' => [], + ], + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SiteIds' => [ + 'description' => '关联的站点ID，多个站点ID用逗号（","）分割', + 'type' => 'string', + 'example' => '7096621098****, 7096621099****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'PolicyNameExist', + 'errorMessage' => 'The policy name already exists.', + 'description' => '策略名称已存在。', + ], + [ + 'errorCode' => 'CreateTimeError', + 'errorMessage' => 'The effective time of the same policy template cannot overlap.', + 'description' => '同一策略模板的有效时间不能重叠。', + ], + [ + 'errorCode' => 'ScenePolicyQuotaExceedLimit', + 'errorMessage' => 'The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.', + 'description' => '场景策略配置数量超过上限，每个账号最多支持创建10个场景策略。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建定制场景策略', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-03T09:31:40.000Z', + 'description' => '请求参数发生变更、响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateCustomScenePolicy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Name\\": \\"test\\",\\n \\"Template\\": \\"promotion\\",\\n \\"StartTime\\": \\"2021-11-07T17:00:00Z\\",\\n \\"EndTime\\": \\"2021-11-07T18:00:00Z\\",\\n \\"Objects\\": [\\n \\"7096621098****\\"\\n ],\\n \\"PolicyId\\": 1,\\n \\"SiteIds\\": \\"7096621098****, 7096621099****\\"\\n}","type":"json"}]', + ], + 'CreateEdgeContainerApp' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239242', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用名称，必须小写字母打头，支持小写字母，数字，横杠。长度限制6~128字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-test', + 'maxLength' => 128, + 'minLength' => 6, + ], + ], + [ + 'name' => 'ServicePort', + 'in' => 'formData', + 'schema' => [ + 'description' => '服务端端口号，范围1~65535。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '443', + 'minimum' => '80', + 'example' => '80', + ], + ], + [ + 'name' => 'TargetPort', + 'in' => 'formData', + 'schema' => [ + 'description' => '后端端口，也是应用的服务端口，范围1~65535。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '65535', + 'minimum' => '1', + 'example' => '80', + ], + ], + [ + 'name' => 'Remarks', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息，不填写则默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test app', + 'maxLength' => 1024, + ], + ], + [ + 'name' => 'HealthCheckType', + 'in' => 'formData', + 'schema' => [ + 'description' => '健康检查类型，包括四层和七层探测，不填写默认为空。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **l4**：表示四层探测。'."\n" + .'- **l7**：表示七层探测。', + 'type' => 'string', + 'required' => false, + 'example' => 'l7', + 'default' => 'l7', + ], + ], + [ + 'name' => 'HealthCheckHost', + 'in' => 'formData', + 'schema' => [ + 'description' => '用于健康检查的域名， 不填写则默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com', + ], + ], + [ + 'name' => 'HealthCheckHttpCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '健康检查正常时的HTTP状态码。取值：'."\n" + ."\n" + .'- **http_2xx**（默认值）。'."\n" + .'- **http_3xx**。', + 'type' => 'string', + 'required' => false, + 'example' => 'http_2xx', + 'default' => 'http_2xx', + ], + ], + [ + 'name' => 'HealthCheckMethod', + 'in' => 'formData', + 'schema' => [ + 'description' => '监听HTTP类型健康检查的健康检查方法。取值：'."\n" + ."\n" + .'- **HEAD**（默认值）：只请求页面的首部。'."\n" + .'- **GET**：请求指定的页面信息，并返回实体主体。', + 'type' => 'string', + 'required' => false, + 'example' => 'HEAD', + 'default' => 'HEAD', + ], + ], + [ + 'name' => 'HealthCheckURI', + 'in' => 'formData', + 'schema' => [ + 'description' => '用于健康检查的URI。'."\n" + .'- 长度限制为**1**~**80**。'."\n" + .'- 默认值：**"/"**。', + 'type' => 'string', + 'required' => false, + 'example' => '/health_check', + ], + ], + [ + 'name' => 'HealthCheckPort', + 'in' => 'formData', + 'schema' => [ + 'description' => '健康检查的端口。'."\n" + .'- 取值范围：**1~65535**。'."\n" + .'- 默认值: **80**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'HealthCheckTimeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '接收来自运行状况检查的响应需要等待的时间。如果后端ECS在指定的时间内没有正确响应，则判定为健康检查失败。 '."\n" + ."\n" + .'- 取值：**1**~**100**。 '."\n" + .'- 默认值：**3**。'."\n" + .'- 单位：**秒**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'HealthCheckInterval', + 'in' => 'formData', + 'schema' => [ + 'description' => '健康检查的时间间隔。'."\n" + .'- 取值：**1**~**50**。'."\n" + .'- 默认值：**5**。'."\n" + .'- 单位：**秒**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'HealthCheckSuccTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '健康检查连续成功次数。如果应用不健康，经过多少次连续探测后都是成功返回，则认为应用恢复健康状态。'."\n" + .'- 取值：**1~10**。'."\n" + .'- 默认值：**2**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'HealthCheckFailTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '健康检查连续失败次数。如果应用健康，经过多少次连续探测后都是失败返回，则认为应用为不健康状态。'."\n" + .'- 取值：**1~10**， '."\n" + .'- 默认：**5**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回响应体的对象。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '创建成功的应用ID。', + 'type' => 'string', + 'example' => 'app-880688675783794688', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.HealthCheckType', + 'errorMessage' => 'Specified parameter HealthCheckType is not valid.', + 'description' => '参数 HealthCheckType 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckHost', + 'errorMessage' => 'Specified parameter HealthCheckHost is not valid.', + 'description' => '参数 HealthCheckHost 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckHttpCode', + 'errorMessage' => 'Specified parameter HealthCheckHttpCode is not valid.', + 'description' => '参数 HealthCheckHttpCode 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckMethod', + 'errorMessage' => 'Specified parameter HealthCheckMethod is not valid.', + 'description' => '参数 HealthCheckMethod 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckURI', + 'errorMessage' => 'Specified parameter HealthCheckURI is not valid.', + 'description' => '参数 HealthCheckURI 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckInterval', + 'errorMessage' => 'Specified parameter HealthCheckInterval is not valid.', + 'description' => '参数 HealthCheckInterval 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckTimeout', + 'errorMessage' => 'Specified parameter HealthCheckTimeout is not valid.', + 'description' => '参数 HealthCheckTimeout 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckSuccTimes', + 'errorMessage' => 'Specified parameter HealthCheckSuccTimes is not valid.', + 'description' => '参数 HealthCheckSuccTimes 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckFailTimes', + 'errorMessage' => 'Specified parameter HealthCheckFailTimes is not valid.', + 'description' => '参数 HealthCheckFailTimes 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.HealthCheckPort', + 'errorMessage' => 'Specified parameter HealthCheckPort is not valid.', + 'description' => '参数 HealthCheckPort 格式不正确', + ], + [ + 'errorCode' => 'InvalidParameter.PageNumber', + 'errorMessage' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', + 'description' => '参数 PageNumber 校验不通过。请仔细检查请求参数是否存在且为正整数。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + 'description' => '名称已存在。', + ], + [ + 'errorCode' => 'ParamNameError', + 'errorMessage' => 'The Name parameter is invalid.', + 'description' => 'Name参数不合法。'."\n", + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '创建边缘容器的应用', + 'summary' => '创建边缘容器的应用，通过应用的版本部署和发布完成边缘服务的容器化。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateEdgeContainerApp', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateEdgeContainerApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"app-880688675783794688\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'CreateEdgeContainerAppImageSecret' => [ + 'summary' => '创建边缘容器应用的镜像秘钥', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + ], + ], + [ + 'name' => 'Registry', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'cr-cn-shanghai.edas.aliyuncs.com', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库用户名。', + 'type' => 'string', + 'required' => true, + 'example' => 'admin', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库密码。', + 'type' => 'string', + 'required' => true, + 'example' => '***', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidParameter.Appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建边缘容器应用镜像秘钥', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'CreateEdgeContainerAppRecord' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239304', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'formData', + 'schema' => [ + 'description' => '关联域名名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'a.example.com', + 'maxLength' => 1024, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'ParameterAlreadyExist', + 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建边缘容器应用的关联域名', + 'summary' => '创建边缘容器应用的关联域名，用户从客户端发起请求访问关联的域名，请求最终会被转发到用户的部署的边缘应用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateEdgeContainerAppRecord', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateEdgeContainerAppRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'CreateEdgeContainerAppVersion' => [ + 'summary' => '创建边缘容器应用版本，可以按照版本进行应用的迭代发布。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239192', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '版本名称，长度**6~128**。', + 'type' => 'string', + 'required' => true, + 'example' => 'verson1', + 'maxLength' => 128, + 'minLength' => 6, + ], + ], + [ + 'name' => 'Remarks', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test app', + 'maxLength' => 1024, + ], + ], + [ + 'name' => 'Containers', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '该版本要部署的容器组，包含具体的镜像信息。 '."\n" + .'镜像信息，由镜像地址及启动命令、参数、环境变量、探针规则等构成，支持多个镜像，json数组结构。', + 'type' => 'array', + 'items' => [ + 'description' => '单个容器对象。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '容器名称，同一个容器组下命名唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'lxg-demo-er', + ], + 'Image' => [ + 'description' => '镜像地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/lihe****h/ea****ts_serv****am:3.**', + ], + 'IsACRImage' => [ + 'description' => '是否为ACR镜像。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + 'ACRImageInfo' => [ + 'description' => 'ACR镜像信息。', + 'type' => 'object', + 'properties' => [ + 'IsEnterpriseRegistry' => [ + 'description' => '是否为企业级镜像。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Domain' => [ + 'description' => 'ACR镜像域名。', + 'type' => 'string', + 'required' => false, + 'example' => '1500.***.net', + ], + 'InstanceId' => [ + 'description' => 'ACR站点实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'xcdn-9axbo****', + ], + 'RegionId' => [ + 'description' => 'ACR 镜像站点实例区域列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'RepoId' => [ + 'description' => '镜像的仓库ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'crr-h1ghghu60ct****', + ], + 'RepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_71', + ], + 'RepoNamespace' => [ + 'description' => '指定镜像仓库命名空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'safeline', + ], + 'Tag' => [ + 'description' => 'ACR镜像标签。', + 'type' => 'string', + 'required' => false, + 'example' => '3.40.2', + ], + 'TagUrl' => [ + 'description' => 'ACR镜像标签地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/****/eas***m:31', + ], + ], + 'required' => false, + ], + 'Spec' => [ + 'description' => '容器规格。表示算力规格，取值范围（1C2G | 2C4G | 2C8G | 4C8G | 4C16G | 8C16G | 8C32G）。', + 'type' => 'string', + 'required' => true, + 'example' => '1C2G', + ], + 'Command' => [ + 'description' => '探针运行命令。表示启动命令，多个以空格分割。', + 'type' => 'string', + 'required' => false, + 'example' => 'nginx', + ], + 'Args' => [ + 'description' => '启动参数。表示启动参数，多个以空格分割。', + 'type' => 'string', + 'required' => false, + 'example' => '-a', + ], + 'Storage' => [ + 'description' => '存储信息。标识存储空间，取值范围（0.5G | 10G | 20G | 30G）。', + 'type' => 'string', + 'required' => true, + 'example' => '0.5G', + ], + 'EnvVariables' => [ + 'description' => '环境变量。表示环境变量，格式为：key1=val1,key2=val2。', + 'type' => 'string', + 'required' => false, + 'example' => 'VITE_APP_TITLE=My App', + ], + 'PostStart' => [ + 'description' => '容器启动前执行命令。表示启动之前的命令，以空格为分隔，服务启动之前执行，一般用于初始化操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'sh poststart.sh "echo hello world" ', + ], + 'PreStop' => [ + 'description' => '容器停止前执行命令。表示启动之后的命令，以空格为分隔，服务退出之前执行，一般用于退出前的清理操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'sh prestop.sh "echo hello world" ', + ], + 'ProbeType' => [ + 'description' => '探针类型，支持如下几种类型：'."\n" + .'- **exec**： 命令型。'."\n" + .'- **tcpSocket**：tcp探测型。'."\n" + .'- **httpGet**：http访问型。', + 'type' => 'string', + 'required' => true, + 'example' => 'exec', + ], + 'ProbeContent' => [ + 'description' => '容器健康探针内容。', + 'type' => 'object', + 'properties' => [ + 'InitialDelaySeconds' => [ + 'description' => '容器探针初始化延迟时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'TimeoutSeconds' => [ + 'description' => '容器健康检查的超时时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'PeriodSeconds' => [ + 'description' => '容器健康检查的间隔时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SuccessThreshold' => [ + 'description' => '健康检查连续成功次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'FailureThreshold' => [ + 'description' => '容器健康检查连续失败次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Command' => [ + 'title' => '容器启动命令', + 'description' => 'exec 类型探针探测命令。', + 'type' => 'string', + 'required' => false, + 'example' => 'echo ok', + ], + 'Port' => [ + 'description' => '容器健康检查的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '9991', + ], + 'Host' => [ + 'description' => '健康检查的域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.rewrite.com', + ], + 'Path' => [ + 'description' => '容器健康检查的路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + 'Scheme' => [ + 'description' => '健康检查的请求协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'http', + ], + 'HttpHeaders' => [ + 'description' => 'HTTP请求头。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Content-Type\\":\\"application/json\\"}]', + ], + ], + 'required' => true, + 'example' => '具体字段可参照k8s官方就绪探针的定义。', + ], + ], + 'required' => true, + ], + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "Name": "container1",'."\n" + .' "Image": "image1",'."\n" + .' "Spec": "1C2G",'."\n" + .' "Command": "/bin/sh",'."\n" + .' "Args": "-c hello",'."\n" + .' "ProbeType": "tcpSocket",'."\n" + .' "ProbeContent": "{\\"Port\\":8080}"'."\n" + .' },'."\n" + .' {'."\n" + .' "Name": "container2",'."\n" + .' "Image": "image2",'."\n" + .' "Spec": "2C4G",'."\n" + .' "ProbeType": "httpGet",'."\n" + .' "ProbeContent": "{\\"Path\\":\\"/\\",\\"Port\\":80,\\"InitialDelaySeconds\\":10}"'."\n" + .' }'."\n" + .']', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VersionId' => [ + 'description' => '返回创建的版本的ID。', + 'type' => 'string', + 'example' => 'ver-87962637161651****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Name', + 'errorMessage' => 'The specified Name is invalid. Please check the Name parameter, which must be between 6 and 128 characters. Kindly make the necessary modifications and call the interface again.', + 'description' => 'Name 参数无效。请检查Name参数，该参数范围为6-128个字符之间，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter.Percentage', + 'errorMessage' => 'The Percentage parameter is invalid. Please check the Percentage parameter, which should be in the range of 1-100. Modify it accordingly and call the interface again.', + 'description' => 'Percentage 参数无效。请检查Percentage参数，该参数范围为1-100，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter.Image', + 'errorMessage' => 'The specified Image is invalid. Please check the Image parameter and make the necessary modifications and call the interface again.', + 'description' => 'Image参数非法。请检查Image参数，该参数不能赋值为非法字符如 @、#、% 等，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter.HttpHeaders', + 'errorMessage' => 'The specified HttpHeaders is invalid. Please check the HttpHeaders parameter. Please make the necessary changes and call the interface again.', + 'description' => 'HttpHeaders参数无效。请检查HttpHeaders参数是否填写，该参数不能包含 @ # 等非法字符，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ParameterAlreadyExist', + 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + 'description' => '名称已存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建边缘容器应用版本', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateEdgeContainerAppVersion', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VersionId\\": \\"ver-87962637161651****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'CreateHttpIncomingRequestHeaderModificationRule' => [ + 'summary' => '新增站点的修改HTTP入站请求头配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257646', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '478016908379824', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'RequestHeaderModification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改请求头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改请求头详情。', + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + 'enum' => [ + 'add', + 'modify', + 'del', + ], + ], + 'Name' => [ + 'description' => '请求头名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'headername'."\n", + ], + 'Value' => [ + 'description' => '请求头值。', + 'type' => 'string', + 'required' => false, + 'example' => 'headvalue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7C414690-9D7B-5D66-9CD9-AD0B3F25ED49', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建修改HTTP入站请求头配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C414690-9D7B-5D66-9CD9-AD0B3F25ED49\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateHttpIncomingResponseHeaderModificationRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257651', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '608665779308176', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'ResponseHeaderModification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改响应头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改响应头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '响应头名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + 'enum' => [ + 'add', + 'modify', + 'del', + ], + ], + 'Value' => [ + 'description' => '响应头值。', + 'type' => 'string', + 'required' => false, + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '434497172875264', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建修改HTTP入站响应头配置', + 'summary' => '新增站点的修改HTTP入站响应头配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"ConfigId\\": 434497172875264\\n}","type":"json"}]', + ], + 'CreateHttpRequestHeaderModificationRule' => [ + 'summary' => '新增站点的修改HTTP请求头配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257646', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example'."\n", + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'RequestHeaderModification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改请求头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改请求头详情。', + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + 'enum' => [ + 'add', + 'modify', + 'del', + ], + ], + 'Name' => [ + 'description' => '请求头名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'headername'."\n", + ], + 'Value' => [ + 'description' => '请求头值。', + 'type' => 'string', + 'required' => false, + 'example' => 'headervalue'."\n", + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建修改HTTP请求头配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:38.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:49.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateHttpRequestHeaderModificationRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateHttpResponseHeaderModificationRule' => [ + 'summary' => '新增HTTP修改响应头配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257651', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过调用[ListSites](~~2850189~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456******', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'ResponseHeaderModification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改响应头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改响应头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '响应头名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'headername', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + 'enum' => [ + 'add', + 'modify', + 'del', + ], + ], + 'Value' => [ + 'description' => '响应头值。', + 'type' => 'string', + 'required' => false, + 'example' => 'headervalue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建修改HTTP响应头配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:39.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateHttpResponseHeaderModificationRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateHttpsApplicationConfiguration' => [ + 'summary' => '新增站点HTTPS应用配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257997', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")', + ], + ], + [ + 'name' => 'HttpsForce', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启强制HTTPS，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HttpsForceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '强制HTTPS跳转状态码，取值范围：'."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 307'."\n" + .'- 308', + 'type' => 'string', + 'required' => false, + 'example' => '301', + ], + ], + [ + 'name' => 'AltSvc', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alt-Svc功能开关，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AltSvcClear', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alt-Svc头是否包含clear参数，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AltSvcPersist', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alt-Svc头包是否含persist参数，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AltSvcMa', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alt-Svc有效时间，单位是秒，默认为86400秒。', + 'type' => 'string', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'Hsts', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HSTS，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HstsMaxAge', + 'in' => 'query', + 'schema' => [ + 'description' => 'HSTS过期时间，单位是秒。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'HstsIncludeSubdomains', + 'in' => 'query', + 'schema' => [ + 'description' => '是否在HSTS中包括子域，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HstsPreload', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HSTS预加载，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'HttpsSniVerify', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启SNI校验，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HttpsNoSniDeny', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启拒绝无SNI的TLS握手请求，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HttpsSniWhitelist', + 'in' => 'query', + 'schema' => [ + 'description' => '指定允许的SNI白名单列表，多个以空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc edf', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '添加站点HTTPS应用配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-03T07:09:13.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateHttpsApplicationConfiguration', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + ], + 'CreateHttpsBasicConfiguration' => [ + 'summary' => '新增站点HTTPS基础配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257999', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + ], + [ + 'name' => 'Https', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HTTPS，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Tls10', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启TLS1.0，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Tls11', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启TLS1.1，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Tls12', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启TLS1.2，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Tls13', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启TLS1.3，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'CiphersuiteGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '加密套件组，默认使用全部加密套件。取值范围：'."\n" + .'- all：全部加密套件。'."\n" + .'- strict：强加密套件。'."\n" + .'- custom：自定义加密套件。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'Ciphersuite', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义加密套件，表示当CiphersuiteGroup为custom时选取的具体加密算法。', + 'type' => 'string', + 'required' => false, + 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', + ], + ], + [ + 'name' => 'OcspStapling', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启OCSP，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Http2', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HTTP2，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Http3', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HTTP3，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '添加站点HTTPS基础配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateHttpsBasicConfiguration', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + ], + 'CreateImageTransform' => [ + 'summary' => '新增站点图片转换配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257352', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启图片转换。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '新增站点图片转换配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateImageTransform', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + ], + 'CreateKvNamespace' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238788', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => [ + 'description' => 'KV存储空间的名字。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'KV存储空间的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a test namespace.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'KV存储空间状态，取值：'."\n" + ."\n" + .'- **online**：正常。'."\n" + ."\n" + .'- **delete**：待删除。'."\n" + ."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'- **deleted**：已删除。', + 'type' => 'string', + 'example' => 'online', + ], + 'Namespace' => [ + 'description' => 'KV存储空间名称。', + 'type' => 'string', + 'example' => 'test_namespace', + 'maxLength' => 64, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + 'NamespaceId' => [ + 'description' => 'KV存储空间的ID。', + 'type' => 'string', + 'example' => '657717877171818496', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'Description' => [ + 'description' => 'KV存储空间的描述信息。', + 'type' => 'string', + 'example' => 'this is a test namespace.', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidResource', + 'errorMessage' => 'Resource authentication failed.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum storage capacity of the Edge KV namespace has been reached. Delete unwanted key-value pairs to save the storage.', + 'description' => '边缘存储的存储空间（Namespace）容量超过限制，请清理Namespace中无需使用的Key，从而减少Namespace中的存储消耗。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + [ + 'errorCode' => 'InvalidKey.QuotaFull', + 'errorMessage' => 'The total number of IP exceeds the quota.', + 'description' => 'ip总数量超过配额。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建KV存储空间', + 'summary' => '在当前账号下创建一个KV存储空间。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-03T01:43:48.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateKvNamespace', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateKvNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"online\\",\\n \\"Namespace\\": \\"test_namespace\\",\\n \\"NamespaceId\\": \\"657717877171818496\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Description\\": \\"this is a test namespace.\\"\\n}","type":"json"}]', + ], + 'CreateList' => [ + 'summary' => '创建新的自定义列表，这些列表通常用于规则匹配引擎中值的引用，以便在各种安全策略中实现复杂的逻辑和控制。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239651', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '列表名称', + 'description' => '列表名称，用于创建自定义列表的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + [ + 'name' => 'Kind', + 'in' => 'formData', + 'schema' => [ + 'title' => '列表种类', + 'description' => '列表种类，用于指定自定义列表的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '列表描述', + 'description' => '列表描述，用于提供自定义列表的详细信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'a custom list', + ], + ], + [ + 'name' => 'Items', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '列表内容', + 'description' => '列表内容，提供具体的列表项数据。', + 'type' => 'array', + 'items' => [ + 'title' => '列表内容', + 'description' => '列表内容，提供具体的列表项数据。', + 'type' => 'string', + 'required' => false, + 'example' => '10.1.1.1', + ], + 'required' => false, + 'example' => 'a custom list', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Id' => [ + 'title' => '列表ID', + 'description' => '自定义列表的ID，可通过调用[ListLists](~~2850217~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40000001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'List.Name.AlreadyExist', + 'errorMessage' => 'The specified list name already exists.', + 'description' => '指定的列表名称已存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建自定义列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:49.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T09:53:47.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 40000001\\n}","type":"json"}]', + ], + 'CreateLoadBalancer' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238480', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器名称，需要满足域名格式校验，并且是站点下的子域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'lb.example.com', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器是否启用。'."\n" + ."\n" + .'- true：启用。'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'AdaptiveRouting', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '跨地址池回源配置。', + 'type' => 'object', + 'properties' => [ + 'FailoverAcrossPools' => [ + 'description' => '是否跨地址池回源。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false: 否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DefaultPools', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '默认地址池列表。', + 'type' => 'array', + 'items' => [ + 'description' => '默认地址池ID，整型。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '95223818027****', + ], + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'FallbackPool', + 'in' => 'query', + 'schema' => [ + 'description' => '兜底地址池ID，当所有其他池不可用时，流量将被导向此处。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'RandomSteering', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '加权轮询配置，用于控制不同地址池的流量分配权重。', + 'type' => 'object', + 'properties' => [ + 'DefaultWeight' => [ + 'description' => '默认的轮询权重，用于所有没有单独指定权重的地址池。取值范围：0-100之间的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'PoolWeights' => [ + 'description' => '各后端服务器池的权重配置，键为池ID，值为权重系数。权重系数表示相对流量分配的比例。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => '单个源地址池的权重，0-100的数字，0表示不往该源地址池调度流量。', + 'example' => '50', + ], + ], + ], + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '规则信息。', + 'type' => 'array', + 'items' => [ + 'description' => '规则结构体。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_1', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.request.method eq "GET" and http.request.version eq "HTTP/1.0") or (ip.geoip.country eq "CN") or (http.host eq "www.example.com")', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'FixedResponse' => [ + 'description' => '匹配规则后执行响应指定内容。', + 'type' => 'object', + 'properties' => [ + 'ContentType' => [ + 'description' => 'HTTP Header中的Content-Type字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'application/octet-stream', + ], + 'Location' => [ + 'description' => 'HTTP 返回中的location字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com/index.html', + ], + 'MessageBody' => [ + 'description' => '响应body值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hello World!', + ], + 'StatusCode' => [ + 'description' => '响应状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + 'required' => false, + 'example' => '{"content_type": "application/json", "location": "www.example.com", "message_body": "Testing Hello", "status_code": 0}', + ], + 'Overrides' => [ + 'description' => '匹配规则后修改对应请求改写的负载均衡配置，配置的字段，会覆盖负载均衡器配置里相应的字段。', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "adaptive_routing": {'."\n" + .' "failover_across_pools": true'."\n" + .' },'."\n" + .' "sub_region_pools": {'."\n" + .' "AL,AT": ['."\n" + .' 92298024898****,'."\n" + .' 92304347804****'."\n" + .' ],'."\n" + .' "BG,BY": ['."\n" + .' 92298024898****'."\n" + .' ]'."\n" + .' },'."\n" + .' "default_pools": ['."\n" + .' 92298024898****,'."\n" + .' 92304347804****'."\n" + .' ],'."\n" + .' "fallback_pool": 92298024898****,'."\n" + .' "location_strategy": {'."\n" + .' "mode": "resolver_ip",'."\n" + .' "prefer_ecs": "always"'."\n" + .' },'."\n" + .' "random_steering": {'."\n" + .' "default_weight": 0.3,'."\n" + .' "pool_weights": {'."\n" + .' "92298024898****": 0.7,'."\n" + .' "92304347804****": 0.8'."\n" + .' }'."\n" + .' },'."\n" + .' "region_pools": {'."\n" + .' "CN,SEAS": ['."\n" + .' 92298024898****,'."\n" + .' 92304347804****'."\n" + .' ],'."\n" + .' "SAF,SAS": ['."\n" + .' 92304347804****'."\n" + .' ]'."\n" + .' },'."\n" + .' "session_affinity": "ip",'."\n" + .' "steering_policy": "geo",'."\n" + .' "ttl": 30'."\n" + .' }', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，可以不填，不填时以列表顺序执行，如果填的话，是大于0的整数。数值越大越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Terminates' => [ + 'description' => '是否终止执行后续规则。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否，默认值。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'SessionAffinity', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '会话保持，取值：'."\n" + .'- off：不开启。'."\n" + .'- ip：按ip方式会话保持。'."\n" + .'- cookie: 按cookie方式会话保持。', + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + 'enum' => [], + ], + ], + [ + 'name' => 'SteeringPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡策略。'."\n" + ."\n" + .'- geo: 地址策略。'."\n" + .'- random: 加权轮询。'."\n" + .'- order: 主备方式。', + 'type' => 'string', + 'required' => true, + 'example' => 'order', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器的详细描述信息，便于管理和识别。', + 'type' => 'string', + 'required' => false, + 'example' => '测试负载均衡器描述', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => 'TTL值，DNS记录的生存时间，默认为30秒。取值范围：10-600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'Monitor', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '监视器配置，用于健康检查。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监视器协议类型，如HTTP，用于健康检查，值为off时，表示不进行检查。'."\n" + ."\n" + .'- TCP'."\n" + .'- UDP'."\n" + .'- SMTP'."\n" + .'- HTTPS'."\n" + .'- HTTP'."\n" + .'- ICMP Ping'."\n" + .'- off', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'Method' => [ + 'description' => '监视器请求方法，如`GET`，HTTP协议中的方法。', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + 'Port' => [ + 'description' => '源站端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1921', + ], + 'Path' => [ + 'description' => '监视器检查路径，如`/healthcheck`，HTTP请求路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/health', + ], + 'Interval' => [ + 'description' => '监视间隔，如`60`秒，检查频率。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'Timeout' => [ + 'description' => '应用健康检查超时时间，单位为秒，取值范围：1-10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'ExpectedCodes' => [ + 'description' => '预期状态码，如`200,202`，成功的HTTP响应。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + 'FollowRedirects' => [ + 'description' => '是否跟随重定向。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ConsecutiveUp' => [ + 'description' => '连续探测多少次成功算成功，如`3`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'ConsecutiveDown' => [ + 'description' => '连续探测多少次失败算失败，如`5`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'Header' => [ + 'description' => '探测时所带头部信息，HTTP头。', + 'type' => 'any', + 'required' => false, + 'example' => ' {'."\n" + .' "host": ['."\n" + .' "example1.com",'."\n" + .' "example2.com"'."\n" + .' ]'."\n" + .' }', + ], + 'MonitoringRegion' => [ + 'description' => '探测点所在区域，默认为Global，'."\n" + ."\n" + .'- Global: 全球。'."\n" + .'- ChineseMainland: 中国内地。'."\n" + .'- OutsideChineseMainland: 全球（不包括中国内地）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OutsideChineseMainland' => 'OutsideChineseMainland', + 'ChineseMainland' => 'ChineseMainland', + 'Global' => 'Global', + ], + 'example' => 'Global', + ], + ], + 'required' => true, + 'example' => 'order', + ], + ], + [ + 'name' => 'SubRegionPools', + 'in' => 'query', + 'schema' => [ + 'description' => '二级region对应的地址池，多个二级region共用一批地址池时，可以多个二级region，使用逗号拼接作为key。', + 'type' => 'any', + 'required' => false, + 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', + ], + ], + [ + 'name' => 'RegionPools', + 'in' => 'query', + 'schema' => [ + 'description' => '一级region对应的地址池。', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + 'Id' => [ + 'description' => '负载均衡器ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99867648760****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'LoadBalancerQuotaCheckFailed', + 'errorMessage' => 'Load balancer enable quota check failed.', + 'description' => '您当前的套餐无法使用负载均衡器相关功能，如需使用，请进行套餐升级。', + ], + [ + 'errorCode' => 'LoadBalancerNumberExceedQuotaLimit', + 'errorMessage' => 'The number of load balancers you have added has reached the limit of the plan quota. Please delete the unused load balancers or upgrade the plan and try again.', + 'description' => '您添加的负载均衡器数量已经达到套餐配额限制，请删除不使用的负载均衡器或者升级套餐后进行重试。', + ], + [ + 'errorCode' => 'LoadBalancerRuleQuotaCheckFailed', + 'errorMessage' => 'Your current plan does not support configuring load balancer custom rules, or the load balancer rules you have added exceed the plan quota limit. Please upgrade the plan or delete the rules that are no longer in use and try again.', + 'description' => '您当前的套餐不支持配置负载均衡器自定义规则，或者您已经添加的负载均衡器规则超过套餐配额限制，请升级套餐或者删除不再使用的规则后重试。', + ], + [ + 'errorCode' => 'LoadBalancerPolicyCheckFailed', + 'errorMessage' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', + 'description' => '您当前的套餐不支持使用该负载均衡器调度策略，请升级套餐后重试。', + ], + [ + 'errorCode' => 'LoadBalancerHealthDetectionQuotaCheckFailed', + 'errorMessage' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.', + 'description' => '您当前的套餐不允许配置负载均衡器的健康探测，请升级套餐后重试。', + ], + [ + 'errorCode' => 'LoadBalancerHealthDetectionIntervalCheckFailed', + 'errorMessage' => 'The configured load balancer health detection interval exceeds the quota range allowed by the plan. Please revise the interval within the range or upgrade the plan and try again.', + 'description' => '您配置的负载均衡器健康探测时间间隔超出了套餐允许的配额范围，请订正为范围内的间隔或者升级套餐后，进行重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'MonitorExpectedBodyInvalid', + 'errorMessage' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', + 'description' => '传入的监视器预期返回值不正确，长度不能大于102400字符，请您确认返回值后重试。', + ], + [ + 'errorCode' => 'MonitorExpectedCodesInvalid', + 'errorMessage' => 'Invalid expected status code for the probe.Make sure that you specify no more than 10 status codes in the probe settings, and each status code must be 3 to 4 characters in length.Examples: 200, 301, 3xx, 8000, and 88xx.', + 'description' => '传入的监视器预期返回码不合法。请注意：返回码的数量不能超过10个，且每个返回码的长度应不少于3个字符且不超过4个字符。例如：200、301、3xx、8000、88xx。', + ], + [ + 'errorCode' => 'MonitorHeaderInvalid', + 'errorMessage' => 'Invalid request header for the probe. You can add up to 10 request headers, each with 1 to 9 values. The combined length of all headers and values cannot exceed 6,000 characters. You cannot configure the User-Agent header.', + 'description' => '传入的监视器携带的请求头非法。请确保请求头数量不超过10个，每个请求头的值长度在1到10之间，并且不得使用User-Agent请求头（该请求头保留用于内部特定场景）。此外，所有请求头及其值的总长度不得超过6000个字符。请您检查并修正请求头配置后重试。', + ], + [ + 'errorCode' => 'MonitorMethodNotSupport', + 'errorMessage' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', + 'description' => '传入的监视器请求方法不支持，只支持以下方法：GET/HEAD。', + ], + [ + 'errorCode' => 'MonitorPathNotSupport', + 'errorMessage' => 'Invalid probe URL path.If you set the probe protocol to HTTP or HTTPS, make sure you specify a probe URL path that does not exceed 1,024 characters in length.', + 'description' => '传入的监听路径不支持。当监听类型为HTTP或HTTPS时，监听路径不能为空，且路径长度不得超过1024个字符，请您检查路径后重试。', + ], + [ + 'errorCode' => 'MonitorPortNotSupport', + 'errorMessage' => 'Invalid probe port. Specify a valid port from 1 to 65535 for the probe request. Then, try again.', + 'description' => '传入的监视器监听端口不支持，端口取值范围：[1-65535]，请您确保端口在取值范围内重试。', + ], + [ + 'errorCode' => 'MonitorRetriesInvalid', + 'errorMessage' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', + 'description' => '传入的监视器重试次数参数不支持，支持的重试次数取值范围为：[0-5]，请确保设置的重试次数在此范围内。', + ], + [ + 'errorCode' => 'MonitorTimeoutInvalid', + 'errorMessage' => 'Invalid timeout for the probe. Valid values are 1 to 10.', + 'description' => '传入的监视器超时时间超出取值范围，支持以下范围：[1-10]。', + ], + [ + 'errorCode' => 'MonitorTypeNotSupport', + 'errorMessage' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', + 'description' => '传入的监视器类型不支持，监视器只支持以下类型：off/HTTP/HTTPS/TCP/UDP/ICMP Ping/SMTP。', + ], + [ + 'errorCode' => 'OriginPoolNotExist', + 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', + 'description' => '传入的源地址池不存在，或该地址池不属于当前用户和站点，请您确认后重试。', + ], + [ + 'errorCode' => 'LoadBalancerNameConflict', + 'errorMessage' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', + 'description' => '负载均衡器名称或源地址池记录名已存在，请更换一个唯一的名字重试。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'LoadBalancer.NameInvalid', + 'errorMessage' => 'The name of the Server Load Balancer instance is a valid domain name or belongs to the site. Check that it is correct and try again.', + 'description' => '负载均衡实例的名称是合法的域名或属于站点，请检查正确后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'QuotaExceeded', + 'errorMessage' => 'The quota is exceeded.', + 'description' => '额度不足', + ], + ], + [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建负载均衡器', + 'summary' => '用于创建一个新的负载均衡器实例，支持自定义路由策略、会话保持、监控配置等高级功能。', + 'description' => '通过此API，用户可以根据业务需求配置负载均衡服务，包括但不限于自适应路由、加权轮询、规则匹配、健康检查等设置，以实现流量的有效管理和优化。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-16T02:25:11.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-02-13T01:34:54.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-02-10T01:25:59.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateLoadBalancer', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"Id\\": 0\\n}","type":"json"}]', + ], + 'CreateNetworkOptimization' => [ + 'summary' => '新增站点网络优化配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '258000', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '340035003106221', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + ], + [ + 'name' => 'SmartRouting', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启智能路由服务，默认关闭。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Http2Origin', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HTTP2回源，默认关闭。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Websocket', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启Websocket，默认开启。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Grpc', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启GRPC，默认关闭。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'UploadMaxFilesize', + 'in' => 'query', + 'schema' => [ + 'description' => '最大上传文件大小，单位是MB，取值范围：100～500。', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '添加站点网络优化配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateNetworkOptimization', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateNetworkOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + ], + 'CreateOriginPool' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238443', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '源地址池名称，一个站点下源地址池名称唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'pool1', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '源地址池是否启用：'."\n" + ."\n" + .'- true: 启用；'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Origins', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源地址池里添加的源站信息，多个源站使用数组传值。', + 'type' => 'array', + 'items' => [ + 'description' => '单个源站信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '源站名称，一个源地址下源站名称唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'origin1', + ], + 'Address' => [ + 'description' => '源站地址，如：www.example.com。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + 'Enabled' => [ + 'description' => '源站是否启用：'."\n" + ."\n" + .'- true: 启用；'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Header' => [ + 'description' => '回源时带的请求头，只支持Host。', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "Host": ['."\n" + .' "example.com"'."\n" + .' ]'."\n" + .' }', + ], + 'Weight' => [ + 'description' => '权重，0-100的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'Type' => [ + 'description' => '源站类型：'."\n" + ."\n" + .'- ip_domain: ip或域名类型源站；'."\n" + .'- OSS：OSS地址源站；'."\n" + .'- S3：AWS S3源站。', + 'type' => 'string', + 'required' => false, + 'example' => 'ip_domain', + ], + 'AuthConf' => [ + 'description' => '鉴权信息，源站为OSS或者S3等源站需要鉴权时，需要传鉴权相关配置信息。', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'description' => '鉴权类型。'."\n" + ."\n" + .'- public：公共读写，源站为OSS或S3且为公共读写时使用；'."\n" + .'- private_same_account：私有同账号，源站为OSS，且鉴权类型为同账号私有鉴权时使用；'."\n" + .'- private_cross_account：私有跨账号，源站为OSS，且鉴权类型为跨账号私有鉴权时使用；'."\n" + .'- private：源站为S3，且鉴权类型为私有时使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'public', + ], + 'AccessKey' => [ + 'description' => '私有鉴权时需要传的access key。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAccessKeyID', + ], + 'SecretKey' => [ + 'description' => '私有鉴权时需要传的secret key。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAccessKeySecret', + ], + 'Version' => [ + 'description' => '源站为AWS S3时需要传的签名版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2', + ], + 'Region' => [ + 'description' => '源站为AWS S3时需要传的源站region。', + 'type' => 'string', + 'required' => false, + 'example' => 'us-east-1', + ], + ], + 'required' => false, + ], + 'IpVersionPolicy' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21655860979****', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n", + ], + 'Id' => [ + 'description' => '新增的源地址池ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '103852052519****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'SourceNumberExceedLimit', + 'errorMessage' => 'The number of sources in the origin pool exceeds the quota limit.', + 'description' => '您在源地址池中可创建的源站个数已达到套餐上限，请查看您的套餐配额，并升级套餐以获得更多配额。', + ], + [ + 'errorCode' => 'PoolNumberExceedQuotaLimit', + 'errorMessage' => 'The number of origin pool you have added has reached the upper limit of the plan quota. Please delete the origin pool that is no longer in use or upgrade the plan and try again.', + 'description' => '您添加的源站组数量已经达到套餐的配额上限，请删除不再使用的源站组或者升级套餐后，进行重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.AddressConflict', + 'errorMessage' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', + 'description' => '传入的源站地址有冲突，在同一个源地址池中，不能存在重复的源站地址，请您确保源站地址的唯一性。', + ], + [ + 'errorCode' => 'OriginPoolNameConflict', + 'errorMessage' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.', + 'description' => '源地址池名称冲突，请确保新名称与现有源地址池及负载均衡器名称均不相同。', + ], + [ + 'errorCode' => 'SourceAddressInvalid', + 'errorMessage' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', + 'description' => '源站地址无效，请检查并确保输入的是正确的IP或域名格式。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'SourceInBlackList', + 'errorMessage' => 'The source is in the black list.', + 'description' => '源站在黑名单中。', + ], + [ + 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', + 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的源服务器地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', + 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的源服务器地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'OriginPool.TypeNotSupport', + 'errorMessage' => 'The origin address pool type is not supported.', + 'description' => '源地址池类型不支持。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建源地址池', + 'summary' => '在站点在创建源地址池，创建成功后，源地址池可以用于负载均衡器，也可以用于记录直接回源。', + 'description' => '源地址下可以添加多个源站，支持域名、IP、OSS、S3等类型的源站，支持OSS和S3类型源站的回源鉴权。', + 'changeSet' => [ + [ + 'createdAt' => '2025-05-20T11:43:19.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateOriginPool', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\",\\n \\"Id\\": 0\\n}","type":"json"}]', + ], + 'CreateOriginProtection' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250009', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4VDL9A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'AutoConfirmIPList', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'example' => 'off', + 'default' => 'off', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '开启源站防护', + 'summary' => '开启源站防护。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateOriginProtection', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'CreateOriginRule' => [ + 'summary' => '新增站点回源规则配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '258002', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '340035003106221', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true。'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")。', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + ], + [ + 'name' => 'OriginHost', + 'in' => 'query', + 'schema' => [ + 'description' => '回源请求中携带的HOST。', + 'type' => 'string', + 'required' => false, + 'example' => 'origin.example.com'."\n", + ], + ], + [ + 'name' => 'OriginScheme', + 'in' => 'query', + 'schema' => [ + 'description' => '回源请求使用的协议。取值范围：'."\n" + .'- http：使用HTTP协议回源。'."\n" + .'- https：使用HTTPS协议回源。'."\n" + .'- follow：跟随客户端协议回源。', + 'type' => 'string', + 'required' => false, + 'example' => 'http', + ], + ], + [ + 'name' => 'OriginSni', + 'in' => 'query', + 'schema' => [ + 'description' => '回源请求中携带的SNI。', + 'type' => 'string', + 'required' => false, + 'example' => 'origin.example.com', + ], + ], + [ + 'name' => 'DnsRecord', + 'in' => 'query', + 'schema' => [ + 'description' => '改写回源请求的DNS解析记录。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.example.com'."\n", + ], + ], + [ + 'name' => 'OriginHttpPort', + 'in' => 'query', + 'schema' => [ + 'description' => '使用HTTP协议回源时访问的源站端口。', + 'type' => 'string', + 'required' => false, + 'example' => '8080', + ], + ], + [ + 'name' => 'OriginHttpsPort', + 'in' => 'query', + 'schema' => [ + 'description' => '使用HTTPS协议回源时访问的源站端口。', + 'type' => 'string', + 'required' => false, + 'example' => '4433', + ], + ], + [ + 'name' => 'Range', + 'in' => 'query', + 'schema' => [ + 'description' => '使用range分片方式回源下载文件。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。'."\n" + .'- force：强制。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'OriginMtls', + 'in' => 'query', + 'schema' => [ + 'description' => 'mtls开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'OriginVerify', + 'in' => 'query', + 'schema' => [ + 'description' => '源站证书校验开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'RangeChunkSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'range分片大小。取值范围：'."\n" + .'- 512KB'."\n" + .'- 1MB'."\n" + .'- 2MB'."\n" + .'- 4MB', + 'type' => 'string', + 'required' => false, + 'example' => '1MB', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OriginReadTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '源站读超时时间(秒)。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Follow302Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '回源302跟随开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Follow302MaxTries', + 'in' => 'query', + 'schema' => [ + 'description' => '302跟随次数上限，取值范围[1-5]。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Follow302RetainArgs', + 'in' => 'query', + 'schema' => [ + 'description' => '保留原始请求参数开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Follow302RetainHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '保留原始请求头开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Follow302TargetHost', + 'in' => 'query', + 'schema' => [ + 'description' => '修改302后的回源host。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '添加站点回源规则配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-17T08:47:33.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-04-01T01:57:04.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-20T05:57:46.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-02-27T09:16:40.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateOriginRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + ], + 'CreatePage' => [ + 'summary' => '创建自定义错误响应页面。当用户的请求被Web应用防火墙（WAF）阻断时，可以展示这些自定义的错误页面。用户可以配置页面HTML内容、页面类型、描述等信息，并通过BASE64编码方式提交页面内容。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239648', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '页面名称', + 'description' => '自定义页面的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '页面描述', + 'description' => '页面的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'a custom deny page', + ], + ], + [ + 'name' => 'ContentType', + 'in' => 'formData', + 'schema' => [ + 'title' => 'HTTP Header中的Content-Type字段，如：text/html、application/json', + 'description' => '指定HTTP Header中的Content-Type字段，例如：'."\n" + .'* text/html'."\n" + .'* application/json', + 'type' => 'string', + 'required' => true, + 'example' => 'text/html', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'title' => 'BASE64编码后的 Content-Type 对应的响应页面内容', + 'description' => 'BASE64编码后的页面内容。'."\n" + .'示例值: "PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=" （表示 "hello page"）', + 'type' => 'string', + 'required' => false, + 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Id' => [ + 'title' => '自定义响应页面的ID', + 'description' => '自定义响应页面的ID，可通过调用[ListPages](~~2850223~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建自定义响应页面', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:49.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T09:53:47.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreatePage', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreatePage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 50000001\\n}","type":"json"}]', + ], + 'CreateRecord' => [ + 'summary' => '在站点下创建一条DNS解析记录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239598', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '记录名称', + 'description' => '记录名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'Proxied', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '是否代理加速', + 'description' => '记录是否开启代理加速。只有CNAME记录或者A/AAAA记录（即：type参数值等于A/AAAA或者CNAME）可以开启代理加速。取值：'."\n" + .'- **true**：开启代理。'."\n" + .'- **false**：关闭代理加速。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '记录类型', + 'description' => '记录的DNS类型。例如**A/AAAA**、**CNAME**、**TXT**等。', + 'type' => 'string', + 'required' => true, + 'example' => 'A/AAAA', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'CNAME记录的源站类型。添加CNAME记录时（type参数值等于cname），需要填写此参数。取值：'."\n" + ."\n" + .'- **OSS**：OSS源站。'."\n" + .'- **S3**：S3源站。'."\n" + .'- **LB**：负载均衡器源站。'."\n" + .'- **OP**：源地址池源站。'."\n" + .'- **Domain**：普通域名源站。'."\n" + ."\n" + .'该参数不传或传空时，则默认为Domain，即普通域名源站类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'BizName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务场景', + 'description' => '用于标记DNS记录的业务场景，DNS记录开启代理加速时（proxied参数值等于true），需要传这个参数，DNS记录不开启代理加速时（proxied参数值等于false），不需要传这个参数，取值：'."\n" + .'- **image_video**：视频图片。'."\n" + .'- **api**：api接口。'."\n" + .'- **web**：web网页。', + 'type' => 'string', + 'required' => false, + 'example' => 'web', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '记录的过期时间，单位秒。当取值为1时，表示记录的过期时间为自动。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '记录的DNS信息。不同类型的记录，该字段需要传的内容也不同，请参考'."\n" + .'[说明文档](~~2708761~~)[说明文档](https://www.alibabacloud.com/help/doc-detail/2708761.html)'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '记录值或部分内容。添加记录的类型是A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI时，该参数必填。在不同类型的记录中，分别表示不同的含义：'."\n" + ."\n" + .'- **A/AAAA**：指向的Ip地址。多个Ip时，用半角逗号,分隔。至少需要有一个Ipv4地址。'."\n" + .'- **CNAME**：指向的目标域名。'."\n" + .'- **NS**：指定域名的名称服务器。'."\n" + .'- **MX**: 有效的目标邮件服务器域名。'."\n" + .'- **TXT**：有效的文本字符串。'."\n" + .'- **CAA**：有效的证书颁发机构域名。'."\n" + .'- **SRV**：有效的目标主机域名。'."\n" + .'- **URI**: 有效的 URI 字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'Priority' => [ + 'description' => '记录的优先级，范围为**0~65535**。数值越小，优先级越高。添加MX、SRV、URI记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Flag' => [ + 'description' => '记录的标志位。CAA记录的Flag指示其优先级和处理方式，取值范围为**0~255**。添加CAA记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '128', + ], + 'Tag' => [ + 'description' => '记录的标签。CAA记录的Tag表示其具体类型和用途。添加CAA记录时，该参数必填。Tag取值：'."\n" + .'- **issue**：表示授权某个CA颁发该域名的证书。后面一般跟着CA的域名。'."\n" + .'- **issuewild**：授权某个CA颁发该域名的通配符证书（例如 *.example.com）。'."\n" + .'- **iodef**：指定一个URI，用于接收有关违反CAA记录的报告。', + 'type' => 'string', + 'required' => false, + 'example' => 'issue', + ], + 'Weight' => [ + 'description' => '记录的权重，范围为**0~65535**。添加SRV、URI记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Port' => [ + 'description' => '记录的端口，范围为**0~65535**。添加SRV记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Type' => [ + 'description' => '记录的证书类型（在CERT记录中），或公钥类型（在SSHFP记录中）。添加CERT、SSHFP记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'RSA', + ], + 'KeyTag' => [ + 'description' => '记录的公钥标识，范围为**0~65535**。添加CERT记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Algorithm' => [ + 'description' => '记录所采用的加密算法，范围为**0~255**。添加CERT、SSHFP记录时，该字段必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Certificate' => [ + 'description' => '记录的公钥证书信息。添加CERT、SMIMEA和TLSA记录时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'dGVzdGFkYWxrcw==', + ], + 'Usage' => [ + 'description' => '记录的用途标识，范围为**0~255**。添加SMIMEA和TLSA时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Selector' => [ + 'description' => '记录所使用的证书或公钥的类型，范围为**0~255**。添加SMIMEA和TLSA时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'MatchingType' => [ + 'description' => '记录用于匹配或验证证书的算法策略，范围为**0~255**。添加SMIMEA和TLSA记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Fingerprint' => [ + 'description' => '记录的公钥指纹值。添加SSHFP记录时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef1234567890', + ], + ], + 'required' => true, + 'example' => '{'."\n" + .' "value":"2.2.2.2"'."\n" + .'}', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '记录的备注信息，最大长度为100字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a remark.', + ], + ], + [ + 'name' => 'AuthConf', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'CNAME记录的源站鉴权信息。', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'description' => '源站鉴权类型，不同的源站类型，支持的鉴权类型不同，源站类型是指本接口中的SourceType参数，现在源站类型为OSS和S3时，需要填写源站鉴权类型，可选值：'."\n" + .'- **public**：公共读，当源站类型为OSS或S3，且源站为公共读时，选此值。'."\n" + .'- **private**: 私有读，当源站类型为S3，且源站为私有读时，选此值。'."\n" + .'- **private_same_account**: 私有同账号读，当源站类型为OSS，在同一个阿里云账号下，且源站为私有读时，选此值。'."\n" + .'- **private_cross_account**: 私有跨账号读，当源站类型为OSS，不在同一个阿里云账号下，且源站为私有读时，选此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'private', + ], + 'AccessKey' => [ + 'description' => '源站所属账号的AccessKey，当源站类型为OSS且源站鉴权类型为私有跨账号读，或者源站类型为S3且源站鉴权类型为私有读时，需要填写此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', + ], + 'SecretKey' => [ + 'description' => '源站所属账号的SecretKey，当源站类型为OSS且源站鉴权类型为私有跨账号读，或者源站类型为S3且源站鉴权类型为私有读时，需要填写此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'VIxuvJSA2S03f******kp208dy5w7', + ], + 'Version' => [ + 'description' => '签名算法版本，当源站类型为S3且源站鉴权类型为私有读时需要，支持以下两种：'."\n" + .'- **v2**'."\n" + .'- **v4**'."\n" + ."\n" + .'不传时，默认为v4。', + 'type' => 'string', + 'required' => false, + 'example' => 'v4', + ], + 'Region' => [ + 'description' => '源站所属区域，当源站类型为S3时，需要填写此值，源站所属的区域需要在S3的官方网站上获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'us-east-1', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'HostPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '回源HOST策略，记录类型为CNAME时生效，设置回源时带HOST的策略，有两种模式：'."\n" + ."\n" + .'- **follow_hostname**: 跟随请求HOST。'."\n" + .'- **follow_origin_domain**: 跟随源站域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'follow_origin_domain', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + 'RecordId' => [ + 'description' => '创建的记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.InvalidRecordName', + 'errorMessage' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', + 'description' => '您输入的记录名称不符合规范，请根据产品文档调整记录名称。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordData', + 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', + 'description' => '记录内容参数错误，请根据接口文档调整参数内容。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'QuotaExceed.RecordCount', + 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', + 'description' => '记录数量已达上限，请删除部分记录后重试或升级套餐。', + ], + [ + 'errorCode' => 'Record.Conflict', + 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'QuotaExceed.WildCardRecord', + 'errorMessage' => 'The maximum number of wildcard records has been reached. Delete some and try again.', + 'description' => '泛域名记录数量已达上限，请删除部分泛域名记录后重试。', + ], + [ + 'errorCode' => 'Record.NoResource', + 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', + 'description' => '为记录分配资源失败，请提工单处理。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidBiz', + 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', + 'description' => '业务类型的值为空或传入参数错误。', + ], + [ + 'errorCode' => 'Record.RecordValueContainSourceInBlacklist', + 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', + 'description' => '记录值包含黑名单地址，详情可提交工单咨询。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', + 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', + 'description' => '若添加站点同名记录，请将主机记录命名为@，若添加其他记录，主机记录后缀需要和站点名完全一致。请调整后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordNameExceedLimit', + 'errorMessage' => 'The length of the record name exceeds the maximum limit.', + 'description' => '记录名称不能超过200个字符。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidHostPolicy', + 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', + 'description' => '回源Host的参数错误。', + ], + [ + 'errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', + 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', + 'description' => 'CNAME方式接入的站点仅支持添加A/AAAA、CNAME类型记录。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordCommentExceedLimit', + 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', + 'description' => '记录的备注信息大于50个字符。', + ], + [ + 'errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', + 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', + 'description' => '创建或编辑A/AAAA记录时，记录值包含了无效IP。', + ], + [ + 'errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', + 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', + 'description' => '创建或编辑A/AAAA记录时，IP数量超限，一个主机记录仅支持8个IPv4和4个IPv6 IP，请调整后重试。', + ], + [ + 'errorCode' => 'Record.CAARecordFlagExceedLimit', + 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CAA记录的flag参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CAARecordTagExceedLimit', + 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', + 'description' => '创建或编辑CAA记录信息时，Tag值传入了issue、issuewild、iodef以外的非法字符。', + ], + [ + 'errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', + 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录的algorithm参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CERTRecordKeyTagExceedLimit', + 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录的keyTag参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CERTRecordTypeExceedLimit', + 'errorMessage' => 'The CERT record type is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录type参数超出了范围。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedIPASource', + 'errorMessage' => 'The CNAME record cannot be the origin of the added Layer 4 application. Check the values of other Layer 4 proxy records and try again.', + 'description' => 'CNAME记录不能是已经添加的四层应用的源站，请检查其他四层代理记录的记录值并重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', + 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', + 'description' => 'CNAME记录不能是已经添加的源地址池的源站，请检查后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedRecordSource', + 'errorMessage' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.', + 'description' => 'CNAME记录不能是已经添加的记录的源站，请检查其他记录的记录值并重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedIPARecord', + 'errorMessage' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.', + 'description' => 'CNAME记录的记录值不能与其他已经存在的四层代理记录名完全相同。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', + 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', + 'description' => 'CNAME记录的记录值不能与其他已经存在的CNAME记录名完全相同。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', + 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', + 'description' => 'CNAME记录的记录值不能和主机记录完全一样，请调整后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueExceedLimit', + 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', + 'description' => '记录值不能超过253个字符，请删减后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueInvalidDomainUnderline', + 'errorMessage' => 'Record values (DNS-only records) generally start with an underscore, a lowercase letter a-z, and the numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.', + 'description' => '记录值（仅DNS的记录）一般需以下划线 _、小写字母 a-z 、数字 0-9开头。记录中间部分可用小写字母、数字或连字符 -，长度在 0 到 61 个字符之间。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueInvalidRecordDomain', + 'errorMessage' => 'Record values (records with agent acceleration enabled) must start with a lowercase letter a-z and numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.', + 'description' => '记录值（开启代理加速的记录）一般需以小写字母 a-z 、数字 0-9开头。记录中间部分可用小写字母、数字或连字符 -，长度在 0 到 61 个字符之间。', + ], + [ + 'errorCode' => 'Record.EmptyRecordValue', + 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', + 'description' => '记录值为空，请正确填写后重试。', + ], + [ + 'errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', + 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', + 'description' => '创建或编辑CERT记录信息时，CERT记录的证书值不是base64编码后的值。', + ], + [ + 'errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', + 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', + 'description' => '创建或编辑SSHFP记录信息时，指纹fingerprint值不是16进制编码的。', + ], + [ + 'errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', + 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', + 'description' => '创建或编辑CAA记录信息时，CAA记录的标签Tag，只能是分号或分号分隔的合法域名。', + ], + [ + 'errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', + 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以mailto:为前缀时，后面必须接一个合法的email地址。', + ], + [ + 'errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', + 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', + 'description' => '创建或编辑SMIMEA记录信息时，SMIMEA记录的证书值不是base64编码后的值。', + ], + [ + 'errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', + 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', + 'description' => '创建或编辑TLSA记录信息时，传入的证书值不是16进制编码的。', + ], + [ + 'errorCode' => 'Record.InvalidURLWithURIRecord', + 'errorMessage' => 'The URI record value must be a valid URL address.', + 'description' => '创建或编辑URI记录信息时，记录值必须是一个合法的URL地址。', + ], + [ + 'errorCode' => 'Record.NoRecordNameConflictWithNSRecord', + 'errorMessage' => 'No record name can conflict with an NS record name.', + 'description' => '任何记录名不能和NS记录名冲突。', + ], + [ + 'errorCode' => 'Record.NSRecordCannotEqualSiteName', + 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', + 'description' => '不允许添加和站点名称完全同名的NS记录。', + ], + [ + 'errorCode' => 'Record.OSSSourceInvalidAuthType', + 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', + 'description' => '记录的OSS源站鉴权类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.ParseJSONRecordValueFailed', + 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', + 'description' => '记录值的JSON格式不正确，请调整后重试。', + ], + [ + 'errorCode' => 'Record.PoolSourceNotExistPool', + 'errorMessage' => 'If the source station type of the record is source address pool, the input source address pool does not exist.', + 'description' => '记录的源站类型为源地址池的情况下，输入的源地址池不存在。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', + 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', + 'description' => 'A/AAAA、CNAME记录之间不能重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithIPAName', + 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能和四层代理记录重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithLBName', + 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能与负载均衡记录重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithNSRecord', + 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', + 'description' => '创建或编辑DNS记录信息时，NS记录名不能和任何其他类型记录名重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithPoolName', + 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能和源地址池记录名重名。', + ], + [ + 'errorCode' => 'Record.RecordNameInBlacklist', + 'errorMessage' => 'The record name is in blacklist.', + 'description' => '记录名在黑名单中，无法添加。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthRegion', + 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', + 'description' => '记录的S3源站所属区域不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthType', + 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', + 'description' => '记录的S3源站鉴权类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthVersion', + 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', + 'description' => '记录的S3源站的鉴权签名算法版本不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.SourceAccessKeyExceedLimit', + 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', + 'description' => '记录源站的 AccessKey 参数值的字符长度超出了范围。', + ], + [ + 'errorCode' => 'Record.SourceEmptyAK', + 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', + 'description' => '记录的源站所属账号的 AccessKey 为空。', + ], + [ + 'errorCode' => 'Record.SourceEmptyAuthConf', + 'errorMessage' => 'The authentication information of the origin station is empty.', + 'description' => '记录的源站的鉴权信息为空。', + ], + [ + 'errorCode' => 'Record.SourceEmptySecretKey', + 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', + 'description' => '记录的源站所属账号的 SecretKey 为空。', + ], + [ + 'errorCode' => 'Record.SourceSecretKeyExceedLimit', + 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', + 'description' => '记录源站的 SecretKey 参数值的字符长度超出了范围。', + ], + [ + 'errorCode' => 'Record.SRVRecordInvalidRecordName', + 'errorMessage' => 'SRV host record name is not valid. The SRV host record name must begin with an underscore (-) followed by a lowercase letter (a-z), a number (0-9), and a hyphen (-), followed by 1 arbitrary character, followed by an underscore (-) and a lowercase letter, number, or hyphen.', + 'description' => 'SRV主机记录名称不合法。SRV主机记录名称必须以下划线（-）开头，后跟小写字母（a-z）、数字（0-9）、连字符（-），后接1个任意字符，再跟1个下划线（-）和小写字母、数字或连字符。', + ], + [ + 'errorCode' => 'Record.SRVRecordPortExceedLimit', + 'errorMessage' => 'The SRV record port is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的SRV记录端口超出了范围。', + ], + [ + 'errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', + 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', + 'description' => '创建或编辑DNS记录信息时，SSHFP记录的algorithm参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.TTLExceedLimit', + 'errorMessage' => 'The TTL parameter value for a record is out of range.', + 'description' => '创建或编辑DNS记录信息时，记录的TTL参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.TXTRecordValueExceedLimit', + 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', + 'description' => '创建或编辑DNS记录信息时，TXT记录值不能超过450个字符。', + ], + [ + 'errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', + 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', + 'description' => '创建或编辑DNS记录信息时，SSHFP记录Type参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', + 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', + 'description' => '主机记录名称非法。主机记录内不能包含连续的点号。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', + 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', + 'description' => '主机记录名称非法，SRV记录名称禁止使用星号。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidATChar', + 'errorMessage' => 'Illegal host record name. The at symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.', + 'description' => '主机记录名称非法。@符号只能出现在主机记录的首位，且后面只能跟.符号，不允许接其他字符串。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', + 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', + 'description' => '主机记录名称非法。主机记录值不能以点号、中划线开头或结尾。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidStartSymbol', + 'errorMessage' => 'Illegal host record name. The asterisk is only allowed in the first place of the host record, and only the following dot is allowed after the asterisk.', + 'description' => '主机记录名称非法。星号只允许在主机记录首位，并且星号后面只允许跟点。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', + 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', + 'description' => '主机记录名称非法。用\'.\'号分隔的每段字符数量不能超过63个。', + ], + [ + 'errorCode' => 'Record.UnsupportedSourceType', + 'errorMessage' => 'The recorded source station type is not in the supported range.', + 'description' => '记录的源站类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.UnsupportedType', + 'errorMessage' => 'The record type parameter is unsupported.', + 'description' => '记录类型错误，请检查记录类型参数。', + ], + [ + 'errorCode' => 'Record.ValidProxiedForSpecifedRecordType', + 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', + 'description' => '创建或编辑记录时，代理状态开启了代理加速，仅A/AAAA、CNAME类型支持开启代理加速。', + ], + [ + 'errorCode' => 'Record.RecordUsageExceedLimit', + 'errorMessage' => 'The usage parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的usage参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordSelectorExceedLimit', + 'errorMessage' => 'The selector parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的selector参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordMatchingTypeExceedLimit', + 'errorMessage' => 'The matchingType parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的matchingType参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordPriorityExceedLimit', + 'errorMessage' => 'The record priority parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的记录优先级参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordWeightExceedLimit', + 'errorMessage' => 'The record weight parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的记录权重参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithSameRecordType', + 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', + 'description' => '记录冲突，存在记录值相同的同名主机记录。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidUnderLine', + 'errorMessage' => 'The host record name contains an illegal underscore. The underscore is only supported at the beginning of the TXT, CNAME, MX, SRV, and NS records. Proxy acceleration cannot be enabled, and records can only be added in the DNS mode.', + 'description' => '主机记录名称包含了非法下划线。下划线仅可在TXT、CNAME、MX、SRV、NS的记录中的开头处支持，且不能开启代理加速，仅能以DNS方式添加记录。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidDSRecordName', + 'errorMessage' => 'Please add/import an NS record with the same name before adding this DS record.', + 'description' => '请先添加/导入同名的NS记录，再添加该DS记录。', + ], + [ + 'errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', + 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', + 'description' => '以CNAME方式接入的站点，提交了未开启加速的记录。', + ], + [ + 'errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', + 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', + 'description' => '创建或编辑CAA记录信息时，Tag值不能以mailto: http://或者mailto: https:// 开头。', + ], + [ + 'errorCode' => 'Record.WildcardConflictForSpecifiedRecordType', + 'errorMessage' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.', + 'description' => 'A/AAAA,CNAME记录不能同时添加all和星号前缀的记录。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameOnlyContainSymbol', + 'errorMessage' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.', + 'description' => '主机记录值不能以各类符号单独存在，可加入任何小写字母或数字。'."\n", + ], + [ + 'errorCode' => 'SameNameRecordExceedLimit', + 'errorMessage' => 'The number of records with the same name exceeds the upper limit.', + 'description' => '同名称的记录数量超过上限。', + ], + [ + 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', + 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', + 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', + 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以http://或https://为前缀时，后面必须接一个合法的URL地址。'."\n", + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameOnlyRangeChars', + 'errorMessage' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, some special characters are supported as valid characters in host records.', + 'description' => '主机记录字符非法。主机记录值合法字符仅支持小写字母a-z、大写字母A-Z、数字0-9、\'-\' 、\'_\' 、\'.\'、\'*\'、\'@\'。'."\n", + ], + ], + ], + 'title' => '创建解析记录', + 'requestParamsDescription' => '记录的Data部分，包括记录的DNS信息。不同类型的记录，该字段需要传的内容也不同。详细说明请参考'."\n" + .'[说明文档](https://help.aliyun.com/document_detail/2708761.html)[说明文档](https://www.alibabacloud.com/help/doc-detail/2708761.html)'."\n" + .'。', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-28T01:22:08.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-02-18T05:59:13.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-11-05T03:27:37.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-10-10T12:01:10.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-24T08:28:18.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-23T02:21:51.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRecord', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"RecordId\\": 1234567890123\\n}","type":"json"}]', + ], + 'CreateRedirectRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257657', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '重定向类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'static' => 'static', + 'dynamic' => 'dynamic', + ], + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + [ + 'name' => 'TargetUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '重定向后的目标URL。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://www.exapmle.com/index.html'."\n", + ], + ], + [ + 'name' => 'StatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点给客户端响应重定向地址时候使用的响应状态码。取值范围：'."\n" + ."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 303'."\n" + .'- 307'."\n" + .'- 308', + 'type' => 'string', + 'required' => true, + 'example' => '301', + 'enum' => [ + '301', + '302', + '303', + '307', + '308', + ], + ], + ], + [ + 'name' => 'ReserveQueryString', + 'in' => 'query', + 'schema' => [ + 'description' => '保留查询字符串。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1FCB0DA6-9B6D-509D-B91C-B9B9F0780D0E', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建重定向配置', + 'summary' => '新增站点的重定向配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:38.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRedirectRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FCB0DA6-9B6D-509D-B91C-B9B9F0780D0E\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateRewriteUrlRule' => [ + 'summary' => '新增站点的重写URL功能配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257641', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")'."\n", + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example'."\n", + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'RewriteUriType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '路径重写类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'static' => 'static', + 'dynamic' => 'dynamic', + ], + 'example' => 'static', + 'enum' => [], + ], + ], + [ + 'name' => 'Uri', + 'in' => 'query', + 'schema' => [ + 'description' => '重写后的目标URI。', + 'type' => 'string', + 'required' => false, + 'example' => '/image/example.jpg'."\n", + ], + ], + [ + 'name' => 'RewriteQueryStringType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '查询字符串重写类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'static' => 'static', + 'dynamic' => 'dynamic', + ], + 'example' => 'static'."\n", + 'enum' => [], + ], + ], + [ + 'name' => 'QueryString', + 'in' => 'query', + 'schema' => [ + 'description' => '重写后的查询字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'example=123'."\n", + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '39237781679****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '添加重写URL配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:38.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRewriteUrlRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateRoutine' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '238770', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名, 同一个账号下命名唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Routine描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'the description of this routine', + ], + ], + [ + 'name' => 'HasAssets', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否包含Assets文件标记。', + 'type' => 'boolean', + 'required' => false, + 'example' => '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Status' => [ + 'description' => '接口操作结果，成功或失败。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RoutineAlreadyExist', + 'errorMessage' => 'The routine name already exists.', + 'description' => '输入的函数名已存在，请您重新设置。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'ParameterNotExist', + 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', + 'description' => '输入参数不存在，请您核对后重试。', + ], + [ + 'errorCode' => 'ServiceNotOpen', + 'errorMessage' => 'You have not activated Edge Routine. Activate the service and try again.', + 'description' => '您尚未开通边缘函数服务，请开通服务后重试。', + ], + [ + 'errorCode' => 'RoutineNumberExceedQuotaLimit', + 'errorMessage' => 'The maximum number of configuration items for the feature has been reached. Adjust your configurations and try again.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限，请您调整后重试。', + ], + [ + 'errorCode' => 'DependedByOthers', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'UserOperationStatusIsLocked', + 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', + 'description' => '您正在调用其他操作函数相关的接口，请等待其他接口调用完成后重试。', + ], + ], + ], + 'title' => '创建边缘函数', + 'summary' => '创建一个边缘函数（Routine）。', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-04T05:48:49.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-11-05T06:54:07.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRoutine', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateRoutine', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CreateRoutineCodeDeployment' => [ + 'summary' => '用于在指定环境中按比例灰度发布Routine代码版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '238829', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Env', + 'in' => 'formData', + 'schema' => [ + 'description' => '环境名，目前只能输入测试环境`staging`或生产环境`production`。', + 'type' => 'string', + 'required' => true, + 'example' => 'staging', + 'enum' => [ + 'production', + 'staging', + ], + ], + ], + [ + 'name' => 'Strategy', + 'in' => 'formData', + 'schema' => [ + 'description' => '部署策略，目前只能输入固定字符串percentage。', + 'type' => 'string', + 'required' => true, + 'example' => 'percentage', + 'enum' => [ + 'percentage', + ], + ], + ], + [ + 'name' => 'CodeVersions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '比例灰度版本号配置列表。最多支持两个版本号，且总比例之和等于100。', + 'type' => 'array', + 'items' => [ + 'description' => '比例灰度版本号单条配置。', + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => '代码版本灰度比例。取值1-100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + 'CodeVersion' => [ + 'description' => '代码版本号。', + 'type' => 'string', + 'required' => true, + 'example' => '1723599747213377175', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 2, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '该条任务请求Id。'."\n", + 'type' => 'string', + 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Strategy' => [ + 'description' => '灰度发布策略，固定字符串“percentage”。'."\n", + 'type' => 'string', + 'example' => 'percentage', + ], + 'DeploymentId' => [ + 'description' => '部署记录ID。'."\n", + 'type' => 'string', + 'example' => '234', + ], + 'CodeVersions' => [ + 'description' => '比例灰度代码版本号配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '比例灰度代码单条版本号配置。', + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => '代码版本灰度比例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'CodeVersion' => [ + 'description' => '代码版本号。', + 'type' => 'string', + 'example' => '1723599747213377175', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'ParameterNotExist', + 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', + 'description' => '输入参数不存在，请您核对后重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'DependedByOthers', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', + 'description' => '输入的参数校验不通过，请您核对参数的正确性后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建边缘函数代码版本部署', + 'description' => '## 请求说明'."\n" + .'- 创建Routine代码版本部署时，环境名`Env`仅支持填写测试环境`staging`或生产环境`production`。'."\n" + .'- `CodeVersions`参数最多支持两个版本的灰度发布，并且这些版本的比例总和必须等于100%。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateRoutineCodeDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Strategy\\": \\"percentage\\",\\n \\"DeploymentId\\": \\"234\\",\\n \\"CodeVersions\\": [\\n {\\n \\"Percentage\\": 100,\\n \\"CodeVersion\\": \\"1723599747213377175\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateRoutineRelatedRecord' => [ + 'summary' => '添加边缘函数Routine的关联站点记录，在站点下添加一条新的记录，用于触发执行边缘函数程序代码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239007', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '54362329990032', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'formData', + 'schema' => [ + 'description' => '记录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-record-1.example.com', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Status' => [ + 'description' => '接口操作状态，成功或失败。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RecordId' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3227405728754048', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'DependedByOthers', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SiteParameterNotMatch', + 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', + 'description' => '输入的站点相关参数校验失败。请检查参数正确性后重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'ParameterAlreadyExist', + 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RelatedRecordNumberExceedQuotaLimit', + 'errorMessage' => 'The maximum number of records associated with the routine has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'description' => '您的函数关联记录数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多的函数关联记录配额数量。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'errorCode' => 'UserOperationStatusIsLocked', + 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', + 'description' => '您正在调用其他操作函数相关的接口，请等待其他接口调用完成后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建边缘函数关联记录', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-04T05:48:48.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-11-05T06:54:07.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateRoutineRelatedRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\",\\n \\"RecordId\\": 3227405728754048\\n}","type":"json"}]', + ], + 'CreateRoutineRoute' => [ + 'summary' => '新增边缘函数路由配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266190', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => '路由名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_route', + ], + ], + [ + 'name' => 'RouteEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '路由开关。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容。', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")', + ], + ], + [ + 'name' => 'RoutineName', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'Bypass', + 'in' => 'query', + 'schema' => [ + 'description' => '旁路模式。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Fallback', + 'in' => 'query', + 'schema' => [ + 'description' => '异常回源开关，开启后若函数出现异常如CPU使用超限则请求回源。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidRoutine', + 'errorMessage' => 'The name of routine is invalid.', + 'description' => '边缘函数名称不合法。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '新增边缘函数路由配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-25T05:35:35.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRoutineRoute', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRoutineRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateScheduledPreloadExecutions' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239296', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '预热任务ID，通过调用[CreateScheduledPreloadJob](~~2850459~~)接口生成。', + 'type' => 'string', + 'required' => false, + 'example' => '665d3af3621bccf3fe29e1a4', + ], + ], + [ + 'name' => 'Executions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '待添加的定时预热任务执行计划列表。', + 'type' => 'array', + 'items' => [ + 'description' => '执行计划信息。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '定时预热计划开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-06-03T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '定时预热计划结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-06-04T02:02:09Z', + ], + 'Interval' => [ + 'description' => '定时预热计划每批执行间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '30', + ], + 'SliceLen' => [ + 'description' => '每批定时预热URL个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + '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' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + 'FailedExecutions' => [ + 'description' => '添加失败的预热计划信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'example' => '66599bd7397885b43804901c', + ], + 'StartTime' => [ + 'description' => '定时预热计划开始时间。', + 'type' => 'string', + 'example' => '2024-06-02T02:43:35Z', + ], + 'EndTime' => [ + 'description' => '定时预热计划结束时间。', + 'type' => 'string', + 'example' => '2024-06-03T02:43:35Z', + ], + 'Interval' => [ + 'description' => '定时预热计划每批执行间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'SliceLen' => [ + 'description' => '每批定时预热URL个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Status' => [ + 'description' => '定时预热计划的状态，包括如下状态。'."\n" + .'- **waiting**：等待被执行。'."\n" + .'- **running**：正在执行中。'."\n" + .'- **finished**：执行完成。'."\n" + .'- **failed**：执行失败。'."\n" + .'- **stopped**：暂停执行中。', + 'type' => 'string', + 'example' => 'running', + ], + 'JobId' => [ + 'description' => '预热任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + ], + 'description' => '', + ], + ], + 'FailedMessages' => [ + 'description' => '计划添加失败信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '失败信息。', + 'type' => 'string', + 'example' => 'execution id: 66599bd7397885b43804921c, error: end time is before start time.', + ], + ], + 'SuccessCount' => [ + 'description' => '成功新增的预热计划个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'SuccessExecutions' => [ + 'description' => '添加成功的预热计划信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'example' => '66599bd7397885b43804901c', + ], + 'StartTime' => [ + 'description' => '定时预热计划开始时间。', + 'type' => 'string', + 'example' => '2024-06-02T02:43:35Z', + ], + 'EndTime' => [ + 'description' => '定时预热计划结束时间。', + 'type' => 'string', + 'example' => '2024-06-03T02:43:35Z', + ], + 'Interval' => [ + 'description' => '定时预热计划每批执行间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'SliceLen' => [ + 'description' => '每批定时预热URL个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Status' => [ + 'description' => '定时预热计划的状态，包括如下状态。'."\n" + .'- **waiting**：等待被执行。'."\n" + .'- **running**：正在执行中。'."\n" + .'- **finished**：执行完成。'."\n" + .'- **failed**：执行失败。'."\n" + .'- **stopped**：暂定执行中。', + 'type' => 'string', + 'example' => 'failed', + ], + 'JobId' => [ + 'description' => '预热任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + ], + 'description' => '', + ], + ], + 'TotalCount' => [ + 'description' => '总共请求新增的计划个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '批量新增定时预热任务的计划', + 'summary' => '制定批量新增定时预热任务的计划。', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-12T03:12:20.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateScheduledPreloadExecutions', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateScheduledPreloadExecutions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"FailedExecutions\\": [\\n {\\n \\"Id\\": \\"66599bd7397885b43804901c\\",\\n \\"StartTime\\": \\"2024-06-02T02:43:35Z\\",\\n \\"EndTime\\": \\"2024-06-03T02:43:35Z\\",\\n \\"Interval\\": 60,\\n \\"SliceLen\\": 10,\\n \\"Status\\": \\"running\\",\\n \\"JobId\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"AliUid\\": \\"15685865xxx14622\\"\\n }\\n ],\\n \\"FailedMessages\\": [\\n \\"execution id: 66599bd7397885b43804921c, error: end time is before start time.\\"\\n ],\\n \\"SuccessCount\\": 12,\\n \\"SuccessExecutions\\": [\\n {\\n \\"Id\\": \\"66599bd7397885b43804901c\\",\\n \\"StartTime\\": \\"2024-06-02T02:43:35Z\\",\\n \\"EndTime\\": \\"2024-06-03T02:43:35Z\\",\\n \\"Interval\\": 60,\\n \\"SliceLen\\": 10,\\n \\"Status\\": \\"failed\\",\\n \\"JobId\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"AliUid\\": \\"15685865xxx14622\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', + ], + 'CreateScheduledPreloadJob' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239344', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'InsertWay', + 'in' => 'formData', + 'schema' => [ + 'description' => '预热文件上传方式，支持文本框和OSS方式上传。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss', + 'enum' => [ + 'textBox', + 'oss', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '定时预热任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + ], + ], + [ + 'name' => 'OssUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '定时预热OSS文件，填入OSS的文件地址。'."\n" + .'注意：OSS文件中是您需要预热的URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '190007158391808', + ], + ], + [ + 'name' => 'UrlList', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要预热的URL列表，文本框方式上传预热文件时使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://testurl.com/a.txt'."\n" + .'http://testurl.com/b.txt', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247B78', + ], + 'AliUid' => [ + 'title' => '阿里云UID', + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + 'CreatedAt' => [ + 'title' => '任务创建时间', + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2023-06-05T10:04:20+0800', + ], + 'Domains' => [ + 'title' => '预热域名列表', + 'description' => '预热域名列表。', + 'type' => 'string', + 'example' => 'testurl.com', + ], + 'ErrorInfo' => [ + 'title' => '错误信息', + 'description' => '错误信息，多个用逗号隔开：'."\n" + .'- **InvalidUrl**：链接格式不正确。'."\n" + .'- **InvalidDomain**：域名归属校验不通过。'."\n" + .'- **QuotaExcess**：超出配额上限。'."\n" + .'- **OtherErrors**：其它错误。', + 'type' => 'string', + 'example' => 'InvalidDomain', + ], + 'FailedFileOss' => [ + 'title' => '失败文件OSS地址', + 'description' => '失败文件OSS地址。', + 'type' => 'string', + 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', + ], + 'FileId' => [ + 'title' => 'URL列表文件ID（下载时使用）', + 'description' => 'URL列表文件ID（下载时使用）。', + 'type' => 'string', + 'example' => '665d3b48621bccf3fe29e1a7', + ], + 'Id' => [ + 'title' => '任务ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'InsertWay' => [ + 'title' => 'URL插入方式', + 'description' => 'URL插入方式。', + 'type' => 'string', + 'example' => 'oss', + 'enum' => [ + 'file', + 'url', + ], + ], + 'Name' => [ + 'title' => '任务名称', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'SiteId' => [ + 'title' => '站点ID', + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '190007158391808', + ], + 'TaskSubmitted' => [ + 'title' => '已提交的cdncm预热任务数', + 'description' => '已提交到系统进行预热任务的URL数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskType' => [ + 'title' => '任务类型（刷新/预热）', + 'description' => '任务类型（刷新/预热）。', + 'type' => 'string', + 'example' => 'preload', + 'enum' => [ + 'preload', + 'refresh', + 'path', + ], + ], + 'UrlCount' => [ + 'title' => 'URL总数', + 'description' => 'URL总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UrlSubmitted' => [ + 'title' => '已提交的URL数', + 'description' => '已提交的URL数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '新增定时预热任务', + 'summary' => '添加一个定时预热任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateScheduledPreloadJob', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateScheduledPreloadJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\",\\n \\"AliUid\\": \\"15685865xxx14622\\",\\n \\"CreatedAt\\": \\"2023-06-05T10:04:20+0800\\",\\n \\"Domains\\": \\"testurl.com\\",\\n \\"ErrorInfo\\": \\"InvalidDomain\\",\\n \\"FailedFileOss\\": \\"https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7\\",\\n \\"FileId\\": \\"665d3b48621bccf3fe29e1a7\\",\\n \\"Id\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"InsertWay\\": \\"oss\\",\\n \\"Name\\": \\"example\\",\\n \\"SiteId\\": 190007158391808,\\n \\"TaskSubmitted\\": 1,\\n \\"TaskType\\": \\"preload\\",\\n \\"UrlCount\\": 2,\\n \\"UrlSubmitted\\": 1\\n}","type":"json"}]', + ], + 'CreateSite' => [ + 'summary' => '让用户创建一个新的站点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239619', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SiteName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '记录名称', + 'description' => '站点名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Coverage', + 'in' => 'query', + 'schema' => [ + 'description' => '加速区域。取值：'."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **global**：全球。'."\n" + .'- **overseas**：全球（不包含中国内地）。', + 'type' => 'string', + 'required' => true, + 'example' => 'domestic', + 'enum' => [ + 'global', + 'domestic', + 'overseas', + ], + ], + ], + [ + 'name' => 'AccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的接入类型。取值：'."\n" + ."\n" + .'- **NS**：表示使用托管NS的方式接入。'."\n" + .'- **CNAME** ：表示使用配置CNAME的方式接入。', + 'type' => 'string', + 'required' => true, + 'example' => 'NS', + 'enum' => [ + 'NS', + 'CNAME', + ], + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可通过调用[ListUserRatePlanInstances](~~2852398~~)接口获取。实例ID和站点ID至少填写一个，若两者都填，则以实例ID为准进行查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'dbaudit-cn-nwy349jdb03'."\n", + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。不传该参数时，系统自动补全默认资源组ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmw4znnok****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'NameServerList' => [ + 'description' => '为站点分配的NS列表，用半角逗号（,）分隔。当站点的接入方式为NS接入时，该字段有值，需要将站点的DNS服务器修改成这些NS。随后即可验证站点的归属权，激活站点。', + 'type' => 'string', + 'example' => 'ns1.example.com,ns2.example.com', + ], + 'VerifyCode' => [ + 'description' => '站点的校验码。当站点的接入方式为CNAME接入时，需要在站点的DNS服务器下配置一条记录名称为**_esaauth.[站点名称]**'."\n" + .'、记录值为**校验码**的TXT记录。随后即可验证站点的归属权，激活站点。', + 'type' => 'string', + 'example' => 'verify_aah9dioasmov****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'InvalidParameter.SiteName', + 'errorMessage' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', + 'description' => '站点名称无效，请重新输入站点名称，可以包含字母和数字，不能包含特殊字符。', + ], + [ + 'errorCode' => 'QuotaExceed.SiteCount', + 'errorMessage' => 'The maximum number of websites associated with your plan has been reached.', + 'description' => '站点数量超出配额限制。', + ], + [ + 'errorCode' => 'Site.Conflict', + 'errorMessage' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', + 'description' => '站点冲突，多个账户下存在相同名称的站点，请删除或更名后重试。', + ], + [ + 'errorCode' => 'Site.AlreadyExist', + 'errorMessage' => 'The website name you specified already exists. Try with another name.', + 'description' => '您输入的站点已存在，请您重新设置。', + ], + [ + 'errorCode' => 'SubSiteUnavailable', + 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', + 'description' => '仅企业版支持以子域名创建站点，请升级您的套餐。', + ], + [ + 'errorCode' => 'Site.InvalidCoverage', + 'errorMessage' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', + 'description' => '您选择的加速区域不在当前套餐支持范围内，请更换为套餐支持的加速区域后重试。', + ], + [ + 'errorCode' => 'InvalidSiteICP', + 'errorMessage' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'description' => '您配置的站点未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + [ + 'errorCode' => 'InvalidSiteName', + 'errorMessage' => 'Invalid website name. Check and try again.', + 'description' => '您配置的站点名称不正确，请确保传入正确的站点名称后重试。', + ], + [ + 'errorCode' => 'Site.InBlacklist', + 'errorMessage' => 'The site name is in the blacklist.', + 'description' => '站点名称在黑名单中。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + ], + ], + 'title' => '创建站点', + 'description' => '- 创建站点之前，您必须拥有可用的套餐实例。'."\n" + .'- 如果加速区域包含中国内地，站点必须完成备案。', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-10T02:01:25.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-10-08T03:26:26.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateSite', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE\\",\\n \\"SiteId\\": 1234567890123,\\n \\"NameServerList\\": \\"ns1.example.com,ns2.example.com\\",\\n \\"VerifyCode\\": \\"verify_aah9dioasmov****\\"\\n}","type":"json"}]', + ], + 'CreateSiteCustomLog' => [ + 'summary' => '用于添加站点日志中的自定义请求头、响应头及Cookie字段配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238449', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11223', + ], + ], + [ + 'name' => 'RequestHeaders', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '请求头参数。', + 'type' => 'array', + 'items' => [ + 'description' => '单个请求头参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'x-acs-request-id', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResponseHeaders', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '响应头参数。', + 'type' => 'array', + 'items' => [ + 'description' => '单个响应头参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'X_Swift_Error', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Cookie参数。', + 'type' => 'array', + 'items' => [ + 'description' => '单个Cookie参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'sessionId', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '操作成功返回结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '073bd613-6e72-4461-b6bc-19326dfc6a9c', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'RealTimeLog.RegexpCheckFail', + 'errorMessage' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.', + 'description' => '您配置的参数字段中包含有非法字符，请检查后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建站点自定义日志字段', + 'description' => '- **自定义字段限制**：确保自定义字段的键名仅包含字母、数字、下划线或空格，避免使用其他异常字符，以免触发错误提示。'."\n" + .'- **参数传递**：通过`formData`提交`SiteId`、`RequestHeaders`、`ResponseHeaders`及`Cookies`数组，每个数组元素为对应的自定义字段名。'."\n" + .'- **SiteId必需**：尽管示例中未明确标记为必需，但实际上`SiteId`是调用此API时必须提供的站点标识。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateSiteCustomLog', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateSiteCustomLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"073bd613-6e72-4461-b6bc-19326dfc6a9c\\"\\n}","type":"json"}]', + ], + 'CreateSiteDeliveryTask' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239178', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'formData', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '业务类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1**（默认值）：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => true, + 'example' => 'dcdn_log_access_l1', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12312312112***', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据中心。取值为：'."\n" + .'- **cn**：中国内地。'."\n" + .'- **oversea**：海外（非中国内地）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'dcdn-test-task', + ], + ], + [ + 'name' => 'FieldName', + 'in' => 'formData', + 'schema' => [ + 'description' => '日志所选的字段，以英文逗号“，”隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'user_agent,ip_adress,ip_port', + ], + ], + [ + 'name' => 'DeliveryType', + 'in' => 'formData', + 'schema' => [ + 'description' => '投递类型：'."\n" + .'- **sls**： 阿里云日志服务。'."\n" + .'- **http**： http服务。'."\n" + .'- **aws3**： 亚马逊s3服务。'."\n" + .'- **oss**： 阿里云对象存储服务。'."\n" + .'- **kafka**： kafka服务。'."\n" + .'- **aws3cmpt**： 亚马逊s3兼容服务。', + 'type' => 'string', + 'required' => true, + 'example' => 'sls', + ], + ], + [ + 'name' => 'DiscardRate', + 'in' => 'formData', + 'schema' => [ + 'description' => '丢弃率不填则默认为0。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.0', + ], + ], + [ + 'name' => 'S3Delivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'S3/S3兼容投递配置参数。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '服务所在区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'BucketPath' => [ + 'description' => 'Bucket路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'logriver-test/log', + ], + 'AccessKey' => [ + 'description' => '阿里云账号或 RAM 用户的AccessKey ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAccessKeyID', + ], + 'SecretKey' => [ + 'description' => 'S3账号使用的SecretKey ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'LDSIKh***', + ], + 'Endpoint' => [ + 'description' => '服务器Endpoint，当S3Cmpt为true时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://s3.oss-cn-hangzhou.aliyuncs.com', + ], + 'PrefixPath' => [ + 'description' => '存储路径前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'logriver-test/log', + ], + 'S3Cmpt' => [ + 'description' => '是否为S3兼容。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ServerSideEncryption' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => '', + ], + 'VertifyType' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'OssDelivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'OSS投递配置。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'OSS区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'Aliuid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1234***', + ], + 'BucketName' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_rlog', + ], + 'PrefixPath' => [ + 'description' => 'OSS存储路径前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'test/', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'HttpDelivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'HTTP投递配置参数。', + 'type' => 'object', + 'properties' => [ + 'DestUrl' => [ + 'description' => 'HTTP服务器投递地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxx.aliyun.com/v1/log/upload', + ], + 'StandardAuthOn' => [ + 'description' => '是否使用标态鉴权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'StandardAuthParam' => [ + 'description' => '标态鉴权参数。', + 'type' => 'object', + 'properties' => [ + 'PrivateKey' => [ + 'description' => '私钥。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'ExpiredTime' => [ + 'description' => '加密超时时间。'."\n" + ."\n" + .'> '."\n" + .'> 大于0值，建议300以上', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + 'UrlPath' => [ + 'description' => '标态鉴权 uri 路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1/log/upload', + ], + ], + 'required' => false, + ], + 'MaxBatchSize' => [ + 'description' => '单次投递最大条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'MaxBatchMB' => [ + 'description' => '单次投递最大字节数，单位为MB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'MaxRetry' => [ + 'description' => '最大重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'TransformTimeout' => [ + 'description' => '超时等待时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'LogBodyPrefix' => [ + 'description' => '日志投递包前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdnVersion:1.0', + ], + 'LogBodySuffix' => [ + 'description' => '日志投递包尾缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdnVersion:1.0', + ], + 'Compress' => [ + 'description' => '压缩方式，默认不压缩。', + 'type' => 'string', + 'required' => false, + 'example' => 'gzip', + ], + 'HeaderParam' => [ + 'description' => '自定义Header头。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'StaticValue' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + 'description' => '', + ], + ], + 'QueryParam' => [ + 'description' => '自定义请求参数。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'StaticValue' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + 'description' => '', + ], + ], + 'LogSplit' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => '', + ], + 'LastLogSplit' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => '', + ], + 'LogSplitWords' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'KafkaDelivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Kafka投递配置参数。', + 'type' => 'object', + 'properties' => [ + 'Topic' => [ + 'description' => 'Kafka消息主题。', + 'type' => 'string', + 'required' => false, + 'example' => 'dqc_test2', + ], + 'UserAuth' => [ + 'description' => '是否开启用户鉴权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'MachanismType' => [ + 'description' => '加密方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'plain', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'Password' => [ + 'description' => '加密密码。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'Brokers' => [ + 'description' => '服务器数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'Kafka Broker服务器列表。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.xxx.xxx:9902', + ], + 'required' => false, + ], + 'Compress' => [ + 'description' => '压缩方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'lz4', + ], + 'Balancer' => [ + 'description' => '负载均衡方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'kafka.LeastBytes', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SlsDelivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'SLS投递配置。', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => [ + 'description' => 'SLS实时日志区域名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'SLSProject' => [ + 'description' => 'SLS实时日志名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'dcdn-test20240417', + ], + 'SLSLogStore' => [ + 'description' => 'SLS实时日志库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'accesslog-test', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'FilterVer', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9358E852-992D-5BC7-8BD7-975CA02773A8', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'er-oss', + ], + 'SiteId' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'DataCenter' => [ + 'description' => '数据中心。取值为：'."\n" + .'- **cn**：中国内地。'."\n" + .'- **oversea**：海外（非中国内地）。', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RealTimeLog.ProjectExistError', + 'errorMessage' => 'The real-time log delivery task name already exists. Check the task name and try again.', + 'description' => '该实时日志任务名称已存在，请重新检查任务名称后重试。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'RealTimeLog.KafkaBrokersExceedError', + 'errorMessage' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', + 'description' => '您可投递的实时日志Kafka Broker服务器地址数量超过上限(最高为50个)。', + ], + [ + 'errorCode' => 'RealTimeLog.S3EndpointInvalidError', + 'errorMessage' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', + 'description' => '您投递的S3地址不正确，请检查投递地址后重试。', + ], + [ + 'errorCode' => 'RealTimeLog.StatusQuotaError', + 'errorMessage' => 'The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'description' => '您的实时日志可投递数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多实时日志投递配额。', + ], + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'title' => '新建实时日志投递任务', + 'summary' => '新建一个实时日志投递任务。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-24T01:43:11.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-02-28T07:44:20.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-10-18T01:07:12.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-24T08:31:52.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateSiteDeliveryTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateSiteDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9358E852-992D-5BC7-8BD7-975CA02773A8\\",\\n \\"TaskName\\": \\"er-oss\\",\\n \\"SiteId\\": 0,\\n \\"DataCenter\\": \\"cn\\"\\n}","type":"json"}]', + ], + 'CreateTransportLayerApplication' => [ + 'summary' => '创建一个四层加速应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245117', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => [ + 'description' => '四层应用的域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'aaa.example.com', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '转发规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则详情。每一条规则，除备注外，其他参数为必填。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => '转发规则协议，取值：'."\n" + ."\n" + .'- TCP：TCP协议。'."\n" + .'- UDP：UDP协议。', + 'type' => 'string', + 'required' => true, + 'example' => 'TCP', + 'enum' => [ + 'TCP', + 'UDP', + ], + ], + 'EdgePort' => [ + 'description' => '边缘端口。支持：'."\n" + ."\n" + .'- 单个端口，例如80。'."\n" + .'- 端口范围，例如 81-85，代表端口 81、82、83、84、85。'."\n" + .'- 端口和端口范围组合，端口、端口范围之间用逗号分隔，例如80,81-85,90，代表端口80、81、82、83、84、85、90。'."\n" + ."\n" + .'单个规则的边缘端口以及多个规则之间的边缘端口不允许重叠。', + 'type' => 'string', + 'required' => true, + 'example' => '80', + ], + 'SourceType' => [ + 'description' => '源站类型，支持：'."\n" + .'- **ip**: IP。'."\n" + .'- **domain**: 域名。'."\n" + .'- **OP**: 源地址池。'."\n" + .'- **LB**: 负载均衡器。', + 'type' => 'string', + 'required' => true, + 'example' => 'ip', + 'enum' => [ + 'ip', + 'domain', + 'OP', + 'LB', + ], + ], + 'SourcePort' => [ + 'description' => '源站端口。支持：'."\n" + ."\n" + .'- 单个端口，当源站端口为单个端口时，支持任意合法的边缘端口组合。'."\n" + .'- 端口范围，仅当边缘端口为端口段时，源站端口才允许设置为端口范围且范围大小需要与边缘端口一致。例如边缘端口若为90-93，则不允许将源站端口设置为81-85，因为源站端口范围为5，边缘端口范围为3，两者不一致。', + 'type' => 'string', + 'required' => true, + 'example' => '80', + ], + 'ClientIPPassThroughMode' => [ + 'description' => '客户端IP传递协议，支持：'."\n" + .'- **off**: 不传递。'."\n" + .'- **PPv1**: PROXY Protocol v1协议，支持TCP协议的客户端IP传递。'."\n" + .'- **PPv2**: PROXY Protocol v2协议，支持TCP和UDP协议的客户端IP传递。'."\n" + .'- **SPP**: Simple Proxy Protocol协议，支持UDP协议的客户端IP传递。', + 'type' => 'string', + 'required' => true, + 'example' => 'SPP', + 'enum' => [ + 'off', + 'PPv2', + 'PPv1', + 'SPP', + ], + ], + 'Source' => [ + 'description' => '源站具体的值，需要与源站类型相匹配。', + 'type' => 'string', + 'required' => true, + 'example' => '1.1.1.1', + ], + 'Comment' => [ + 'description' => '规则的备注信息（可选）。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + [ + 'name' => 'IpAccessRule', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP访问规则开关，开启后，WAF中的 IP访问规则对四层应用生效。'."\n" + ."\n" + .'- on: 开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'Ipv6', + 'in' => 'query', + 'schema' => [ + 'description' => 'Ipv6开关。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'off', + ], + ], + [ + 'name' => 'CrossBorderOptimization', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启中国大陆网络接入优化，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'StaticIp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求响应详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9e5448c7-edaf-49aa-9887-0fcd0832306c', + ], + 'ApplicationId' => [ + 'description' => '四层应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '165503967****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordData', + 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', + 'description' => '记录内容参数错误，请根据接口文档调整参数内容。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordType', + 'errorMessage' => 'Invalid record type. Adjust your configurations based on the API documentation.', + 'description' => '记录类型错误，请根据接口文档调整参数内容。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'QuotaExceed.RecordCount', + 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', + 'description' => '记录数量已达上限，请删除部分记录后重试或升级套餐。', + ], + [ + 'errorCode' => 'Record.Conflict', + 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'TransportLayerRulesExceedLimit', + 'errorMessage' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', + 'description' => '您配置的转发规则已经超过了最大限制，请删除无用的转发规则后进行重试。', + ], + [ + 'errorCode' => 'TransportLayerApplicationConflict', + 'errorMessage' => 'The Layer -4 accelerated application conflicts with other applications. Check whether the application name and host record conflict with other applications in the site.', + 'description' => '您当前操作的四层加速应用与其他应用冲突，请检查应用名、主机记录等是否与该站点下的其他应用冲突。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidRecordName', + 'errorMessage' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', + 'description' => '您输入的记录名称不符合规范，请根据产品文档调整记录名称。', + ], + [ + 'errorCode' => 'EdgePortsOverlap', + 'errorMessage' => 'There is overlap between multiple edge ports, please check and try again after modification.', + 'description' => '多个边缘端口之间存在重叠，请检查后进行修改重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ClientIpPassThroughMode', + 'errorMessage' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', + 'description' => '无效的客户端IP传递协议，请参考接口文档，传入合法的参数。', + ], + [ + 'errorCode' => 'InvalidParameter.RuleSource', + 'errorMessage' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', + 'description' => '转发规则的源站不存在或者不合法，请传入正确的源站后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.Port', + 'errorMessage' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', + 'description' => '无效的边缘端口或者源站端口，请按照接口文档中的要求，传入合法的端口。', + ], + [ + 'errorCode' => 'InvalidParameter.Protocol', + 'errorMessage' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', + 'description' => '无效的端口协议，请按照接口文档的要求，传入合法的端口协议。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'IpaResourceUnavailable', + 'errorMessage' => 'The resource is unavailable.', + 'description' => '没有足够的资源可供新域名接入。', + ], + [ + 'errorCode' => 'Record.NoResource', + 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', + 'description' => '为记录分配资源失败，请提工单处理。', + ], + [ + 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', + 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', + 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'Site.NotActive', + 'errorMessage' => 'The status of the applied site or site is not activated.', + 'description' => '应用的站点或站点的状态不是已激活。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建四层加速应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9e5448c7-edaf-49aa-9887-0fcd0832306c\\",\\n \\"ApplicationId\\": 0\\n}","type":"json"}]', + ], + 'CreateUrlObservation' => [ + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264795', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456******', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '要监测的网页URL。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com/test', + 'enum' => [], + ], + ], + [ + 'name' => 'SdkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SDK集成方式。支持'."\n" + ."\n" + .'- **automatic**：自动集成。'."\n" + .'- **manual**：手动集成。', + 'type' => 'string', + 'required' => true, + 'example' => 'automatic', + 'enum' => [ + 'manual', + 'automatic', + ], + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建网页监测配置', + 'summary' => '创建网页监测配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-08-18T03:46:41.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateUrlObservation', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateUrlObservation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateUserDeliveryTask' => [ + 'summary' => '用于新建用户自定义的日志投递任务至SLS、HTTP、OSS、S3或Kafka等目标。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238999', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'formData', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => true, + 'example' => 'dcdn_log_access_l1', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据中心。取值：'."\n" + .'- **cn** ：中国内地。'."\n" + .'- **sg**： 全球（不包含中国内地）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'FieldName', + 'in' => 'formData', + 'schema' => [ + 'description' => '选择字段，以英文逗号分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'user_agent,ip_address,ip_port', + ], + ], + [ + 'name' => 'DeliveryType', + 'in' => 'formData', + 'schema' => [ + 'description' => '投递类型：'."\n" + ."\n" + .'- **sls**： 阿里云日志服务。'."\n" + .'- **http**： http服务。'."\n" + .'- **aws3**： 亚马逊s3服务。'."\n" + .'- **oss**： 阿里云对象存储服务。'."\n" + .'- **kafka**： kafka服务。'."\n" + .'- **aws3cmpt**： 亚马逊s3兼容服务。', + 'type' => 'string', + 'required' => true, + 'example' => 'sls', + ], + ], + [ + 'name' => 'DiscardRate', + 'in' => 'formData', + 'schema' => [ + 'description' => '丢弃率，不填则默认为0。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'S3Delivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 's3/s3兼容投递配置参数。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '服务所在区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'BucketPath' => [ + 'description' => 'Bucket存储路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'logriver-test/log', + ], + 'AccessKey' => [ + 'description' => 's3账号使用的AccessKey ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'g0f46623ll0g0', + ], + 'SecretKey' => [ + 'description' => 's3账号使用的SecretKey ID。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'Endpoint' => [ + 'description' => 'S3 endpoint地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://s3.oss-cn-hangzhou.aliyuncs.com', + ], + 'PrefixPath' => [ + 'description' => '存储路径前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'logriver-test/log', + ], + 'S3Cmpt' => [ + 'description' => '是否为s3兼容。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ServerSideEncryption' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => '', + ], + 'VertifyType' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'OssDelivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Oss投递配置参数。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'Oss区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'Aliuid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1234***', + ], + 'BucketName' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_rlog', + ], + 'PrefixPath' => [ + 'description' => 'Oss存储路径前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'test/', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'HttpDelivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Http投递配置参数。', + 'type' => 'object', + 'properties' => [ + 'DestUrl' => [ + 'description' => 'http服务器投递地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxx.aliyun.com/v1/log/upload', + ], + 'StandardAuthOn' => [ + 'description' => '是否使用标态鉴权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'StandardAuthParam' => [ + 'description' => '标态鉴权参数。', + 'type' => 'object', + 'properties' => [ + 'PrivateKey' => [ + 'description' => '密钥。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + 'ExpiredTime' => [ + 'description' => '过期时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + 'UrlPath' => [ + 'description' => 'URL路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1/log/upload', + ], + ], + 'required' => false, + ], + 'MaxBatchSize' => [ + 'description' => '单次投递最大条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'MaxBatchMB' => [ + 'description' => '单次投递最大字节数，单位为MB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'MaxRetry' => [ + 'description' => '最大重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'TransformTimeout' => [ + 'description' => '超时等待时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'LogBodyPrefix' => [ + 'description' => '日志投递包前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdnVersion:1.0', + ], + 'LogBodySuffix' => [ + 'description' => '日志投递包尾缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdnVersion:1.0', + ], + 'Compress' => [ + 'description' => '压缩方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'gzip', + ], + 'LogSplitWords' => [ + 'description' => '日志分隔符。', + 'type' => 'string', + 'required' => false, + 'example' => '\\n', + ], + 'HeaderParam' => [ + 'description' => '自定义Header头。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'StaticValue' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + 'description' => '自定义Header头值。', + ], + ], + 'description' => '自定义Header头名称。', + ], + ], + 'QueryParam' => [ + 'description' => '自定义请求参数。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'StaticValue' => [ + 'type' => 'string', + 'required' => false, + 'description' => '自定义请求参数值。', + 'example' => 'v1.1', + ], + ], + 'description' => '自定义请求参数名称。', + ], + ], + 'LogSplit' => [ + 'description' => '是否开启日志分割，默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'LastLogSplit' => [ + 'description' => '末尾分隔符。', + 'type' => 'boolean', + 'required' => false, + 'example' => '\\n', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'KafkaDelivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Kafka投递配置参数。', + 'type' => 'object', + 'properties' => [ + 'Topic' => [ + 'description' => 'Kafka消息主题。', + 'type' => 'string', + 'required' => false, + 'example' => 'dqc_test2', + ], + 'UserAuth' => [ + 'description' => '是否开启用户鉴权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'MachanismType' => [ + 'description' => '加密方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'plain', + ], + 'UserName' => [ + 'description' => '加密用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'Password' => [ + 'description' => '加密密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'Brokers' => [ + 'description' => '服务器数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'Kafka broker服务器列表。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.1:9902', + ], + 'required' => false, + ], + 'Compress' => [ + 'description' => '压缩方式，默认不压缩。', + 'type' => 'string', + 'required' => false, + 'example' => 'lz4', + ], + 'Balancer' => [ + 'description' => '负载均衡方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'kafka.LeastBytes', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SlsDelivery', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'SLS投递配置。', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => [ + 'description' => '日志服务（SLS）所在区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'SLSProject' => [ + 'description' => '日志服务(SLS) Project名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'dcdn-test20240417', + ], + 'SLSLogStore' => [ + 'description' => '日志服务(SLS) LogStore名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'accesslog-test', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Details', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + [ + 'name' => 'FilterVer', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2CCD40B1-3F20-5FF0-8A67-E3F34B87744F', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'er-http', + ], + 'DataCenter' => [ + 'description' => '数据中心。取值：'."\n" + .'- **cn**：中国内地。'."\n" + .'- **sg**： 全球（不包含中国内地）。', + 'type' => 'string', + 'example' => 'cn', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'online', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + ], + 403 => [ + [ + 'errorCode' => 'ErService.NotOpen', + 'errorMessage' => 'Er service has not opend.', + 'description' => '您没有开通边缘函数服务。', + ], + [ + 'errorCode' => 'RealTimeLog.S3EndpointInvalidError', + 'errorMessage' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', + 'description' => '您投递的S3地址不正确，请检查投递地址后重试。', + ], + [ + 'errorCode' => 'RealTimeLog.KafkaBrokersExceedError', + 'errorMessage' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', + 'description' => '您可投递的实时日志Kafka Broker服务器地址数量超过上限(最高为50个)。', + ], + [ + 'errorCode' => 'RealTimeLog.StatusQuotaError', + 'errorMessage' => 'The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'description' => '您的实时日志可投递数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多实时日志投递配额。', + ], + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建用户粒度日志投递任务', + 'description' => '本接口允许用户创建针对特定日志数据的投递任务，支持多种投递目标与详细的配置选项，包括但不限于SLS存储、HTTP服务、阿里云OSS、S3兼容存储以及Kafka消息队列。用户可自定义任务名称、选择日志字段、指定数据中心、设置丢弃率、选择投递类型，并根据所选类型配置相应的投递详情。'."\n" + ."\n" + .'- **字段筛选**：通过`FieldName`指定需要投递的日志字段。'."\n" + .'- **过滤规则**：利用`FilterRules`实现日志数据的预处理过滤。'."\n" + .'- **多样化投递**：支持SLS、HTTP(S)、阿里云OSS、S3兼容存储及Kafka等多种投递方式，每种方式有其特定的配置参数。'."\n" + ."\n" + .'## 注意事项'."\n" + .'- 确保提供的认证信息（如AccessKey、SecretKey）具有足够的权限执行投递操作。'."\n" + .'- 当选择加密或鉴权的投递方式时，正确配置相关的安全参数。'."\n" + .'- 验证`FilterRules`语法正确性，确保过滤逻辑符合预期。'."\n" + .'- 根据实际需求调整高级参数如重试次数、超时时间等，以优化投递效率与稳定性。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-24T01:43:11.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-12-26T08:21:56.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-10-18T01:07:12.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-24T08:31:53.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateUserDeliveryTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateUserDeliveryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CCD40B1-3F20-5FF0-8A67-E3F34B87744F\\",\\n \\"TaskName\\": \\"er-http\\",\\n \\"DataCenter\\": \\"cn\\",\\n \\"Status\\": \\"online\\"\\n}","type":"json"}]', + ], + 'CreateUserWafRuleset' => [ + 'summary' => '用于创建实例级别的Web应用防火墙规则集，支持多种类型的防护规则。', + 'description' => '## 请求说明'."\n" + .'- 本API允许用户为指定实例创建新的WAF（Web Application Firewall）规则集。'."\n" + .'- `InstanceId` 是必需参数，指定了要为其创建规则集的具体实例。'."\n" + .'- `Phase` 参数定义了规则集的应用阶段，例如自定义规则、频次控制等。'."\n" + .'- `Name` 和 `Expression` 是必填项，分别代表规则集的名字和具体的匹配表达式。'."\n" + .'- 可选参数 `Description` 提供了对规则集功能或用途的文字描述。'."\n" + .'- `Status` 控制着规则集是否立即生效 (`on`) 或者处于关闭状态 (`off`)。'."\n" + .'- 通过 `Rules` 参数可以进一步配置更详细的规则列表，每个规则都包含名称、位置、表达式及动作等属性。'."\n" + .'- 成功响应将返回新创建规则集的唯一标识符 `Id` 以及所有关联规则的ID列表 `RuleIds`。'."\n", + 'path' => '/', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'esa-site-ads11w', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF运行阶段。', + 'type' => 'string', + 'required' => true, + 'example' => 'http_custom', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a test ruleset.', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集状态。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + ], + ], + [ + 'name' => 'Expression', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集表达式。', + 'type' => 'string', + 'required' => true, + 'example' => 'ip.src == 1.1.1.1', + ], + ], + [ + 'name' => 'Shared', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'WAF批量规则共享配置。', + 'required' => false, + '$ref' => '#/components/schemas/WafBatchRuleShared', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'WAF规则集下的规则配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则集下的规则配置。', + 'required' => false, + '$ref' => '#/components/schemas/WafRuleConfig', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'Id' => [ + 'description' => 'WAF规则集的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'RuleIds' => [ + 'description' => 'WAF规则集下的规则ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则集下的规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '87570', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Rule.Config.Noncompliance', + 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', + 'description' => '指定的规则配置未满足既定的合规性标准。请检查规则设置，查找任何不符合或违反预期标准的差异，并进行必要的调整，以确保所有规则均得到正确验证。', + ], + [ + 'errorCode' => 'Rule.Config.Malformed', + 'errorMessage' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', + 'description' => '指定的规则配置格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致，并予以纠正，以符合预期的配置架构。', + ], + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建用户WAF规则集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Id\\": 0,\\n \\"RuleIds\\": [\\n 87570\\n ]\\n}","type":"json"}]', + ], + 'CreateVideoProcessing' => [ + 'summary' => '新增站点视频处理配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257663', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VideoSeekEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '拖拽播放功能开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'FlvVideoSeekMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'FLV拖拽模式。取值范围：'."\n" + .'- by_byte：按字节拖拽。'."\n" + .'- by_time：按时间拖拽。', + 'type' => 'string', + 'required' => false, + 'example' => 'by_byte', + ], + ], + [ + 'name' => 'Mp4SeekStart', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义mp4开始参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'start', + ], + ], + [ + 'name' => 'Mp4SeekEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义mp4结束参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'end', + ], + ], + [ + 'name' => 'FlvSeekStart', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义FLV开始参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'start', + ], + ], + [ + 'name' => 'FlvSeekEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义FLV结束参数 。', + 'type' => 'string', + 'required' => false, + 'example' => 'end', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816**********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '新增站点视频处理配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateVideoProcessing', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + ], + 'CreateWafRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239618', + 'abilityTreeNodes' => [ + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'formData', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段。', + 'type' => 'string', + 'required' => true, + 'example' => 'http_custom', + ], + ], + [ + 'name' => 'RulesetId', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000001', + 'minimum' => '1', + ], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => 'WAF规则配置', + 'description' => '规则配置，指定创建规则的详细配置。', + 'required' => false, + '$ref' => '#/components/schemas/WafRuleConfig', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'RulesetId' => [ + 'description' => 'WAF规则集的ID，可通过调用[ListWafRulesets](~~2878359~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'Id' => [ + 'description' => 'WAF规则的ID，可通过调用[ListWafRules](~~2878257~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Rule.Name.AlreadyExists', + 'errorMessage' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', + 'description' => '指定的规则名称在系统配置中已存在，不能重复使用。请选择一个不与现有规则名称冲突的独特规则名称，或在必要时考虑更改现有规则的名称，以消除任何可能的歧义，并确保每个规则标识符的唯一性。', + ], + [ + 'errorCode' => 'Rule.Config.Malformed', + 'errorMessage' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', + 'description' => '指定的规则配置格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致，并予以纠正，以符合预期的配置架构。', + ], + [ + 'errorCode' => 'Rule.Config.Noncompliance', + 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', + 'description' => '指定的规则配置未满足既定的合规性标准。请检查规则设置，查找任何不符合或违反预期标准的差异，并进行必要的调整，以确保所有规则均得到正确验证。', + ], + [ + 'errorCode' => 'Expression.Invalid', + 'errorMessage' => 'The specified expression is invalid: %s.', + 'description' => '指定的表达式是无效的。', + ], + [ + 'errorCode' => 'Ruleset.NotExist', + 'errorMessage' => 'The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system\'s rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect.', + 'description' => '指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确，并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体，请确保其创建和注册的必要步骤已经成功执行，以便其可用。', + ], + ], + ], + 'title' => '创建WAF规则', + 'summary' => '该接口用于在Web应用防火墙（WAF）中创建新的规则。这可以用于细化防火墙的行为，以提高网站或应用的安全性。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:52.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWafRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWafRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"RulesetId\\": 10000001,\\n \\"Id\\": 20000001\\n}","type":"json"}]', + ], + 'CreateWafRuleset' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264021', + 'abilityTreeNodes' => [ + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'formData', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'http_whitelist' => '白名单规则', + 'http_custom' => '自定义规则', + 'http_managed' => '托管规则', + 'http_anti_scan' => '扫描防护规则', + 'http_ratelimit' => '频次控制规则', + 'http_bot' => '高级模式Bots', + ], + 'example' => 'http_custom', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则集名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Id' => [ + 'description' => '规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Expression.Invalid', + 'errorMessage' => 'The specified expression is invalid: %s.', + 'description' => '指定的表达式是无效的。', + ], + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + ], + 'title' => '创建WAF规则集', + 'summary' => '创建WAF规则集。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWafRuleset', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWafRuleset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 10000001\\n}","type":"json"}]', + ], + 'CreateWaitingRoom' => [ + 'summary' => '创建站点等候室。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239586', + 'abilityTreeNodes' => [ + 'FEATUREdcdnO4KC7Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'waitingroom_example'."\n", + ], + ], + [ + 'name' => 'QueueAllEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '全部排队。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'HostNameAndPath', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '主机名和路径。', + 'type' => 'array', + 'items' => [ + 'description' => '主机名和路径详情。', + 'type' => 'object', + 'properties' => [ + 'Subdomain' => [ + 'description' => '子域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test.', + ], + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + 'Path' => [ + 'description' => '路径。', + 'type' => 'string', + 'required' => true, + 'example' => '/test', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + [ + 'name' => 'CookieName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义Cookie名称。', + 'type' => 'string', + 'required' => true, + 'example' => '__aliwaitingroom_example', + ], + ], + [ + 'name' => 'TotalActiveUsers', + 'in' => 'query', + 'schema' => [ + 'description' => '活跃用户总数。', + 'type' => 'string', + 'required' => true, + 'example' => '300', + ], + ], + [ + 'name' => 'NewUsersPerMinute', + 'in' => 'query', + 'schema' => [ + 'description' => '每分钟新用户数。', + 'type' => 'string', + 'required' => true, + 'example' => '200', + ], + ], + [ + 'name' => 'SessionDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '会话持续时间，单位是分钟。', + 'type' => 'string', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'DisableSessionRenewalEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '禁用会话续订。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'QueuingMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '排队方式。取值：'."\n" + ."\n" + .'- **random**：随机。'."\n" + .'- **fifo**：先进先出。'."\n" + .'- **passthrough**：直通。'."\n" + .'- **reject-all**：拒绝全部。', + 'type' => 'string', + 'required' => true, + 'example' => 'fifo', + 'enum' => [ + 'fifo', + 'random', + 'passthrough', + 'reject-all', + ], + ], + ], + [ + 'name' => 'QueuingStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室状态码。取值：'."\n" + ."\n" + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**', + 'type' => 'string', + 'required' => true, + 'example' => '200', + 'enum' => [ + '200', + '202', + '429', + ], + ], + ], + [ + 'name' => 'JsonResponseEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'JSON响应。开启后accept请求头包含"application/json"会返回JSON数据。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '等候室描述。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'WaitingRoomType', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室类型。支持以下类型：'."\n" + ."\n" + .'- **default**：默认类型。'."\n" + .'- **custom**：自定义类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + 'enum' => [ + 'default', + 'custom', + ], + ], + ], + [ + 'name' => 'CustomPageHtml', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '用户自定义等候室页面内容，当等候室类型为自定义类型时，需要传入。传入的内容需要经过base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'SGVsbG8gd29ybGQ=', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '等候室页面的语言，当等候室类型为默认类型时，需要传入。支持以下类型：'."\n" + .'- **enus**：英文。'."\n" + .'- **zhcn**：中文简体。'."\n" + .'- **zhhk**：中文繁体。', + 'type' => 'string', + 'required' => false, + 'example' => 'enus', + 'enum' => [ + 'enus', + 'zhcn', + 'zhhk', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '85H66C7B-671A-4297-9187-2C4477247A74', + ], + 'WaitingRoomId' => [ + 'type' => 'string', + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建等候室', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-12T02:01:32.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWaitingRoom', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWaitingRoom', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85H66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"WaitingRoomId\\": \\"\\"\\n}","type":"json"}]', + ], + 'CreateWaitingRoomEvent' => [ + 'summary' => '创建等候室事件，可以选择排队方式以及类型等。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239633', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVCBH9N', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'WaitingRoomId', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室ID，可通过调用[ListWaitingRooms](~~2850279~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '6a51d5bc6460887abd1291dc7d4db28b', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室事件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'waitingroom_example', + ], + ], + [ + 'name' => 'TotalActiveUsers', + 'in' => 'query', + 'schema' => [ + 'description' => '活跃用户总数。', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'NewUsersPerMinute', + 'in' => 'query', + 'schema' => [ + 'description' => '每分钟新用户数。', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'SessionDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '会话持续时间，单位是分钟。', + 'type' => 'string', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'DisableSessionRenewalEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '禁用会话续订。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'QueuingMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '排队方式。取值：'."\n" + ."\n" + .'- **random**：随机。'."\n" + .'- **fifo**：先进先出。'."\n" + .'- **passthrough**：直通。'."\n" + .'- **reject-all**：拒绝全部。', + 'type' => 'string', + 'required' => true, + 'example' => 'random', + 'enum' => [ + 'fifo', + 'random', + 'passthrough', + 'reject-all', + ], + ], + ], + [ + 'name' => 'QueuingStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室状态码。取值：'."\n" + ."\n" + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**', + 'type' => 'string', + 'required' => true, + 'example' => '202', + 'enum' => [ + '200', + '202', + '429', + ], + ], + ], + [ + 'name' => 'JsonResponseEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'JSON响应。开启后accept请求头包含"application/json"会返回JSON数据。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '等候室描述。', + 'type' => 'string', + 'required' => false, + 'example' => '测试等候室', + ], + ], + [ + 'name' => 'WaitingRoomType', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室类型。支持以下类型：'."\n" + ."\n" + .'- **default**：默认类型。'."\n" + .'- **custom**：自定义类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + 'enum' => [ + 'default', + 'custom', + ], + ], + ], + [ + 'name' => 'CustomPageHtml', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '用户自定义等候室页面内容，当等候室类型为自定义类型时，需要传入。传入的内容需要经过base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'SGVsbG8gd29ybGQ=', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '事件开始时间戳。', + 'type' => 'string', + 'required' => true, + 'example' => '1719763200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '事件结束时间戳。', + 'type' => 'string', + 'required' => true, + 'example' => '1719849600', + ], + ], + [ + 'name' => 'PreQueueEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '预排队开关。'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'PreQueueStartTime', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '预排队开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '1719763200', + ], + ], + [ + 'name' => 'RandomPreQueueEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '随机排队开关。'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '等候室页面的语言，当等候室类型为默认类型时，需要传入。支持以下类型：'."\n" + ."\n" + .'- **enus**：英文。'."\n" + .'- **zhcn**：中文简体。'."\n" + .'- **zhhk**：中文繁体。', + 'type' => 'string', + 'required' => false, + 'example' => 'zhcn', + 'enum' => [ + 'enus', + 'zhcn', + 'zhhk', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', + ], + 'WaitingRoomEventId' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建等候室事件', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-12T02:01:32.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWaitingRoomEvent', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWaitingRoomEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\",\\n \\"WaitingRoomEventId\\": 0\\n}","type":"json"}]', + ], + 'CreateWaitingRoomRule' => [ + 'summary' => '创建一个等候室绕过规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239640', + 'abilityTreeNodes' => [ + 'FEATUREdcdnA885EB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'WaitingRoomId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要绕过的等候室ID。', + 'type' => 'string', + 'required' => true, + 'example' => '25133f536f1b1f6b6091f6a92c614dd4', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'waitingroom_example'."\n", + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => true, + 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'WaitingRoomRuleId' => [ + 'description' => '等候室绕过规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '420072638347264', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '创建等候室绕过规则', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-12T02:01:32.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWaitingRoomRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWaitingRoomRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"WaitingRoomRuleId\\": 420072638347264\\n}","type":"json"}]', + ], + 'DeactivateVersionManagement' => [ + 'summary' => '关闭站点的版本管理功能。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238972', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '关闭站点版本管理', + 'description' => '需要在仅有版本0与默认环境的情况下，才能关闭。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeactivateVersionManagement', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:DeactivateVersionManagement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C\\"\\n}","type":"json"}]', + ], + 'DeleteCacheRule' => [ + 'summary' => '删除缓存配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257616', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3500241*********', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListCacheRules](~~ListCacheRules~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3528160*********', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除站点缓存配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteCacheRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCacheRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\"\\n}","type":"json"}]', + ], + 'DeleteCertificate' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238835', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书Id。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaded901474b9693acf530e0fb1d95', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d95', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F5A19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除站点证书', + 'summary' => '删除站点下的特定证书。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Id\\": \\"babaded901474b9693acf530e0fb1d95\\",\\n \\"RequestId\\": \\"F32C57AA-7BF8-49AE-A2CC-9F42390F5A19\\"\\n}","type":"json"}]', + ], + 'DeleteClientCaCertificate' => [ + 'summary' => '删除指定的客户端CA证书。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239205', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除客户端CA证书', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteClientCaCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteClientCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'DeleteClientCertificate' => [ + 'summary' => '删除已吊销的客户端证书。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238905', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除客户端证书', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'DeleteCompressionRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257667', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListCompressionRules](~~2867498~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除压缩规则配置', + 'summary' => '删除站点的压缩规则配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteCompressionRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCompressionRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', + ], + 'DeleteCustomHostname' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239584', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4DMKZ4', + ], + ], + 'parameters' => [ + [ + 'name' => 'HostnameId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义主机名ID。', + 'description' => 'SaaS 域名的 ID，可通过调用[ListCustomHostnames](~~3018667~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'Record.ServiceBusy', + 'errorMessage' => 'The record is being configured. Try again later.', + 'description' => '该记录正在配置中，请稍后再试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'CustomHostname.NotFound', + 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', + 'description' => '该自定义主机名不存在，请调整后重试。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除 SaaS 域名', + 'summary' => '根据 HostnameId，删除站点下的单条 SaaS 域名。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\"\\n}","type":"json"}]', + ], + 'DeleteCustomResponseCodeRule' => [ + 'summary' => '删除站点的修改响应码配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257650', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '478016908379824', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '434497172875264', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除修改响应码配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', + ], + 'DeleteCustomScenePolicy' => [ + 'summary' => '删除指定的定制场景策略配置信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239258', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID，可通过调用[DescribeCustomScenePolicies](~~2850508~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + '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' => '5CC228B4-7A67-4016-9C9F-4A4133494A91', + ], + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'PolicyNotExist', + 'errorMessage' => 'The policy does not exist.', + 'description' => '策略不存在。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除定制场景策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteCustomScenePolicy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC228B4-7A67-4016-9C9F-4A4133494A91\\",\\n \\"PolicyId\\": 1\\n}","type":"json"}]', + ], + 'DeleteEdgeContainerApp' => [ + 'summary' => '根据应用ID删除不再需要的边缘容器应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238431', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1232321454***', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'State' => [ + 'description' => '删除状态。', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Record.AlreadyExist', + 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + ], + [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除边缘容器应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteEdgeContainerApp', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteEdgeContainerApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"State\\": \\"ok\\"\\n}","type":"json"}]', + ], + 'DeleteEdgeContainerAppImageSecret' => [ + 'summary' => '删除边缘容器应用的镜像秘钥', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像秘钥名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'reg-123*****', + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidParameter.Appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除边缘容器应用镜像秘钥', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', + ], + 'DeleteEdgeContainerAppRecord' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239235', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'formData', + 'schema' => [ + 'description' => '关联域名名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'a.example.com', + 'maxLength' => 1024, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除某个边缘容器应用的关联域名', + 'summary' => '删除某个边缘容器应用的关联域名，删除之后则无法再通过此域名访问到边缘容器服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteEdgeContainerAppRecord', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteEdgeContainerAppRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'DeleteEdgeContainerAppVersion' => [ + 'summary' => '删除边缘容器应用的版本。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238348', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-96253477062511****', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的版本ID，您可以调用[ListEdgeContainerAppVersions](~~ListEdgeContainerAppVersions~~)接口获取版本ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ver-89884764010378****', + ], + ], + ], + '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' => 'b021e538-9dde-46ed-a1f2-9469da8f3e77', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除边缘容器应用的指定版本', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteEdgeContainerAppVersion', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"b021e538-9dde-46ed-a1f2-9469da8f3e77\\"\\n}","type":"json"}]', + ], + 'DeleteHttpDDoSIntelligentRule' => [ + 'summary' => '删除深度学习和防护下发的规则', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263721', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + 'minLength' => 1, + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '20928021', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'SiteId' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20757864', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'The specified SiteId is invalid.', + 'description' => '站点ID参数非法。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + [ + 'errorCode' => 'InvalidParameter.ApiShieldSellVerison', + 'errorMessage' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', + 'description' => '该站点没有操作API安全功能企业级能力相关权限。', + ], + [ + 'errorCode' => 'SiteVersion.NotExist', + 'errorMessage' => 'The specified version is invalid or version management is not enabled for your website.Make sure that you specify a valid version and version management is enabled. Then, try again.', + 'description' => '传入的站点版本无效或当前站点尚未开通版本管理功能。请您检查配置的版本是否正确后重试，若尚未开通版本管理功能请开通后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除深度学习和防护下发的规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpDDoSIntelligentRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"SiteId\\": 0,\\n \\"RecordName\\": \\"www.example.com\\",\\n \\"RuleId\\": 20757864\\n}","type":"json"}]', + ], + 'DeleteHttpIncomingRequestHeaderModificationRule' => [ + 'summary' => '删除站点的修改HTTP入站请求头配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257650', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '54362329990032', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用ListHttpIncomingRequestHeaderModificationRules接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '427428371703808', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除修改HTTP入站请求头配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpIncomingRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', + ], + 'DeleteHttpIncomingResponseHeaderModificationRule' => [ + 'summary' => '删除站点的修改HTTP入站响应头配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257656', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '672344269424192', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用ListHttpIncomingResponseHeaderModificationRules接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除修改HTTP入站响应头配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpIncomingResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'DeleteHttpRequestHeaderModificationRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257650', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListHttpRequestHeaderModificationRules](~~ListHttpRequestHeaderModificationRules~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3528160969****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除修改HTTP请求头配置', + 'summary' => '删除站点的修改HTTP请求头配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteHttpRequestHeaderModificationRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', + ], + 'DeleteHttpResponseHeaderModificationRule' => [ + 'summary' => '删除站点的修改HTTP响应头配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257656', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListHttpResponseHeaderModificationRules](~~2867489~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除修改HTTP响应头配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteHttpResponseHeaderModificationRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', + ], + 'DeleteHttpsApplicationConfiguration' => [ + 'summary' => '删除HTTPS应用配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257618', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[listHttpsApplicationConfigurations](~~2869087~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + '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' => '35C66C7B-671H-4297-9187-2C4477247A78', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除站点HTTPS应用配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteHttpsApplicationConfiguration', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpsApplicationConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', + ], + 'DeleteHttpsBasicConfiguration' => [ + 'summary' => '删除HTTPS基础配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257619', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListHttpsBasicConfigurations](~~ListHttpsBasicConfigurations~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3528160969****', + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除站点HTTPS基础配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteHttpsBasicConfiguration', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpsBasicConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'DeleteImageTransform' => [ + 'summary' => '删除站点图片转换配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257355', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListImageTransforms](~~2869056~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除站点图片转换配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteImageTransform', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteImageTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'DeleteKv' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238798', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的Key名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_key', + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除KV存储空间的单个键值对', + 'summary' => '从KV存储空间中删除一个特定的键值对。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteKv', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', + ], + 'DeleteKvNamespace' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239195', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + 'maxLength' => 64, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除KV存储空间', + 'summary' => '删除账号拥有的单个KV存储空间。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-03T01:43:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteKvNamespace', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteKvNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', + ], + 'DeleteList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239621', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '列表ID', + 'description' => '自定义列表的ID，可通过调用[ListLists](~~2850217~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '40000001', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'List.BeingBound', + 'errorMessage' => 'The specified list is being bound.', + 'description' => '指定的列表正在被一个或多个防护规则绑定。', + ], + [ + 'errorCode' => 'List.NotExist', + 'errorMessage' => 'The specified list does not exist.', + 'description' => '指定的列表不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除自定义列表', + 'summary' => '删除自定义列表，如果不再需要某个列表，可以通过此接口进行删除。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:49.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'DeleteLoadBalancer' => [ + 'summary' => '删除指定的负载均衡器。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238494', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器ID，用于唯一标识要查询的负载均衡器，负载均衡器创建时会直接返回，也可以通 [ListLoadBalancers](~~2868897~~) 接口获取站点下所有负载均衡器查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '99867648760****', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1159101787****', + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'LoadBalancerNotExist', + 'errorMessage' => 'The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.', + 'description' => '传入的站点负载均衡器无效或当前站点尚未开通负载均衡功能。请您检查负载均衡器名称配置的是否正确后重试，若尚未开通负载均衡功能请开通后重试。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除负载均衡器', + 'description' => '通过负载均衡器ID，删除负载均衡器，一次只能删除一条。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteLoadBalancer', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteLoadBalancer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'DeleteNetworkOptimization' => [ + 'summary' => '删除网络优化配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257620', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListNetworkOptimizations](~~2869051~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816**********', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除站点网络优化配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteNetworkOptimization', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteNetworkOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'DeleteOriginCaCertificate' => [ + 'summary' => '删除源服务器CA证书。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261743', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaabcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除源服务器CA证书', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginCaCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', + ], + 'DeleteOriginClientCertificate' => [ + 'summary' => '删除域名粒度回源客户端证书。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261752', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaabcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'title' => '删除域名粒度回源客户端证书', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'DeleteOriginPool' => [ + 'summary' => '传入源地址池ID，删除一条源地址池。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238349', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '源地址池ID，可通过调用[ListOriginPools](~~ListOriginPools~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '103852052519****', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21655860979****', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'OriginPoolNotExist', + 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', + 'description' => '传入的源地址池不存在，或该地址池不属于当前用户和站点，请您确认后重试。', + ], + [ + 'errorCode' => 'PoolReferenceExist', + 'errorMessage' => 'Failed to delete the origin pool because it has been referenced.Remove all references to the pool and try again.', + 'description' => '源地址池存在引用，不允许删除。请解除引用关系后重试。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除源地址池', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginPool', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'DeleteOriginProtection' => [ + 'summary' => '关闭源站防护功能。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250118', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4VDL9A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OriginProtectionNotExist', + 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', + 'description' => '站点没有配置源站防护，所以不能对其进行修改或删除。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '关闭源站防护', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-21T06:58:57.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginProtection', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\"\\n}","type":"json"}]', + ], + 'DeleteOriginRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257621', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3400350********', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListOriginRules](~~ListOriginRules~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '33793140540****', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除站点回源规则配置', + 'summary' => '删除回源规则配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'DeletePage' => [ + 'summary' => '删除已创建的自定义响应页面。当一个自定义的响应页面不再需要时，用户可以调用此接口来将其从系统中移除。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239625', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '自定义响应页面的ID', + 'description' => '自定义响应页面的ID，可通过调用[ListPages](~~2850223~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50000001', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Id' => [ + 'title' => '自定义响应页面的ID', + 'description' => '自定义响应页面的ID，可通过调用[ListPages](~~2850223~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Page.BeingBound', + 'errorMessage' => 'Failed to delete the custom error page because it has been associated with one or more rules.'."\n" + ."\n" + .'Dissociate all rules from the error page first.', + 'description' => '指定的自定义错误页面无法删除，因为它当前正被系统中的一个或多个规则所绑定。在可以删除之前，需要先将错误页面与所有相关的规则解绑。请先审查规则配置，然后解除与错误页面的关联，再尝试删除，以确保系统的一致性和可靠的错误处理。', + ], + [ + 'errorCode' => 'Page.NotExist', + 'errorMessage' => 'The specified custom error page does not exist or is not recognized by the system.Check whether the error page identifier is correct and matches an error page that has been created and registered in the system\'s error handling framework.If you want to create a new error page, make sure that the creation process is complete.', + 'description' => '指定的自定义错误页面不存在，或者未被系统识别。请确保错误页面的标识符是正确的，并且该页面已经被妥善地在系统的错误处理框架中创建和注册。如果打算新增一个错误页面，请验证创建过程是否已成功完成。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除自定义响应页面', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:48.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeletePage', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeletePage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 50000001\\n}","type":"json"}]', + ], + 'DeleteRecord' => [ + 'summary' => '根据RecordId，删除站点下的单条DNS解析记录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239584', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '记录的ID，可以通过[ListRecords](~~2850265~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'Record.Reserved', + 'errorMessage' => 'Another operation on the record is in progress. Try again later.', + 'description' => '记录操作正在进行中，请稍等重试。', + ], + [ + 'errorCode' => 'Record.ServiceBusy', + 'errorMessage' => 'The record is being configured. Try again later.', + 'description' => '该记录正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'Record.ProtectedAsCustomHostnameSource', + 'errorMessage' => 'Failed to delete the record because it is the origin server of existing custom hostnames.Remove all references to the record and try again.', + 'description' => '该记录是已有自定义主机名的源站，不允许删除。请移除所有对该记录的引用后重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'Record.NotFound', + 'errorMessage' => 'The record does not exist. Check your configurations and try again.', + 'description' => '传入的请求记录不存在，请检查您的输入参数后重试。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除DNS记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRecord', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', + ], + 'DeleteRedirectRule' => [ + 'summary' => '删除站点的重定向配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257661', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListRedirectRules](~~ListRedirectRules~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BF9B849D-D847-5B16-9371-8ECB557A5921', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除重定向配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRedirectRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRedirectRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF9B849D-D847-5B16-9371-8ECB557A5921\\"\\n}","type":"json"}]', + ], + 'DeleteRewriteUrlRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257645', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListRewriteUrlRules](~~2867480~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除重写URL配置', + 'summary' => '删除站点的重写URL配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRewriteUrlRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRewriteUrlRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', + ], + 'DeleteRoutine' => [ + 'summary' => '删除边缘数Routine。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238943', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Status' => [ + 'description' => '接口操作状态，成功或失败。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'DependedByOthers', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SiteParameterNotMatch', + 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', + 'description' => '输入的站点相关参数校验失败。请检查参数正确性后重试。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'ParameterNotExist', + 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', + 'description' => '输入参数不存在，请您核对后重试。', + ], + [ + 'errorCode' => 'CodeVersionInUse', + 'errorMessage' => 'Failed to delete the code version because it is being used. Before you delete it, roll back to the previous version.', + 'description' => '代码版本正在使用中，无法直接删除，请先将此版本回滚到上一版本，然后再尝试删除操作。', + ], + [ + 'errorCode' => 'UserOperationStatusIsLocked', + 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', + 'description' => '您正在调用其他操作函数相关的接口，请等待其他接口调用完成后重试。', + ], + ], + ], + 'title' => '删除边缘函数', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-04T05:48:48.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-11-05T06:54:07.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRoutine', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteRoutine', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'DeleteRoutineCodeVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238902', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'CodeVersion', + 'in' => 'formData', + 'schema' => [ + 'description' => '代码版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1710120201067203242', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Status' => [ + 'description' => '接口操作状态，成功或失败。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'DependedByOthers', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SiteParameterNotMatch', + 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', + 'description' => '输入的站点相关参数校验失败。请检查参数正确性后重试。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'ParameterNotExist', + 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', + 'description' => '输入参数不存在，请您核对后重试。', + ], + [ + 'errorCode' => 'CodeVersionInUse', + 'errorMessage' => 'Failed to delete the code version because it is being used. Before you delete it, roll back to the previous version.', + 'description' => '代码版本正在使用中，无法直接删除，请先将此版本回滚到上一版本，然后再尝试删除操作。', + ], + [ + 'errorCode' => 'UserOperationStatusIsLocked', + 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', + 'description' => '您正在调用其他操作函数相关的接口，请等待其他接口调用完成后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除边缘函数版本代码', + 'summary' => '删除边缘函数Routine某版本代码。', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-04T05:48:47.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-11-05T06:54:07.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRoutineCodeVersion', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteRoutineCodeVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'DeleteRoutineRelatedRecord' => [ + 'summary' => '删除边缘函数Routine的关联记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239362', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-xxx', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'formData', + 'schema' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345'."\n", + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'formData', + 'schema' => [ + 'description' => '记录名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-xxx.example.com', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Status' => [ + 'description' => '接口操作状态。 '."\n" + .' * **OK**：成功。 '."\n" + .' * **Fail**：失败。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'DependedByOthers', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SiteParameterNotMatch', + 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', + 'description' => '输入的站点相关参数校验失败。请检查参数正确性后重试。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'ParameterNotExist', + 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', + 'description' => '输入参数不存在，请您核对后重试。', + ], + [ + 'errorCode' => 'UserOperationStatusIsLocked', + 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', + 'description' => '您正在调用其他操作函数相关的接口，请等待其他接口调用完成后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除边缘函数关联记录', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-04T05:48:48.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-11-05T06:54:06.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteRoutineRelatedRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'DeleteRoutineRoute' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266192', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11223***', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListSiteRoutes](~~2879631~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3528160969****', + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'title' => '删除边缘函数路由配置', + 'summary' => '删除边缘函数路由配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRoutineRoute', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRoutineRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'DeleteScheduledPreloadExecution' => [ + 'summary' => '根据预热计划ID删除单个定时预热计划。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238929', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => '665d3b48621bccf3fe29e1a7', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除单个定时预热计划', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteScheduledPreloadExecution', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:DeleteScheduledPreloadExecution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'DeleteScheduledPreloadJob' => [ + 'summary' => '根据定时预热任务ID删除指定定时预热任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239180', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '定时预热任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '665d3af3621bccf3fe29e1a4'."\n", + ], + ], + ], + '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' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除指定定时预热任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteScheduledPreloadJob', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteScheduledPreloadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', + ], + 'DeleteSite' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239599', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'NameServerNotDelete', + 'errorMessage' => 'Before deleting the site, you need to go to your domain name service provider to delete the NS record assigned by ESA for the site (to avoid that you forget to delete NS and other users steal your site).', + 'description' => '删除站点前，您需要前往您的域名服务商删除ESA为该站点分配的NS记录（避免您忘记删除NS造成其他用户盗用您的站点）。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除单个站点', + 'summary' => '根据站点ID删除一个站点。', + 'changeSet' => [ + [ + 'createdAt' => '2025-01-10T01:51:16.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteSite', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteSite', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\"\\n}","type":"json"}]', + ], + 'DeleteSiteDeliveryTask' => [ + 'summary' => '删除正在进行的日志任务投递。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239145', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456******', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'cdn-test-task', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除实时日志任务投递', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-18T01:07:12.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteSiteDeliveryTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteSiteDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', + ], + 'DeleteSiteOriginClientCertificate' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261745', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaabcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'title' => '删除站点粒度回源客户端证书', + 'summary' => '删除站点粒度回源客户端证书。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteSiteOriginClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteSiteOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'DeleteTransportLayerApplication' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245121', + 'abilityTreeNodes' => [ + 'FEATUREdcdn2E10XY', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可通过调用[ListTransportLayerApplications](~~ListTransportLayerApplications~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '170996390868****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90510C29-1E40-5A11-93F1-B9F5EDF57EE1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'TransportLayerApplicationNotExist', + 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', + 'description' => '当前操作的四层加速应用不存在，请修改后重试。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'IpaNotActive', + 'errorMessage' => 'The ipa application is not active.', + 'description' => '当前应用正在部署中。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除四层加速应用', + 'summary' => '删除四层加速应用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteTransportLayerApplication', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90510C29-1E40-5A11-93F1-B9F5EDF57EE1\\"\\n}","type":"json"}]', + ], + 'DeleteUrlObservation' => [ + 'summary' => '删除网页监测配置。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264796', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID，可通过调用[ListUrlObservations](~~ListUrlObservations~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除网页监测配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteUrlObservation', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteUrlObservation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'DeleteUserDeliveryTask' => [ + 'summary' => '根据指定任务名与阿里云UID删除用户任务投递配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239170', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应成功时的结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '952ea16b-1f05-4a76-bb32-420282d8aeb9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ErService.HasOpened', + 'errorMessage' => 'You have already activated Edge Routine.', + 'description' => '您已开通边缘函数服务，无需重复开通。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除用户投递任务', + 'description' => '本接口允许用户根据指定的**任务名**及**阿里云UID**来删除已设置的任务投递配置。操作前请确保提供的信息准确无误，以避免影响相关日志或数据的正常处理。'."\n" + ."\n" + .'**注意：**'."\n" + .'- 删除操作不可逆，请谨慎操作。'."\n" + .'- 需要具有相应权限的账号才能调用此接口。'."\n" + .'- 返回的 `RequestId` 可用于追踪请求处理进度及排查问题。', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-18T01:07:11.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteUserDeliveryTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteUserDeliveryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952ea16b-1f05-4a76-bb32-420282d8aeb9\\"\\n}","type":"json"}]', + ], + 'DeleteUserWafRuleset' => [ + 'summary' => '用于删除指定实例下的特定WAF规则集。', + 'description' => '## 请求说明'."\n" + .'- `InstanceId` 和 `Id` 是必需参数，分别指定了要操作的WAF实例ID和具体的规则集ID。'."\n", + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'esa-xxxxxxx', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Ruleset.NotExist', + 'errorMessage' => 'The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system\'s rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect.', + 'description' => '指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确，并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体，请确保其创建和注册的必要步骤已经成功执行，以便其可用。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除用户WAF规则集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteUserWafRuleset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx-xxxx-xxxx\\"\\n}","type":"json"}]', + ], + 'DeleteVideoProcessing' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257667', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListVideoProcessings](~~ListVideoProcessings~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6abd807e-ed2a-44de-ac54-ac38a62472e6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => 'The specified configid does not exist.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除站点视频处理配置', + 'summary' => '删除站点视频处理配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteVideoProcessing', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6abd807e-ed2a-44de-ac54-ac38a62472e6\\"\\n}","type":"json"}]', + ], + 'DeleteWafRule' => [ + 'summary' => '该接口用于删除Web应用防火墙（WAF）中的指定规则，此操作将删除与该规则相关联的配置和条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239585', + 'abilityTreeNodes' => [ + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '规则ID', + 'description' => 'WAF规则的ID，可通过调用[ListWafRules](~~2878257~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20000001', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'Rule.NotExist', + 'errorMessage' => 'The specified rule does not exist.', + 'description' => '指定的规则在当前上下文或系统配置中不存在。请确认规则标识符的存在，并确保它已被正确定义或实现。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除WAF规则', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:52.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWafRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWafRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'DeleteWafRuleset' => [ + 'summary' => '删除指定的WAF规则集。通过此接口，用户可以移除不再需要的Web应用防火墙规则集。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239657', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '规则集ID', + 'description' => 'WAF规则集的ID，可通过调用[ListWafRulesets](~~2878359~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000001', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Ruleset.NotExist', + 'errorMessage' => 'The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system\'s rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect.', + 'description' => '指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确，并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体，请确保其创建和注册的必要步骤已经成功执行，以便其可用。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除WAF规则集', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:51.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWafRuleset', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWafRuleset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'DeleteWaitingRoom' => [ + 'summary' => '通过站点删除等候室。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239636', + 'abilityTreeNodes' => [ + 'FEATUREdcdnO4KC7Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'WaitingRoomId', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室ID。', + 'type' => 'string', + 'required' => true, + 'example' => '25133f536f1b1f6b6091f6a92c614dd4'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'WaitingRoomRuleNotExist', + 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', + 'description' => '您要修改的等候室绕过规则不存在，请检查并传入正确的等候室绕过规则。', + ], + [ + 'errorCode' => 'WaitingRoomEventNotExist', + 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', + 'description' => '您要修改的等候室事件不存在，请检查并传入正确的等候室事件。', + ], + [ + 'errorCode' => 'WaitingRoomNotExist', + 'errorMessage' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.', + 'description' => '您要修改的等候室不存在或不属于您，请确认后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除等候室', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWaitingRoom', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWaitingRoom', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\"\\n}","type":"json"}]', + ], + 'DeleteWaitingRoomEvent' => [ + 'summary' => '删除等候室对应的事件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239623', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVCBH9N', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'WaitingRoomEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '302909890***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'WaitingRoomRuleNotExist', + 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', + 'description' => '您要修改的等候室绕过规则不存在，请检查并传入正确的等候室绕过规则。', + ], + [ + 'errorCode' => 'WaitingRoomEventNotExist', + 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', + 'description' => '您要修改的等候室事件不存在，请检查并传入正确的等候室事件。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + ], + 'title' => '删除等候室事件', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-21T03:25:57.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWaitingRoomEvent', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWaitingRoomEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'DeleteWaitingRoomRule' => [ + 'summary' => '通过站点删除等候室绕过规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239632', + 'abilityTreeNodes' => [ + 'FEATUREdcdnA885EB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'WaitingRoomRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '要更新的等候室绕过规则ID，可通过调用[ListWaitingRoomRules](~~2850279~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3672886****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'WaitingRoomRuleNotExist', + 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', + 'description' => '您要修改的等候室绕过规则不存在，请检查并传入正确的等候室绕过规则。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + ], + 'title' => '删除等候室绕过规则', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-21T03:25:57.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWaitingRoomRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWaitingRoomRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'DescribeCustomScenePolicies' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239312', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**10**，可选值：**5**，**10**，**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + 'enum' => [ + '5', + '10', + '20', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。取值范围为：**1~100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '1234****', + ], + ], + ], + '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' => '85H66C7B-671A-4297-9187-2C4477247A74', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Quota' => [ + 'description' => '配置额度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DataModule' => [ + 'description' => '定制场景策略配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '定制场景策略配置信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '定制场景策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Template' => [ + 'description' => '模板名称。取值：'."\n" + .'- **promotion**：重大活动', + 'type' => 'string', + 'example' => 'promotion', + ], + 'StartTime' => [ + 'description' => '策略生效开始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-03-04T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '策略生效结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-03-06T16:00:00Z'."\n", + ], + 'Status' => [ + 'description' => '策略的生效状态，取值：'."\n" + .'- **Disabled**：已被禁用'."\n" + .'- **Pending**：等待生效'."\n" + .'- **Running**：运行生效'."\n" + .'- **Expired**：过期失效', + 'type' => 'string', + 'example' => 'Expired', + ], + 'Objects' => [ + 'description' => '关联的站点ID信息列表。'."\n" + ."\n" + .'> 该字段为待废弃字段，建议读取SiteIds字段内容。', + 'type' => 'array', + 'items' => [ + 'description' => '策略关联的站点ID。', + 'type' => 'string', + 'example' => '123456****', + ], + ], + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234****'."\n", + ], + 'SiteIds' => [ + 'description' => '关联的站点ID，多个站点ID用逗号（","）分割。', + 'type' => 'string', + 'example' => '123456****,123457****'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询定制场景策略', + 'summary' => '查询定制场景策略配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-03T09:31:40.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-02-19T08:08:25.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCustomScenePolicies', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeCustomScenePolicies', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85H66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"TotalCount\\": 1,\\n \\"Quota\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataModule\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"Template\\": \\"promotion\\",\\n \\"StartTime\\": \\"2023-03-04T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-03-06T16:00:00Z\\\\n\\",\\n \\"Status\\": \\"Expired\\",\\n \\"Objects\\": [\\n \\"123456****\\"\\n ],\\n \\"PolicyId\\": 0,\\n \\"SiteIds\\": \\"123456****,123457****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDDoSAllEventList' => [ + 'summary' => '该接口用于查询DDoS攻击事件列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239644', + 'abilityTreeNodes' => [ + 'FEATUREdcdnO1ZP9O', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '查询的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-02-12T15:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'开始结束时间跨度最长不超过31天。'."\n" + ."\n" + .'不设置该参数表示选取当前时间作为查询的结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-02-22T15:59:59Z', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '待查询的DDoS攻击事件的类型。取值：'."\n" + .'- **web-cc**：表示Web资源耗尽型攻击。'."\n" + .'- **cc**：表示连接型攻击。'."\n" + .'- **traffic**：表示流量型攻击。'."\n" + ."\n" + .'不设置该参数表示查询Web资源耗尽型攻击事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'web-cc', + 'enum' => [ + 'web-cc', + 'cc', + 'traffic', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。取值范围为：**1**~**100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**10**，支持**5**、**10**、**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + 'enum' => [ + '5', + '10', + '20', + ], + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '7096621098****', + ], + ], + ], + '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' => 'D73A4243-CFBD-5110-876F-09237E77ECBD', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7096621098****', + ], + 'TotalCount' => [ + 'description' => '查询结果总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DataList' => [ + 'description' => 'DDoS攻击事件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'DDoS攻击事件信息。', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'description' => '攻击目标。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TargetId' => [ + 'description' => 'Web资源耗尽型攻击目标ID。', + 'type' => 'string', + 'example' => '000000000155****', + ], + 'StartTime' => [ + 'description' => 'DDoS攻击事件的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-02-12T15:00:00Z', + ], + 'EndTime' => [ + 'description' => 'DDoS攻击事件的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-02-12T15:59:59Z', + ], + 'EventType' => [ + 'description' => '待查询的DDoS攻击事件的类型。取值：'."\n" + .'- **web-cc**：表示Web资源耗尽型攻击。'."\n" + .'- **cc**：表示连接型攻击。'."\n" + .'- **traffic**：表示流量型攻击。', + 'type' => 'string', + 'example' => 'web-cc', + ], + 'Bps' => [ + 'description' => '流量型攻击BPS峰值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '800', + ], + 'Pps' => [ + 'description' => '流量型攻击PPS峰值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12000', + ], + 'Cps' => [ + 'description' => '连接型攻击CPS峰值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'web-cc_1', + ], + 'Qps' => [ + 'description' => 'Web资源耗尽型攻击QPS峰值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7692', + ], + 'Coverage' => [ + 'description' => '攻击区域。取值：'."\n" + ."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **global**：全球。'."\n" + .'- **overseas**：全球（不包含中国内地）。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'EventResult' => [ + 'description' => '事件结果。取值：'."\n" + ."\n" + .'- **clean**：成功清洗。'."\n" + .'- **ratelimit**：限速。'."\n" + .'- **blackhole**：黑洞。', + 'type' => 'string', + 'example' => 'clean', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询DDoS攻击事件列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-19T03:35:35.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDDoSAllEventList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeDDoSAllEventList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D73A4243-CFBD-5110-876F-09237E77ECBD\\",\\n \\"SiteId\\": 0,\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataList\\": [\\n {\\n \\"Target\\": \\"example.com\\",\\n \\"TargetId\\": \\"000000000155****\\",\\n \\"StartTime\\": \\"2023-02-12T15:00:00Z\\",\\n \\"EndTime\\": \\"2023-02-12T15:59:59Z\\",\\n \\"EventType\\": \\"web-cc\\",\\n \\"Bps\\": 800,\\n \\"Pps\\": 12000,\\n \\"Cps\\": 50,\\n \\"EventId\\": \\"web-cc_1\\",\\n \\"Qps\\": 7692,\\n \\"Coverage\\": \\"domestic\\",\\n \\"EventResult\\": \\"clean\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDDoSBpsList' => [ + 'summary' => '查询DDoS网络层BPS、PPS数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239163', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL050IJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC+0时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-05-14T17:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间，开始结束时间跨度最长不超过31天。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-18T06:19:42Z', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '70966210986912', + ], + ], + [ + 'name' => 'Coverage', + 'in' => 'query', + 'schema' => [ + 'description' => '防护区域，不填默认为global，填写时取值如下：'."\n" + ."\n" + .'- domestic：中国内地。'."\n" + ."\n" + .'- overseas：全球(不包含中国内地)。'."\n" + ."\n" + .'- global：全球。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'domestic' => 'domestic', + 'global' => 'global', + 'overseas' => 'overseas', + ], + 'example' => 'global', + ], + ], + ], + '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' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + 'DataInterval' => [ + 'description' => '每条数据之间的时间间隔，单位：秒。'."\n" + ."\n" + .'根据StartTime和EndTime的间隔生成：小于1小时，60s；大于等于1小时，小于1天，300s；大于等于1天，小于一周，1800s；大于等于一周，3600s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'StartTime' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-05-14T17:00:00Z'."\n", + ], + 'EndTime' => [ + 'description' => '获取数据结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间，开始结束时间跨度最长不超过31天。', + 'type' => 'string', + 'example' => '2023-05-18T06:19:42Z'."\n", + ], + 'DataModule' => [ + 'description' => '每个时间间隔的网络带宽数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的网络带宽数据。', + 'type' => 'object', + 'properties' => [ + 'TotalBps' => [ + 'description' => '总带宽，单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000000', + ], + 'AttackBps' => [ + 'description' => '攻击带宽，单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9000000000', + ], + 'NormalBps' => [ + 'description' => '正常业务带宽，单位：bps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000000', + ], + 'TotalPps' => [ + 'description' => '总PPS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000', + ], + 'AttackPps' => [ + 'description' => '攻击PPS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9000000', + ], + 'NormalPps' => [ + 'description' => '正常业务PPS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000', + ], + 'TimeStamp' => [ + 'description' => '该条数据的时间，日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-05-14T17:00:00Z', + ], + ], + ], + ], + ], + ], + ], + [], + [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询DDoS网络层数据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDDoSBpsList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeDDoSBpsList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"DataInterval\\": 300,\\n \\"StartTime\\": \\"2023-05-14T17:00:00Z\\\\n\\",\\n \\"EndTime\\": \\"2023-05-18T06:19:42Z\\\\n\\",\\n \\"DataModule\\": [\\n {\\n \\"TotalBps\\": 10000000000,\\n \\"AttackBps\\": 9000000000,\\n \\"NormalBps\\": 1000000000,\\n \\"TotalPps\\": 100000000,\\n \\"AttackPps\\": 9000000,\\n \\"NormalPps\\": 1000000,\\n \\"TimeStamp\\": \\"2023-05-14T17:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDDoSL7QpsList' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239197', + 'abilityTreeNodes' => [ + 'FEATUREdcdnO1ZP9O', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '查询的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-19T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 开始结束时间跨度最长不超过31天。'."\n" + ."\n" + .'不设置该参数表示选取当前时间作为查询的结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-19T19:00:00Z', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '记录ID，可通过调用[ListRecords](~~ListRecords~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '86510927836942****', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度，单位为秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持60（1分钟）、300（5分钟）、1800（半小时）和3600（1小时）取值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '300', + 'enum' => [ + '60', + '300', + '1800', + '3600', + ], + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + ], + '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' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****'."\n", + ], + 'RecordId' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86510927836942****', + ], + 'DataInterval' => [ + 'description' => '查询数据的时间粒度，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'StartTime' => [ + 'description' => '查询的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-19T16:00:00Z'."\n", + ], + 'EndTime' => [ + 'description' => '查询的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-19T19:00:00Z'."\n", + ], + 'DataModule' => [ + 'description' => '应用层时间走势数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用层时间走势数据。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '全部QPS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Attack' => [ + 'description' => '攻击QPS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Normal' => [ + 'description' => '正常QPS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'TimeStamp' => [ + 'description' => '数据时间，格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-19T16:00:00Z'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询DDoS应用层时间维度聚合统计信息', + 'summary' => '调用DescribeDdosL7QpsList查询DDoS应用层时间维度聚合统计信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDDoSL7QpsList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeDDoSL7QpsList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"SiteId\\": 0,\\n \\"RecordId\\": 0,\\n \\"DataInterval\\": 300,\\n \\"StartTime\\": \\"2023-04-19T16:00:00Z\\\\n\\",\\n \\"EndTime\\": \\"2023-04-19T19:00:00Z\\\\n\\",\\n \\"DataModule\\": [\\n {\\n \\"Total\\": 9,\\n \\"Attack\\": 5,\\n \\"Normal\\": 4,\\n \\"TimeStamp\\": \\"2023-04-19T16:00:00Z\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDdosMaxBurstGbps' => [ + 'summary' => '查询DDoS实例的国内最大防护带宽', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254005', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可通过调用[ListUserRatePlanInstances](~~2852398~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'esa-site-a71k7bw19dz4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B5D71671-B074-5702-A0F5-B923920FDDD4', + ], + 'InstanceId' => [ + 'description' => '套餐实例ID。', + 'type' => 'string', + 'example' => 'esa-site-a71k7bw19dz4', + ], + 'MaxBurstGbps' => [ + 'description' => 'DDoS实例的国内最大防护带宽，单位Gbps。', + 'type' => 'string', + 'example' => '300', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', + 'description' => '输入的参数校验不通过，请您核对参数的正确性后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询DDoS实例的国内最大防护带宽', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B5D71671-B074-5702-A0F5-B923920FDDD4\\",\\n \\"InstanceId\\": \\"esa-site-a71k7bw19dz4\\",\\n \\"MaxBurstGbps\\": \\"300\\"\\n}","type":"json"}]', + ], + 'DescribeEdgeContainerAppStats' => [ + 'summary' => '提供ESA边缘容器的各项指标监控数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '241915', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tenant', + 'in' => 'query', + 'schema' => [ + 'description' => '租户。', + 'type' => 'string', + 'required' => false, + 'example' => 't-xxxx', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '应用基础信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-xxxx', + ], + ], + [ + 'name' => 'Locate', + 'in' => 'query', + 'schema' => [ + 'description' => '地区。', + 'type' => 'string', + 'required' => false, + 'example' => 'huizhou', + ], + ], + [ + 'name' => 'Isp', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom,unicom,mobile', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => [ + 'description' => '指标字段。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'container_fs_writes_bytes_avg' => '写IO', + 'container_memory_rss' => '内存使用量', + 'container_memory_rss_quota_rate' => '内存limit占比', + 'container_cpu_usage_seconds_quota_rate' => 'CPU limit比例%', + 'container_cpu_usage_seconds_total' => 'CPU核数', + 'pod_ready_rate' => 'PodReady率', + 'container_fs_reads_bytes_avg' => '读IO', + ], + 'example' => 'pod_ready_rate', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-09-02T15:04:05Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'>结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-09-02T16:04:05Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'CpuUsageSecondsQuotaRateAvg' => [ + 'description' => 'CPU limit比例平均值', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + ], + 'CpuUsageSecondsTotalAvg' => [ + 'description' => 'CPU核数平均值', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'FsReadsBytesAvgAvg' => [ + 'description' => '读IO平均值', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'FsWritesBytesAvgAvg' => [ + 'description' => '写IO平均值', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'MemoryRssAvg' => [ + 'description' => '内存使用量平均值', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + ], + 'MemoryRssQuotaRateAvg' => [ + 'description' => '内存limit占比平均值', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'PodReadyRateAvg' => [ + 'description' => 'PodReady率平均值', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'Points' => [ + 'description' => '图表对应列的时间和数值。', + 'type' => 'array', + 'items' => [ + 'description' => '图表对应列的数值和时间。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '变更时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-01-18T15:04:05Z', + ], + 'ContainerCpuUsageSecondsQuotaRate' => [ + 'description' => 'CPU limit比例%', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + ], + 'ContainerCpuUsageSecondsTotal' => [ + 'description' => 'CPU核数', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'ContainerFsReadsBytesAvg' => [ + 'description' => '读IO', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ContainerFsWritesBytesAvg' => [ + 'description' => '写IO', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ContainerMemoryRss' => [ + 'description' => '内存使用量', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + ], + 'ContainerMemoryRssQuotaRate' => [ + 'description' => '内存limit占比', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'PodReadyRate' => [ + 'description' => 'PodReady率', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified EndTime is invalid.', + 'description' => '请提供正确的结束时间格式。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：yyyy-MM-ddTHH:mm:ssZ。', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime parameter is invalid.', + 'description' => '请提供正确的开始时间格式。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CpuUsageSecondsQuotaRateAvg\\": 0.1,\\n \\"CpuUsageSecondsTotalAvg\\": 2,\\n \\"FsReadsBytesAvgAvg\\": 0,\\n \\"FsWritesBytesAvgAvg\\": 0,\\n \\"MemoryRssAvg\\": 0.1,\\n \\"MemoryRssQuotaRateAvg\\": 1,\\n \\"PodReadyRateAvg\\": 100,\\n \\"Points\\": [\\n {\\n \\"Time\\": \\"2024-01-18T15:04:05Z\\",\\n \\"ContainerCpuUsageSecondsQuotaRate\\": 0.1,\\n \\"ContainerCpuUsageSecondsTotal\\": 2,\\n \\"ContainerFsReadsBytesAvg\\": 0,\\n \\"ContainerFsWritesBytesAvg\\": 0,\\n \\"ContainerMemoryRss\\": 0.1,\\n \\"ContainerMemoryRssQuotaRate\\": 1,\\n \\"PodReadyRate\\": 100\\n }\\n ],\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', + 'title' => '提供ESA边缘容器的各项指标监控数据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeEdgeContainerAppStats', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeEdgeContainerAppStats', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeHttpDDoSAttackIntelligentProtection' => [ + 'summary' => '该接口用于查询HTTP DDoS智能防护配置信息，返回DDoS的防护模式以及防护等级。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239217', + 'abilityTreeNodes' => [ + 'FEATUREdcdnO1ZP9O', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'AiMode' => [ + 'description' => 'HTTP DDoS深度学习和防护模式。取值：'."\n" + .'- **observe**：观察'."\n" + .'- **defense**：拦截', + 'type' => 'string', + 'example' => 'defense', + ], + 'AiTemplate' => [ + 'description' => 'HTTP DDoS深度学习和防护等级。取值：'."\n" + .'- **level0**：非常宽松'."\n" + .'- **level30**：宽松'."\n" + .'- **level60**：正常'."\n" + .'- **level90**：严格', + 'type' => 'string', + 'example' => 'level60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE\\",\\n \\"SiteId\\": 0,\\n \\"AiMode\\": \\"defense\\",\\n \\"AiTemplate\\": \\"level60\\"\\n}","type":"json"}]', + 'title' => '查询HTTP DDoS深度学习和防护配置信息', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-19T03:35:35.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeHttpDDoSAttackIntelligentProtection', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeHttpDDoSAttackIntelligentProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'DescribeHttpDDoSAttackProtection' => [ + 'summary' => '该接口用于查询HTTP DDoS攻击防护配置信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239336', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + ], + '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' => '35C66C7B-671H-4297-9187-2C4477247A78', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'GlobalMode' => [ + 'description' => 'HTTP DDoS攻击防护策略模式。取值：'."\n" + .'- **very weak**：表示非常宽松。'."\n" + .'- **weak**：表示宽松。'."\n" + .'- **default**：表示正常。'."\n" + .'- **hard**：表示严格。', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\",\\n \\"SiteId\\": 0,\\n \\"GlobalMode\\": \\"default\\"\\n}","type":"json"}]', + 'title' => '查询HTTP DDoS攻击防护配置信息', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-19T03:35:35.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeHttpDDoSAttackProtection', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeHttpDDoSAttackProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'DescribeHttpDDoSAttackRules' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263687', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值;**1**，取值范围：**1~65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + 'enum' => [ + '5', + '10', + '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' => 'D4030CD2-0D9D-5E92-B358-421AE58307C6', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RuleInfos' => [ + 'description' => '规则信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'Illegal request。', + ], + 'RuleIdInfo' => [ + 'description' => '规则简称。', + 'type' => 'string', + 'example' => 'global_01_s', + ], + 'RuleDesc' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'example' => 'The HTTP request\'s Accept header contains invalid features#1', + ], + 'Status' => [ + 'description' => '规则状态，取值如下：'."\n" + ."\n" + .'- **on**：开启规则。'."\n" + .'- **off**：关闭规则。', + 'type' => 'string', + 'example' => 'on', + ], + 'DefaultAction' => [ + 'description' => '默认执行动作。', + 'type' => 'string', + 'example' => 'deny', + ], + 'Action' => [ + 'description' => '执行动作。', + 'type' => 'string', + 'example' => 'deny', + ], + 'RuleId' => [ + 'description' => 'HTTP DDoS规则ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20203578', + ], + 'LogRuleId' => [ + 'description' => '防护规则ID（日志记录用）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100010', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'The specified SiteId is invalid.', + 'description' => '站点ID参数非法。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询HTTP DDoS攻击防护规则', + 'summary' => '查询HTTP DDoS攻击防护规则。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4030CD2-0D9D-5E92-B358-421AE58307C6\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RuleInfos\\": [\\n {\\n \\"RuleName\\": \\"Illegal request。\\",\\n \\"RuleIdInfo\\": \\"global_01_s\\",\\n \\"RuleDesc\\": \\"The HTTP request\'s Accept header contains invalid features#1\\",\\n \\"Status\\": \\"on\\",\\n \\"DefaultAction\\": \\"deny\\",\\n \\"Action\\": \\"deny\\",\\n \\"RuleId\\": 20203578,\\n \\"LogRuleId\\": 100010\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeHttpDDoSIntelligentAclRules' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263690', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + 'enum' => [ + '5', + '10', + '20', + ], + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'acl', + 'default' => 'acl', + 'enum' => [ + 'acl', + ], + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'TotalCount' => [ + 'description' => '总规则数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RuleInfos' => [ + 'description' => '规则信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'smart_cc_***', + ], + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'test.example.com', + ], + 'Action' => [ + 'description' => '防护动作。', + 'type' => 'string', + 'example' => 'deny', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20569929', + ], + 'Condition' => [ + 'description' => '规则触发条件。', + 'type' => 'string', + 'example' => '{"$and":[{"key":"URI","opValue":"prefix-match","values":"/"}]}', + ], + 'PunishTime' => [ + 'description' => '处置时间。(单位：秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1800', + ], + 'LogRuleId' => [ + 'description' => '防护规则ID（日志记录用）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000030', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'The specified SiteId is invalid.', + 'description' => '站点ID参数非法。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询深度学习和防护下发的精准访问控制规则', + 'summary' => '查询深度学习和防护下发的精准访问控制规则。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RuleInfos\\": [\\n {\\n \\"RuleName\\": \\"smart_cc_***\\",\\n \\"RecordName\\": \\"test.example.com\\",\\n \\"Action\\": \\"deny\\",\\n \\"RuleId\\": 20569929,\\n \\"Condition\\": \\"{\\\\\\"$and\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"URI\\\\\\",\\\\\\"opValue\\\\\\":\\\\\\"prefix-match\\\\\\",\\\\\\"values\\\\\\":\\\\\\"/\\\\\\"}]}\\",\\n \\"PunishTime\\": 1800,\\n \\"LogRuleId\\": 1000030\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeHttpDDoSIntelligentRateLimitRules' => [ + 'summary' => '查询深度学习和防护下发的频率控制规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263694', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + 'enum' => [ + '5', + '10', + '20', + ], + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc', + 'default' => 'cc', + 'enum' => [ + 'cc', + ], + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'TotalCount' => [ + 'description' => '总规则数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RuleInfos' => [ + 'description' => '规则信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'inner_cc_client_ip_ratelimit', + ], + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'test.example.com', + ], + 'Action' => [ + 'description' => '执行动作。', + 'type' => 'string', + 'example' => 'js', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20110849', + ], + 'RateLimit' => [ + 'description' => '频次信息。', + 'type' => 'string', + 'example' => '{"threshold":2000,"interval":5,"target":"ip","ttl":600}', + ], + 'Statistics' => [ + 'description' => '统计信息。', + 'type' => 'string', + 'example' => '{"field":"ip","mode":"count"}', + ], + 'Condition' => [ + 'description' => '规则触发条件。', + 'type' => 'string', + 'example' => '{"$and":[{"key":"URI","opValue":"prefix-match","values":"/"}]}', + ], + 'PunishTime' => [ + 'description' => '处置时间。(单位：秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86400', + ], + 'LogRuleId' => [ + 'description' => '防护规则ID（日志记录用）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100030', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'The specified SiteId is invalid.', + 'description' => '站点ID参数非法。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询深度学习和防护下发的频率控制规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RuleInfos\\": [\\n {\\n \\"RuleName\\": \\"inner_cc_client_ip_ratelimit\\",\\n \\"RecordName\\": \\"test.example.com\\",\\n \\"Action\\": \\"js\\",\\n \\"RuleId\\": 20110849,\\n \\"RateLimit\\": \\"{\\\\\\"threshold\\\\\\":2000,\\\\\\"interval\\\\\\":5,\\\\\\"target\\\\\\":\\\\\\"ip\\\\\\",\\\\\\"ttl\\\\\\":600}\\",\\n \\"Statistics\\": \\"{\\\\\\"field\\\\\\":\\\\\\"ip\\\\\\",\\\\\\"mode\\\\\\":\\\\\\"count\\\\\\"}\\",\\n \\"Condition\\": \\"{\\\\\\"$and\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"URI\\\\\\",\\\\\\"opValue\\\\\\":\\\\\\"prefix-match\\\\\\",\\\\\\"values\\\\\\":\\\\\\"/\\\\\\"}]}\\",\\n \\"PunishTime\\": 86400,\\n \\"LogRuleId\\": 100030\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeKvAccountStatus' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239022', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '账户状态。'."\n" + ."\n" + .'- **online**：开启。'."\n" + .'- **offline**：关闭。', + 'type' => 'string', + 'example' => 'online', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询账户的KV状态信息', + 'summary' => '查询账户在KV服务的状态信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeKvAccountStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeKvAccountStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"online\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', + ], + 'DescribePreloadTasks' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239113', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '查询内容，精确匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.com/1.jpg?b=2', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。取值范围为：**1**~**100000**。'."\n" + .'默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**20**，最大值：**50**。取值为**1~50**之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-22T17:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-23T06:23:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行状态。取值：'."\n" + ."\n" + .'- **Complte**：完成。'."\n" + .'- **Refreshing**：预热中。'."\n" + .'- **Failed**：预热失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Complete', + 'enum' => [ + 'Refreshing', + 'Complete', + 'Failed', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '83', + ], + 'Tasks' => [ + 'description' => '任务列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：预热中。'."\n" + .'- **Failed**：预热失败。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-03-28 14:28:57', + ], + 'Process' => [ + 'description' => '任务完成进度百分比。', + 'type' => 'string', + 'example' => '100%', + ], + 'Description' => [ + 'description' => '预热失败后返回的错误描述。取值：'."\n" + ."\n" + .'- **Internal Error**：内部错误。'."\n" + .'- **Origin Timeout**：源站响应超时。'."\n" + .'- **Origin Return StatusCode 5XX**：源站响应5xx错误码。', + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'Content' => [ + 'description' => '预热对象。', + 'type' => 'string', + 'example' => 'http://a.com/1.jpg?b=2', + ], + 'TaskId' => [ + 'description' => '查询到的任务ID。', + 'type' => 'string', + 'example' => '1597854579687428', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidStationParameter', + 'errorMessage' => 'The specified Station is invalid.', + 'description' => '指定的节点参数无效。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified taskId is invalid.', + 'description' => '指定的任务ID无效。', + ], + [ + 'errorCode' => 'InvalidParameters.InvalidUrls', + 'errorMessage' => 'The specified urls are invalid.', + 'description' => '请求的URL参数无效。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询预热任务详情', + 'summary' => '查询任务预热详情，支持按时间、任务状态、预热URL进行分页查询。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribePreloadTasks', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribePreloadTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 83,\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"Complete\\",\\n \\"CreateTime\\": \\"2023-03-28 14:28:57\\",\\n \\"Process\\": \\"100%\\",\\n \\"Description\\": \\"Internal Error\\",\\n \\"Content\\": \\"http://a.com/1.jpg?b=2\\",\\n \\"TaskId\\": \\"1597854579687428\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribePurgeTasks' => [ + 'summary' => '查询刷新任务的执行情况。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239334', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBCJPGN', + 'FEATUREdcdnELTTM1', + 'FEATUREdcdnA9FG2P', + 'FEATUREdcdnRELTJV', + 'FEATUREdcdnEWYS3A', + 'FEATUREdcdn4QVGXU', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '查询内容，精确匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.com/1.jpg?b=1', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + .'- **file**（默认值）：文件刷新。'."\n" + .'- **cachetag**：缓存标签刷新。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **ignoreParams**：去参数刷新。'."\n" + .'- **hostname**：主机名刷新。'."\n" + .'- **purgeall**：刷新站点下所有缓存。', + 'type' => 'string', + 'required' => false, + 'example' => 'file', + 'enum' => [ + 'file', + 'directory', + 'ignoreparams', + 'hostname', + 'purgeall', + 'cachetag', + 'cachekey', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页。取值范围为：**1~100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**20**，最大值：**50**。取值为**1~50**之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-11-16T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-11-18T15:59:59Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行状态。取值：'."\n" + ."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：刷新中。'."\n" + .'- **Failed**：刷新失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Complete', + 'enum' => [ + 'Complete', + 'Refreshing', + 'Failed', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Tasks' => [ + 'description' => '任务列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。'."\n" + ."\n" + .'- **Complete**：完成。'."\n" + ."\n" + .'- **Refreshing**：刷新中。'."\n" + ."\n" + .'- **Failed**：刷新失败。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-07-26T01:56:15Z', + ], + 'Type' => [ + 'description' => '刷新任务类型，取值：'."\n" + .'- **file**（默认值）：文件刷新。'."\n" + .'- **cachetag**：缓存标签刷新。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **ignoreParams**：去参数刷新。'."\n" + .'- **hostname**：主机名刷新。'."\n" + .'- **purgeall**：刷新站点下所有缓存。', + 'type' => 'string', + 'example' => 'file', + ], + 'Process' => [ + 'description' => '任务完成进度百分比。', + 'type' => 'string', + 'example' => '100%', + ], + 'Description' => [ + 'description' => '刷新任务失败返回错误描述。', + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'Content' => [ + 'description' => '刷新对象。', + 'type' => 'string', + 'example' => 'http://a.com/1.jpg?b=1', + ], + 'TaskId' => [ + 'description' => '任务ID。'."\n", + 'type' => 'string', + 'example' => '16346513304', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidStationParameter', + 'errorMessage' => 'The specified Station is invalid.', + 'description' => '指定的节点参数无效。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified taskId is invalid.', + 'description' => '指定的任务ID无效。', + ], + [ + 'errorCode' => 'InvalidParameters.InvalidUrls', + 'errorMessage' => 'The specified urls are invalid.', + 'description' => '请求的URL参数无效。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询刷新任务', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-10T01:55:17.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribePurgeTasks', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribePurgeTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 15,\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"Complete\\",\\n \\"CreateTime\\": \\"2023-07-26T01:56:15Z\\",\\n \\"Type\\": \\"file\\",\\n \\"Process\\": \\"100%\\",\\n \\"Description\\": \\"Internal Error\\",\\n \\"Content\\": \\"http://a.com/1.jpg?b=1\\",\\n \\"TaskId\\": \\"16346513304\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRatePlanInstanceStatus' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239092', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，从[ListUserRatePlanInstances](~~ListUserRatePlanInstances~~)接口查询获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'xcdn-91fknmb80f0g***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60423A7F-A83D-1E24-B80E-86DD25790759', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'xcdn-91fknmb80f0g***'."\n", + ], + 'InstanceStatus' => [ + 'description' => '实例状态，取值：'."\n" + .'- running：运行中'."\n" + .'- renewing：正在续费'."\n" + .'- upgrading：正在升配'."\n" + .'- releasePrepaidService：预付费超期释放'."\n" + .'- creating：正在创建'."\n" + .'- downgrading：正在降配'."\n" + .'- ceasePrepaidService：预付费到期停服', + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidInstance', + 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', + 'description' => '实例ID缺失或者参数无效，请确认实例ID无误后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询套餐实例状态', + 'summary' => '调用DescribeRatePlanInstanceStatus查询套餐实例状态。', + 'description' => '先购买创建套餐实例后，才能查询对应的实例状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRatePlanInstanceStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:DescribeRatePlanInstanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60423A7F-A83D-1E24-B80E-86DD25790759\\",\\n \\"InstanceId\\": \\"xcdn-91fknmb80f0g***\\\\n\\",\\n \\"InstanceStatus\\": \\"running\\"\\n}","type":"json"}]', + ], + 'DescribeSiteLogs' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238778', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGVXOQA', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可以通过调用ListSites获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456***', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '分页大小，默认300，最大1000，取值：1~1000之前的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1000', + 'example' => '10', + 'default' => '300', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围为大于1的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-11-06T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 说明 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-11-06T17:00:00Z', + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'SiteLogDetails' => [ + 'description' => '站点日志信息组合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456***', + ], + 'LogCount' => [ + 'description' => '本页返回的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'LogInfos' => [ + 'description' => '站点日志包信息。', + 'type' => 'array', + 'items' => [ + 'description' => '下载地址。', + 'type' => 'object', + 'properties' => [ + 'LogSize' => [ + 'description' => '日志大小，单位：字节。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '438304768', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2022-11-06T17:00:00Z'."\n", + ], + 'LogName' => [ + 'description' => '日志名称。', + 'type' => 'string', + 'example' => 'example.com_2022_11_07_000000_020000.gz.xxxxxx', + ], + 'LogPath' => [ + 'description' => '日志路径。'."\n" + ."\n\n" + .'> 需要关注返回参数LogPath中的字段Expires（过期时间戳），过期后日志下载链接失效，需要重新获取。', + 'type' => 'string', + 'example' => 'example.aliyundoc.com /v1.l1cache/105252530/example.com/2022_11_07/example.com_2022_11_07_000000_020000.gz.xxxxxx?Expires=1636963354&OSSAccessKeyId=LTAIviCc6zy8****&Signature=u0V6foRfZniHE8i%2BHUdxGOhZsK****'."\n", + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2022-11-06T16:00:00Z'."\n", + ], + ], + ], + ], + 'PageInfos' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页大小，默认**300**，取值：**1~1000**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '47', + ], + 'PageIndex' => [ + 'description' => '返回数据的页码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The StartTime cannot exceed 31 days before the current time.', + 'description' => '请求参数StartTime不允许比当前时间小31天', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询站点离线日志下载地址', + 'summary' => '查询指定站点的原始访问日志的下载地址。', + 'description' => '- 当您不指定StartTime和EndTime时，默认读取过去24小时的日志数据；当指定StartTime和EndTime时，按指定的起止时间查询日志。'."\n" + .'- 查询数据的时间粒度为一小时。'."\n" + .'- 单用户调用频率：50次/秒。'."\n" + .'- 仅支持查询最近一个月的日志记录（开始时间和当前时间跨度不大于31天）。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeSiteLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"SiteLogDetails\\": [\\n {\\n \\"SiteName\\": \\"example.com\\",\\n \\"SiteId\\": 0,\\n \\"LogCount\\": 300,\\n \\"LogInfos\\": [\\n {\\n \\"LogSize\\": 438304768,\\n \\"EndTime\\": \\"2022-11-06T17:00:00Z\\\\n\\",\\n \\"LogName\\": \\"example.com_2022_11_07_000000_020000.gz.xxxxxx\\",\\n \\"LogPath\\": \\"example.aliyundoc.com /v1.l1cache/105252530/example.com/2022_11_07/example.com_2022_11_07_000000_020000.gz.xxxxxx?Expires=1636963354&OSSAccessKeyId=LTAIviCc6zy8****&Signature=u0V6foRfZniHE8i%2BHUdxGOhZsK****\\\\n\\",\\n \\"StartTime\\": \\"2022-11-06T16:00:00Z\\\\n\\"\\n }\\n ],\\n \\"PageInfos\\": {\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 47,\\n \\"PageIndex\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSiteTimeSeriesData' => [ + 'summary' => '查询账户维度或站点维度流量分析时序数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239272', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVIK4DM', + 'FEATUREdcdn2Z4HOI', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。通过调用[ListSites](~~ListSites~~)接口获取站点ID。'."\n" + ."\n" + .'此参数为空时查询用户维度数据。', + 'type' => 'string', + 'required' => false, + 'example' => '1150376036*****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-08T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-09T16:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度，单位为秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持60(一分钟) 、300(5分钟)、3600(1小时)和86400(1天)取值，具体请参见上方的**支持查询的时间粒度**。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询指标。', + 'type' => 'array', + 'items' => [ + 'description' => '查询指标。', + 'type' => 'object', + 'properties' => [ + 'FieldName' => [ + 'description' => '查询指标值。'."\n" + ."\n" + .'>具体维度请参见[数据分析字段说明](~~2878520~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Traffic', + ], + 'Dimension' => [ + 'description' => '查询维度。', + 'type' => 'array', + 'items' => [ + 'description' => '查询维度。'."\n" + ."\n" + .'>具体维度请参见[数据分析字段说明](~~2878520~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'FieldName' => [ + 'description' => '查询指标值。', + 'type' => 'string', + 'example' => 'Traffic', + ], + 'DimensionName' => [ + 'description' => '查询维度。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'DimensionValue' => [ + 'description' => '查询维度值。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'DetailData' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2023-04-08T16:00:00Z', + ], + 'Value' => [ + 'description' => '数值。', + 'type' => 'any', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + 'SummarizedData' => [ + 'description' => '查询汇总数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => [ + 'description' => '查询汇总指标值。', + 'type' => 'string', + 'example' => 'Traffic', + ], + 'DimensionName' => [ + 'description' => '查询汇总维度。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'DimensionValue' => [ + 'description' => '查询汇总维度值。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'AggMethod' => [ + 'description' => '汇总方法。', + 'type' => 'string', + 'example' => 'sum', + ], + 'Value' => [ + 'description' => '汇总数值。', + 'type' => 'any', + 'example' => '12345', + ], + ], + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'StartTime' => [ + 'description' => '获取数据的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-08T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '获取数据的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-09T16:00:00Z', + ], + 'Interval' => [ + 'description' => '数据粒度，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'SamplingRate' => [ + 'description' => '采样率，单位：%。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.TimeRange', + 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', + 'description' => '您配置的数据查询时间范围过长，请调整数据查询时间范围后重试。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', + 'description' => '输入的参数校验不通过，请您核对参数的正确性后重试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'errorCode' => 'InvalidParameter.Field', + 'errorMessage' => 'The specified Field is invalid.', + 'description' => '您的查询指标有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。', + ], + [ + 'errorCode' => 'InvalidParameter.Dimension', + 'errorMessage' => 'The specified Dimension is invalid.', + 'description' => '您的查询维度有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。'."\n", + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified start time or end time is malformed.', + 'description' => '您指定的时间格式有误，时间需要符合yyyy-MM-ddTHH:mm:ssZ格式。请您正确输入后重试。', + ], + [ + 'errorCode' => 'TooManyDimensions', + 'errorMessage' => 'Too many query dimensions specified. Delete some and try again.', + 'description' => '您配置的数据查询维度过多，请您删除部分查询维度后重试。', + ], + ], + ], + 'title' => '查询流量分析时序数据', + 'description' => '- 如果您不指定 StartTime 和 EndTime，该接口返回过去 24 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。'."\n" + .'- 根据 StartTime 和 EndTime 跨度返回不同时间粒度。'."\n" + .' * 小于等于 3 小时，返回 1 分钟粒度数据。'."\n" + .' * 跨度大于 3 小时且小于等于 12 小时, 返回 5 分钟粒度数据。'."\n" + .' * 跨度大于 12 小时且小于等于 1 天, 返回 15 分钟粒度数据。'."\n" + .' * 跨度大于 1 天且小于等于10 天，返回小时粒度数据。'."\n" + .' * 跨度大于 10 天且小于等于 31 天返回天粒度数据。'."\n" + .'- 由于查询时间段的访问次数较大，数据分析可能经过采样。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 10, + 'regionId' => '*', + 'api' => 'DescribeSiteTimeSeriesData', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeSiteTimeSeriesData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"FieldName\\": \\"Traffic\\",\\n \\"DimensionName\\": \\"ALL\\",\\n \\"DimensionValue\\": \\"ALL\\",\\n \\"DetailData\\": [\\n {\\n \\"TimeStamp\\": \\"2023-04-08T16:00:00Z\\",\\n \\"Value\\": \\"123\\"\\n }\\n ]\\n }\\n ],\\n \\"SummarizedData\\": [\\n {\\n \\"FieldName\\": \\"Traffic\\",\\n \\"DimensionName\\": \\"ALL\\",\\n \\"DimensionValue\\": \\"ALL\\",\\n \\"AggMethod\\": \\"sum\\",\\n \\"Value\\": \\"12345\\"\\n }\\n ],\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"StartTime\\": \\"2023-04-08T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-04-09T16:00:00Z\\",\\n \\"Interval\\": 300,\\n \\"SamplingRate\\": 100\\n}","type":"json"}]', + ], + 'DescribeSiteTopData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239025', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVIK4DM', + 'FEATUREdcdn2Z4HOI', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。通过调用[ListSites](~~ListSites~~)接口获取站点ID。'."\n" + ."\n\n" + .'此参数为空时查询用户维度数据。', + 'type' => 'string', + 'required' => false, + 'example' => '1150376036*****'."\n", + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-08T16:00:00Z'."\n", + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-09T16:00:00Z'."\n", + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度，单位为秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询指标。', + 'type' => 'array', + 'items' => [ + 'description' => '查询指标。', + 'type' => 'object', + 'properties' => [ + 'FieldName' => [ + 'description' => '查询指标值。'."\n" + ."\n" + .'> 具体维度请参见[数据分析字段说明](~~2878520~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Traffic', + ], + 'Dimension' => [ + 'description' => '查询维度。', + 'type' => 'array', + 'items' => [ + 'description' => '查询维度。'."\n" + ."\n" + .'> 具体维度请参见[数据分析字段说明](~~2878520~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '查询Top数据个数。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 5 => '5', + 10 => '10', + 150 => '150', + ], + 'example' => '5', + 'default' => '300', + 'enum' => [ + '5', + '10', + '15', + '100', + '150', + '999', + '300', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'FieldName' => [ + 'description' => '查询指标值。', + 'type' => 'string', + 'example' => 'Traffic', + ], + 'DimensionName' => [ + 'description' => '查询维度。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'DetailData' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DimensionValue' => [ + 'description' => '查询维度值。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Value' => [ + 'description' => '数值。', + 'type' => 'any', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '35C66C7B-671H-4297-9187-2C447724****', + ], + 'StartTime' => [ + 'description' => '获取数据的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-08T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '获取数据的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-09T16:00:00Z', + ], + 'SamplingRate' => [ + 'description' => '采样率，单位：%。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.TimeRange', + 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', + 'description' => '您配置的数据查询时间范围过长，请调整数据查询时间范围后重试。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', + 'description' => '输入的参数校验不通过，请您核对参数的正确性后重试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'errorCode' => 'InvalidParameter.Field', + 'errorMessage' => 'The specified Field is invalid.', + 'description' => '您的查询指标有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。', + ], + [ + 'errorCode' => 'InvalidParameter.Dimension', + 'errorMessage' => 'The specified Dimension is invalid.', + 'description' => '您的查询维度有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。'."\n", + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified start time or end time is malformed.', + 'description' => '您指定的时间格式有误，时间需要符合yyyy-MM-ddTHH:mm:ssZ格式。请您正确输入后重试。', + ], + [ + 'errorCode' => 'TooManyDimensions', + 'errorMessage' => 'Too many query dimensions specified. Delete some and try again.', + 'description' => '您配置的数据查询维度过多，请您删除部分查询维度后重试。', + ], + ], + ], + 'title' => '查询流量分析Top数据', + 'summary' => '查询账户维度或站点维度流量分析Top数据。', + 'description' => '- 如果您不指定 StartTime 和 EndTime，该接口返回过去 24 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'- 由于查询时间段的访问次数较多，数据分析可能经过采样。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 10, + 'regionId' => '*', + 'api' => 'DescribeSiteTopData', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeSiteTopData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"FieldName\\": \\"Traffic\\",\\n \\"DimensionName\\": \\"ALL\\",\\n \\"DetailData\\": [\\n {\\n \\"DimensionValue\\": \\"ALL\\",\\n \\"Value\\": \\"123\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C447724****\\",\\n \\"StartTime\\": \\"2023-04-08T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-04-09T16:00:00Z\\",\\n \\"SamplingRate\\": 100\\n}","type":"json"}]', + ], + 'DescribeUrlObservationData' => [ + 'summary' => '查询网页观测质量数据。', + 'description' => '如果您不指定 StartTime 和 EndTime，该接口返回过去 24 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。', + 'path' => '/', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '255157', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '54362329990032', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的开始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-08T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间。格式为：yyyy-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-19T15:59:59Z', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '要监测的网页URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com/test', + ], + ], + [ + 'name' => 'ClientPlatform', + 'in' => 'query', + 'schema' => [ + 'description' => '设备平台，参数为空则查询全部。'."\n" + ."\n" + .'- PC'."\n" + ."\n" + .'- Mobile', + 'type' => 'string', + 'required' => false, + 'example' => 'PC', + 'enum' => [ + 'PC', + 'Mobile', + ], + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '检测的指标数据。'."\n" + ."\n" + .'* TTFB：度量资源发起请求到响应的第一个字节开始到达之间的时间。'."\n" + .'* FCP：度量从页面开始加载到页面内容的任何部分在屏幕上呈现这之间的时间。'."\n" + .'* LCP：报告视区中可见的最大图像或文本块的呈现时间。'."\n" + .'* CLS：一个度量页面整个生命周期内发生的每一次意外布局变化的最大布局突变分数的度量值。'."\n" + .'* INP：度量页面的响应能力，页面需要多长时间以看得见的方式响应用户输入。'."\n" + .'* FID：度量从用户第一次与页面交互到浏览器实际能够为响应该交互开始处理事件处理程序这之间的时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'TTFB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'UrlDetailData' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '要监测的网页URL。', + 'type' => 'string', + 'example' => 'example.com/test', + ], + 'ClientPlatform' => [ + 'description' => '设备平台。', + 'type' => 'string', + 'example' => 'PC', + ], + 'Country' => [ + 'description' => '所属国家。', + 'type' => 'string', + 'example' => 'CN', + ], + 'TTFB' => [ + 'description' => '度量资源发起请求到响应的第一个字节开始到达之间的时间，单位：ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'FCP' => [ + 'description' => '度量从页面开始加载到页面内容的任何部分在屏幕上呈现这之间的时间，单位：ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'LCP' => [ + 'description' => '报告视区中可见的最大图像或文本块的呈现时间，单位：ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'CLS' => [ + 'description' => '一个度量页面整个生命周期内发生的每一次意外布局变化的最大布局突变分数的度量值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'FID' => [ + 'description' => '度量从用户第一次与页面交互到浏览器实际能够为响应该交互开始处理事件处理程序这之间的时间，单位：ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'INP' => [ + 'description' => '度量页面的响应能力，页面需要多长时间以看得见的方式响应用户输入，单位：ms。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + ], + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-11-06T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间。格式为：yyyy-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-19T15:59:59Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.TimeRange', + 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', + 'description' => '您配置的数据查询时间范围过长，请调整数据查询时间范围后重试。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', + 'description' => '输入的参数校验不通过，请您核对参数的正确性后重试。', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified start time or end time is malformed.', + 'description' => '您指定的时间格式有误，时间需要符合yyyy-MM-ddTHH:mm:ssZ格式。请您正确输入后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询网页观测质量数据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeUrlObservationData', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeUrlObservationData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UrlDetailData\\": [\\n {\\n \\"Url\\": \\"example.com/test\\",\\n \\"ClientPlatform\\": \\"PC\\",\\n \\"Country\\": \\"CN\\",\\n \\"TTFB\\": 123,\\n \\"FCP\\": 123,\\n \\"LCP\\": 123,\\n \\"CLS\\": 0.5,\\n \\"FID\\": 123,\\n \\"INP\\": 123\\n }\\n ],\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"StartTime\\": \\"2022-11-06T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-04-19T15:59:59Z\\"\\n}","type":"json"}]', + ], + 'DisableCustomScenePolicy' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239134', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID，可通过调用[DescribeCustomScenePolicies](~~2850508~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '100001', + ], + ], + ], + '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' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + 'PolicyId' => [ + 'description' => '禁用的策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'PolicyNotExist', + 'errorMessage' => 'The policy does not exist.', + 'description' => '策略不存在。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '禁用定制场景策略', + 'summary' => '禁用指定的定制场景策略。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DisableCustomScenePolicy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DisableCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n \\"PolicyId\\": 100001\\n}","type":"json"}]', + ], + 'EditSiteWafSettings' => [ + 'summary' => '该接口用于编辑站点的Web应用防火墙（WAF）配置。用户可以通过此接口修改站点的WAF设置，如修改WAF识别的客户端IP等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239647', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4VDL9A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Settings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '站点WAF配置', + 'description' => '站点WAF配置信息，以JSON格式传递。', + 'required' => false, + '$ref' => '#/components/schemas/WafSiteSettings', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '编辑站点的WAF配置', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-19T09:09:37.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:51.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T08:22:13.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'EditSiteWafSettings', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:EditSiteWafSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'EnableCustomScenePolicy' => [ + 'summary' => '启用指定的定制场景策略。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238963', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID，可通过调用[DescribeCustomScenePolicies](~~2850508~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + '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' => '65C66B7B-671A-8297-9187-2R5477247B76', + ], + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'PolicyNotExist', + 'errorMessage' => 'The policy does not exist.', + 'description' => '策略不存在。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '启用定制场景策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'EnableCustomScenePolicy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:EnableCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\",\\n \\"PolicyId\\": 1\\n}","type":"json"}]', + ], + 'ExportRecords' => [ + 'summary' => '导出站点下的所有DNS记录，以固定的文本格式返回结果。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239639', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过调用[ListSites](~~2850189~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567890123', + ], + ], + ], + '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' => 'C69B5894-D1BA-592C-95D0-DADBE7AEAC63', + ], + 'Content' => [ + 'description' => '导出的DNS记录内容。', + 'type' => 'string', + 'example' => ';; site:example.com.\\n;; Exported:2024-01-24 15:54:35\\n\\n;; A Records\\na1.example.com. 30 IN A 1.1.1.1 direct\\na2.example.com. 30 IN A 1.1.1.1 direct\\na3.example.com. 30 IN A 1.1.1.1 direct\\n', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '导出记录', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T08:22:08.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ExportRecords', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ExportRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C69B5894-D1BA-592C-95D0-DADBE7AEAC63\\",\\n \\"Content\\": \\";; site:example.com.\\\\\\\\n;; Exported:2024-01-24 15:54:35\\\\\\\\n\\\\\\\\n;; A Records\\\\\\\\na1.example.com. 30 IN A 1.1.1.1 direct\\\\\\\\na2.example.com. 30 IN A 1.1.1.1 direct\\\\\\\\na3.example.com. 30 IN A 1.1.1.1 direct\\\\\\\\n\\"\\n}","type":"json"}]', + ], + 'GetApiSchemaUsage' => [ + 'summary' => '获取架构验证上传文件套餐配额用量信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdcdnOKX321', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1159101787****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + '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' => '952ea16b-1f05-4a76-bb32-420282d8****', + ], + 'InstanceId' => [ + 'description' => '套餐实例ID。', + 'type' => 'string', + 'example' => 'esa-site-agknce3n****', + ], + 'InstanceUsage' => [ + 'description' => '站点对应实例中架构验证已上传的文件数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Usages' => [ + 'description' => '各个站点使用量详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '每个站点使用量详细信息。', + 'type' => 'object', + 'properties' => [ + 'Usage' => [ + 'description' => '站点使用量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Id' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40000449', + ], + 'Name' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ApiShield.Quota', + 'errorMessage' => 'This website does not have the permission to view API security features.', + 'description' => '该站点没有API安全功能查看权限。', + ], + [ + 'errorCode' => 'SiteVersion.NotExist', + 'errorMessage' => 'The specified version is invalid or version management is not enabled for your website.Make sure that you specify a valid version and version management is enabled. Then, try again.', + 'description' => '传入的站点版本无效或当前站点尚未开通版本管理功能。请您检查配置的版本是否正确后重试，若尚未开通版本管理功能请开通后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取架构验证上传文件套餐配额用量信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetApiSchemaUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952ea16b-1f05-4a76-bb32-420282d8****\\",\\n \\"InstanceId\\": \\"esa-site-agknce3n****\\",\\n \\"InstanceUsage\\": 10,\\n \\"Usages\\": [\\n {\\n \\"Usage\\": 0,\\n \\"Id\\": 40000449,\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetCacheReserveSpecification' => [ + 'summary' => '查询当前可购买的缓存保持规格列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239117', + 'abilityTreeNodes' => [ + 'FEATUREdcdn51XOHW', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + 'CacheReserveRegion' => [ + 'description' => '缓存保持使用区域规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '区域详情。', + 'type' => 'string', + 'example' => 'HK', + ], + ], + 'CacheReserveCapacity' => [ + 'description' => '缓存保持容量规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容量规格详情。单位GB。', + 'type' => 'string', + 'example' => '512000', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询可购买的缓存保持规格', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCacheReserveSpecification', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCacheReserveSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"CacheReserveRegion\\": [\\n \\"HK\\"\\n ],\\n \\"CacheReserveCapacity\\": [\\n \\"512000\\"\\n ]\\n}","type":"json"}]', + ], + 'GetCacheRule' => [ + 'summary' => '查询单条缓存配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257574', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListCacheRules](~~2866985~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置；'."\n" + .'- rule：查询规则配置；', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example'."\n", + ], + 'BypassCache' => [ + 'description' => '设置绕过缓存模式。取值范围：'."\n" + ."\n" + .'- cache_all：所有请求都缓存。'."\n" + .'- bypass_all：所有请求都绕过缓存。', + 'type' => 'string', + 'example' => 'cache_all', + ], + 'BrowserCacheMode' => [ + 'description' => '浏览器缓存模式。取值范围：'."\n" + .'- no_cache：不缓存。'."\n" + .'- follow_origin：遵循源站缓存策略。'."\n" + .'- override_origin：代替源站缓存策略。', + 'type' => 'string', + 'example' => 'follow_origin', + ], + 'BrowserCacheTtl' => [ + 'description' => '浏览器缓存过期时间，单位是秒。', + 'type' => 'string', + 'example' => '300', + ], + 'EdgeCacheMode' => [ + 'description' => '节点缓存模式。取值范围：'."\n" + .'- follow_origin：遵循源站缓存策略（如果存在），否则使用默认缓存策略。'."\n" + .'- no_cache：不缓存。'."\n" + .'- override_origin：代替源站缓存策略。'."\n" + .'- follow_origin_bypass：遵循源站缓存策略（如果存在），否则不缓存。'."\n" + .'- follow_origin_override：遵循源站缓存策略（如果存在），否则使用自定义缓存TTL。', + 'type' => 'string', + 'example' => 'follow_origin', + ], + 'EdgeCacheTtl' => [ + 'description' => '节点缓存过期时间，单位是秒。', + 'type' => 'string', + 'example' => '300', + ], + 'EdgeStatusCodeCacheTtl' => [ + 'description' => '状态码缓存过期时间，单位是秒。'."\n" + .'- 支持对指定状态码设置缓存过期时间，例如：404=10，表示对404状态码缓存10秒。'."\n" + .'- 支持对4xx、5xx系列状态码设置缓存过期时间，例如：4xx=10，表示对400系列的所有状态码都缓存10秒。', + 'type' => 'string', + 'example' => '4xx=10', + ], + 'SortQueryStringForCache' => [ + 'description' => '查询字符串排序。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'QueryStringMode' => [ + 'description' => '在生成缓存键的时候，对查询字符串的处理模式。取值范围：'."\n" + ."\n" + .'- ignore_all：全部忽略。'."\n" + .'- exclude_query_string：删除指定查询字符串。'."\n" + .'- reserve_all：默认值，全部保留。'."\n" + .'- include_query_string：保留指定查询字符串。', + 'type' => 'string', + 'example' => 'reserve_all', + ], + 'QueryString' => [ + 'description' => '需要保留或者删除的查询字符串，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'example', + ], + 'IncludeHeader' => [ + 'description' => '生成缓存键的时候，包括指定的标头名称及其值，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'example', + ], + 'IncludeCookie' => [ + 'description' => '生成缓存键的时候，包括指定的cookie名称及其值，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'cookie_exapmle', + ], + 'CacheReserveEligibility' => [ + 'description' => '缓存保持资格。用于控制用户请求在回源的时候是否绕过缓存保持节点。取值范围：'."\n" + ."\n" + .'- bypass_cache_reserve：请求绕过缓存保持。'."\n" + .'- eligible_for_cache_reserve：符合缓存保持资格。', + 'type' => 'string', + 'example' => 'bypass_cache_reserve', + ], + 'CheckPresenceHeader' => [ + 'description' => '生成缓存键的时候，检查header是否存在，如果存在，则在缓存键中加入header名称（header名称不区分大小写）。支持输入多个header名称，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'headername', + ], + 'CheckPresenceCookie' => [ + 'description' => '生成缓存键的时候，检查cookie是否存在，如果存在，则在缓存键中加入cookie名称（cookie名称不区分大小写）。支持输入多个cookie名称，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'cookiename', + ], + 'UserDeviceType' => [ + 'description' => '生成缓存键的时候，加入客户端设备类型。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'UserGeo' => [ + 'description' => '生成缓存键的时候，加入客户端地理位置。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'UserLanguage' => [ + 'description' => '生成缓存键的时候，加入客户端语言类型。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'ServeStale' => [ + 'description' => '响应过期缓存。开启之后，在源服务器不可用的情况下，节点依然可以使用已缓存的过期文件响应用户请求。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'AdditionalCacheablePorts' => [ + 'description' => '在指定端口上开启缓存功能。取值范围：8880、2052、2082、2086、2095、2053、2083、2087、2096。', + 'type' => 'string', + 'example' => '2095', + ], + 'CacheDeceptionArmor' => [ + 'description' => '缓存欺骗防御。用于防御Web缓存欺骗攻击，通过校验的缓存内容才会被缓存下来。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'PostCache' => [ + 'title' => 'Post缓存功能开关。', + 'description' => 'Post缓存功能开关。', + 'type' => 'string', + 'example' => 'on', + ], + 'PostBodyCacheKey' => [ + 'title' => '缓存键的处理模式。', + 'description' => '缓存键的处理模式。', + 'type' => 'string', + 'example' => 'ignore', + ], + 'PostBodySizeLimit' => [ + 'description' => 'Body大小限制，值为数字，单位是KB，支持1～8KB大小的Body，值为空的时候，默认按8KB生效。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"ConfigId\\": 352816096987136,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\\\n\\",\\n \\"BypassCache\\": \\"cache_all\\",\\n \\"BrowserCacheMode\\": \\"follow_origin\\",\\n \\"BrowserCacheTtl\\": \\"300\\",\\n \\"EdgeCacheMode\\": \\"follow_origin\\",\\n \\"EdgeCacheTtl\\": \\"300\\",\\n \\"EdgeStatusCodeCacheTtl\\": \\"4xx=10\\",\\n \\"SortQueryStringForCache\\": \\"on\\",\\n \\"QueryStringMode\\": \\"reserve_all\\",\\n \\"QueryString\\": \\"example\\",\\n \\"IncludeHeader\\": \\"example\\",\\n \\"IncludeCookie\\": \\"cookie_exapmle\\",\\n \\"CacheReserveEligibility\\": \\"bypass_cache_reserve\\",\\n \\"CheckPresenceHeader\\": \\"headername\\",\\n \\"CheckPresenceCookie\\": \\"cookiename\\",\\n \\"UserDeviceType\\": \\"on\\",\\n \\"UserGeo\\": \\"on\\",\\n \\"UserLanguage\\": \\"on\\",\\n \\"ServeStale\\": \\"on\\",\\n \\"AdditionalCacheablePorts\\": \\"2095\\",\\n \\"CacheDeceptionArmor\\": \\"on\\",\\n \\"PostCache\\": \\"on\\",\\n \\"PostBodyCacheKey\\": \\"ignore\\",\\n \\"PostBodySizeLimit\\": \\"1\\"\\n}","type":"json"}]', + 'title' => '查询站点缓存配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCacheRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCacheRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'GetCacheTag' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257339', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + 'CaseInsensitive' => [ + 'description' => '是否忽略大小写。取值范围：'."\n" + .'- on：开启，忽略大小写。'."\n" + .'- off：关闭，不忽略大小写。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'TagName' => [ + 'description' => '自定义CacheTag名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'SiteVersion' => [ + 'description' => '站点的版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点缓存标签配置', + 'summary' => '查询站点缓存标签配置，在使用按缓存标签刷新功能时，用于指定源站响应信息中携带的CacheTag名称。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCacheTag', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCacheTag', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"CaseInsensitive\\": \\"on\\",\\n \\"TagName\\": \\"example\\",\\n \\"SiteVersion\\": 1\\n}","type":"json"}]', + ], + 'GetCertificate' => [ + 'summary' => '获取站点下指定证书信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239130', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书Id。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaded901474b9693acf530e0fb1d95', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Certificate' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----', + ], + 'Result' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'CasId' => [ + 'description' => '云证书Id。', + 'type' => 'string', + 'example' => '30000478', + ], + 'Id' => [ + 'description' => '证书Id。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d95', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'cas' => '云盾证书', + 'upload' => '自定义上传证书', + 'keyless' => 'Keyless证书', + 'free' => '免费证书', + ], + 'example' => 'free', + ], + 'CommonName' => [ + 'description' => '证书通用名称CN字段。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'NotBefore' => [ + 'description' => '证书有效期的开始时间。', + 'type' => 'string', + 'example' => '2023-11-26T16:00:00Z', + ], + 'NotAfter' => [ + 'description' => '证书有效期的截止时间。', + 'type' => 'string', + 'example' => '2023-11-26T16:00:00Z', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => 'DigiCert', + ], + 'IssuerCN' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'DigiCert Global Root CA', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SigAlg' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'ECDSA-SHA1', + ], + 'PubAlg' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'ECDSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-05-12 02:00:53', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-09-22 05:33:13', + ], + 'SerialNumber' => [ + 'description' => '证书的序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1daa', + ], + 'FingerprintSha256' => [ + 'description' => '证书sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', + ], + 'DCV' => [ + 'description' => 'DCV信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'DCV信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'DCV ID。', + 'type' => 'string', + 'example' => 'bababf7cdd1546a2ad04c0def1f4c980', + ], + 'Type' => [ + 'description' => 'DCV类型。可能值：DNS；HTTP。', + 'type' => 'string', + 'enumValueTitles' => [ + 'DNS' => 'DNS', + 'HTTP' => 'HTTP', + ], + 'example' => 'HTTP', + ], + 'Key' => [ + 'description' => 'DCV名称。DNS类型为TXT记录名；HTTP类型为URL。', + 'type' => 'string', + 'example' => 'http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow', + ], + 'Value' => [ + 'description' => 'DCV内容。', + 'type' => 'string', + 'example' => 'pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ', + ], + 'Status' => [ + 'description' => '验证状态。', + 'type' => 'string', + 'example' => 'pending', + ], + ], + ], + ], + 'ApplyCode' => [ + 'description' => '证书申请错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ApplyMessage' => [ + 'description' => '证书申请错误信息。', + 'type' => 'string', + 'example' => 'canceled', + ], + 'KeyServerId' => [ + 'description' => 'Keyless server ID，当Type为keyless时有效。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838e****', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Status\\": \\"OK\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\",\\n \\"Result\\": {\\n \\"CasId\\": \\"30000478\\",\\n \\"Id\\": \\"babaded901474b9693acf530e0fb1d95\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"free\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"NotBefore\\": \\"2023-11-26T16:00:00Z\\",\\n \\"NotAfter\\": \\"2023-11-26T16:00:00Z\\",\\n \\"Issuer\\": \\"DigiCert\\",\\n \\"IssuerCN\\": \\"DigiCert Global Root CA\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SigAlg\\": \\"ECDSA-SHA1\\",\\n \\"PubAlg\\": \\"ECDSA\\",\\n \\"CreateTime\\": \\"2020-05-12 02:00:53\\",\\n \\"UpdateTime\\": \\"2022-09-22 05:33:13\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1daa\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66\\",\\n \\"DCV\\": [\\n {\\n \\"Id\\": \\"bababf7cdd1546a2ad04c0def1f4c980\\",\\n \\"Type\\": \\"HTTP\\",\\n \\"Key\\": \\"http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow\\",\\n \\"Value\\": \\"pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ\\",\\n \\"Status\\": \\"pending\\"\\n }\\n ],\\n \\"ApplyCode\\": 2,\\n \\"ApplyMessage\\": \\"canceled\\",\\n \\"KeyServerId\\": \\"baba39055622c008b90285a8838e****\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '获取指定证书信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:GetCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'GetCertificateQuota' => [ + 'summary' => '查询免费证书的配额和用量。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238965', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '证书Quota类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'free', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Quota' => [ + 'description' => '免费证书配额。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'QuotaUsage' => [ + 'description' => '免费证书配额用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'Type' => [ + 'description' => '证书Quota类型。', + 'type' => 'string', + 'example' => 'free', + ], + 'SiteCount' => [ + 'description' => '站点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SiteUsage' => [ + 'description' => '站点使用量详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '站点使用量详情。', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'string', + 'example' => '165929521496928', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'SiteUsage' => [ + 'description' => '站点使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed', + 'errorMessage' => 'Failed to check free certificate Quota, please try again later.', + 'description' => '检查免费证书Quota失败，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询免费证书配额和用量', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCertificateQuota', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:GetCertificateQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Quota\\": 10,\\n \\"QuotaUsage\\": 5,\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Type\\": \\"free\\",\\n \\"SiteCount\\": 2,\\n \\"SiteUsage\\": [\\n {\\n \\"SiteId\\": \\"165929521496928\\",\\n \\"SiteName\\": \\"example.com \\",\\n \\"SiteUsage\\": 5\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetClientCaCertificate' => [ + 'summary' => '获取指定的客户端CA证书。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238932', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。可通过[ListClientCaCertificates](~~2860651~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'babab9db65ee5efcca9f3d41d4b5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Certificate' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----', + ], + 'Result' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babab9db65ee5efcca9f3d41d4b5****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'upload', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-03-05 18:24:04', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-03-05 18:24:04', + ], + 'SerialNumber' => [ + 'type' => 'string', + 'description' => '', + ], + 'FingerprintSha256' => [ + 'type' => 'string', + 'description' => '', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取客户端CA证书', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-12T03:30:13.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetClientCaCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetClientCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Status\\": \\"OK\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\",\\n \\"Result\\": {\\n \\"Id\\": \\"babab9db65ee5efcca9f3d41d4b5****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"upload\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-03-05 18:24:04\\",\\n \\"UpdateTime\\": \\"2024-03-05 18:24:04\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"FingerprintSha256\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'GetClientCertificate' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238926', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'active', + ], + 'Certificate' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----', + ], + 'Result' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'active', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'dcdn', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期的开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期的截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书的签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-06-24 07:48:51', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-09-22 05:33:13', + ], + 'CACertificateId' => [ + 'description' => 'CA证书ID。', + 'type' => 'string', + 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', + ], + 'SerialNumber' => [ + 'type' => 'string', + 'description' => '', + ], + 'FingerprintSha256' => [ + 'type' => 'string', + 'description' => '', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取客户端证书信息', + 'summary' => '获取指定的客户端证书信息。', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-12T03:30:14.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Status\\": \\"active\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\",\\n \\"Result\\": {\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"active\\",\\n \\"Type\\": \\"dcdn\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-06-24 07:48:51\\",\\n \\"UpdateTime\\": \\"2024-09-22 05:33:13\\",\\n \\"CACertificateId\\": \\"babab9db65ee5efcca9f3d41d4b50d66\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"FingerprintSha256\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'GetClientCertificateHostnames' => [ + 'summary' => '获取指定客户端CA证书的域名绑定列表，当不指定证书时，返回ESA CA证书的域名绑定列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239234', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Id' => [ + 'description' => '客户端CA证书ID。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + 'Hostnames' => [ + 'description' => '绑定的域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取客户端证书的域名绑定', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetClientCertificateHostnames', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetClientCertificateHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"Hostnames\\": [\\n \\"www.example.com \\"\\n ],\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\"\\n}","type":"json"}]', + ], + 'GetCnameFlattening' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257388', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + ], + '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' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + 'FlattenMode' => [ + 'description' => '拉平模式。取值范围：'."\n" + .'- flatten_all：拉平所有。'."\n" + .'- flatten_at_root： 仅拉平根域。默认拉平根域。', + 'type' => 'string', + 'enumValueTitles' => [ + 'flatten_at_root' => 'flatten_at_root', + 'flatten_all' => 'flatten_all', + ], + 'example' => 'flatten_all', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点CNAME拉平配置', + 'summary' => '查询站点CNAME拉平配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCnameFlattening', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCnameFlattening', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"FlattenMode\\": \\"flatten_all\\"\\n}","type":"json"}]', + ], + 'GetCompressionRule' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257665', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34003500310****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListCompressionRules](~~2867498~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '186C6DF2-D96A-5102-B04E-FB92C16C9867', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'Gzip' => [ + 'description' => 'Gzip压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Brotli' => [ + 'description' => 'Brotli压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Zstd' => [ + 'description' => 'Zstd压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询压缩规则配置详情', + 'summary' => '查询站点的压缩规则详情。', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-12T02:25:41.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCompressionRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCompressionRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"186C6DF2-D96A-5102-B04E-FB92C16C9867\\",\\n \\"ConfigId\\": 0,\\n \\"ConfigType\\": \\"rule\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"Gzip\\": \\"on\\",\\n \\"Brotli\\": \\"on\\",\\n \\"Zstd\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetCrossBorderOptimization' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257426', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '340035003106221', + ], + ], + ], + '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' => 'CF521A24-633F-5350-A6A5-42AD503D0D20', + ], + 'Enable' => [ + 'description' => '是否开启中国大陆网络接入优化，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点中国大陆网络接入优化配置', + 'summary' => '查询站点中国大陆网络接入优化配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCrossBorderOptimization', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCrossBorderOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF521A24-633F-5350-A6A5-42AD503D0D20\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetCustomHostname' => [ + 'summary' => '获取单条 SaaS 域名的详细配置信息，包括域名验证 TXT 名称、域名验证 TXT 内容、证书过期时间（开启 SSL）等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239656', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4DMKZ4', + ], + ], + 'parameters' => [ + [ + 'name' => 'HostnameId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义主机名ID。', + 'description' => 'SaaS 域名的 ID，可通过调用[ListCustomHostnames](~~3018667~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '7C414690-9D7B-5D66-9CD9-AD0B3F25ED49', + ], + 'CustomHostnameModel' => [ + 'description' => '查询到的单个 SaaS 域名信息。', + 'type' => 'object', + 'properties' => [ + 'HostnameId' => [ + 'title' => '自定义主机名ID。', + 'description' => 'SaaS 域名的 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'Hostname' => [ + 'title' => '自定义主机名。', + 'description' => 'SaaS 域名。', + 'type' => 'string', + 'example' => 'custom.site.com', + ], + 'SiteId' => [ + 'title' => '关联站点ID。', + 'description' => '站点 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '890601022130656', + ], + 'SiteName' => [ + 'title' => '关联站点名称。', + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RecordId' => [ + 'title' => '绑定的源站记录ID。', + 'description' => '记录 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4042843419650112', + ], + 'RecordName' => [ + 'title' => '绑定的源站记录名。', + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'origin.example.com', + ], + 'Status' => [ + 'title' => '自定义主机名状态。', + 'description' => 'SaaS 域名状态。'."\n" + .'- **pending**: 待验证。'."\n" + .'- **active**: 已激活。'."\n" + .'- **conflicted**: 被占用。'."\n" + .'- **offline**: 已下线。', + 'type' => 'string', + 'example' => 'active', + 'enum' => [ + 'pending', + 'active', + 'conflicted', + 'offline', + ], + ], + 'VerifyHost' => [ + 'title' => '归属校验TXT名称。', + 'description' => '域名验证 TXT 名称。', + 'type' => 'string', + 'example' => '_esa_custom_hostname.custom.site.com', + ], + 'VerifyCode' => [ + 'title' => '归属校验TXT内容。', + 'description' => '域名验证 TXT 内容。', + 'type' => 'string', + 'example' => 'verify_16ab7f4d389d4dff6655f995c6a997bd', + ], + 'SslFlag' => [ + 'title' => 'SSL开关。', + 'description' => 'SSL开关。'."\n" + .'- **on**: 开启 SSL。'."\n" + .'- **off**: 关闭 SSL。', + 'type' => 'string', + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + 'CertType' => [ + 'title' => '证书类型。', + 'description' => '证书类型。'."\n" + .'- **free**: 免费证书。'."\n" + .'- **upload**: 上传证书。'."\n" + .'- **cas**: 云盾证书。', + 'type' => 'string', + 'example' => 'free', + 'enum' => [ + 'free', + 'upload', + 'cas', + ], + ], + 'CasId' => [ + 'title' => '云盾证书ID。', + 'description' => '云盾证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30000478', + ], + 'CertId' => [ + 'title' => '证书ID。', + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'baba2c9e90e840b3b55698cedf02b308', + ], + 'Certificate' => [ + 'title' => '证书公钥。', + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----', + ], + 'CertStatus' => [ + 'title' => '证书状态。', + 'description' => '证书状态。'."\n" + .'- **OK**: 正常。'."\n" + .'- **Applying**: 申请中。'."\n" + .'- **ApplyFailed**: 申请失败。'."\n" + .'- **Expiring**: 即将过期。'."\n" + .'- **Expired**: 已过期。', + 'type' => 'string', + 'example' => 'OK', + 'enum' => [ + 'OK', + 'Expired', + 'Expiring', + 'Applying', + 'ApplyFailed', + ], + ], + 'CertTxtKey' => [ + 'title' => '证书校验TXT名称。', + 'description' => '证书验证 TXT 名称。', + 'type' => 'string', + 'example' => '_acme-challenge.custom.site.com', + ], + 'CertTxtValue' => [ + 'title' => '证书校验TXT内容。', + 'description' => '证书验证 TXT 内容。', + 'type' => 'string', + 'example' => 'lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM', + ], + 'CertHttpKey' => [ + 'title' => '证书校验HTTP名称', + 'description' => '证书验证 HTTP 地址。', + 'type' => 'string', + 'example' => 'http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc', + ], + 'CertHttpValue' => [ + 'title' => '证书校验HTTP内容。', + 'description' => '证书验证 HTTP 内容。', + 'type' => 'string', + 'example' => 'jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0', + ], + 'CertNotAfter' => [ + 'title' => '证书过期时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '证书过期时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2026-04-19T11:15:20Z', + ], + 'CertApplyMessage' => [ + 'title' => '免费证书申请错误说明。', + 'description' => '免费证书申请错误说明。', + 'type' => 'string', + 'example' => 'canceled', + ], + 'CertApplyCode' => [ + 'title' => '免费证书申请错误码。', + 'description' => '免费证书申请错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'CreateTime' => [ + 'title' => '创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'description' => 'SaaS 域名的创建时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2026-04-19T11:15:20Z', + ], + 'UpdateTime' => [ + 'title' => '更新时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'description' => 'SaaS 域名的更新时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2026-04-19T11:15:20Z', + ], + 'OfflineReason' => [ + 'title' => '下线原因。', + 'description' => 'SaaS 域名被下线的原因。'."\n" + .'- **expiration_ arrears**：订阅套餐到期或账号欠费。'."\n" + .'- **internally_disabled**：被系统内部停用。'."\n" + .'- **missing_icp**：域名缺少ICP。'."\n" + .'- **content_violation**：内容违规。'."\n" + .'- **proactively_disabled**：您主动停用或您设置的用量封顶停用。', + 'type' => 'string', + 'example' => 'missing_icp', + 'enum' => [ + 'proactively_disabled', + 'content_violation', + 'internally_disabled', + 'missing_icp', + 'expiration_arrears', + ], + ], + 'ConflictWith' => [ + 'title' => '冲突原因。', + 'description' => 'SaaS 域名被占用的原因。'."\n" + .'- **existing_custom_hostname**: 与现有 SaaS 域名冲突。'."\n" + .'- **existing_record**: 与现有站点记录冲突。'."\n" + .'- **existing_load_balancer**: 与现有负载均衡器冲突。'."\n" + .'- **existing_origin_pool**: 与现有源地址池冲突。', + 'type' => 'string', + 'example' => 'existing_custom_hostname', + 'enum' => [ + 'existing_custom_hostname', + 'existing_site', + 'existing_record', + 'existing_load_balancer', + 'existing_origin_pool', + ], + ], + 'PrivateKey' => [ + 'description' => '证书私钥。', + 'type' => 'string', + 'example' => '-----BEGIN RSA PRIVATE KEY-----', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 404 => [ + [ + 'errorCode' => 'CustomHostname.NotFound', + 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', + 'description' => '该自定义主机名不存在，请调整后重试。', + ], + [ + 'errorCode' => 'CustomHostname.ApplyCertFailed', + 'errorMessage' => 'Fail to apply a free cert for custom hostname. Please try again later.', + 'description' => '', + ], + [ + 'errorCode' => 'CustomHostname.SetCertFailed', + 'errorMessage' => 'Fail to deploy a cert for custom hostname. Please try again later.', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询 SaaS 域名详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C414690-9D7B-5D66-9CD9-AD0B3F25ED49\\",\\n \\"CustomHostnameModel\\": {\\n \\"HostnameId\\": 1234567890123,\\n \\"Hostname\\": \\"custom.site.com\\",\\n \\"SiteId\\": 890601022130656,\\n \\"SiteName\\": \\"example.com\\",\\n \\"RecordId\\": 4042843419650112,\\n \\"RecordName\\": \\"origin.example.com\\",\\n \\"Status\\": \\"active\\",\\n \\"VerifyHost\\": \\"_esa_custom_hostname.custom.site.com\\",\\n \\"VerifyCode\\": \\"verify_16ab7f4d389d4dff6655f995c6a997bd\\",\\n \\"SslFlag\\": \\"on\\",\\n \\"CertType\\": \\"free\\",\\n \\"CasId\\": 30000478,\\n \\"CertId\\": \\"baba2c9e90e840b3b55698cedf02b308\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\",\\n \\"CertStatus\\": \\"OK\\",\\n \\"CertTxtKey\\": \\"_acme-challenge.custom.site.com\\",\\n \\"CertTxtValue\\": \\"lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM\\",\\n \\"CertHttpKey\\": \\"http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc\\",\\n \\"CertHttpValue\\": \\"jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0\\",\\n \\"CertNotAfter\\": \\"2026-04-19T11:15:20Z\\",\\n \\"CertApplyMessage\\": \\"canceled\\",\\n \\"CertApplyCode\\": 2,\\n \\"CreateTime\\": \\"2026-04-19T11:15:20Z\\",\\n \\"UpdateTime\\": \\"2026-04-19T11:15:20Z\\",\\n \\"OfflineReason\\": \\"missing_icp\\",\\n \\"ConflictWith\\": \\"existing_custom_hostname\\",\\n \\"PrivateKey\\": \\"-----BEGIN RSA PRIVATE KEY-----\\"\\n }\\n}","type":"json"}]', + ], + 'GetCustomResponseCodeRule' => [ + 'summary' => '查询站点的修改响应码配置详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257648', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '775724064754208', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '424022244554752', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ReturnCode' => [ + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'PageId' => [ + 'description' => '响应页面。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询修改响应码配置详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"ConfigId\\": 352816096987136,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ReturnCode\\": \\"200\\",\\n \\"PageId\\": \\"0\\"\\n}","type":"json"}]', + ], + 'GetDevelopmentMode' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257406', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5407498413****', + ], + ], + ], + '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' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + 'Enable' => [ + 'description' => '开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点开发模式配置', + 'summary' => '查询站点开发模式配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetDevelopmentMode', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetDevelopmentMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetEdgeContainerApp' => [ + 'summary' => '获取边缘容器的应用信息，包括应用基础配置、健康检查等信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239322', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + 'App' => [ + 'description' => '应用基础信息', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '应用的状态信息，取值为：'."\n" + .'- creating：创建中'."\n" + .'- failed：创建失败'."\n" + .'- created：创建成功', + 'type' => 'string', + 'example' => 'created', + ], + 'GatewayType' => [ + 'description' => '网关类型，可能值：'."\n" + .'- l7：七层网关'."\n" + .'- l4：四层网关', + 'type' => 'string', + 'example' => 'l7', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-07-25T05:58:05Z', + ], + 'VersionCount' => [ + 'description' => '应用版本数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DomainName' => [ + 'description' => '当前应用绑定的域名，如果未绑定，则为空字符串。', + 'type' => 'string', + 'example' => 'www.1feel.cn', + ], + 'Remarks' => [ + 'description' => '应用的备注信息。', + 'type' => 'string', + 'example' => 'test app', + ], + 'ServicePort' => [ + 'description' => '服务端端口号，范围1~65535。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-88068867578379****', + ], + 'TargetPort' => [ + 'description' => '后端端口，也是应用的服务端口，范围1~65535。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'QuicCid' => [ + 'description' => '是否开启QUIC支持。', + 'type' => 'string', + 'example' => 'false', + ], + 'Name' => [ + 'description' => '应用名称', + 'type' => 'string', + 'example' => 'test-app1', + ], + 'UpdateTime' => [ + 'description' => '应用的上次修改时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-03-26T02:35:58Z', + ], + 'HealthCheck' => [ + 'description' => '表示健康检查信息的对象。', + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => '应用健康检查超时时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Type' => [ + 'description' => '应用健康检查类型，取值：'."\n" + .'- l7'."\n" + .'- l4', + 'type' => 'string', + 'example' => 'l7', + ], + 'Host' => [ + 'description' => '应用健康检查的域名。', + 'type' => 'string', + 'example' => 'test.com', + ], + 'Interval' => [ + 'description' => '应用健康检查的间隔时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SuccTimes' => [ + 'description' => '应用的健康检查连续成功次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Method' => [ + 'description' => '应用的健康检查的方法。', + 'type' => 'string', + 'example' => 'HEAD', + ], + 'HttpCode' => [ + 'description' => '应用的健康检查成功的状态码范围。', + 'type' => 'string', + 'example' => 'http_2xx', + ], + 'FailTimes' => [ + 'description' => '应用的健康检查连续失败次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Port' => [ + 'description' => '应用的健康检查端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Uri' => [ + 'description' => '应用的健康检查的路径。', + 'type' => 'string', + 'example' => '/health_check', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取边缘容器的应用信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerApp', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"App\\": {\\n \\"Status\\": \\"created\\",\\n \\"GatewayType\\": \\"l7\\",\\n \\"CreateTime\\": \\"2023-07-25T05:58:05Z\\",\\n \\"VersionCount\\": 1,\\n \\"DomainName\\": \\"www.1feel.cn\\",\\n \\"Remarks\\": \\"test app\\",\\n \\"ServicePort\\": 80,\\n \\"AppId\\": \\"app-88068867578379****\\",\\n \\"TargetPort\\": 80,\\n \\"QuicCid\\": \\"false\\",\\n \\"Name\\": \\"test-app1\\",\\n \\"UpdateTime\\": \\"2023-03-26T02:35:58Z\\",\\n \\"HealthCheck\\": {\\n \\"Timeout\\": 60,\\n \\"Type\\": \\"l7\\",\\n \\"Host\\": \\"test.com\\",\\n \\"Interval\\": 5,\\n \\"SuccTimes\\": 3,\\n \\"Method\\": \\"HEAD\\",\\n \\"HttpCode\\": \\"http_2xx\\",\\n \\"FailTimes\\": 5,\\n \\"Port\\": 80,\\n \\"Uri\\": \\"/health_check\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetEdgeContainerAppLogRiver' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249444', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-880688675****88', + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'Stdout' => [ + 'description' => '开启容器的标准输出采集。', + 'type' => 'boolean', + ], + 'Path' => [ + 'description' => '容器的日志文件路径，必须为绝对路径，以“/”开头；支持使用星号（*）和半角问号（?）通配符。', + 'type' => 'string', + 'example' => '/root/hello.log', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取边缘容器日志采集配置信息', + 'summary' => '获取边缘容器应用日志采集配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppLogRiver', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppLogRiver', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Stdout\\": true,\\n \\"Path\\": \\"/root/hello.log\\"\\n}","type":"json"}]', + ], + 'GetEdgeContainerAppResourceCapacity' => [ + 'summary' => '获取边缘容器应用的资源容量', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + ], + ], + ], + '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' => '50423A7F-A83D-1E24-B80E-86DD25790759'."\n", + ], + 'Regions' => [ + 'description' => '可用地域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '中国内地：'."\n" + .'- 华东：huadong'."\n" + .'- 华南：huanan'."\n" + .'- 华中：huazhong'."\n" + .'- 华北：huabei'."\n" + .'- 西北：xibei'."\n" + .'- 西南：xinan'."\n" + .'- 东北：dongbei'."\n" + ."\n" + .'特别行政区以及海外：'."\n" + ."\n" + .'- 中国台湾：tw'."\n" + .'- 中国澳门：mo'."\n" + .'- 中国香港：hk'."\n" + .'- 日本：jp'."\n" + .'- 美国：us'."\n" + .'- 泰国：th'."\n" + .'- 韩国：kr'."\n" + .'- 俄罗斯：ru'."\n" + .'- 新加坡：sg'."\n" + .'- 法国：fr'."\n" + .'- 西班牙：es'."\n" + .'- 意大利：it'."\n" + .'- 瑞典：se'."\n" + .'- 阿联酋：ae'."\n" + .'- 印尼：id'."\n" + .'- 智利：cl'."\n" + .'- 菲律宾：ph'."\n" + .'- 马来西亚：my'."\n" + .'- 越南：vn'."\n" + .'- 阿根廷：ar'."\n" + .'- 澳大利亚：au'."\n" + .'- 巴西：br'."\n" + .'- 哥伦比亚：co'."\n" + .'- 德国：de'."\n" + .'- 英国：gb'."\n" + .'- 秘鲁：pe'."\n" + .'- 沙特：sa'."\n" + .'- 荷兰：nl'."\n" + .'- 南非：za', + 'type' => 'string', + 'example' => 'huadong', + ], + 'Isp' => [ + 'description' => '支持如下几种运营商，海外与特别行政区不会输出。'."\n" + .'运营商：'."\n" + ."\n" + .'- 中国移动：cmcc'."\n" + .'- 中国电信：chinanet'."\n" + .'- 中国联通：unicom', + 'type' => 'string', + 'example' => 'unicom', + ], + 'Replicas' => [ + 'description' => '可部署的容器副本数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidParameter.Appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取边缘容器应用资源容量', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50423A7F-A83D-1E24-B80E-86DD25790759\\\\n\\",\\n \\"Regions\\": [\\n {\\n \\"Region\\": \\"huadong\\",\\n \\"Isp\\": \\"unicom\\",\\n \\"Replicas\\": 16\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetEdgeContainerAppResourceReserve' => [ + 'summary' => '获取边缘容器资源预留配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '265068', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-88068867578379****', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + 'Enable' => [ + 'description' => '是否开启资源预留。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Forever' => [ + 'description' => '是否永久开启预留。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DurationTime' => [ + 'description' => '预留截止时间，该接口输入为UTC时间，输入北京时间需+8小时，例如当前为不北京时间 2006-01-02 06:04:05 , 则需要输入"2006-01-02T14:04:05Z"。', + 'type' => 'string', + 'example' => '2006-01-02T15:04:05Z', + ], + 'ReserveSet' => [ + 'description' => '预留资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '预留区域对象。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '中国内地：'."\n" + .'- 华东：huadong'."\n" + .'- 华南：huanan'."\n" + .'- 华中：huazhong'."\n" + .'- 华北：huabei'."\n" + .'- 西北：xibei'."\n" + .'- 西南：xinan'."\n" + .'- 东北：dongbei'."\n" + ."\n" + .'特别行政区以及海外：'."\n" + .'- 中国台湾：tw'."\n" + .'- 中国澳门：mo'."\n" + .'- 中国香港：hk'."\n" + .'- 日本：jp'."\n" + .'- 美国：us'."\n" + .'- 泰国：th'."\n" + .'- 韩国：kr'."\n" + .'- 俄罗斯：ru'."\n" + .'- 新加坡：sg'."\n" + .'- 法国：fr'."\n" + .'- 西班牙：es'."\n" + .'- 意大利：it'."\n" + .'- 瑞典：se'."\n" + .'- 阿联酋：ae'."\n" + .'- 印尼：id'."\n" + .'- 智利：cl'."\n" + .'- 菲律宾：ph'."\n" + .'- 马来西亚：my'."\n" + .'- 越南：vn'."\n" + .'- 阿根廷：ar'."\n" + .'- 澳大利亚：au'."\n" + .'- 巴西：br'."\n" + .'- 哥伦比亚：co'."\n" + .'- 德国：de'."\n" + .'- 英国：gb'."\n" + .'- 秘鲁：pe'."\n" + .'- 沙特：sa'."\n" + .'- 荷兰：nl'."\n" + .'- 南非：za', + 'type' => 'string', + 'example' => 'huazhong', + ], + 'Isp' => [ + 'description' => '支持如下几种运营商，海外与特别行政区无需填入。'."\n" + .'运营商：'."\n" + .'- 中国移动：cmcc'."\n" + .'- 中国电信：chinanet'."\n" + .'- 中国联通：unicom', + 'type' => 'string', + 'example' => 'cmcc', + ], + 'Replicas' => [ + 'description' => '容器副本数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidParameter.Appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + ], + 'title' => '获取边缘容器应用资源预留配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppResourceReserve', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppResourceReserve', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"Enable\\": true,\\n \\"Forever\\": true,\\n \\"DurationTime\\": \\"2006-01-02T15:04:05Z\\",\\n \\"ReserveSet\\": [\\n {\\n \\"Region\\": \\"huazhong\\",\\n \\"Isp\\": \\"cmcc\\",\\n \\"Replicas\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetEdgeContainerAppResourceStatus' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267316', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-96253477062511****', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'Regions' => [ + 'description' => '部署区域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '部署区域。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '中国内地：'."\n" + .'- 华东：huadong'."\n" + .'- 华南：huanan'."\n" + .'- 华中：huazhong'."\n" + .'- 华北：huabei'."\n" + .'- 西北：xibei'."\n" + .'- 西南：xinan'."\n" + .'- 东北：dongbei'."\n" + ."\n" + .'特别行政区以及海外：'."\n" + ."\n" + .'- 中国台湾：tw'."\n" + .'- 中国澳门：mo'."\n" + .'- 中国香港：hk'."\n" + .'- 日本：jp'."\n" + .'- 美国：us'."\n" + .'- 泰国：th'."\n" + .'- 韩国：kr'."\n" + .'- 俄罗斯：ru'."\n" + .'- 新加坡：sg'."\n" + .'- 法国：fr'."\n" + .'- 西班牙：es'."\n" + .'- 意大利：it'."\n" + .'- 瑞典：se'."\n" + .'- 阿联酋：ae'."\n" + .'- 印尼：id'."\n" + .'- 智利：cl'."\n" + .'- 菲律宾：ph'."\n" + .'- 马来西亚：my'."\n" + .'- 越南：vn'."\n" + .'- 阿根廷：ar'."\n" + .'- 澳大利亚：au'."\n" + .'- 巴西：br'."\n" + .'- 哥伦比亚：co'."\n" + .'- 德国：de'."\n" + .'- 英国：gb'."\n" + .'- 秘鲁：pe'."\n" + .'- 沙特：sa'."\n" + .'- 荷兰：nl'."\n" + .'- 南非：za', + 'type' => 'string', + 'example' => 'huadong', + ], + 'Isp' => [ + 'description' => '支持如下几种运营商，海外与特别行政区不会输出。'."\n" + .'运营商：'."\n" + ."\n" + .'- 中国移动：cmcc'."\n" + .'- 中国电信：chinanet'."\n" + .'- 中国联通：unicom', + 'type' => 'string', + 'example' => 'unicom', + ], + 'Total' => [ + 'description' => '部署的总副本数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Ready' => [ + 'description' => '就绪的副本数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsStaging' => [ + 'description' => '是否为测试环境。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsOffline' => [ + 'description' => '是否处于平滑下线中。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidParameter.Appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + ], + 'title' => '获取边缘容器应用资源分布', + 'summary' => '获取边缘容器应用资源分布。', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-09T17:07:02.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppResourceStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppResourceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Regions\\": [\\n {\\n \\"Region\\": \\"huadong\\",\\n \\"Isp\\": \\"unicom\\",\\n \\"Total\\": 1,\\n \\"Ready\\": 1,\\n \\"IsStaging\\": false,\\n \\"IsOffline\\": false\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetEdgeContainerAppStatus' => [ + 'summary' => '获取边缘容器的应用状态信息，包括应用的部署、发布、回滚等信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238718', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'PublishEnv', + 'in' => 'query', + 'schema' => [ + 'description' => '发布环境，支持"prod","staging"两种发布环境。', + 'type' => 'string', + 'required' => false, + 'example' => 'staging', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', + ], + 'AppStatus' => [ + 'description' => '描述应用状态信息的对象。', + 'type' => 'object', + 'properties' => [ + 'PublishPercentage' => [ + 'description' => '应用的发布比例。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50%', + ], + 'RollbackTime' => [ + 'description' => '最近一次回滚时间。', + 'type' => 'string', + 'example' => '2024-07-25T05:58:05Z'."\n", + ], + 'PublishEnv' => [ + 'description' => '发布的环境，取值如下：'."\n" + ."\n" + .'- **prod**: 生产环境。'."\n" + .'- **staging**：预发环境。', + 'type' => 'string', + 'example' => 'prod', + ], + 'PublishingVersion' => [ + 'description' => '应用的发布版本。', + 'type' => 'string', + 'example' => 'ver-123123123123****'."\n", + ], + 'BaseLineVersion' => [ + 'description' => '应用的版本基线。', + 'type' => 'string', + 'example' => 'ver-123123123123****'."\n", + ], + 'PublishStatus' => [ + 'description' => '应用的发布状态。'."\n" + .'- **publishing**：发布中。'."\n" + .'- **published**：已发布。'."\n" + .'- **rollbacking**：回滚中。'."\n" + .'- **rollbacked**：回滚完成。', + 'type' => 'string', + 'example' => 'pubishing', + ], + 'DeployTime' => [ + 'description' => '应用的部署时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-07-25T05:58:05Z'."\n", + ], + 'PublishTime' => [ + 'description' => '应用的发布时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-07-25T05:58:05Z'."\n", + ], + 'DeployedVersion' => [ + 'description' => '应用的部署版本。', + 'type' => 'string', + 'example' => 'ver-123123123123****', + ], + 'ExpectPercentage' => [ + 'description' => '应用的预期发布比例。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50%', + ], + 'DeployStatus' => [ + 'description' => '应用的部署状态。'."\n" + .'- **undeploy**：未部署。'."\n" + .'- **deploying**：部署中。'."\n" + .'- **deployed**：已部署。'."\n" + .'- **undeploying**：取消部署中。', + 'type' => 'string', + 'example' => 'undeploy', + ], + 'UnDeployTime' => [ + 'description' => '应用的取消部署时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2024-07-25T05:58:05Z'."\n", + ], + 'PublishType' => [ + 'description' => '发布类型，支持如下两种：'."\n" + ."\n" + .'- **percentage**：按照百分比发布。'."\n" + ."\n" + .'- **region**：按照区域发布。'."\n" + ."\n" + .'若不填写，默认使用百分比发布。', + 'type' => 'string', + 'example' => 'percentage', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '发布区域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '区域名称。', + 'type' => 'string', + 'example' => 'jiangsu', + ], + ], + ], + 'description' => '', + ], + 'FullRelease' => [ + 'description' => '是否全量发布。该字段仅当 PublishType设置为 region 时生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取边缘容器的应用状态信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\",\\n \\"AppStatus\\": {\\n \\"PublishPercentage\\": 0,\\n \\"RollbackTime\\": \\"2024-07-25T05:58:05Z\\\\n\\",\\n \\"PublishEnv\\": \\"prod\\",\\n \\"PublishingVersion\\": \\"ver-123123123123****\\\\n\\",\\n \\"BaseLineVersion\\": \\"ver-123123123123****\\\\n\\",\\n \\"PublishStatus\\": \\"pubishing\\",\\n \\"DeployTime\\": \\"2024-07-25T05:58:05Z\\\\n\\",\\n \\"PublishTime\\": \\"2024-07-25T05:58:05Z\\\\n\\",\\n \\"DeployedVersion\\": \\"ver-123123123123****\\",\\n \\"ExpectPercentage\\": 0,\\n \\"DeployStatus\\": \\"undeploy\\",\\n \\"UnDeployTime\\": \\"2024-07-25T05:58:05Z\\\\n\\",\\n \\"PublishType\\": \\"percentage\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n \\"jiangsu\\"\\n ]\\n },\\n \\"FullRelease\\": true\\n }\\n}","type":"json"}]', + ], + 'GetEdgeContainerAppVersion' => [ + 'summary' => '获取边缘容器应用的版本信息，通过版本信息选择某个版本进行发布。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238877', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '版本ID，可使用[ListEdgeContainerAppVersions](~~ListEdgeContainerAppVersions~~)接口获取版本ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ver-87962637161651****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Version' => [ + 'description' => '版本信息。', + 'type' => 'object', + 'properties' => [ + 'LastPublishTime' => [ + 'description' => '版本上次发布时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-07-25T04:58:05Z', + ], + 'PublishTime' => [ + 'description' => '发布时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-11-14T02:04:03Z', + ], + 'Status' => [ + 'description' => '当前版本的状态。取值：'."\n" + ."\n" + .'- **created**：创建成功。'."\n" + .'- **failed**：创建失败。'."\n" + .'- **creating**：创建中。', + 'type' => 'string', + 'example' => 'created', + ], + 'CreateTime' => [ + 'description' => '版本创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-07-01T09:32:33Z', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-88068867578379****', + ], + 'VersionId' => [ + 'description' => '返回创建的版本的ID。', + 'type' => 'string', + 'example' => 'ver-87962637161651****', + ], + 'Name' => [ + 'description' => '版本名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'UpdateTime' => [ + 'description' => '版本的上次修改时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2021-12-03T10:52:52Z', + ], + 'Remarks' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'aaa', + ], + 'Containers' => [ + 'description' => '该版本要部署的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '描述单个容器具体信息的对象。', + 'type' => 'object', + 'properties' => [ + 'EnvVariables' => [ + 'description' => '环境变量', + 'type' => 'string', + 'example' => 'ENV=prod', + ], + 'Args' => [ + 'description' => '启动参数。', + 'type' => 'string', + 'example' => '-c /path/config.toml', + ], + 'Spec' => [ + 'description' => '规格', + 'type' => 'string', + 'example' => '1C2G', + ], + 'Storage' => [ + 'description' => '容器存储规格。', + 'type' => 'string', + 'example' => '0.5G, 标识存储空间，取值范围（0.5G | 10G | 20G | 30G）', + ], + 'IsACRImage' => [ + 'description' => '是否为ACR镜像。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ACRImageInfo' => [ + 'description' => 'ACR镜像信息。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => 'ACR镜像域名。', + 'type' => 'string', + 'example' => '*.mooc.seewo.com', + ], + 'InstanceId' => [ + 'description' => 'ACR站点实例ID。', + 'type' => 'string', + 'example' => 'xcdn-9ak2thl14z5s', + ], + 'RegionId' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RepoId' => [ + 'description' => '镜像仓库ID。', + 'type' => 'string', + 'example' => 'crr-zeu0xyk28alyxozh', + ], + 'RepoName' => [ + 'description' => '镜像仓库的名称。', + 'type' => 'string', + 'example' => 'test_1', + ], + 'RepoNamespace' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'wpy1', + ], + 'Tag' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'test-healthy-100-soa-1710987653', + ], + 'TagUrl' => [ + 'description' => 'ACR镜像标签地址。', + 'type' => 'string', + 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2', + ], + 'IsEnterpriseRegistry' => [ + 'description' => '是否为企业级镜像。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Image' => [ + 'description' => '镜像地址', + 'type' => 'string', + 'example' => 'nginx:1.14.0', + ], + 'Command' => [ + 'description' => '容器启动命令。', + 'type' => 'string', + 'example' => 'sh abc.sh 1 2 3', + ], + 'ProbeType' => [ + 'description' => '探针类型。', + 'type' => 'string', + 'example' => 'httpGet', + ], + 'Name' => [ + 'description' => '版本名称。', + 'type' => 'string', + 'example' => 'version01', + ], + 'PreStop' => [ + 'description' => '容器停止前执行命令。', + 'type' => 'string', + 'example' => 'sh prestop.sh "echo hello world" ', + ], + 'PostStart' => [ + 'description' => '容器启动前执行命令。', + 'type' => 'string', + 'example' => 'sh poststart.sh "echo hello world" ', + ], + 'ProbeContent' => [ + 'description' => '探针内容。', + 'type' => 'object', + 'properties' => [ + 'SuccessThreshold' => [ + 'description' => '健康检查连续成功次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Host' => [ + 'description' => '健康检查的域名。', + 'type' => 'string', + 'example' => 'test.com', + ], + 'HttpHeaders' => [ + 'description' => 'HTTP请求头。', + 'type' => 'string', + 'example' => '[{\\"Content-Type\\":\\"application/json', + ], + 'Scheme' => [ + 'description' => '健康检查的请求协议。', + 'type' => 'string', + 'example' => 'http', + ], + 'InitialDelaySeconds' => [ + 'description' => '容器探针初始化延迟时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Command' => [ + 'description' => '探针运行命令。', + 'type' => 'string', + 'example' => 'sh test.sh', + ], + 'FailureThreshold' => [ + 'description' => '容器健康检查连续失败次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TimeoutSeconds' => [ + 'description' => '容器健康检查的超时时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Path' => [ + 'description' => '容器健康检查的路径。', + 'type' => 'string', + 'example' => '/health_check', + ], + 'Port' => [ + 'description' => '后端服务器使用的端口。取值范围：**1**~**65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'PeriodSeconds' => [ + 'description' => '容器健康检查的间隔时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidVersion.NotFound', + 'errorMessage' => 'The version does not exist.', + 'description' => '这个版本号不存在。'."\n", + ], + [ + 'errorCode' => 'InvalidParameter.VersionId', + 'errorMessage' => 'The specified VersionId is invalid.  Please check the VersionId parameter. You may not have entered the parameter or the parameter does not start with ver-string. Please modify it and call the interface again.', + 'description' => 'VersionId参数无效。请检查VersionId参数，你有可能未输入该参数或者，参数并未以ver-字符串开头，请进行修改后，重新调用接口。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '获取边缘容器应用的版本信息', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-12T02:06:26.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppVersion', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Version\\": {\\n \\"LastPublishTime\\": \\"2023-07-25T04:58:05Z\\",\\n \\"PublishTime\\": \\"2022-11-14T02:04:03Z\\",\\n \\"Status\\": \\"created\\",\\n \\"CreateTime\\": \\"2022-07-01T09:32:33Z\\",\\n \\"AppId\\": \\"app-88068867578379****\\",\\n \\"VersionId\\": \\"ver-87962637161651****\\",\\n \\"Name\\": \\"test\\",\\n \\"UpdateTime\\": \\"2021-12-03T10:52:52Z\\",\\n \\"Remarks\\": \\"aaa\\",\\n \\"Containers\\": [\\n {\\n \\"EnvVariables\\": \\"ENV=prod\\",\\n \\"Args\\": \\"-c /path/config.toml\\",\\n \\"Spec\\": \\"1C2G\\",\\n \\"Storage\\": \\"0.5G, 标识存储空间，取值范围（0.5G | 10G | 20G | 30G）\\",\\n \\"IsACRImage\\": false,\\n \\"ACRImageInfo\\": {\\n \\"Domain\\": \\"*.mooc.seewo.com\\",\\n \\"InstanceId\\": \\"xcdn-9ak2thl14z5s\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RepoId\\": \\"crr-zeu0xyk28alyxozh\\",\\n \\"RepoName\\": \\"test_1\\",\\n \\"RepoNamespace\\": \\"wpy1\\",\\n \\"Tag\\": \\"test-healthy-100-soa-1710987653\\",\\n \\"TagUrl\\": \\"registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2\\",\\n \\"IsEnterpriseRegistry\\": false\\n },\\n \\"Image\\": \\"nginx:1.14.0\\",\\n \\"Command\\": \\"sh abc.sh 1 2 3\\",\\n \\"ProbeType\\": \\"httpGet\\",\\n \\"Name\\": \\"version01\\",\\n \\"PreStop\\": \\"sh prestop.sh \\\\\\"echo hello world\\\\\\" \\",\\n \\"PostStart\\": \\"sh poststart.sh \\\\\\"echo hello world\\\\\\" \\",\\n \\"ProbeContent\\": {\\n \\"SuccessThreshold\\": 1,\\n \\"Host\\": \\"test.com\\",\\n \\"HttpHeaders\\": \\"[{\\\\\\\\\\\\\\"Content-Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"application/json\\",\\n \\"Scheme\\": \\"http\\",\\n \\"InitialDelaySeconds\\": 20,\\n \\"Command\\": \\"sh test.sh\\",\\n \\"FailureThreshold\\": 3,\\n \\"TimeoutSeconds\\": 5,\\n \\"Path\\": \\"/health_check\\",\\n \\"Port\\": 80,\\n \\"PeriodSeconds\\": 5\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetEdgeContainerDeployRegions' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238476', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'GetEdgeContainerDeployRegions', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Regions' => [ + 'description' => '区域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用地域。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'zhejiang', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取边缘容器应用部署区域', + 'summary' => '根据应用ID获取边缘容器应用部署区域。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerDeployRegions', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerDeployRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Regions\\": [\\n \\"zhejiang\\"\\n ]\\n}","type":"json"}]', + ], + 'GetEdgeContainerLogs' => [ + 'summary' => '该接口用于获取边缘容器日志信息。输出行数可指定。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238630', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + ], + ], + [ + 'name' => 'Lines', + 'in' => 'query', + 'schema' => [ + 'description' => '输出的日志行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '500', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247B78', + ], + 'Items' => [ + 'description' => '日志列表。', + 'type' => 'array', + 'items' => [ + 'description' => '日志内容。', + 'type' => 'string', + 'example' => 'hello world.', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取边缘容器日志信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerLogs', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\",\\n \\"Items\\": [\\n \\"hello world.\\"\\n ]\\n}","type":"json"}]', + ], + 'GetEdgeContainerStagingDeployStatus' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238416', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'GetEdgeContainerStagingDeployStatus', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Phase' => [ + 'description' => '测试环境容器所处状态。'."\n" + .'- NoContainer 无容器。'."\n" + .'- Pending 等待部署。'."\n" + .'- ContainerCreating 容器创建中。'."\n" + .'- Running 运行中。'."\n" + .'- Succeeded 已完成。'."\n" + .'- ImagePullBackOff 镜像拉取失败。'."\n" + .'- CrashLoopBackOff 容器启动异常。'."\n" + .'- Failed 失败。'."\n" + .'- Unknown 未知。', + 'type' => 'string', + 'example' => 'Running', + ], + 'CreationTimestamp' => [ + 'description' => '创建时间（时间戳）。', + 'type' => 'string', + 'example' => '2024-09-24T06:46:35Z', + ], + 'Initialized' => [ + 'description' => '容器初始化状态。'."\n" + ."\n" + .'- **ok**： 成功。'."\n" + ."\n" + .'- **unready**：未完成', + 'type' => 'string', + 'example' => 'ok', + ], + 'Scheduled' => [ + 'description' => '容器调度状态。'."\n" + ."\n" + .'- **ok**： 成功。'."\n" + ."\n" + .'- **unready**：未完成', + 'type' => 'string', + 'example' => 'ok', + ], + 'Ready' => [ + 'description' => '容器流量接入是否Ready。'."\n" + ."\n" + .'- **ok**： 成功。'."\n" + ."\n" + .'- **unready**：未完成', + 'type' => 'string', + 'example' => 'ok', + ], + 'ContainersReady' => [ + 'description' => '容器状态是否Ready。'."\n" + ."\n" + .'- **ok**： 成功。'."\n" + ."\n" + .'- **unready**：未完成', + 'type' => 'string', + 'example' => 'ok', + ], + 'PodRestartState' => [ + 'description' => '容器重启状态。', + 'type' => 'object', + 'properties' => [ + 'RestartCount' => [ + 'description' => '重启次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastTerminatedReason' => [ + 'description' => '历史重启原因。', + 'type' => 'string', + 'example' => 'OOMKilled', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2F2C992B-3FE2-5EBB-A61F-F9DD4EB257DA', + ], + 'VIPs' => [ + 'description' => 'VIP列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VIP', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取应用测试环境部署状态', + 'summary' => '根据应用ID获取应用测试环境部署状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerStagingDeployStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerStagingDeployStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Phase\\": \\"Running\\",\\n \\"CreationTimestamp\\": \\"2024-09-24T06:46:35Z\\",\\n \\"Initialized\\": \\"ok\\",\\n \\"Scheduled\\": \\"ok\\",\\n \\"Ready\\": \\"ok\\",\\n \\"ContainersReady\\": \\"ok\\",\\n \\"PodRestartState\\": {\\n \\"RestartCount\\": 1,\\n \\"LastTerminatedReason\\": \\"OOMKilled\\"\\n },\\n \\"RequestId\\": \\"2F2C992B-3FE2-5EBB-A61F-F9DD4EB257DA\\",\\n \\"VIPs\\": [\\n \\"1.1.1.1\\"\\n ]\\n}","type":"json"}]', + ], + 'GetEdgeContainerTerminal' => [ + 'summary' => '该接口用于获取边缘容器应用终端信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238310', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-88068867578379****', + ], + ], + ], + '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' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + 'Pod' => [ + 'description' => '容器组名称。', + 'type' => 'string', + 'example' => '1775b9e0-8463-457e-89e8-fb7b6d125b2e', + ], + 'Cluster' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'c497b44c2a59f4ae0bd2826edc40a2c6e', + ], + 'Namespace' => [ + 'description' => 'Namespace名称。', + 'type' => 'string', + 'example' => 'ns1', + ], + 'Container' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'worker0', + ], + 'SessionId' => [ + 'description' => '会话ID。', + 'type' => 'string', + 'example' => 'af22f4xxxxxxxxxxxxxxxxxx', + ], + 'Token' => [ + 'description' => '分享令牌信息。', + 'type' => 'string', + 'example' => 'af22f4-xxxxx-xxxx-xxxx-xxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取边缘容器应用终端信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerTerminal', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerTerminal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n \\"Pod\\": \\"1775b9e0-8463-457e-89e8-fb7b6d125b2e\\",\\n \\"Cluster\\": \\"c497b44c2a59f4ae0bd2826edc40a2c6e\\",\\n \\"Namespace\\": \\"ns1\\",\\n \\"Container\\": \\"worker0\\",\\n \\"SessionId\\": \\"af22f4xxxxxxxxxxxxxxxxxx\\",\\n \\"Token\\": \\"af22f4-xxxxx-xxxx-xxxx-xxxx\\"\\n}","type":"json"}]', + ], + 'GetErService' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239198', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + 'tenantRelevance' => 'publicInformation', + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'PlanName' => [ + 'description' => '计费模式：'."\n" + ."\n" + .'- **er_paymode**：中国或中国内地付费。'."\n" + ."\n" + .'- **er_freemode**：中国或中国内地免费。'."\n" + ."\n" + .'- **er_paymodeintl**：国际付费。'."\n" + ."\n" + .'- **err_freemodeintl**：国际免费。', + 'type' => 'string', + 'example' => 'er_paymode', + ], + 'Status' => [ + 'description' => '服务状态： '."\n" + ."\n" + .'- **Creating**：创建中。'."\n" + ."\n" + .'- **Running**：运行中。'."\n" + ."\n" + .'- **NotOpened**：不可用。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询边缘函数服务状态', + 'summary' => '检查边缘函数服务的当前运行状况。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetErService', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetErService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"PlanName\\": \\"er_paymode\\",\\n \\"Status\\": \\"Running\\"\\n}","type":"json"}]', + ], + 'GetHttpIncomingRequestHeaderModificationRule' => [ + 'summary' => '查询站点的修改HTTP入站请求头配置详情', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257648', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '608665779308176', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用ListHttpIncomingRequestHeaderModificationRules接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '433045006266368', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5CC228B4-7A67-4016-9C9F-4A4133494A91', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '402411533580288', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example'."\n", + ], + 'RequestHeaderModification' => [ + 'description' => '修改请求头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改请求头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '请求头名称。', + 'type' => 'string', + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'example' => 'add', + ], + 'Value' => [ + 'description' => '请求头值。', + 'type' => 'string', + 'example' => 'headValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询修改HTTP入站请求头配置详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpIncomingRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC228B4-7A67-4016-9C9F-4A4133494A91\\",\\n \\"ConfigId\\": 402411533580288,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\\\n\\",\\n \\"RequestHeaderModification\\": [\\n {\\n \\"Name\\": \\"headerName\\",\\n \\"Operation\\": \\"add\\",\\n \\"Value\\": \\"headValue\\",\\n \\"Type\\": \\"static\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetHttpIncomingResponseHeaderModificationRule' => [ + 'summary' => '查询站点的修改HTTP入站响应头配置详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257653', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '347168101647504', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用ListHttpIncomingResponseHeaderModificationRules接口获取', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '430509230649344', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '432637955352576', + ], + 'ConfigType' => [ + 'description' => '配置类型，取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ResponseHeaderModification' => [ + 'description' => '修改响应头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改响应头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '响应头名称。', + 'type' => 'string', + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'example' => 'add', + ], + 'Value' => [ + 'description' => '响应头值。', + 'type' => 'string', + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询修改HTTP入站响应头配置详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpIncomingResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"ConfigId\\": 432637955352576,\\n \\"ConfigType\\": \\"rule\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ResponseHeaderModification\\": [\\n {\\n \\"Name\\": \\"headerName\\",\\n \\"Operation\\": \\"add\\",\\n \\"Value\\": \\"headerValue\\",\\n \\"Type\\": \\"static\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetHttpRequestHeaderModificationRule' => [ + 'summary' => '查询站点的修改HTTP请求头配置详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257648', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListHttpRequestHeaderModificationRules](~~2867483~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3528160969****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3528160969****'."\n", + ], + 'ConfigType' => [ + 'description' => '配置类型，取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'RequestHeaderModification' => [ + 'description' => '修改请求头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改请求头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '请求头名称。', + 'type' => 'string', + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'example' => 'add', + ], + 'Value' => [ + 'description' => '请求头值。', + 'type' => 'string', + 'example' => 'headValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询修改HTTP请求头配置详情', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:39.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetHttpRequestHeaderModificationRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"ConfigId\\": 0,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"RequestHeaderModification\\": [\\n {\\n \\"Name\\": \\"headerName\\",\\n \\"Operation\\": \\"add\\",\\n \\"Value\\": \\"headValue\\",\\n \\"Type\\": \\"static\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetHttpResponseHeaderModificationRule' => [ + 'summary' => '查询站点的修改HTTP响应头配置详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257653', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListHttpResponseHeaderModificationRules](~~2867483~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + 'ConfigType' => [ + 'description' => '配置类型，取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ResponseHeaderModification' => [ + 'description' => '修改响应头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改响应头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '响应头名称。', + 'type' => 'string', + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'example' => 'add', + ], + 'Value' => [ + 'description' => '响应头值。', + 'type' => 'string', + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询修改HTTP响应头配置详情', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:38.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetHttpResponseHeaderModificationRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"ConfigId\\": 0,\\n \\"ConfigType\\": \\"rule\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ResponseHeaderModification\\": [\\n {\\n \\"Name\\": \\"headerName\\",\\n \\"Operation\\": \\"add\\",\\n \\"Value\\": \\"headerValue\\",\\n \\"Type\\": \\"static\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetHttpsApplicationConfiguration' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257600', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[listHttpsApplicationConfigurations](~~2869087~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + ], + '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' => 'A3790430-3A06-535F-A424-0998BD9A6C9F', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'HttpsForce' => [ + 'description' => '是否开启强制HTTPS，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HttpsForceCode' => [ + 'description' => '强制HTTPS跳转状态码，取值范围：'."\n" + ."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 307'."\n" + .'- 308', + 'type' => 'string', + 'example' => '301', + ], + 'AltSvc' => [ + 'description' => 'Alt-Svc功能开关，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'AltSvcClear' => [ + 'description' => 'Alt-Svc头是否包含clear参数，默认关闭。取值：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'AltSvcPersist' => [ + 'description' => 'Alt-Svc头包是否含persist参数，默认关闭。取值：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'AltSvcMa' => [ + 'description' => 'Alt-Svc有效时间，单位是秒，默认为86400秒。', + 'type' => 'string', + 'example' => '86400', + ], + 'Hsts' => [ + 'description' => '是否开启HSTS，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HstsMaxAge' => [ + 'description' => 'HSTS过期时间，单位是秒。', + 'type' => 'string', + 'example' => '3600', + ], + 'HstsIncludeSubdomains' => [ + 'description' => '是否在HSTS中包括子域，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HstsPreload' => [ + 'description' => '是否开启HSTS预加载，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HttpsSniVerify' => [ + 'description' => '是否开启SNI校验，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HttpsNoSniDeny' => [ + 'description' => '是否开启拒绝无SNI的TLS握手请求，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HttpsSniWhitelist' => [ + 'description' => '指定允许的SNI白名单列表，多个以空格分隔。', + 'type' => 'string', + 'example' => 'abc edf', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点HTTPS应用配置', + 'summary' => '查询单条HTTPS应用配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-03T07:09:13.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetHttpsApplicationConfiguration', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpsApplicationConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3790430-3A06-535F-A424-0998BD9A6C9F\\",\\n \\"ConfigId\\": 352816096987136,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"HttpsForce\\": \\"on\\",\\n \\"HttpsForceCode\\": \\"301\\",\\n \\"AltSvc\\": \\"on\\",\\n \\"AltSvcClear\\": \\"on\\",\\n \\"AltSvcPersist\\": \\"on\\",\\n \\"AltSvcMa\\": \\"86400\\",\\n \\"Hsts\\": \\"on\\",\\n \\"HstsMaxAge\\": \\"3600\\",\\n \\"HstsIncludeSubdomains\\": \\"on\\",\\n \\"HstsPreload\\": \\"on\\",\\n \\"HttpsSniVerify\\": \\"on\\",\\n \\"HttpsNoSniDeny\\": \\"on\\",\\n \\"HttpsSniWhitelist\\": \\"abc edf\\"\\n}","type":"json"}]', + ], + 'GetHttpsBasicConfiguration' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257602', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListHttpsBasicConfigurations](~~2867470~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + ], + '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' => 'C370DAF1-C838-4288-A1A0-9A87633D2***', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置；'."\n" + .'- rule：查询规则配置；', + 'type' => 'string', + 'example' => 'global', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'Https' => [ + 'description' => '是否开启HTTPS，默认开启。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tls10' => [ + 'description' => '是否开启TLS1.0，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tls11' => [ + 'description' => '是否开启TLS1.1，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tls12' => [ + 'description' => '是否开启TLS1.2，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tls13' => [ + 'description' => '是否开启TLS1.3，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'CiphersuiteGroup' => [ + 'description' => '加密套件组，默认使能全部加密套件。取值范围：'."\n" + ."\n" + .'- all：全部加密套件。'."\n" + .'- strict：强加密套件。'."\n" + .'- custom：自定义加密套件。', + 'type' => 'string', + 'example' => 'all', + ], + 'Ciphersuite' => [ + 'description' => '自定义加密套件，表示当CiphersuiteGroup为custom时选取的具体加密算法。', + 'type' => 'string', + 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', + ], + 'OcspStapling' => [ + 'description' => '是否开启OCSP，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Http2' => [ + 'description' => '是否开启HTTP2，默认开启。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Http3' => [ + 'description' => '是否开启HTTP3，默认开启。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点HTTPS基础配置', + 'summary' => '查询单条HTTPS基础配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetHttpsBasicConfiguration', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpsBasicConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D2***\\",\\n \\"ConfigId\\": 352816096987136,\\n \\"ConfigType\\": \\"global\\",\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"Https\\": \\"on\\",\\n \\"Tls10\\": \\"on\\",\\n \\"Tls11\\": \\"on\\",\\n \\"Tls12\\": \\"on\\",\\n \\"Tls13\\": \\"on\\",\\n \\"CiphersuiteGroup\\": \\"all\\",\\n \\"Ciphersuite\\": \\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\",\\n \\"OcspStapling\\": \\"on\\",\\n \\"Http2\\": \\"on\\",\\n \\"Http3\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetIPv6' => [ + 'summary' => '查询站点IPv6配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257435', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + ], + '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' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + 'Enable' => [ + 'description' => 'IPv6开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'Region' => [ + 'description' => '开启Ipv6的区域，默认为x.x：'."\n" + ."\n" + .'- x.x: 全球。'."\n" + .'- cn.cn: 中国大陆。', + 'type' => 'string', + 'enumValueTitles' => [ + 'x.x' => 'x.x', + 'cn.cn' => 'cn.cn', + ], + 'example' => 'x.x', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询站点IPv6配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:33:21.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetIPv6', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetIPv6', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"Enable\\": \\"on\\",\\n \\"Region\\": \\"x.x\\"\\n}","type":"json"}]', + ], + 'GetImageTransform' => [ + 'summary' => '查询单条站点图片转换配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257356', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListImageTransforms](~~2869056~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置；'."\n" + .'- rule：规则配置；', + 'type' => 'string', + 'enumValueTitles' => [ + 'rule' => 'rule', + 'global' => 'global', + ], + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Enable' => [ + 'description' => '是否开启图片转换。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询单条站点图片转换配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetImageTransform', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetImageTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ConfigId\\": 352816096987136,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 2,\\n \\"Enable\\": \\"on\\",\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.request.uri.path.file_name eq \\\\\\\\\\\\\\"jpg\\\\\\\\\\\\\\")\\",\\n \\"RuleName\\": \\"test\\"\\n}","type":"json"}]', + ], + 'GetKv' => [ + 'summary' => '查询Key-Value对的某个Key值。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239214', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的键的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_key', + ], + ], + [ + 'name' => 'Base64', + 'in' => 'query', + 'schema' => [ + 'description' => '值是否进行base64解码，当调用[PutKv](~~2850482~~)接口指定base64为true时，要读取原始内容时指定此参数为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '键的值内容。', + 'type' => 'string', + 'example' => 'test_value', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The specified parameters are invalid.', + 'description' => '参数非法。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询KV存储空间的某个键值对', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-26T03:43:35.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '50', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetKv', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Value\\": \\"test_value\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', + ], + 'GetKvAccount' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239142', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '账户状态。'."\n" + ."\n" + .'- **online**：开启。'."\n" + .'- **offline**：关闭。', + 'type' => 'string', + 'example' => 'online', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'NamespaceUsed' => [ + 'description' => '账号下已申请KV存储空间数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NamespaceQuota' => [ + 'description' => '账号下最多可申请的KV存储空间配额数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CapacityString' => [ + 'description' => '账户下所有KV存储空间的可用容量。', + 'type' => 'string', + 'example' => '1 GB', + ], + 'CapacityUsedString' => [ + 'description' => '账户下所有KV存储空间的已用容量。', + 'type' => 'string', + 'example' => '100 MB', + ], + 'Capacity' => [ + 'description' => '账户下所有KV存储空间的可用容量，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + 'CapacityUsed' => [ + 'description' => '账户下所有KV存储空间的已用容量，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10048576', + ], + 'NamespaceList' => [ + 'description' => '账号的KV存储空间列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'KV存储空间状态，取值：'."\n" + ."\n" + .'- **online**：正常。'."\n" + ."\n" + .'- **delete**：待删除。'."\n" + ."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'- **deleted**：已删除。', + 'type' => 'string', + 'example' => 'online', + ], + 'Namespace' => [ + 'description' => 'KV存储空间名称。', + 'type' => 'string', + 'example' => 'test_namespace', + ], + 'NamespaceId' => [ + 'description' => 'KV存储空间ID。', + 'type' => 'string', + 'example' => '643355322374688768', + ], + 'Description' => [ + 'description' => 'KV存储空间的描述信息。', + 'type' => 'string', + 'example' => 'the first namespace', + ], + 'Capacity' => [ + 'description' => 'KV存储空间的可用容量，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + 'CapacityUsed' => [ + 'description' => 'KV存储空间的已用容量，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100048576', + ], + 'CapacityString' => [ + 'description' => 'KV存储空间的可用容量。', + 'type' => 'string', + 'example' => '1 GB', + ], + 'CapacityUsedString' => [ + 'description' => 'KV存储空间的已用容量。', + 'type' => 'string', + 'example' => '100 MB', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询账户的KV服务使用信息', + 'summary' => '查询账户在KV服务的使用信息，包含所有的KV存储空间列表等信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetKvAccount', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetKvAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"online\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"NamespaceUsed\\": 1,\\n \\"NamespaceQuota\\": 10,\\n \\"CapacityString\\": \\"1 GB\\",\\n \\"CapacityUsedString\\": \\"100 MB\\",\\n \\"Capacity\\": 1073741824,\\n \\"CapacityUsed\\": 10048576,\\n \\"NamespaceList\\": [\\n {\\n \\"Status\\": \\"online\\",\\n \\"Namespace\\": \\"test_namespace\\",\\n \\"NamespaceId\\": \\"643355322374688768\\",\\n \\"Description\\": \\"the first namespace\\",\\n \\"Capacity\\": 1073741824,\\n \\"CapacityUsed\\": 100048576,\\n \\"CapacityString\\": \\"1 GB\\",\\n \\"CapacityUsedString\\": \\"100 MB\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetKvDetail' => [ + 'summary' => '查询键值对的值和TTL信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239214', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的键的名称。', + 'description' => '查询的键的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_key', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '键的值内容。'."\n" + .'根节点的值', + 'description' => '键的值内容。'."\n" + .'根节点的值', + 'type' => 'string', + 'example' => 'test_value', + ], + 'RequestId' => [ + 'title' => '键的过期时间（相对时间，单位：秒）。', + 'description' => '键的过期时间（相对时间，单位：秒）。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'ExpirationTtl' => [ + 'title' => '键的过期时间（相对时间，单位：秒）。', + 'description' => '键的过期时间（相对时间，单位：秒）。', + 'type' => 'string', + 'example' => '3600', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The specified parameters are invalid.', + 'description' => '参数非法。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询键值对的值和TTL信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Value\\": \\"test_value\\",\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ExpirationTtl\\": \\"3600\\"\\n}","type":"json"}]', + ], + 'GetKvNamespace' => [ + 'summary' => '查询账号下某个KV存储空间的信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239017', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + 'maxLength' => 64, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'KV存储空间状态，取值：'."\n" + ."\n" + .'- **online**：正常。'."\n" + ."\n" + .'- **delete**：待删除。'."\n" + ."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'- **deleted**：已删除。', + 'type' => 'string', + 'example' => 'online', + ], + 'Namespace' => [ + 'description' => 'KV存储空间的名称。', + 'type' => 'string', + 'example' => 'test_namespace', + ], + 'NamespaceId' => [ + 'description' => 'KV存储空间的ID。', + 'type' => 'string', + 'example' => '643355322374688768', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'Description' => [ + 'description' => 'KV存储空间的描述信息。', + 'type' => 'string', + 'example' => 'this is a test namespace.', + ], + 'CapacityString' => [ + 'description' => 'KV存储空间可用容量。', + 'type' => 'string', + 'example' => '1 GB', + ], + 'CapacityUsedString' => [ + 'description' => 'KV存储空间已用容量。', + 'type' => 'string', + 'example' => '100 MB', + ], + 'Capacity' => [ + 'description' => 'KV存储空间可用容量，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + 'CapacityUsed' => [ + 'description' => 'KV存储空间已用容量，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10048576', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询KV存储空间信息', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-03T01:43:47.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-20T13:49:20.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetKvNamespace', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetKvNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"online\\",\\n \\"Namespace\\": \\"test_namespace\\",\\n \\"NamespaceId\\": \\"643355322374688768\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Description\\": \\"this is a test namespace.\\",\\n \\"CapacityString\\": \\"1 GB\\",\\n \\"CapacityUsedString\\": \\"100 MB\\",\\n \\"Capacity\\": 1073741824,\\n \\"CapacityUsed\\": 10048576\\n}","type":"json"}]', + ], + 'GetList' => [ + 'summary' => '获取单个自定义列表的详细信息，用户可以通过此接口查询特定列表的属性，包括名称、描述、种类以及列表内容。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239602', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '列表ID', + 'description' => '自定义列表的ID，可通过调用[ListLists](~~2850217~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '40000001', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'UpdateTime' => [ + 'title' => '修改时间', + 'description' => '自定义列表的最后修改时间。', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00Z', + ], + 'Id' => [ + 'title' => '列表ID', + 'description' => '自定义列表的ID，可通过调用[ListLists](~~2850217~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '40000001', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '列表名称', + 'description' => '自定义列表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + 'maxLength' => 128, + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '列表描述', + 'description' => '自定义列表描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'a custom list', + 'maxLength' => 1024, + 'pattern' => '', + 'default' => '', + ], + 'Kind' => [ + 'title' => '列表种类', + 'description' => '自定义列表种类。', + 'type' => 'string', + 'example' => 'ip', + ], + 'Items' => [ + 'title' => '列表内容', + 'description' => '自定义列表内容，数组形式展示列表项。', + 'type' => 'array', + 'items' => [ + 'title' => '列表内容', + 'description' => '自定义列表内容。', + 'type' => 'string', + 'example' => '10.1.1.1', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取单个自定义列表详情', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:49.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T08:22:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"UpdateTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"Id\\": 40000001,\\n \\"Name\\": \\"example\\",\\n \\"Description\\": \\"a custom list\\",\\n \\"Kind\\": \\"ip\\",\\n \\"Items\\": [\\n \\"10.1.1.1\\"\\n ]\\n}","type":"json"}]', + ], + 'GetLoadBalancer' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238515', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '监视器id。', + 'description' => '负载均衡器ID，用于唯一标识要查询的负载均衡器，负载均衡器创建时会直接返回，也可以通 [ListLoadBalancers](~~2868897~~) 接口获取站点下所有负载均衡器查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '99867648760****', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1159101787****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '成功响应时返回的数据结构，包含负载均衡器的详细配置信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'Id' => [ + 'description' => '负载均衡器的唯一标识ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99867648760****', + ], + 'Name' => [ + 'description' => '负载均衡器的名称。', + 'type' => 'string', + 'example' => 'lb.example.com', + ], + 'SiteId' => [ + 'description' => '负载均衡器所归属的站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11591017874****', + ], + 'Enabled' => [ + 'description' => '负载均衡器是否启用。'."\n" + ."\n" + .'- true：启用。'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Ttl' => [ + 'description' => 'TTL值，DNS记录的生存时间，默认为30秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'SessionAffinity' => [ + 'description' => '会话保持，取值：'."\n" + .'- off：不开启。'."\n" + .'- ip：按ip方式会话保持。'."\n" + .'- cookie: 按cookie方式会话保持。', + 'type' => 'string', + 'example' => 'ip', + ], + 'FallbackPool' => [ + 'description' => '兜底地址池ID，当所有其他地址池不可用时，流量将被重定向至此地址池。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '96228666776****', + ], + 'SteeringPolicy' => [ + 'description' => '负载均衡策略。', + 'type' => 'string', + 'example' => 'order', + ], + 'Description' => [ + 'description' => '负载均衡器的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'AdaptiveRouting' => [ + 'description' => '跨地址池回源配置。', + 'type' => 'object', + 'properties' => [ + 'FailoverAcrossPools' => [ + 'description' => '是否跨地址池回源。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false: 否。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'DefaultPools' => [ + 'description' => '默认地址池ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '默认地址池。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '96228666776****', + ], + ], + 'RandomSteering' => [ + 'description' => '加权轮询配置，用于控制不同地址池的流量分配权重。', + 'type' => 'object', + 'properties' => [ + 'DefaultWeight' => [ + 'description' => '默认的轮询权重，用于所有没有单独指定权重的地址池。取值范围：0-100的数字。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'PoolWeights' => [ + 'description' => '各后端服务器池的权重配置，键为池ID，值为权重系数。权重系数表示相对流量分配的比例。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => '单个源地址池的权重，0-100的数字，0表示不往该源地址池调度流量。', + 'example' => '50', + ], + ], + ], + ], + 'Rules' => [ + 'description' => '规则配置列表，用于定义特定条件下的行为。', + 'type' => 'array', + 'items' => [ + 'description' => '规则集中的规则配置。', + 'type' => 'object', + 'properties' => [ + 'FixedResponse' => [ + 'description' => '匹配规则后执行响应指定内容。', + 'type' => 'object', + 'properties' => [ + 'ContentType' => [ + 'description' => 'HTTP Header中的Content-Type字段。', + 'type' => 'string', + 'example' => 'application/json', + ], + 'Location' => [ + 'description' => 'http返回中的location字段。', + 'type' => 'string', + 'example' => 'http://www.example.com/index.html', + ], + 'MessageBody' => [ + 'description' => '响应body值。', + 'type' => 'string', + 'example' => 'Hello World.', + ], + 'StatusCode' => [ + 'description' => '状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + 'Overrides' => [ + 'description' => '匹配规则后修改对应请求改写的负载均衡配置，配置的字段，会覆盖负载均衡器配置里相应的字段。', + 'type' => 'any', + 'example' => '{'."\n" + .' "adaptive_routing": {'."\n" + .' "failover_across_pools": true'."\n" + .' },'."\n" + .' "sub_region_pools": {'."\n" + .' "GB": ['."\n" + .' 96228666776****'."\n" + .' ],'."\n" + .' "US": ['."\n" + .' 96228666776****'."\n" + .' ]'."\n" + .' },'."\n" + .' "default_pools": ['."\n" + .' 96228666776****,'."\n" + .' 96228666776****'."\n" + .' ],'."\n" + .' "fallback_pool": 96228666776****,'."\n" + .' "location_strategy": {'."\n" + .' "mode": "resolver_ip",'."\n" + .' "prefer_ecs": "always"'."\n" + .' },'."\n" + .' "random_steering": {'."\n" + .' "default_weight": 30,'."\n" + .' "pool_weights": {'."\n" + .' "96228666776****": 70,'."\n" + .' "96228666776****": 80'."\n" + .' }'."\n" + .' },'."\n" + .' "region_pools": {'."\n" + .' "ENAM": ['."\n" + .' 96228666776****,'."\n" + .' 92843536908****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 92843536908****'."\n" + .' ]'."\n" + .' },'."\n" + .' "session_affinity": "cookie",'."\n" + .' "session_affinity_attributes": {'."\n" + .' "drain_duration": 100,'."\n" + .' "headers": ["none"],'."\n" + .' "require_all_headers": false,'."\n" + .' "samesite": "Auto",'."\n" + .' "secure": "Auto",'."\n" + .' "zero_downtime_failover": "sticky"'."\n" + .' },'."\n" + .' "session_affinity_ttl": 1800,'."\n" + .' "steering_policy": "dynamic_latency",'."\n" + .' "ttl": 30'."\n" + .' }', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => 'http.request.uri.path contains "/testing"', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'r2', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'off', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越大越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Terminates' => [ + 'description' => '是否终止执行后续规则。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否，默认值。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'Monitor' => [ + 'description' => '监视器配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监视器协议类型，如HTTP，用于健康检查，值为off时，表示不进行检查。', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'Method' => [ + 'description' => '健康检查的方法。', + 'type' => 'string', + 'example' => 'GET', + ], + 'Port' => [ + 'description' => '目标端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Path' => [ + 'description' => '路径。', + 'type' => 'string', + 'example' => '/', + ], + 'Interval' => [ + 'description' => '健康检查的间隔时间，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'ExpectedCodes' => [ + 'description' => '预期状态码，如200,202，成功的HTTP响应。', + 'type' => 'string', + 'example' => '200,202', + ], + 'FollowRedirects' => [ + 'description' => '是否跟随重定向。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConsecutiveUp' => [ + 'description' => '连续探测多少次成功算成功，如`3`。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ConsecutiveDown' => [ + 'description' => '连续探测多少次失败算失败，如`5`。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Header' => [ + 'description' => '探测时所带头部信息，HTTP头。', + 'type' => 'any', + 'example' => '{'."\n" + .' "host": ['."\n" + .' "example1.com",'."\n" + .' "example2.com"'."\n" + .' ]'."\n" + .' }', + ], + 'Timeout' => [ + 'description' => '健康检查超时时间，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'MonitoringRegion' => [ + 'description' => '探测点所在区域，默认为Global，'."\n" + ."\n" + .'- Global: 全球。'."\n" + .'- ChineseMainland: 中国内地。'."\n" + .'- OutsideChineseMainland: 全球（不包括中国内地）。', + 'type' => 'string', + 'example' => 'Global', + ], + ], + ], + 'Status' => [ + 'description' => '负载均衡器的状态。', + 'type' => 'string', + 'example' => 'healthy', + ], + 'SubRegionPools' => [ + 'description' => '二级region对应的地址池，多个二级region共用一批地址池时，可以多个二级region，使用逗号拼接作为key。', + 'type' => 'any', + 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', + ], + 'RegionPools' => [ + 'description' => '一级region对应的地址池。', + 'type' => 'any', + 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'LoadBalancerNotExist', + 'errorMessage' => 'The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.', + 'description' => '传入的站点负载均衡器无效或当前站点尚未开通负载均衡功能。请您检查负载均衡器名称配置的是否正确后重试，若尚未开通负载均衡功能请开通后重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询单个负载均衡器', + 'summary' => '根据指定站点ID和负载均衡器ID，获取单个负载均衡器的详细信息。', + 'description' => '此API允许用户通过提供必要的身份验证信息和资源标识，查询特定负载均衡器的配置详情，包括但不限于名称、会话保持策略、路由策略等。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-16T02:25:11.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetLoadBalancer', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetLoadBalancer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Id\\": 0,\\n \\"Name\\": \\"lb.example.com\\",\\n \\"SiteId\\": 0,\\n \\"Enabled\\": true,\\n \\"Ttl\\": 60,\\n \\"SessionAffinity\\": \\"ip\\",\\n \\"FallbackPool\\": 0,\\n \\"SteeringPolicy\\": \\"order\\",\\n \\"Description\\": \\"test\\",\\n \\"AdaptiveRouting\\": {\\n \\"FailoverAcrossPools\\": true\\n },\\n \\"DefaultPools\\": [\\n 0\\n ],\\n \\"RandomSteering\\": {\\n \\"DefaultWeight\\": 50,\\n \\"PoolWeights\\": {\\n \\"key\\": 50\\n }\\n },\\n \\"Rules\\": [\\n {\\n \\"FixedResponse\\": {\\n \\"ContentType\\": \\"application/json\\",\\n \\"Location\\": \\"http://www.example.com/index.html\\",\\n \\"MessageBody\\": \\"Hello World.\\",\\n \\"StatusCode\\": 200\\n },\\n \\"Overrides\\": \\"{\\\\n \\\\\\"adaptive_routing\\\\\\": {\\\\n \\\\\\"failover_across_pools\\\\\\": true\\\\n },\\\\n \\\\\\"sub_region_pools\\\\\\": {\\\\n \\\\\\"GB\\\\\\": [\\\\n 96228666776****\\\\n ],\\\\n \\\\\\"US\\\\\\": [\\\\n 96228666776****\\\\n ]\\\\n },\\\\n \\\\\\"default_pools\\\\\\": [\\\\n 96228666776****,\\\\n 96228666776****\\\\n ],\\\\n \\\\\\"fallback_pool\\\\\\": 96228666776****,\\\\n \\\\\\"location_strategy\\\\\\": {\\\\n \\\\\\"mode\\\\\\": \\\\\\"resolver_ip\\\\\\",\\\\n \\\\\\"prefer_ecs\\\\\\": \\\\\\"always\\\\\\"\\\\n },\\\\n \\\\\\"random_steering\\\\\\": {\\\\n \\\\\\"default_weight\\\\\\": 30,\\\\n \\\\\\"pool_weights\\\\\\": {\\\\n \\\\\\"96228666776****\\\\\\": 70,\\\\n \\\\\\"96228666776****\\\\\\": 80\\\\n }\\\\n },\\\\n \\\\\\"region_pools\\\\\\": {\\\\n \\\\\\"ENAM\\\\\\": [\\\\n 96228666776****,\\\\n 92843536908****\\\\n ],\\\\n \\\\\\"WNAM\\\\\\": [\\\\n 92843536908****\\\\n ]\\\\n },\\\\n \\\\\\"session_affinity\\\\\\": \\\\\\"cookie\\\\\\",\\\\n \\\\\\"session_affinity_attributes\\\\\\": {\\\\n \\\\\\"drain_duration\\\\\\": 100,\\\\n \\\\\\"headers\\\\\\": [\\\\\\"none\\\\\\"],\\\\n \\\\\\"require_all_headers\\\\\\": false,\\\\n \\\\\\"samesite\\\\\\": \\\\\\"Auto\\\\\\",\\\\n \\\\\\"secure\\\\\\": \\\\\\"Auto\\\\\\",\\\\n \\\\\\"zero_downtime_failover\\\\\\": \\\\\\"sticky\\\\\\"\\\\n },\\\\n \\\\\\"session_affinity_ttl\\\\\\": 1800,\\\\n \\\\\\"steering_policy\\\\\\": \\\\\\"dynamic_latency\\\\\\",\\\\n \\\\\\"ttl\\\\\\": 30\\\\n }\\",\\n \\"Rule\\": \\"http.request.uri.path contains \\\\\\"/testing\\\\\\"\\",\\n \\"RuleName\\": \\"r2\\",\\n \\"RuleEnable\\": \\"off\\",\\n \\"Sequence\\": 1,\\n \\"Terminates\\": true\\n }\\n ],\\n \\"Monitor\\": {\\n \\"Type\\": \\"HTTP\\",\\n \\"Method\\": \\"GET\\",\\n \\"Port\\": 80,\\n \\"Path\\": \\"/\\",\\n \\"Interval\\": 60,\\n \\"ExpectedCodes\\": \\"200,202\\",\\n \\"FollowRedirects\\": true,\\n \\"ConsecutiveUp\\": 3,\\n \\"ConsecutiveDown\\": 5,\\n \\"Header\\": \\"{\\\\n \\\\\\"host\\\\\\": [\\\\n \\\\\\"example1.com\\\\\\",\\\\n \\\\\\"example2.com\\\\\\"\\\\n ]\\\\n }\\",\\n \\"Timeout\\": 5,\\n \\"MonitoringRegion\\": \\"Global\\"\\n },\\n \\"Status\\": \\"healthy\\",\\n \\"SubRegionPools\\": \\"{\\\\\\"AL,MO\\\\\\": [92298024898****],\\\\\\"CN-SH,CN-SX,CN-SC\\\\\\":[92304347804****,92843536908****]}\\",\\n \\"RegionPools\\": \\"{\\\\n \\\\\\"ENAM\\\\\\": [\\\\n 12345678****\\\\n ],\\\\n \\\\\\"WNAM\\\\\\": [\\\\n 23456789****,\\\\n 23456789****\\\\n ]\\\\n}\\"\\n}","type":"json"}]', + ], + 'GetManagedTransform' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257447', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可以通过调用[ListSites](~~2850189~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AddClientGeolocationHeader' => [ + 'description' => '添加访问者地理位置标头。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'AddRealClientIpHeader' => [ + 'description' => '添加包含真实客户端IP的 "ali-real-client-ip" 标头。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'SiteVersion' => [ + 'description' => '站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RealClientIpHeaderName' => [ + 'description' => '真实客户端IP标头名称。', + 'type' => 'string', + 'example' => 'test_header', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点托管转换配置', + 'summary' => '查询站点托管转换配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-05-09T05:58:30.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetManagedTransform', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetManagedTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AddClientGeolocationHeader\\": \\"on\\",\\n \\"AddRealClientIpHeader\\": \\"on\\",\\n \\"SiteVersion\\": 0,\\n \\"RealClientIpHeaderName\\": \\"test_header\\"\\n}","type":"json"}]', + ], + 'GetNetworkOptimization' => [ + 'summary' => '查询单条网络优化配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257603', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12312312213212', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListNetworkOptimizations](~~2869051~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + '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' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'SmartRouting' => [ + 'description' => '是否开启智能路由服务，默认关闭。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'example' => 'on', + ], + 'Http2Origin' => [ + 'description' => '是否开启HTTP2回源，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'example' => 'on', + ], + 'Websocket' => [ + 'description' => '是否开启Websocket，默认开启。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'example' => 'on', + ], + 'Grpc' => [ + 'description' => '是否开启GRPC，默认关闭。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'example' => 'on', + ], + 'UploadMaxFilesize' => [ + 'description' => '最大上传文件大小，单位是MB，取值范围：100～500。', + 'type' => 'string', + 'example' => '500', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点网络优化配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetNetworkOptimization', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetNetworkOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"ConfigId\\": 0,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 2,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"SmartRouting\\": \\"on\\",\\n \\"Http2Origin\\": \\"on\\",\\n \\"Websocket\\": \\"on\\",\\n \\"Grpc\\": \\"on\\",\\n \\"UploadMaxFilesize\\": \\"500\\"\\n}","type":"json"}]', + ], + 'GetOriginCaCertificate' => [ + 'summary' => '获取源服务器CA证书信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261741', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaabcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Certificate' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----', + ], + 'Result' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'upload', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-03-05 18:24:04', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-03-05 18:24:04', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d**', + ], + 'FingerprintSha256' => [ + 'description' => '证书sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3558df77-8a7a-4060-a900-2d7949403836', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取源服务器CA证书信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginCaCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Status\\": \\"OK\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\",\\n \\"Result\\": {\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"upload\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-03-05 18:24:04\\",\\n \\"UpdateTime\\": \\"2024-03-05 18:24:04\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n },\\n \\"RequestId\\": \\"3558df77-8a7a-4060-a900-2d7949403836\\"\\n}","type":"json"}]', + ], + 'GetOriginClientCertificate' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261753', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaabcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Certificate' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----', + ], + 'Result' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'upload', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'DigiCert', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书的签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-05-12 02:00:53', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-03-05 18:24:04', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d**', + ], + 'FingerprintSha256' => [ + 'description' => '证书sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', + ], + 'Hostnames' => [ + 'description' => '绑定域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => '[\'www.example.com\', \'mail.example.com\']', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'title' => '获取域名粒度回源客户端证书信息', + 'summary' => '获取域名粒度回源客户端证书信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Status\\": \\"OK\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\",\\n \\"Result\\": {\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"upload\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"DigiCert\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2020-05-12 02:00:53\\",\\n \\"UpdateTime\\": \\"2024-03-05 18:24:04\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\",\\n \\"Hostnames\\": [\\n \\"[\'www.example.com\', \'mail.example.com\']\\"\\n ]\\n },\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', + ], + 'GetOriginClientCertificateHostnames' => [ + 'summary' => '获取域名粒度回源客户端证书绑定的域名列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261755', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaabcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Hostnames' => [ + 'description' => '绑定的域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'title' => '获取域名粒度回源客户端证书绑定的域名列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginClientCertificateHostnames', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginClientCertificateHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Hostnames\\": [\\n \\"www.example.com \\"\\n ],\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'GetOriginPool' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238601', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '监视器id。', + 'description' => '源地址池ID，可通过调用[ListOriginPools](~~2863947~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1038520525196928', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '216558609793952', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Id' => [ + 'description' => '源地址池ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '103852052519****', + ], + 'Name' => [ + 'description' => '源地址池名称，一个站点下源地址池名称唯一。', + 'type' => 'string', + 'example' => 'pool1', + ], + 'SiteId' => [ + 'description' => '源地址池所属的站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21655860979****', + ], + 'RecordName' => [ + 'description' => '为源地址池分配的域名，可以用来作站点下记录的源站地址。', + 'type' => 'string', + 'example' => 'pool1.example.com', + ], + 'Enabled' => [ + 'description' => '源地址池是否启用：'."\n" + ."\n" + .'- true: 启用；'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'References' => [ + 'description' => '源地址池被引用信息，源地址池被负载均衡器配置或者被记录配置为源站时，被认为是引用。', + 'type' => 'object', + 'properties' => [ + 'LoadBalancers' => [ + 'description' => '使用此源地址池的负载均衡器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '使用此源地址池的负载均衡器信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '负载均衡器名字。', + 'type' => 'string', + 'example' => 'lb1.example.com', + ], + 'Id' => [ + 'description' => '负载均衡器ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99874066052****', + ], + ], + ], + ], + 'DnsRecords' => [ + 'description' => '使用此源地址池为源站的七层记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '使用此源地址池为源站的七层记录信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'Id' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '104285288635****', + ], + ], + ], + ], + 'IPARecords' => [ + 'description' => '使用此源地址池为源站的四层记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '使用此源地址池为源站的四层记录信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'ipa.example.com', + ], + 'Id' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '104285288635****', + ], + ], + ], + ], + ], + ], + 'ReferenceLBCount' => [ + 'description' => '被多少个负载均衡器引用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Origins' => [ + 'description' => '源地址池里添加的源站信息。', + 'type' => 'array', + 'items' => [ + 'description' => '源地址池里添加的源站信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '源站ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99750209487****', + ], + 'Name' => [ + 'description' => '源站名称。', + 'type' => 'string', + 'example' => 'origin1', + ], + 'Address' => [ + 'description' => '源站地址，如：www.example.com。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'Enabled' => [ + 'description' => '源站是否启用：'."\n" + ."\n" + .'- true: 启用；'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Weight' => [ + 'description' => '权重，0-100的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Type' => [ + 'description' => '源站类型：'."\n" + ."\n" + .'- ip_domain: ip或域名类型源站；'."\n" + .'- OSS：OSS地址源站；'."\n" + .'- S3：AWS S3源站。', + 'type' => 'string', + 'example' => 'ip_domain', + ], + 'Header' => [ + 'description' => '回源时带的请求头，只支持Host。', + 'type' => 'any', + 'example' => '{'."\n" + .' "Host": ['."\n" + .' "example.com"'."\n" + .' ]'."\n" + .' }', + ], + 'AuthConf' => [ + 'description' => '鉴权信息，源站为OSS或者S3等源站需要鉴权时，需要传鉴权相关配置信息。', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'description' => '鉴权类型。'."\n" + ."\n" + .'- public：公共读写，源站为OSS或S3且为公共读写时使用；'."\n" + .'- private_same_account：私有同账号，源站为OSS，且鉴权类型为同账号私有鉴权时使用；'."\n" + .'- private_cross_account：私有跨账号，源站为OSS，且鉴权类型为跨账号私有鉴权时使用；'."\n" + .'- private：源站为S3，且鉴权类型为私有时使用。', + 'type' => 'string', + 'example' => 'public', + ], + 'AccessKey' => [ + 'description' => 'AuthType取值为private_cross_account或private时需要传的AccessKey。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'SecretKey' => [ + 'description' => 'AuthType取值为private_cross_account或private时需要传的SecretKey。', + 'type' => 'string', + 'example' => 'yourAccessKeySecret', + ], + 'Version' => [ + 'description' => '源站为AWS S3时需要传的签名版本。', + 'type' => 'string', + 'example' => 'v4', + ], + 'Region' => [ + 'description' => '源站为AWS S3时需要传的源站Region。', + 'type' => 'string', + 'example' => 'us-east-1'."\n", + ], + ], + ], + 'IpVersionPolicy' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'OriginPoolNotExist', + 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', + 'description' => '传入的源地址池不存在，或该地址池不属于当前用户和站点，请您确认后重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询单个源地址池', + 'summary' => '根据源地址池ID获取单条源地址池信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginPool', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Id\\": 0,\\n \\"Name\\": \\"pool1\\",\\n \\"SiteId\\": 0,\\n \\"RecordName\\": \\"pool1.example.com\\",\\n \\"Enabled\\": true,\\n \\"References\\": {\\n \\"LoadBalancers\\": [\\n {\\n \\"Name\\": \\"lb1.example.com\\",\\n \\"Id\\": 0\\n }\\n ],\\n \\"DnsRecords\\": [\\n {\\n \\"Name\\": \\"www.example.com\\",\\n \\"Id\\": 0\\n }\\n ],\\n \\"IPARecords\\": [\\n {\\n \\"Name\\": \\"ipa.example.com\\",\\n \\"Id\\": 0\\n }\\n ]\\n },\\n \\"ReferenceLBCount\\": 5,\\n \\"Origins\\": [\\n {\\n \\"Id\\": 0,\\n \\"Name\\": \\"origin1\\",\\n \\"Address\\": \\"www.example.com\\",\\n \\"Enabled\\": true,\\n \\"Weight\\": 50,\\n \\"Type\\": \\"ip_domain\\",\\n \\"Header\\": \\"{\\\\n \\\\\\"Host\\\\\\": [\\\\n \\\\\\"example.com\\\\\\"\\\\n ]\\\\n }\\",\\n \\"AuthConf\\": {\\n \\"AuthType\\": \\"public\\",\\n \\"AccessKey\\": \\"yourAccessKeyID\\",\\n \\"SecretKey\\": \\"yourAccessKeySecret\\",\\n \\"Version\\": \\"v4\\",\\n \\"Region\\": \\"us-east-1\\\\n\\"\\n },\\n \\"IpVersionPolicy\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetOriginProtection' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250109', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4VDL9A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'CurrentIPWhitelist' => [ + 'description' => '站点当前所使用的回源IP白名单。', + 'type' => 'object', + 'properties' => [ + 'IPv4' => [ + 'description' => '站点当前所使用的回源IP白名单，IPv4地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv4地址或网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + ], + 'IPv6' => [ + 'description' => '站点当前所使用的回源IP白名单，IPv6地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv6地址或网段。', + 'type' => 'string', + 'example' => '2409:8c54:1841:200a::/64', + ], + ], + ], + ], + 'LatestIPWhitelist' => [ + 'description' => '最新的回源IP白名单。', + 'type' => 'object', + 'properties' => [ + 'IPv4' => [ + 'description' => '最新的回源IP白名单，IPv4地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv4地址或网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + ], + 'IPv6' => [ + 'description' => '最新的回源IP白名单，IPv6地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv6地址或网段。', + 'type' => 'string', + 'example' => '2409:8c54:1841:200a::/64', + ], + ], + ], + ], + 'DiffIPWhitelist' => [ + 'description' => '有变化的回源IP白名单。', + 'type' => 'object', + 'properties' => [ + 'AddedIPWhitelist' => [ + 'description' => '新增的回源IP白名单。', + 'type' => 'object', + 'properties' => [ + 'IPv4' => [ + 'description' => '回源IP白名单，IPv4地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv4地址或网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + ], + 'IPv6' => [ + 'description' => '回源IP白名单，IPv6地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv6地址或网段。', + 'type' => 'string', + 'example' => '2409:8c54:1841:200a::/64', + ], + ], + ], + ], + 'NoChangeIpWhitelist' => [ + 'description' => '没有变化的回源IP白名单。', + 'type' => 'object', + 'properties' => [ + 'IPv4' => [ + 'description' => '回源IP白名单，IPv4地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv4地址或网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + ], + 'IPv6' => [ + 'description' => '回源IP白名单，IPv6地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv6地址或网段。', + 'type' => 'string', + 'example' => '2409:8c54:1841:200a::/64', + ], + ], + ], + ], + 'RemovedIPWhitelist' => [ + 'description' => '删除的回源IP白名单。', + 'type' => 'object', + 'properties' => [ + 'IPv4' => [ + 'description' => '回源IP白名单，IPv4地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv4地址或网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + ], + 'IPv6' => [ + 'description' => '回源IP白名单，IPv6地址或网段。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv6地址或网段。', + 'type' => 'string', + 'example' => '2409:8c54:1841:200a::/64', + ], + ], + ], + ], + ], + ], + 'RegionalCurrentIPWhitelist' => [ + 'title' => '站点当前所使用的区域回源IP白名单。', + 'description' => '站点当前所使用的区域回源IP白名单。', + 'type' => 'object', + 'properties' => [ + 'RegionalIPv4' => [ + 'title' => '站点当前所使用的区域回源IP白名单，IPv4网段、区域。', + 'description' => '站点当前所使用的区域回源IP白名单，IPv4网段、区域。', + 'type' => 'array', + 'items' => [ + 'title' => 'IPv4网段、区域。', + 'description' => 'IPv4网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv4网段。', + 'description' => 'IPv4网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv4区域。', + 'description' => 'IPv4区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + 'RegionalIPv6' => [ + 'title' => '站点当前所使用的区域回源IP白名单，IPv6网段、区域。', + 'description' => '站点当前所使用的区域回源IP白名单，IPv6网段、区域。', + 'type' => 'array', + 'items' => [ + 'title' => 'IPv6网段、区域。', + 'description' => 'IPv6网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv6网段。', + 'description' => 'IPv6网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv6区域。', + 'description' => 'IPv6区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + ], + ], + 'RegionalLatestIPWhitelist' => [ + 'title' => '最新的区域回源IP白名单。', + 'description' => '最新的区域回源IP白名单。', + 'type' => 'object', + 'properties' => [ + 'RegionalIPv4' => [ + 'title' => '最新的区域回源IP白名单，IPv4网段、区域。'."\n" + ."\n", + 'description' => '最新的区域回源IP白名单，IPv4网段、区域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'IPv4网段、区域。', + 'description' => 'IPv4网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv4网段。', + 'description' => 'IPv4网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv4区域。', + 'description' => 'IPv4区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + 'RegionalIPv6' => [ + 'title' => '最新的区域回源IP白名单，IPv6网段、区域。'."\n" + ."\n", + 'description' => '最新的区域回源IP白名单，IPv6网段、区域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'IPv6网段、区域。', + 'description' => 'IPv6网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv6网段。', + 'description' => 'IPv6网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv6区域。', + 'description' => 'IPv6区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + ], + ], + 'RegionalDiffIPWhitelist' => [ + 'title' => '有变化的区域回源IP白名单。'."\n" + ."\n", + 'description' => '有变化的区域回源IP白名单。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'AddedIPRegionWhitelist' => [ + 'title' => '新增的区域回源IP白名单。'."\n" + ."\n", + 'description' => '新增的区域回源IP白名单。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'RegionalIPv4' => [ + 'title' => '区域回源IP白名单，IPv4网段、区域。'."\n" + ."\n", + 'description' => '区域回源IP白名单，IPv4网段、区域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'IPv4网段、区域。', + 'description' => 'IPv4网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv4网段。', + 'description' => 'IPv4网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv4区域。', + 'description' => 'IPv4区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + 'RegionalIPv6' => [ + 'title' => '区域回源IP白名单，IPv6网段、区域。'."\n" + ."\n", + 'description' => '区域回源IP白名单，IPv6网段、区域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'IPv6网段、区域。', + 'description' => 'IPv6网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv6网段。', + 'description' => 'IPv6网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv6区域。', + 'description' => 'IPv6区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + ], + ], + 'NoChangeIpWhitelist' => [ + 'title' => '没有变化的区域回源IP白名单。'."\n" + ."\n", + 'description' => '没有变化的区域回源IP白名单。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'RegionalIPv4' => [ + 'title' => '区域回源IP白名单，IPv4网段、区域。'."\n" + ."\n", + 'description' => '区域回源IP白名单，IPv4网段、区域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'IPv4网段、区域。', + 'description' => 'IPv4网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv4网段。', + 'description' => 'IPv4网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv4区域。', + 'description' => 'IPv4区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + 'RegionalIPv6' => [ + 'title' => '区域回源IP白名单，IPv6网段、区域。'."\n" + ."\n", + 'description' => '区域回源IP白名单，IPv6网段、区域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'IPv6网段、区域。', + 'description' => 'IPv6网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv6网段。', + 'description' => 'IPv6网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv6区域。', + 'description' => 'IPv6区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + ], + ], + 'RemovedIPRegionWhitelist' => [ + 'title' => '删除的区域回源IP白名单。'."\n" + ."\n", + 'description' => '删除的区域回源IP白名单。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'RegionalIPv4' => [ + 'title' => '区域回源IP白名单，IPv4网段、区域。'."\n" + ."\n", + 'description' => '区域回源IP白名单，IPv4网段、区域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'IPv4网段、区域。', + 'description' => 'IPv4网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv4网段。', + 'description' => 'IPv4网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv4区域。', + 'description' => 'IPv4区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + ], + ], + ], + ], + 'RegionalIPv6' => [ + 'title' => '区域回源IP白名单，IPv6网段、区域。'."\n" + ."\n", + 'description' => '区域回源IP白名单，IPv6网段、区域。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'IPv6网段、区域。', + 'description' => 'IPv6网段、区域。', + 'type' => 'object', + 'properties' => [ + 'Cidr' => [ + 'title' => 'IPv6网段。', + 'description' => 'IPv6网段。', + 'type' => 'string', + 'example' => '101.66.250.0/25', + ], + 'Region' => [ + 'title' => 'IPv6区域。', + 'description' => 'IPv6区域。', + 'type' => 'string', + 'example' => 'chinese_mainland', + 'enum' => [ + 'chinese_mainland', + 'global_excluding_chinese_mainland', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NeedUpdate' => [ + 'description' => '回源IP白名单是否需要更新，当所使用的回源IP白名单和最新的回源IP白名单有差异时，就需要更新，此值返回true。'."\n" + ."\n" + .'- true：需要更新。'."\n" + .'- false：不需要更新。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OriginProtection' => [ + 'description' => '源站防护开关：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'OriginConverge' => [ + 'description' => '回源收敛开关：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'AutoConfirmIPList' => [ + 'title' => '自动启用最新回源IP列表', + 'description' => '自动启用最新回源IP列表', + 'type' => 'string', + 'example' => 'off', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取源站防护信息', + 'summary' => '查询站点源站防护相关配置，包括源站防护开关、回源收敛开关、是否需要更新回源IP白名单，以及回源IP白名单相关详细信息，包括现在站点所使用的回源IP白名单、最新的回源IP白名单以及两者之间的差异。', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-24T01:42:33.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginProtection', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"CurrentIPWhitelist\\": {\\n \\"IPv4\\": [\\n \\"101.66.250.0/25\\"\\n ],\\n \\"IPv6\\": [\\n \\"2409:8c54:1841:200a::/64\\"\\n ]\\n },\\n \\"LatestIPWhitelist\\": {\\n \\"IPv4\\": [\\n \\"101.66.250.0/25\\"\\n ],\\n \\"IPv6\\": [\\n \\"2409:8c54:1841:200a::/64\\"\\n ]\\n },\\n \\"DiffIPWhitelist\\": {\\n \\"AddedIPWhitelist\\": {\\n \\"IPv4\\": [\\n \\"101.66.250.0/25\\"\\n ],\\n \\"IPv6\\": [\\n \\"2409:8c54:1841:200a::/64\\"\\n ]\\n },\\n \\"NoChangeIpWhitelist\\": {\\n \\"IPv4\\": [\\n \\"101.66.250.0/25\\"\\n ],\\n \\"IPv6\\": [\\n \\"2409:8c54:1841:200a::/64\\"\\n ]\\n },\\n \\"RemovedIPWhitelist\\": {\\n \\"IPv4\\": [\\n \\"101.66.250.0/25\\"\\n ],\\n \\"IPv6\\": [\\n \\"2409:8c54:1841:200a::/64\\"\\n ]\\n }\\n },\\n \\"RegionalCurrentIPWhitelist\\": {\\n \\"RegionalIPv4\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ],\\n \\"RegionalIPv6\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ]\\n },\\n \\"RegionalLatestIPWhitelist\\": {\\n \\"RegionalIPv4\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ],\\n \\"RegionalIPv6\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ]\\n },\\n \\"RegionalDiffIPWhitelist\\": {\\n \\"AddedIPRegionWhitelist\\": {\\n \\"RegionalIPv4\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ],\\n \\"RegionalIPv6\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ]\\n },\\n \\"NoChangeIpWhitelist\\": {\\n \\"RegionalIPv4\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ],\\n \\"RegionalIPv6\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ]\\n },\\n \\"RemovedIPRegionWhitelist\\": {\\n \\"RegionalIPv4\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ],\\n \\"RegionalIPv6\\": [\\n {\\n \\"Cidr\\": \\"101.66.250.0/25\\",\\n \\"Region\\": \\"chinese_mainland\\"\\n }\\n ]\\n }\\n },\\n \\"NeedUpdate\\": true,\\n \\"OriginProtection\\": \\"on\\",\\n \\"OriginConverge\\": \\"on\\",\\n \\"SiteId\\": 0,\\n \\"AutoConfirmIPList\\": \\"off\\"\\n}","type":"json"}]', + ], + 'GetOriginRule' => [ + 'summary' => '查询单条回源规则配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257604', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3400350********', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListOriginRules](~~2866989~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '33793140540****', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816096987136', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true。'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")。', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'OriginHost' => [ + 'description' => '回源请求中携带的HOST。', + 'type' => 'string', + 'example' => 'origin.example.com'."\n", + ], + 'OriginScheme' => [ + 'description' => '回源请求使用的协议。取值范围：'."\n" + ."\n" + .'- http：使用HTTP协议回源。'."\n" + .'- https：使用HTTPS协议回源。'."\n" + .'- follow：跟随客户端协议回源。', + 'type' => 'string', + 'example' => 'http', + ], + 'OriginSni' => [ + 'description' => '回源请求中携带的SNI。', + 'type' => 'string', + 'example' => 'origin.example.com'."\n", + ], + 'DnsRecord' => [ + 'description' => '改写回源请求的DNS解析记录。', + 'type' => 'string', + 'example' => 'test.example.com'."\n", + ], + 'OriginHttpPort' => [ + 'description' => '使用HTTP协议回源时访问的源站端口。', + 'type' => 'string', + 'example' => '8080', + ], + 'OriginHttpsPort' => [ + 'description' => '使用HTTPS协议回源时访问的源站端口。', + 'type' => 'string', + 'example' => '4433', + ], + 'Range' => [ + 'description' => '使用range分片方式回源下载文件。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。'."\n" + .'- force：强制。', + 'type' => 'string', + 'example' => 'on', + ], + 'OriginMtls' => [ + 'description' => 'mtls开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'OriginVerify' => [ + 'description' => '源站证书校验开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'RangeChunkSize' => [ + 'description' => 'range分片大小。取值范围：'."\n" + .'- 512KB'."\n" + .'- 1MB'."\n" + .'- 2MB'."\n" + .'- 4MB', + 'type' => 'string', + 'example' => '1MB', + ], + 'OriginReadTimeout' => [ + 'description' => '源站读超时时间(秒)。', + 'type' => 'string', + 'example' => '10', + ], + 'Follow302Enable' => [ + 'description' => '回源302跟随开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Follow302MaxTries' => [ + 'description' => '302跟随次数上限，取值范围[1-5]。', + 'type' => 'string', + 'example' => '1', + ], + 'Follow302RetainArgs' => [ + 'description' => '保留原始请求参数开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Follow302RetainHeader' => [ + 'description' => '保留原始请求头开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Follow302TargetHost' => [ + 'description' => '修改302后的回源host。', + 'type' => 'string', + 'example' => 'test.com', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136,\\n \\"ConfigType\\": \\"rule\\",\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"OriginHost\\": \\"origin.example.com\\\\n\\",\\n \\"OriginScheme\\": \\"http\\",\\n \\"OriginSni\\": \\"origin.example.com\\\\n\\",\\n \\"DnsRecord\\": \\"test.example.com\\\\n\\",\\n \\"OriginHttpPort\\": \\"8080\\",\\n \\"OriginHttpsPort\\": \\"4433\\",\\n \\"Range\\": \\"on\\",\\n \\"OriginMtls\\": \\"on\\",\\n \\"OriginVerify\\": \\"on\\",\\n \\"RangeChunkSize\\": \\"1MB\\",\\n \\"OriginReadTimeout\\": \\"10\\",\\n \\"Follow302Enable\\": \\"on\\",\\n \\"Follow302MaxTries\\": \\"1\\",\\n \\"Follow302RetainArgs\\": \\"on\\",\\n \\"Follow302RetainHeader\\": \\"on\\",\\n \\"Follow302TargetHost\\": \\"test.com\\"\\n}","type":"json"}]', + 'title' => '查询站点回源规则配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-17T08:47:33.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-04-01T01:57:04.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-03-20T05:57:46.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-02-27T09:16:40.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'GetPage' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239604', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义响应页面的ID', + 'description' => '自定义响应页面的ID，可通过调用[ListPages](~~2850223~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50000001', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225 ', + ], + 'UpdateTime' => [ + 'title' => '修改时间', + 'description' => '自定义响应页面的最后修改时间。', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00Z', + ], + 'Id' => [ + 'title' => '自定义响应页面ID', + 'description' => '自定义响应页面的ID，可通过调用[ListPages](~~2850223~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50000001', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '自定义响应页面名称', + 'description' => '自定义响应页面名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + 'maxLength' => 128, + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '自定义响应页面描述', + 'description' => '自定义响应页面描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'a custom deny page', + 'maxLength' => 1024, + 'pattern' => '', + 'default' => '', + ], + 'Kind' => [ + 'title' => '自定义响应页面类型', + 'description' => '自定义响应页面类型。', + 'type' => 'string', + 'example' => 'custom', + ], + 'ContentType' => [ + 'title' => 'HTTP Header中的Content-Type字段，如：text/html、application/json', + 'description' => 'HTTP Header中的Content-Type字段。', + 'type' => 'string', + 'required' => true, + 'example' => 'text/html', + 'pattern' => '', + 'default' => '', + ], + 'Content' => [ + 'title' => 'BASE64编码后的 Content-Type 对应的响应页面内容', + 'description' => 'BASE64编码后的Content-Type对应的响应页面内容。', + 'type' => 'string', + 'required' => true, + 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', + 'pattern' => '', + 'default' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The specified parameters are invalid.', + 'description' => '参数非法。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取单个自定义响应页面详情', + 'summary' => '根据自定义响应页面的ID获取单个自定义响应页面详情。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:48.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetPage', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225 \\",\\n \\"UpdateTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"Id\\": 50000001,\\n \\"Name\\": \\"example\\",\\n \\"Description\\": \\"a custom deny page\\",\\n \\"Kind\\": \\"custom\\",\\n \\"ContentType\\": \\"text/html\\",\\n \\"Content\\": \\"PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=\\"\\n}","type":"json"}]', + ], + 'GetPurgeQuota' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239209', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBCJPGN', + 'FEATUREdcdnELTTM1', + 'FEATUREdcdnA9FG2P', + 'FEATUREdcdnRELTJV', + 'FEATUREdcdnEWYS3A', + 'FEATUREdcdn4QVGXU', + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '刷新任务类型，取值：'."\n" + .'- **file**（默认值）：文件刷新。'."\n" + .'- **cachetag**：缓存标签刷新。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **ignoreParams**：去参数刷新。'."\n" + .'- **hostname**：主机名刷新。'."\n" + .'- **purgeall**：刷新站点下所有缓存。', + 'type' => 'string', + 'required' => false, + 'example' => 'file', + 'enum' => [ + 'file', + 'cachetag', + 'directory', + 'ignoreparams', + 'hostname', + 'purgeall', + 'preload', + 'cachekey', + ], + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'Quota' => [ + 'description' => '配额总量。', + 'type' => 'string', + 'example' => '100000', + ], + 'Usage' => [ + 'description' => '配额已使用量。', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidStationParameter', + 'errorMessage' => 'The specified Station is invalid.', + 'description' => '指定的节点参数无效。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified taskId is invalid.', + 'description' => '指定的任务ID无效。', + ], + [ + 'errorCode' => 'InvalidParameters.InvalidUrls', + 'errorMessage' => 'The specified urls are invalid.', + 'description' => '请求的URL参数无效。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取刷新配额', + 'summary' => '获取不同刷新类型的配额及配额已使用量。', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-10T01:55:18.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetPurgeQuota', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetPurgeQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Quota\\": \\"100000\\",\\n \\"Usage\\": \\"10\\"\\n}","type":"json"}]', + ], + 'GetRealtimeDeliveryField' => [ + 'summary' => '根据日志业务类型获取实时日志对应的字段列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239152', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '业务类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1**（默认值）：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => true, + 'example' => 'dcdn_log_er', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', + ], + 'FieldContent' => [ + 'description' => '响应字段列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'SortOrder' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => '字段排序。', + 'example' => '1', + ], + 'FieldList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => [ + 'type' => 'string', + 'example' => 'ClientIp', + 'description' => '字段名。', + ], + 'Description' => [ + 'type' => 'string', + 'example' => 'IP address of the client.', + 'description' => '字段英文解释。', + ], + 'DescriptionCn' => [ + 'type' => 'string', + 'example' => '客户端的IP地址', + 'description' => '字段中文解释。', + ], + 'Category' => [ + 'type' => 'string', + 'description' => '字段所属类别。', + 'example' => 'Client', + ], + 'DataType' => [ + 'type' => 'string', + 'example' => 'String', + 'description' => '字段数据类型。', + ], + 'SortOrder' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => '用于字段响应排序。', + 'example' => '1', + ], + 'IsDefault' => [ + 'type' => 'boolean', + 'description' => '是否默认提供。', + 'example' => 'true', + ], + ], + 'description' => '', + ], + 'description' => '字段列表。', + ], + ], + 'description' => '响应字段。', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取实时日志字段列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRealtimeDeliveryField', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRealtimeDeliveryField', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\",\\n \\"FieldContent\\": {\\n \\"key\\": {\\n \\"SortOrder\\": 1,\\n \\"FieldList\\": [\\n {\\n \\"FieldName\\": \\"ClientIp\\",\\n \\"Description\\": \\"IP address of the client.\\",\\n \\"DescriptionCn\\": \\"客户端的IP地址\\",\\n \\"Category\\": \\"Client\\",\\n \\"DataType\\": \\"String\\",\\n \\"SortOrder\\": 1,\\n \\"IsDefault\\": true\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'GetRecord' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239656', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '记录的ID，可以通过[ListRecords](~~2850265~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F5A19', + ], + 'RecordModel' => [ + 'description' => '查询到的单个记录信息。', + 'type' => 'object', + 'properties' => [ + 'BizName' => [ + 'description' => '记录加速时的业务场景。取值：'."\n" + ."\n" + .'- **image_video**：视频图片。'."\n" + .'- **api**：api接口。'."\n" + .'- **web**：web网页。', + 'type' => 'string', + 'example' => 'image_video', + ], + 'Data' => [ + 'description' => '记录的DNS信息。不同类型的记录，该字段返回的内容也不同。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '记录值或部分内容。在不同类型的记录中，分别表示不同的含义：'."\n" + ."\n" + .'- **A/AAAA**：指向的Ip地址。多个Ip时，用","分隔。至少需要有一个Ipv4地址。'."\n" + .'- **CNAME**：指向的目标域名。'."\n" + .'- **NS**：指定域名的名称服务器。'."\n" + .'- **MX**: 有效的目标邮件服务器域名。'."\n" + .'- **TXT**：有效的文本字符串。'."\n" + .'- **CAA**：有效的证书颁发机构域名。'."\n" + .'- **SRV**：有效的目标主机域名。'."\n" + .'- **URI**: 有效的 URI 字符串。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Priority' => [ + 'description' => '记录的优先级。范围为**0~65535**。数值越小，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Flag' => [ + 'description' => '记录的标志位。CAA记录的Flag指示其优先级和处理方式，取值范围为**0~255**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + 'Tags' => [ + 'type' => 'object', + 'description' => '', + ], + 'Weight' => [ + 'description' => '记录的权重，范围为**0~65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Port' => [ + 'description' => '记录的端口。范围为**0~65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8707', + ], + 'Type' => [ + 'description' => '记录的证书类型（在CERT记录中），或公钥类型（在SSHFP记录中）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'RSA', + ], + 'KeyTag' => [ + 'description' => '记录的公钥标识，范围为**0~65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Algorithm' => [ + 'description' => '记录所采用的加密算法。范围为**0~255**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Certificate' => [ + 'description' => '记录的公钥证书信息。', + 'type' => 'string', + 'example' => 'dGVzdGFkYWxrcw==', + ], + 'Usage' => [ + 'description' => '记录的用途标识。范围为**0~255**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Selector' => [ + 'description' => '记录所使用的证书或公钥的类型。范围为**0~255**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MatchingType' => [ + 'description' => '记录用于匹配或验证证书的算法策略。范围为**0~255**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Fingerprint' => [ + 'description' => '记录的公钥指纹值。', + 'type' => 'string', + 'example' => 'abcdef1234567890', + ], + 'Tag' => [ + 'description' => '记录的标签。CAA记录的Tag表示其具体类型和用途。', + 'type' => 'string', + 'example' => 'issue', + ], + ], + 'example' => '{"value":"1.1.1.1"}', + ], + 'CreateTime' => [ + 'description' => '记录的创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-03-10T13:30:39Z', + ], + 'UpdateTime' => [ + 'description' => '记录的更新时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-01-27T02:26:22Z', + ], + 'Proxied' => [ + 'description' => '记录是否开启代理加速。只有CNAME记录与A/AAAA记录可以开启代理加速。取值：'."\n" + ."\n" + .'- **true**：开启代理。'."\n" + .'- **false**：关闭代理加速。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecordId' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'a.example.com', + ], + 'RecordType' => [ + 'description' => '记录的DNS类型。如**A/AAAA、CNAME、TXT**等。', + 'type' => 'string', + 'example' => 'A/AAAA', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Ttl' => [ + 'description' => '记录的过期时间，单位秒。当取值为1时，表示记录的过期时间为自动。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RecordSourceType' => [ + 'description' => 'CNAME记录的源站类型。取值：'."\n" + ."\n" + .'- **OSS**：OSS源站。'."\n" + .'- **S3**：S3源站。'."\n" + .'- **LB**：负载均衡器源站。'."\n" + .'- **OP**：源地址池源站。'."\n" + .'- **Domain**：普通域名源站。'."\n" + ."\n" + .'该参数不传或传空时，则默认为Domain，即普通域名源站类型。', + 'type' => 'string', + 'example' => 'OSS ', + ], + 'RecordCname' => [ + 'description' => '记录的CNAME。', + 'type' => 'string', + 'example' => 'a.example.com.cnamezone.com', + ], + 'Comment' => [ + 'description' => '记录的备注信息。', + 'type' => 'string', + 'example' => '这是一个备注信息', + ], + 'AuthConf' => [ + 'description' => 'CNAME记录的源站鉴权信息。', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'description' => '源站鉴权类型。可选值：'."\n" + .'- **public**：公共读，当源站类型为OSS或S3，且源站为公共读时，选此值。'."\n" + .'- **private**: 私有读，当源站类型为S3，且源站为私有读时，选此值。'."\n" + .'- **private_same_account**: 私有同账号读，当源站类型为OSS，在同一个阿里云账号下，且源站为私有读时，选此值。'."\n" + .'- **private_cross_account**: 私有跨账号读，当源站类型为OSS，不在同一个阿里云账号下，且源站为私有读时，选此值。', + 'type' => 'string', + 'example' => 'public', + ], + 'SecretKey' => [ + 'description' => '源站所属账号的AccessKey。', + 'type' => 'string', + 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', + ], + 'AccessKey' => [ + 'description' => '源站所属账号的AccessKey。', + 'type' => 'string', + 'example' => 'VIxuvJSA2S03f******kp208dy5w7', + ], + 'Version' => [ + 'description' => '签名算法版本。支持以下两种：'."\n" + .'- **v2**'."\n" + .'- **v4**'."\n" + ."\n" + .'不传时，默认为v4。', + 'type' => 'string', + 'example' => 'v2', + ], + 'Region' => [ + 'description' => '源站所属区域。源站所属的区域需要在S3的官方网站上获取。', + 'type' => 'string', + 'example' => 'us-east-1', + ], + ], + ], + 'HostPolicy' => [ + 'description' => '回源HOST策略，记录类型为CNAME时生效，设置回源时带HOST的策略，有两种模式：'."\n" + ."\n" + .'- **follow_hostname**: 跟随主机记录。'."\n" + .'- **follow_origin_domain**: 跟随源站域名。', + 'type' => 'string', + 'example' => 'follow_origin_domain', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'Record.NotFound', + 'errorMessage' => 'The record does not exist. Check your configurations and try again.', + 'description' => '传入的请求记录不存在，请检查您的输入参数后重试。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询解析记录详情', + 'summary' => '获取单条DNS解析记录的详细配置信息，包括记录值、优先级、回源鉴权配置（CNAME记录独有）等。', + 'changeSet' => [ + [ + 'createdAt' => '2025-08-21T09:39:51.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-09-23T08:53:22.000Z', + 'description' => '错误码发生变更、响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRecord', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F32C57AA-7BF8-49AE-A2CC-9F42390F5A19\\",\\n \\"RecordModel\\": {\\n \\"BizName\\": \\"image_video\\",\\n \\"Data\\": {\\n \\"Value\\": \\"example.com\\",\\n \\"Priority\\": 10,\\n \\"Flag\\": 128,\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Weight\\": 0,\\n \\"Port\\": 8707,\\n \\"Type\\": 0,\\n \\"KeyTag\\": 1,\\n \\"Algorithm\\": 1,\\n \\"Certificate\\": \\"dGVzdGFkYWxrcw==\\",\\n \\"Usage\\": 0,\\n \\"Selector\\": 1,\\n \\"MatchingType\\": 1,\\n \\"Fingerprint\\": \\"abcdef1234567890\\",\\n \\"Tag\\": \\"issue\\"\\n },\\n \\"CreateTime\\": \\"2023-03-10T13:30:39Z\\",\\n \\"UpdateTime\\": \\"2023-01-27T02:26:22Z\\",\\n \\"Proxied\\": true,\\n \\"RecordId\\": 1234567890123,\\n \\"RecordName\\": \\"a.example.com\\",\\n \\"RecordType\\": \\"A/AAAA\\",\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Ttl\\": 20,\\n \\"RecordSourceType\\": \\"OSS \\",\\n \\"RecordCname\\": \\"a.example.com.cnamezone.com\\",\\n \\"Comment\\": \\"这是一个备注信息\\",\\n \\"AuthConf\\": {\\n \\"AuthType\\": \\"public\\",\\n \\"SecretKey\\": \\"u0Nkg5gBK*******QF5wvKMM504JUHt\\",\\n \\"AccessKey\\": \\"VIxuvJSA2S03f******kp208dy5w7\\",\\n \\"Version\\": \\"v2\\",\\n \\"Region\\": \\"us-east-1\\"\\n },\\n \\"HostPolicy\\": \\"follow_origin_domain\\"\\n }\\n}","type":"json"}]', + ], + 'GetRedirectRule' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257659', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34003500310****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListRedirectRules](~~ListRedirectRules~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'Type' => [ + 'description' => '重定向类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + 'TargetUrl' => [ + 'description' => '重定向后的目标URL。', + 'type' => 'string', + 'example' => 'http://www.exapmle.com/index.html', + ], + 'StatusCode' => [ + 'description' => '节点给客户端响应重定向地址时候使用的响应状态码。取值范围：'."\n" + ."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 303'."\n" + .'- 307'."\n" + .'- 308', + 'type' => 'string', + 'example' => '301', + ], + 'ReserveQueryString' => [ + 'description' => '保留查询字符串。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询重定向配置详情', + 'summary' => '查询站点的重定向配置的详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRedirectRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetRedirectRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"ConfigId\\": 0,\\n \\"ConfigType\\": \\"rule\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"Type\\": \\"static\\",\\n \\"TargetUrl\\": \\"http://www.exapmle.com/index.html\\",\\n \\"StatusCode\\": \\"301\\",\\n \\"ReserveQueryString\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetRewriteUrlRule' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257643', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****'."\n", + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListRewriteUrlRules](~~2867480~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置；'."\n" + .'- rule：规则配置；', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'RewriteUriType' => [ + 'description' => '路径重写类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + 'Uri' => [ + 'description' => '重写后的目标URI。', + 'type' => 'string', + 'example' => '/image/example.jpg', + ], + 'RewriteQueryStringType' => [ + 'description' => '查询字符串重写类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + 'QueryString' => [ + 'description' => '重写后的查询字符串。', + 'type' => 'string', + 'example' => 'example=123', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询重写URL配置', + 'summary' => '查询重写URL配置详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRewriteUrlRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetRewriteUrlRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"ConfigId\\": 0,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"RewriteUriType\\": \\"static\\",\\n \\"Uri\\": \\"/image/example.jpg\\",\\n \\"RewriteQueryStringType\\": \\"static\\",\\n \\"QueryString\\": \\"example=123\\"\\n}","type":"json"}]', + ], + 'GetRoutine' => [ + 'summary' => '查询边缘函数Routine的所有配置信息，包含代码版本列表、环境配置信息列表、关联域名配置信息列表、关联路由配置信息列表等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239274', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Envs' => [ + 'description' => '环境信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '环境信息。', + 'type' => 'object', + 'properties' => [ + 'Env' => [ + 'description' => '环境名。', + 'type' => 'string', + 'example' => 'production', + ], + 'CodeDeploy' => [ + 'description' => '比例灰度版本部署信息。', + 'type' => 'object', + 'properties' => [ + 'DeployId' => [ + 'description' => '部署记录ID。', + 'type' => 'string', + 'example' => '589267', + ], + 'CreationTime' => [ + 'description' => '部署创建时间。', + 'type' => 'string', + 'example' => '2023-05-11T09:21:36Z', + ], + 'Strategy' => [ + 'description' => '部署策略。默认percentage。', + 'type' => 'string', + 'enumValueTitles' => [ + 'percentage' => 'percentage', + ], + 'example' => 'percentage', + ], + 'CodeVersions' => [ + 'description' => '部署代码版本号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个部署代码版本信息。', + 'type' => 'object', + 'properties' => [ + 'CodeVersion' => [ + 'description' => '代码版本号。', + 'type' => 'string', + 'example' => '1746583193971399525', + ], + 'Percentage' => [ + 'description' => '代码版本灰度部署比例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Description' => [ + 'description' => '代码版本描述。', + 'type' => 'string', + 'example' => 'code version 1.', + ], + 'CreateTime' => [ + 'description' => '代码版本创建时间。', + 'type' => 'string', + 'example' => '2025-07-23T09:01:40Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '边缘函数Routine创建时间。', + 'type' => 'string', + 'example' => '2024-03-11T01:23:21Z'."\n", + ], + 'Description' => [ + 'description' => '边缘函数Routine描述。', + 'type' => 'string', + 'example' => 'ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg', + ], + 'DefaultRelatedRecord' => [ + 'description' => '默认接入访问记录。', + 'type' => 'string', + 'example' => 'routine1.example.com', + ], + 'HasAssets' => [ + 'description' => 'Routine是否带Assets标记。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', + 'description' => '输入的参数校验不通过，请您核对参数的正确性后重试。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询边缘函数配置', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-04T05:48:49.000Z', + 'description' => '请求参数发生变更、响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRoutine', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRoutine', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Envs\\": [\\n {\\n \\"Env\\": \\"production\\",\\n \\"CodeDeploy\\": {\\n \\"DeployId\\": \\"589267\\",\\n \\"CreationTime\\": \\"2023-05-11T09:21:36Z\\",\\n \\"Strategy\\": \\"percentage\\",\\n \\"CodeVersions\\": [\\n {\\n \\"CodeVersion\\": \\"1746583193971399525\\",\\n \\"Percentage\\": 100,\\n \\"Description\\": \\"code version 1.\\",\\n \\"CreateTime\\": \\"2025-07-23T09:01:40Z\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"CreateTime\\": \\"2024-03-11T01:23:21Z\\\\n\\",\\n \\"Description\\": \\"ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg\\",\\n \\"DefaultRelatedRecord\\": \\"routine1.example.com\\",\\n \\"HasAssets\\": false\\n}","type":"json"}]', + ], + 'GetRoutineCodeVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239164', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'CodeVersion', + 'in' => 'formData', + 'schema' => [ + 'description' => '代码版本号。', + 'type' => 'string', + 'required' => true, + 'example' => '1710120201067203242', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'CodeDescription' => [ + 'description' => '代码版本描述。', + 'type' => 'string', + 'example' => 'test ver code desc'."\n", + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-03-11T01:23:21Z'."\n", + ], + 'RoutineCode' => [ + 'description' => '代码内容。', + 'type' => 'string', + 'example' => 'PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEVycm9yPgogIDxDb2RlPk5vU3VjaEtleTwvQ29kZT4KICA8TWVzc2FnZT5UaGUgc3BlY2lmaWVkIGtleSBkb2VzIG5vdCBleGlzdC48L01lc3NhZ2U', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'CodeVersionNumberExceedQuotaLimit', + 'errorMessage' => 'The maximum number of code versions in your plan has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'description' => '您的代码版本数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多的代码版本配额数量。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'errorCode' => 'ParameterNotExist', + 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', + 'description' => '输入参数不存在，请您核对后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询边缘函数某版本代码信息', + 'summary' => '查询边缘程序某版本号代码信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRoutineCodeVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"CodeDescription\\": \\"test ver code desc\\\\n\\",\\n \\"CreateTime\\": \\"2024-03-11T01:23:21Z\\\\n\\",\\n \\"RoutineCode\\": \\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEVycm9yPgogIDxDb2RlPk5vU3VjaEtleTwvQ29kZT4KICA8TWVzc2FnZT5UaGUgc3BlY2lmaWVkIGtleSBkb2VzIG5vdCBleGlzdC48L01lc3NhZ2U\\"\\n}","type":"json"}]', + ], + 'GetRoutineRoute' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266193', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的ConfigId，可通过调用[ListSiteRoutes](~~2879631~~)接口获取ConfigId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '352816******', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点的版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RouteEnable' => [ + 'description' => '路由开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容。', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RouteName' => [ + 'description' => '路由名称。', + 'type' => 'string', + 'example' => 'test_route', + ], + 'RoutineName' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'example' => 'test-routine1', + ], + 'Bypass' => [ + 'description' => '旁路模式。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Mode' => [ + 'description' => '配置模式。取值范围：'."\n" + .'- simple：简单模式。'."\n" + .'- custom： 自定义模式。', + 'type' => 'string', + 'example' => 'simple', + ], + 'Fallback' => [ + 'description' => '异常回源开关，开启后若函数出现异常如CPU使用超限则请求回源。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询单条边缘函数路由配置', + 'summary' => '查询单条边缘函数路由配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-25T05:35:34.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRoutineRoute', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetRoutineRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"ConfigId\\": 0,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RouteEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RouteName\\": \\"test_route\\",\\n \\"RoutineName\\": \\"test-routine1\\",\\n \\"Bypass\\": \\"on\\",\\n \\"Mode\\": \\"simple\\",\\n \\"Fallback\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetRoutineStagingCodeUploadInfo' => [ + 'summary' => '获取边缘函数Routine上传测试版本代码的上传信息，用于上传测试版本代码到OSS。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238993', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'CodeDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '代码描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'the description of code', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'CodeVersion' => [ + 'description' => '代码版本号。', + 'type' => 'string', + 'example' => '1710120201067203242', + ], + 'OssPostConfig' => [ + 'description' => '上传OSS配置信息。', + 'type' => 'object', + 'example' => '{'."\n" + .' "Url": "http://oss_fake_bucket_url",'."\n" + .' "OSSAccessKeyId": "xxx",'."\n" + .' "key": "site_er_js/hello.1418586423220543.unstable.js",'."\n" + .' "callback": "xxx==",'."\n" + .' "x:codeDescription": "xxx=",'."\n" + .' "policy": "xxx",'."\n" + .' "Signature": "xxx="'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'CodeVersionNumberExceedQuotaLimit', + 'errorMessage' => 'The maximum number of code versions in your plan has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'description' => '您的代码版本数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多的代码版本配额数量。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取上传边缘函数测试代码上传信息', + 'description' => '- 上传一次边缘函数ER的测试代码，生成一个版本号，占用一个CodeRev的代码版本数，仅用作测试使用。'."\n" + .'- 一个边缘函数ER最多保留10个版本号，超出限制后需要手动调用DeleteRoutineCodeRevision删除无用的版本。', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-04T05:48:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRoutineStagingCodeUploadInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"CodeVersion\\": \\"1710120201067203242\\",\\n \\"OssPostConfig\\": {\\n \\"Url\\": \\"http://oss_fake_bucket_url\\",\\n \\"OSSAccessKeyId\\": \\"xxx\\",\\n \\"key\\": \\"site_er_js/hello.1418586423220543.unstable.js\\",\\n \\"callback\\": \\"xxx==\\",\\n \\"x:codeDescription\\": \\"xxx=\\",\\n \\"policy\\": \\"xxx\\",\\n \\"Signature\\": \\"xxx=\\"\\n }\\n}","type":"json"}]', + ], + 'GetScheduledPreloadJob' => [ + 'summary' => '根据定时预热任务ID查询单个定时预热任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238950', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '定时预热任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '665d3af3621bccf3fe29e1a4', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'AliUid' => [ + 'title' => '阿里云UID', + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + 'CreatedAt' => [ + 'title' => '任务创建时间', + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2024-06-02T02:23:26Z', + ], + 'Domains' => [ + 'title' => '预热域名列表', + 'description' => '预热域名列表。', + 'type' => 'string', + 'example' => 'testurl.com', + ], + 'ErrorInfo' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'invalid domain:test.com', + ], + 'FailedFileOss' => [ + 'title' => '失败文件OSS地址', + 'description' => '失败文件OSS地址。', + 'type' => 'string', + 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', + ], + 'FileId' => [ + 'title' => 'URL列表文件ID（下载时使用）', + 'description' => 'URL列表文件ID（下载时使用）。', + 'type' => 'string', + 'example' => '665d3b48621bccf3fe29e1a7', + ], + 'Id' => [ + 'title' => '任务ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'InsertWay' => [ + 'title' => 'URL插入方式', + 'description' => 'URL插入方式。', + 'type' => 'string', + 'example' => 'oss', + 'enum' => [ + 'file', + 'url', + ], + ], + 'Name' => [ + 'title' => '任务名称', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'SiteId' => [ + 'title' => '站点ID', + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '190007158391808', + ], + 'TaskSubmitted' => [ + 'title' => '已提交的cdncm预热任务数', + 'description' => '已提交到系统进行预热任务的URL数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskType' => [ + 'title' => '任务类型（刷新/预热）', + 'description' => '任务类型（刷新/预热）。', + 'type' => 'string', + 'example' => 'preload', + 'enum' => [ + 'preload', + 'refresh', + 'path', + ], + ], + 'UrlCount' => [ + 'title' => 'URL总数', + 'description' => 'URL总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UrlSubmitted' => [ + 'title' => '已提交的URL数', + 'description' => '已提交的URL数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询单个定时预热任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetScheduledPreloadJob', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetScheduledPreloadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"AliUid\\": \\"15685865xxx14622\\",\\n \\"CreatedAt\\": \\"2024-06-02T02:23:26Z\\",\\n \\"Domains\\": \\"testurl.com\\",\\n \\"ErrorInfo\\": \\"invalid domain:test.com\\",\\n \\"FailedFileOss\\": \\"https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7\\",\\n \\"FileId\\": \\"665d3b48621bccf3fe29e1a7\\",\\n \\"Id\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"InsertWay\\": \\"oss\\",\\n \\"Name\\": \\"example\\",\\n \\"SiteId\\": 190007158391808,\\n \\"TaskSubmitted\\": 1,\\n \\"TaskType\\": \\"preload\\",\\n \\"UrlCount\\": 2,\\n \\"UrlSubmitted\\": 1\\n}","type":"json"}]', + ], + 'GetSeoBypass' => [ + 'summary' => '查询站点放行搜索引擎爬虫配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257451', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247B78', + ], + 'Enable' => [ + 'description' => '开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点放行搜索引擎爬虫配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSeoBypass', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSeoBypass', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetSite' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239631', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + 'SiteModel' => [ + 'description' => '查询的站点信息。', + 'type' => 'object', + 'properties' => [ + 'AccessType' => [ + 'description' => '站点接入类型。取值：'."\n" + ."\n" + .'- **NS**：通过NS接入。'."\n" + .'- **CNAME**：通过CNAME接入。', + 'type' => 'string', + 'example' => 'NS', + ], + 'CnameZone' => [ + 'description' => '站点的CNAME后缀。通过CNAME方式接入的站点，记录所需要配置CNAME的后缀。', + 'type' => 'string', + 'example' => 'example.cname.com', + ], + 'Coverage' => [ + 'description' => '加速区域。取值：'."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **global**：全球。'."\n" + .'- **overseas**：全球（不包含中国内地）。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'CreateTime' => [ + 'description' => '站点的创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'UpdateTime' => [ + 'description' => '站点的更新时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'InstanceId' => [ + 'description' => '套餐实例ID。', + 'type' => 'string', + 'example' => 'cas-merge-q6h0bv', + ], + 'NameServerList' => [ + 'description' => '站点分配的NS列表。使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'male1-1.ialicdn.com,female1-1.ialicdn.com', + ], + 'PlanName' => [ + 'description' => '套餐名称。', + 'type' => 'string', + 'example' => 'plan-168777532****', + ], + 'PlanSpecName' => [ + 'description' => '站点套餐的规格名称。', + 'type' => 'string', + 'example' => 'normal', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek26g6i6se****', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Status' => [ + 'description' => '站点状态。取值：'."\n" + ."\n" + .'- **pending**：站点待配置。'."\n" + .'- **active**：站点已激活。'."\n" + .'- **offline**：站点已下线。'."\n" + .'- **moved**：站点已被顶替。', + 'type' => 'string', + 'example' => 'pending', + ], + 'Tags' => [ + 'description' => '站点标签。', + 'type' => 'object', + 'example' => '{"tag1":"value1"}', + ], + 'VerifyCode' => [ + 'description' => '站点归属校验码。当站点通过CNAME接入时，需要配置的TXT校验码。', + 'type' => 'string', + 'example' => 'verify_d516cb3740f81f0cef77d162edd1****', + ], + 'VanityNSList' => [ + 'description' => '站点的自定义NS信息，键为单个自定义NS名称，值为自定义NS对应的Ip地址列表，Ip地址列表用半角逗号（,）分隔。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'ns1.example.com', + 'description' => '单个自定义NS名称。', + ], + ], + 'VersionManagement' => [ + 'description' => '版本管理开启状态。为true时代表站点开启了版本管理。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OfflineReason' => [ + 'description' => '站点停用原因。取值：'."\n" + ."\n" + .'- **expiration_ arrears**：订阅套餐到期或账号欠费。'."\n" + .'- **internally_disabled**：被系统内部停用。'."\n" + .'- **missing_icp**：域名缺少ICP。'."\n" + .'- **content_violation**：内容违规。'."\n" + .'- **proactively_disabled**：您主动停用或您设置的用量封顶停用。', + 'type' => 'string', + 'example' => 'expiration_ arrears', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询单个站点信息', + 'summary' => '根据站点ID查询单个站点信息。', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-18T05:59:13.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-09-18T08:21:56.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSite', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSite', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n \\"SiteModel\\": {\\n \\"AccessType\\": \\"NS\\",\\n \\"CnameZone\\": \\"example.cname.com\\",\\n \\"Coverage\\": \\"domestic\\",\\n \\"CreateTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"UpdateTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"InstanceId\\": \\"cas-merge-q6h0bv\\",\\n \\"NameServerList\\": \\"male1-1.ialicdn.com,female1-1.ialicdn.com\\",\\n \\"PlanName\\": \\"plan-168777532****\\",\\n \\"PlanSpecName\\": \\"normal\\",\\n \\"ResourceGroupId\\": \\"rg-aek26g6i6se****\\",\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Status\\": \\"pending\\",\\n \\"Tags\\": {\\n \\"tag1\\": \\"value1\\"\\n },\\n \\"VerifyCode\\": \\"verify_d516cb3740f81f0cef77d162edd1****\\",\\n \\"VanityNSList\\": {\\n \\"key\\": \\"ns1.example.com\\"\\n },\\n \\"VersionManagement\\": true,\\n \\"OfflineReason\\": \\"expiration_ arrears\\"\\n }\\n}","type":"json"}]', + ], + 'GetSiteCurrentNS' => [ + 'summary' => '查询当前站点配置的DNS服务器名称。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239622', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NSList' => [ + 'description' => '站点当前名称服务器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个名称服务器名称。', + 'type' => 'string', + 'example' => 'ns1.example.com', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.SiteName', + 'errorMessage' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', + 'description' => '站点名称无效，请重新输入站点名称，可以包含字母和数字，不能包含特殊字符。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询站点的名称服务器', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T08:21:56.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteCurrentNS', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSiteCurrentNS', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NSList\\": [\\n \\"ns1.example.com\\"\\n ],\\n \\"RequestId\\": \\"2430E05E-1340-5773-B5E1-B743929F46F2\\"\\n}","type":"json"}]', + ], + 'GetSiteCustomLog' => [ + 'summary' => '查询指定站点的自定义日志字段配置详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239137', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11223***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应成功时的数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6befa4aa-2a94-4f51-a245-295787192d2c', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '167026711***', + ], + 'ConfigId' => [ + 'description' => '自定义字段配置Configid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6befa4aa-2a94-4f51-a245-295787192d2c', + ], + 'LogCustomField' => [ + 'description' => '自定义字段。', + 'type' => 'object', + 'properties' => [ + 'RequestHeaders' => [ + 'description' => '请求头参数。', + 'type' => 'array', + 'items' => [ + 'description' => '请求头。', + 'type' => 'string', + 'example' => 'x-acs-request-id', + ], + ], + 'ResponseHeaders' => [ + 'description' => '响应头参数。', + 'type' => 'array', + 'items' => [ + 'description' => '响应头。', + 'type' => 'string', + 'example' => 'X_Swift_Error', + ], + ], + 'Cookies' => [ + 'description' => 'Cookie参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'Cookie。', + 'type' => 'string', + 'example' => 'sessionId', + ], + ], + ], + ], + 'IsExist' => [ + 'description' => '自定义配置是否存在。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取自定义日志字段', + 'description' => '- **功能描述**：此接口用于获取指定站点ID（SiteId）下的自定义日志字段配置信息，包括请求头、响应头及Cookie中的自定义字段。'."\n" + .'- **使用场景**：当需要在日志分析中引用特定的HTTP头或Cookie信息时，可通过此接口获取已配置的自定义日志字段列表。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteCustomLog', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetSiteCustomLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6befa4aa-2a94-4f51-a245-295787192d2c\\",\\n \\"SiteId\\": 0,\\n \\"ConfigId\\": 0,\\n \\"LogCustomField\\": {\\n \\"RequestHeaders\\": [\\n \\"x-acs-request-id\\"\\n ],\\n \\"ResponseHeaders\\": [\\n \\"X_Swift_Error\\"\\n ],\\n \\"Cookies\\": [\\n \\"sessionId\\"\\n ]\\n },\\n \\"IsExist\\": true\\n}","type":"json"}]', + ], + 'GetSiteDeliveryTask' => [ + 'summary' => '获取一个实时日志任务投递的相关信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239221', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'cdn-test-task', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'cdn-test-task', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'test.***.com', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'DiscardRate' => [ + 'description' => '丢弃率。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'DataCenter' => [ + 'description' => '数据中心。取值为：枚举值：'."\n" + ."\n" + .'- **cn** ：中国内地。'."\n" + .'- **sg**： 全球（不包含中国内地）。', + 'type' => 'string', + 'example' => 'cn', + ], + 'BusinessType' => [ + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'example' => 'dcdn_log_access_l1', + ], + 'Status' => [ + 'description' => '任务状态'."\n" + ."\n" + .'- **online**：推送中。'."\n" + ."\n" + .'- **offline**：暂停推送。', + 'type' => 'string', + 'example' => 'online', + ], + 'DeliveryType' => [ + 'description' => '投递类型：'."\n" + ."\n" + .'- **sls**： 阿里云日志服务。'."\n" + .'- **http**：http服务。'."\n" + .'- **aws3**： 亚马逊s3服务。'."\n" + .'- **oss**： 阿里云对象存储服务。'."\n" + .'- **kafka**： kafka服务。'."\n" + .'- **aws3cmpt**： 亚马逊s3兼容服务。', + 'type' => 'string', + 'example' => 'sls', + ], + 'FieldList' => [ + 'description' => '投递字段列表。', + 'type' => 'string', + 'example' => 'Client,UserAgent', + ], + 'FilterRules' => [ + 'description' => '过滤规则。', + 'type' => 'string', + 'example' => '[]', + ], + 'SinkConfig' => [ + 'description' => '投递配置。', + 'type' => 'any', + 'example' => '{\'Region\': \'cn-hangzhou\', \'Endpoint\': \'https://***.oss-cn-hangzhou.aliyuncs.com\', \'BucketPath\': \'hjy-test002/online-logs\'}', + ], + 'RawRule' => [ + 'type' => 'string', + 'description' => '', + ], + 'FilterVer' => [ + 'type' => 'string', + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取投递任务的配置信息', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-24T01:43:10.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteDeliveryTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetSiteDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"TaskName\\": \\"cdn-test-task\\",\\n \\"SiteName\\": \\"test.***.com\\",\\n \\"SiteId\\": 0,\\n \\"DiscardRate\\": 0,\\n \\"DataCenter\\": \\"cn\\",\\n \\"BusinessType\\": \\"dcdn_log_access_l1\\",\\n \\"Status\\": \\"online\\",\\n \\"DeliveryType\\": \\"sls\\",\\n \\"FieldList\\": \\"Client,UserAgent\\",\\n \\"FilterRules\\": \\"[]\\",\\n \\"SinkConfig\\": \\"{\'Region\': \'cn-hangzhou\', \'Endpoint\': \'https://***.oss-cn-hangzhou.aliyuncs.com\', \'BucketPath\': \'hjy-test002/online-logs\'}\\",\\n \\"RawRule\\": \\"\\",\\n \\"FilterVer\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetSiteLogDeliveryQuota' => [ + 'summary' => '查询指定站点与业务类型的实时日志投递剩余配额。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239188', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '实时日志类型，取值：'."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => true, + 'example' => 'dcdn_log_access_l1', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应成功时返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4C14840EF0EAAB6D97CDE0C5F6554ACE', + ], + 'FreeQuota' => [ + 'description' => '剩余quota数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'BusinessType' => [ + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'example' => 'dcdn_log_access_l1', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取站点日志投递配额', + 'description' => '使用此接口可以查询指定阿里云用户下，特定站点与业务类型的实时日志投递服务剩余配额数量。这对于监控与管理您的日志投递容量至关重要，确保日志能够顺利推送至目标存储端，避免因配额不足导致的数据丢失或延迟。'."\n" + ."\n" + .'**参数注意事项：**'."\n" + .'- `BusinessType` 是必填项，需指定业务类型以获取相应的配额信息。'."\n" + .'- `SiteId` 需要是有效的站点ID，且格式应为整数，确保与您在阿里云上配置的站点相对应。'."\n" + ."\n" + .'**响应内容：**'."\n" + .'- 接口成功响应将返回投递配额数量（`FreeQuota`），以及请求标识（`RequestId`），站点ID（`SiteId`）和业务类型（`BusinessType`）作为确认和记录使用。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteLogDeliveryQuota', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetSiteLogDeliveryQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C14840EF0EAAB6D97CDE0C5F6554ACE\\",\\n \\"FreeQuota\\": 3,\\n \\"BusinessType\\": \\"dcdn_log_access_l1\\",\\n \\"SiteId\\": 0\\n}","type":"json"}]', + ], + 'GetSiteNameExclusive' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257455', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + ], + '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' => '35C66C7B-671H-4297-9187-2C4477247A78', + ], + 'Enable' => [ + 'description' => '功能开关。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点名称独占配置', + 'summary' => '查询站点名称独占配置。开启该功能后，其他的账号不再能创建当前站点的同名站点或子站点。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteNameExclusive', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSiteNameExclusive', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetSiteOriginClientCertificate' => [ + 'summary' => '获取站点粒度回源客户端证书信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261746', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaabcd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Certificate' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----', + ], + 'Result' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'upload', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'DigiCert', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-06-24 07:48:51', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-07-20 06:18:42', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babab022c5e9b27bf9c64d7f4b16****', + ], + 'FingerprintSha256' => [ + 'description' => '证书sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'title' => '获取站点粒度回源客户端证书信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteOriginClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSiteOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Status\\": \\"OK\\",\\n \\"Certificate\\": \\"-----BEGIN CERTIFICATE-----\\",\\n \\"Result\\": {\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"upload\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"DigiCert\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-06-24 07:48:51\\",\\n \\"UpdateTime\\": \\"2024-07-20 06:18:42\\",\\n \\"SerialNumber\\": \\"babab022c5e9b27bf9c64d7f4b16****\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n },\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', + ], + 'GetSitePause' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257463', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + 'Paused' => [ + 'description' => '是否已经暂停加速。取值范围：'."\n" + .'- true：已暂停站点加速。'."\n" + .'- false：站点正常加速中。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点暂停配置', + 'summary' => '查询站点暂停配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSitePause', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSitePause', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"Paused\\": true\\n}","type":"json"}]', + ], + 'GetSiteWafSettings' => [ + 'summary' => '该接口用于获取站点WAF配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239627', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4VDL9A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '指定配置路径，不填则代表全部获取。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'bot_management' => '简易模式Bots', + 'add_security_headers' => '添加安全响应头', + 'client_ip_identifier' => '客户端IP定义', + 'add_bot_protection_headers' => '添加安全请求头', + 'security_level' => '安全级别', + ], + 'example' => 'bot_management', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Settings' => [ + 'title' => '站点WAF配置', + 'description' => '站点WAF配置详情。', + '$ref' => '#/components/schemas/WafSiteSettings', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取站点的WAF配置', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-12T06:17:42.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:51.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T08:21:55.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteWafSettings', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetSiteWafSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Settings\\": {\\n \\"ClientIpIdentifier\\": {\\n \\"Headers\\": [\\n \\"X-Forwarded-For\\"\\n ],\\n \\"Mode\\": \\"headers\\"\\n },\\n \\"AddBotProtectionHeaders\\": {\\n \\"Enable\\": true\\n },\\n \\"AddSecurityHeaders\\": {\\n \\"Enable\\": true\\n },\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"BotManagement\\": {\\n \\"DefiniteBots\\": {\\n \\"Action\\": \\"captcha\\",\\n \\"Id\\": 20000001\\n },\\n \\"LikelyBots\\": {\\n \\"Action\\": \\"deny\\",\\n \\"Id\\": 20000002\\n },\\n \\"JSDetection\\": {\\n \\"Enable\\": true\\n },\\n \\"VerifiedBots\\": {\\n \\"Action\\": \\"bypass\\",\\n \\"Id\\": 20000003\\n },\\n \\"EffectOnStatic\\": {\\n \\"Enable\\": true\\n }\\n },\\n \\"BandwidthAbuseProtection\\": {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Id\\": 10000001\\n },\\n \\"DisableSecurityModule\\": {\\n \\"Status\\": \\"on\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetTieredCache' => [ + 'summary' => '查询站点多级缓存配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257309', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'CacheArchitectureMode' => [ + 'description' => '多级缓存架构模式。取值范围：'."\n" + .'- edge：边缘缓存层。'."\n" + .'- edge_smart：边缘缓存层+智能缓存层。'."\n" + .'- edge_regional：边缘缓存层+区域缓存层。'."\n" + .'- edge_regional_smart：边缘缓存层+区域缓存层+智能缓存层。', + 'type' => 'string', + 'enumValueTitles' => [ + 'edge_smart' => 'edge_smart', + 'edge' => 'edge', + 'edge_regional' => 'edge_regional', + 'edge_regional_smart' => 'edge_regional_smart', + ], + 'example' => 'edge', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点多级缓存配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetTieredCache', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetTieredCache', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"CacheArchitectureMode\\": \\"edge\\"\\n}","type":"json"}]', + ], + 'GetTransportLayerApplication' => [ + 'summary' => '查询四层应用详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245120', + 'abilityTreeNodes' => [ + 'FEATUREdcdn2E10XY', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可通过调用[ListTransportLayerApplications](~~ListTransportLayerApplications~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '170997271816****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'EB635996-1FD6-5DFD-BA57-27A849599940', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'ApplicationId' => [ + 'description' => '四层应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17099311410****', + ], + 'RulesCount' => [ + 'description' => '四层加速应用包含的转发规则数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Rules' => [ + 'description' => '转发规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转发规则详情。', + 'type' => 'object', + 'properties' => [ + 'Source' => [ + 'description' => '源站具体的值，需要与源站类型相匹配。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'Protocol' => [ + 'description' => '转发规则协议，取值：'."\n" + ."\n" + .'- TCP：TCP协议。'."\n" + .'- UDP：UDP协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'EdgePort' => [ + 'description' => '边缘端口。支持：'."\n" + ."\n" + .'- 单个端口，例如80。'."\n" + .'- 端口范围，例如 81-85，代表端口 81、82、83、84、85。'."\n" + .'- 端口和端口范围组合，端口、端口范围之间用逗号分隔，例如80,81-85,90，代表端口80、81、82、83、84、85、90。', + 'type' => 'string', + 'example' => '80', + ], + 'SourceType' => [ + 'description' => '源站类型，支持：'."\n" + .'- **ip**: IP。'."\n" + .'- **domain**: 域名。'."\n" + .'- **OP**: 源地址池。'."\n" + .'- **LB**: 负载均衡器。', + 'type' => 'string', + 'example' => 'domain', + ], + 'SourcePort' => [ + 'description' => '源站端口。支持：'."\n" + ."\n" + .'- 单个端口，当源站端口为单个端口时，支持任意合法的边缘端口组合。'."\n" + .'- 端口范围，仅当边缘端口为端口段时，源站端口才允许设置为端口范围且范围大小需要与边缘端口一致。例如边缘端口若为90-93，则不允许将源站端口设置为81-85，因为源站端口范围为5，边缘端口范围为3，两者不一致。', + 'type' => 'string', + 'example' => '80', + ], + 'ClientIPPassThroughMode' => [ + 'description' => '客户端IP传递协议，支持：'."\n" + .'- **off**: 不传递。'."\n" + .'- **PPv1**: PROXY Protocol v1协议，支持TCP协议的客户端IP传递。'."\n" + .'- **PPv2**: PROXY Protocol v2协议，支持TCP和UDP协议的客户端IP传递。'."\n" + .'- **SPP**: Simple Proxy Protocol协议，支持UDP协议的客户端IP传递。', + 'type' => 'string', + 'example' => 'off', + ], + 'Comment' => [ + 'description' => '规则的备注信息。', + 'type' => 'string', + 'example' => '测试', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234323***', + ], + ], + ], + ], + 'Cname' => [ + 'description' => '四层加速应用对应的CNAME域名。只有站点是CNAME方式接入时，该字段才不为空。', + 'type' => 'string', + 'example' => 'example.com.ialicdn.com', + ], + 'RecordName' => [ + 'description' => '四层应用的域名。', + 'type' => 'string', + 'example' => 'test.example.com', + ], + 'IpAccessRule' => [ + 'description' => 'IP访问规则开关，开启后，WAF中的 IP访问规则对四层应用生效。'."\n" + ."\n" + .'- on: 开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'Ipv6' => [ + 'description' => 'Ipv6开关。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'Status' => [ + 'description' => '四层应用状态'."\n" + ."\n" + .'- **deploying**：部署中，在此状态下不允许修改和删除。'."\n" + .'- **active**：已生效。', + 'type' => 'string', + 'enumValueTitles' => [ + 'deploying' => 'deploying', + 'active' => 'active', + ], + 'example' => 'active', + ], + 'CrossBorderOptimization' => [ + 'description' => '是否开启中国大陆网络接入优化，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'StaticIp' => [ + 'type' => 'string', + 'description' => '', + ], + 'StaticIpV4List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'type' => 'string', + 'description' => '', + ], + 'Status' => [ + 'type' => 'string', + 'description' => '', + ], + ], + 'description' => '', + ], + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'TransportLayerApplicationNotExist', + 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', + 'description' => '当前操作的四层加速应用不存在，请修改后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询四层加速应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB635996-1FD6-5DFD-BA57-27A849599940\\",\\n \\"SiteId\\": 0,\\n \\"ApplicationId\\": 0,\\n \\"RulesCount\\": 1,\\n \\"Rules\\": [\\n {\\n \\"Source\\": \\"1.1.1.1\\",\\n \\"Protocol\\": \\"TCP\\",\\n \\"EdgePort\\": \\"80\\",\\n \\"SourceType\\": \\"domain\\",\\n \\"SourcePort\\": \\"80\\",\\n \\"ClientIPPassThroughMode\\": \\"off\\",\\n \\"Comment\\": \\"测试\\",\\n \\"RuleId\\": 0\\n }\\n ],\\n \\"Cname\\": \\"example.com.ialicdn.com\\",\\n \\"RecordName\\": \\"test.example.com\\",\\n \\"IpAccessRule\\": \\"on\\",\\n \\"Ipv6\\": \\"on\\",\\n \\"Status\\": \\"active\\",\\n \\"CrossBorderOptimization\\": \\"on\\",\\n \\"StaticIp\\": \\"\\",\\n \\"StaticIpV4List\\": [\\n {\\n \\"Address\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetUploadTask' => [ + 'summary' => '通过文件上传任务ID查询对应任务的执行状态及运行信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239277', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBCJPGN', + 'FEATUREdcdnRELTJV', + 'FEATUREdcdnEWYS3A', + 'FEATUREdcdn4TTNAL', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456****'."\n", + ], + ], + [ + 'name' => 'UploadId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件上传任务ID，调用[UploadFile](~~2850466~~)接口时分配的此字段。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '159253299357****', + ], + ], + ], + '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' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A52****', + ], + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- **init**：任务初始化。'."\n" + .'- **activacted**：激活。'."\n" + .'- **running**：运行中。'."\n" + .'- **success**：成功。'."\n" + .'- **partial**：部分成功。'."\n" + .'- **fail**：失败。', + 'type' => 'string', + 'example' => 'running', + ], + 'Description' => [ + 'description' => '文件上传任务执行失败后的错误提示信息。', + 'type' => 'string', + 'example' => 'invalid url', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidStationParameter', + 'errorMessage' => 'The specified Station is invalid.', + 'description' => '指定的节点参数无效。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified taskId is invalid.', + 'description' => '指定的任务ID无效。', + ], + [ + 'errorCode' => 'InvalidParameters.InvalidUrls', + 'errorMessage' => 'The specified urls are invalid.', + 'description' => '请求的URL参数无效。', + ], + ], + ], + 'title' => '查询文件上传任务状态', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetUploadTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetUploadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ET5BF670-09D5-4D0B-BEBY-D96A2A52****\\",\\n \\"Status\\": \\"running\\",\\n \\"Description\\": \\"invalid url\\"\\n}","type":"json"}]', + ], + 'GetUserDeliveryTask' => [ + 'summary' => '查询指定用户的任务投递配置及状态信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239202', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7072132a-bd3c-46a6-9e81-aba3e0e3f861', + ], + 'TaskName' => [ + 'description' => '任务名。', + 'type' => 'string', + 'example' => 'testoss11', + ], + 'DiscardRate' => [ + 'description' => '丢弃率。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'DataCenter' => [ + 'description' => '数据中心。取值为：'."\n" + .'- **cn** ：中国内地'."\n" + .'- **sg**： 全球（不包含中国内地）', + 'type' => 'string', + 'example' => 'cn', + ], + 'BusinessType' => [ + 'description' => '业务类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'example' => 'dcdn_log_er', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'online', + ], + 'DeliveryType' => [ + 'description' => '投递类型：'."\n" + .'- **sls**： 阿里云日志服务'."\n" + .'- **http**： http服务'."\n" + .'- **aws3**： 亚马逊s3服务'."\n" + .'- **oss**： 阿里云对象存储服务'."\n" + .'- **kafka**： kafka服务'."\n" + .'- **aws3cmpt**： 亚马逊s3兼容服务', + 'type' => 'string', + 'example' => 'oss', + ], + 'FieldList' => [ + 'description' => '字段数组。', + 'type' => 'string', + 'example' => 'ClientRequestID,ClientRequestHost', + ], + 'FilterRules' => [ + 'description' => '过滤规则。', + 'type' => 'string', + 'example' => '[{"ClientSSLProtocol": {"equals": ["TLSv1.3"]}}]', + ], + 'SinkConfig' => [ + 'description' => '投递配置。', + 'type' => 'any', + 'example' => '{\'Project\': \'er-online-hjy-pro\', \'Logstore\': \'er-online-hjy-log\', \'Region\': \'cn-hangzhou\', \'Endpoint\': \'cn-hangzhou.log.aliyuncs.com\', \'Aliuid\': \'1077912128805410\'}', + ], + 'Details' => [ + 'type' => 'string', + 'description' => '', + ], + 'RawRule' => [ + 'type' => 'string', + 'description' => '', + ], + 'FilterVer' => [ + 'type' => 'string', + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取用户任务投递详情', + 'description' => '- **功能**：此接口用于获取指定阿里云用户下某个任务的详细投递信息，包括任务名、丢弃率、区域、业务类型、状态、投递类型及配置、过滤规则等。'."\n" + .'- **使用场景**：在分析处理效率或排查问题时，需要详细了解或检查特定任务的日志处理与投递配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-24T01:43:11.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-12-26T08:21:56.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-10-18T01:07:11.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:03.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetUserDeliveryTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetUserDeliveryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7072132a-bd3c-46a6-9e81-aba3e0e3f861\\",\\n \\"TaskName\\": \\"testoss11\\",\\n \\"DiscardRate\\": 0,\\n \\"DataCenter\\": \\"cn\\",\\n \\"BusinessType\\": \\"dcdn_log_er\\",\\n \\"Status\\": \\"online\\",\\n \\"DeliveryType\\": \\"oss\\",\\n \\"FieldList\\": \\"ClientRequestID,ClientRequestHost\\",\\n \\"FilterRules\\": \\"[{\\\\\\"ClientSSLProtocol\\\\\\": {\\\\\\"equals\\\\\\": [\\\\\\"TLSv1.3\\\\\\"]}}]\\",\\n \\"SinkConfig\\": \\"{\'Project\': \'er-online-hjy-pro\', \'Logstore\': \'er-online-hjy-log\', \'Region\': \'cn-hangzhou\', \'Endpoint\': \'cn-hangzhou.log.aliyuncs.com\', \'Aliuid\': \'1077912128805410\'}\\",\\n \\"Details\\": \\"\\",\\n \\"RawRule\\": \\"\\",\\n \\"FilterVer\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetUserLogDeliveryQuota' => [ + 'summary' => '查询指定用户各业务类型的日志投递剩余配额。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239047', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => true, + 'example' => 'dcdn_log_access_l1', + ], + ], + ], + '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' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + 'FreeQuota' => [ + 'description' => '剩余可用的额度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'BusinessType' => [ + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'example' => 'dcdn_log_access_l1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'ErService.NotOpen', + 'errorMessage' => 'Er service has not opend.', + 'description' => '您没有开通边缘函数服务。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取实时日志投递配额', + 'description' => '此接口允许用户查询其阿里云账户中，针对不同业务类型的实时日志投递配额情况。用户需提供自己的阿里云用户ID（aliUid）及关注的业务类型（BusinessType），系统将返回该业务类型的剩余quota数量，帮助用户了解当前的配额使用状况。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetUserLogDeliveryQuota', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetUserLogDeliveryQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"FreeQuota\\": 3,\\n \\"BusinessType\\": \\"dcdn_log_access_l1\\"\\n}","type":"json"}]', + ], + 'GetUserWafRuleset' => [ + 'summary' => '此API用于查询指定实例下的WAF规则集详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239606', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'esa-xxxxxxx', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '规则集ID', + 'description' => 'WAF规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000001', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Ruleset' => [ + 'description' => 'WAF规则集。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'WAF规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'Position' => [ + 'description' => 'WAF规则集位置。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'description' => 'WAF规则集名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'Description' => [ + 'description' => 'WAF规则集描述。', + 'type' => 'string', + 'example' => 'example', + ], + 'Status' => [ + 'description' => 'WAF规则集状态。', + 'type' => 'string', + 'example' => 'on', + ], + 'Expression' => [ + 'description' => 'WAF规则集表达式。', + 'type' => 'string', + 'example' => 'ip.src == 1.1.1.1', + ], + 'Phase' => [ + 'description' => 'WAF阶段。', + 'type' => 'string', + 'example' => 'http_custom', + ], + 'Shared' => [ + 'description' => 'WAF规则集共享配置。', + 'example' => '{}', + '$ref' => '#/components/schemas/WafBatchRuleShared', + ], + 'Rules' => [ + 'description' => 'WAF规则集下的规则配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则集下的规则配置。', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => 'WAF规则更新时间。', + 'type' => 'string', + 'example' => '2025-07-07T15:00:00Z', + ], + 'RulesetId' => [ + 'description' => 'WAF规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'Id' => [ + 'description' => 'WAF规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000001', + ], + 'Position' => [ + 'description' => 'WAF规则位置。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Phase' => [ + 'description' => 'WAF阶段。', + 'type' => 'string', + 'example' => 'http_custom', + ], + 'Type' => [ + 'description' => 'WAF规则类型。', + 'type' => 'string', + 'example' => '● 频次控制规则 - http_ratelimit'."\n" + .'● 高频扫描封禁 - http_high_frequency'."\n" + .'● 目录遍历封禁 - http_directory_traversal', + ], + 'Name' => [ + 'description' => 'WAF规则名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'Status' => [ + 'description' => 'WAF规则状态。', + 'type' => 'string', + 'example' => 'on', + ], + 'Fields' => [ + 'description' => 'WAF规则匹配域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WA规则匹配域。', + 'type' => 'string', + 'example' => 'ip.src', + ], + 'example' => '["ip.src"]', + ], + 'CharacteristicsFields' => [ + 'description' => 'WAF规则统计域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则统计域。', + 'type' => 'string', + 'example' => 'http.host', + ], + 'example' => '["http.host"]', + ], + 'Action' => [ + 'description' => 'WAF规则动作。', + 'type' => 'string', + 'example' => 'deny', + ], + 'Skip' => [ + 'description' => 'WAF规则跳过方式。', + 'type' => 'string', + 'example' => 'all', + ], + 'Tags' => [ + 'description' => 'WAF规则跳过阶段列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则跳过阶段。', + 'type' => 'string', + 'example' => 'http_custom', + ], + 'example' => '["http_custom"]', + ], + 'Config' => [ + 'description' => 'WAF规则配置。', + 'example' => '{'."\n" + .' "Id": 20000001,'."\n" + .' "Name": "rule1",'."\n" + .' "Expression": "ip.src eq 1.1.1.1",'."\n" + .' "Action": "deny"'."\n" + .'}', + '$ref' => '#/components/schemas/WafRuleConfig', + ], + ], + 'example' => '{}', + ], + 'example' => '[{}]', + ], + ], + 'example' => '{}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取用户WAF规则集', + 'description' => '## 请求说明'."\n" + .'通过调用`GetUserWafRuleset`接口，您可以根据提供的实例ID和规则集ID来获取特定的WAF（Web应用防火墙）规则集信息。该接口返回的信息包括但不限于规则集的位置、名称、描述、状态以及包含的具体规则等详细内容。请确保在请求时正确填写必需参数以避免请求失败。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Ruleset\\": {\\n \\"Id\\": 10000001,\\n \\"Position\\": 1,\\n \\"Name\\": \\"example\\",\\n \\"Description\\": \\"example\\",\\n \\"Status\\": \\"on\\",\\n \\"Expression\\": \\"ip.src == 1.1.1.1\\",\\n \\"Phase\\": \\"http_custom\\",\\n \\"Shared\\": {\\n \\"Target\\": \\"web\\",\\n \\"Mode\\": \\"automatic\\",\\n \\"CrossSiteId\\": 10000001,\\n \\"Name\\": \\"example\\",\\n \\"Match\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n }\\n },\\n \\"Expression\\": \\"ip.src eq 1.1.1.1\\"\\n },\\n \\"Rules\\": [\\n {\\n \\"UpdateTime\\": \\"2025-07-07T15:00:00Z\\",\\n \\"RulesetId\\": 10000001,\\n \\"Id\\": 20000001,\\n \\"Position\\": 1,\\n \\"Phase\\": \\"http_custom\\",\\n \\"Type\\": \\"● 频次控制规则 - http_ratelimit\\\\n● 高频扫描封禁 - http_high_frequency\\\\n● 目录遍历封禁 - http_directory_traversal\\",\\n \\"Name\\": \\"example\\",\\n \\"Status\\": \\"on\\",\\n \\"Fields\\": [\\n \\"ip.src\\"\\n ],\\n \\"CharacteristicsFields\\": [\\n \\"http.host\\"\\n ],\\n \\"Action\\": \\"deny\\",\\n \\"Skip\\": \\"all\\",\\n \\"Tags\\": [\\n \\"http_custom\\"\\n ],\\n \\"Config\\": {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n },\\n \\"Bypass\\": {\\n \\"Skip\\": \\"part\\",\\n \\"RegularRules\\": [\\n 100001\\n ],\\n \\"CustomRules\\": [\\n 20000001\\n ],\\n \\"RegularTypes\\": [\\n \\"sqli\\"\\n ],\\n \\"Tags\\": [\\n \\"http_custom\\"\\n ]\\n }\\n },\\n \\"ManagedList\\": \\"intelligence_crawler\\",\\n \\"ManagedRulesets\\": [\\n {\\n \\"ProtectionLevel\\": 4,\\n \\"Action\\": \\"deny\\",\\n \\"ManagedRules\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Id\\": 100001\\n }\\n ],\\n \\"AttackType\\": 11,\\n \\"NumberTotal\\": 100,\\n \\"NumberEnabled\\": 50\\n }\\n ],\\n \\"Sigchl\\": [\\n \\"sig\\"\\n ],\\n \\"Name\\": \\"example\\",\\n \\"AppSdk\\": {\\n \\"CustomSign\\": {\\n \\"Value\\": \\"examplesignvalue\\",\\n \\"Key\\": \\"sign\\"\\n },\\n \\"CustomSignStatus\\": \\"on\\",\\n \\"FeatureAbnormal\\": [\\n \\"wxbb_invalid_sign\\"\\n ]\\n },\\n \\"RateLimit\\": {\\n \\"Characteristics\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"OnHit\\": true,\\n \\"TTL\\": 10,\\n \\"Threshold\\": {\\n \\"ManagedRulesBlocked\\": 10,\\n \\"DistinctManagedRules\\": 10,\\n \\"ResponseStatus\\": {\\n \\"Ratio\\": 10,\\n \\"Count\\": 10,\\n \\"Code\\": 404\\n },\\n \\"Traffic\\": \\"10Gb\\",\\n \\"Request\\": 10\\n },\\n \\"Interval\\": 10\\n },\\n \\"Type\\": \\"http_custom\\",\\n \\"AppPackage\\": {\\n \\"PackageSigns\\": [\\n {\\n \\"Sign\\": \\"sign\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n },\\n \\"ManagedGroupId\\": 30000001,\\n \\"Timer\\": {\\n \\"Scopes\\": \\"permanent\\",\\n \\"Zone\\": 8,\\n \\"Periods\\": [\\n {\\n \\"Start\\": \\"2025-01-01T00:00:00Z\\",\\n \\"End\\": \\"2025-01-01T01:00:00Z\\"\\n }\\n ],\\n \\"WeeklyPeriods\\": [\\n {\\n \\"Days\\": \\"1\\",\\n \\"DailyPeriods\\": [\\n {\\n \\"Start\\": \\"00:00:00\\",\\n \\"End\\": \\"01:00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Expression\\": \\"ip.src eq 10.0.0.1\\",\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"Value\\": \\"10.0.0.1\\",\\n \\"Id\\": 20000001,\\n \\"Notes\\": \\"example notes\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetVideoProcessing' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257665', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '23282348***', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListVideoProcessings](~~ListVideoProcessings~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '23321557***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n", + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容。', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'VideoSeekEnable' => [ + 'description' => '拖拽播放功能开关。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + ."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'FlvVideoSeekMode' => [ + 'description' => 'FLV拖拽模式。取值范围：'."\n" + .'- by_byte：按字节拖拽。'."\n" + .'- by_time：按时间拖拽。', + 'type' => 'string', + 'example' => 'by_byte', + ], + 'Mp4SeekStart' => [ + 'description' => '自定义mp4开始参数。', + 'type' => 'string', + 'example' => 'start', + ], + 'Mp4SeekEnd' => [ + 'description' => '自定义mp4结束参数。', + 'type' => 'string', + 'example' => 'end', + ], + 'FlvSeekStart' => [ + 'description' => '自定义FLV开始参数。', + 'type' => 'string', + 'example' => 'start', + ], + 'FlvSeekEnd' => [ + 'description' => '自定义FLV结束参数 。', + 'type' => 'string', + 'example' => 'end', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询站点视频处理配置详情', + 'summary' => '查询站点视频处理配置详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetVideoProcessing', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\",\\n \\"ConfigId\\": 0,\\n \\"ConfigType\\": \\"global\\",\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"VideoSeekEnable\\": \\"on\\",\\n \\"FlvVideoSeekMode\\": \\"by_byte\\",\\n \\"Mp4SeekStart\\": \\"start\\",\\n \\"Mp4SeekEnd\\": \\"end\\",\\n \\"FlvSeekStart\\": \\"start\\",\\n \\"FlvSeekEnd\\": \\"end\\"\\n}","type":"json"}]', + ], + 'GetWafBotAppKey' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239630', + 'abilityTreeNodes' => [ + 'FEATUREdcdn1OLUH8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'AppKey' => [ + 'title' => 'APP key', + 'description' => '应用密钥。', + 'type' => 'string', + 'example' => 'example_appkey', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '获取WAF中BOT阶段的APP key', + 'summary' => '该接口用于获取站点Web应用防火墙（WAF）中BOT行为检测功能的应用密钥 (AppKey)，密钥通常用于与WAF服务进行身份验证和数据交换。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:51.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:56:38.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafBotAppKey', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafBotAppKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"AppKey\\": \\"example_appkey\\"\\n}","type":"json"}]', + ], + 'GetWafFilter' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239605', + 'abilityTreeNodes' => [ + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'query', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF阶段，指定要查询的匹配引擎信息所处的WAF阶段。', + 'type' => 'string', + 'required' => false, + 'example' => 'http_bot', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'title' => '取值目标', + 'description' => '取值目标，定义匹配引擎的应用目标。', + 'type' => 'string', + 'required' => false, + 'example' => 'characteristics', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '规则类型', + 'description' => '规则类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'http_custom_cc', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Filter' => [ + 'title' => '数据内容', + 'description' => '返回的匹配引擎配置信息。', + 'type' => 'object', + 'properties' => [ + 'Phase' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF处理请求的阶段。', + 'type' => 'string', + 'example' => 'http_bot', + ], + 'Target' => [ + 'title' => '取值目标', + 'description' => '匹配引擎取值目标。', + 'type' => 'string', + 'example' => 'characteristics', + ], + 'Type' => [ + 'title' => '规则类型', + 'description' => '规则类型。', + 'type' => 'string', + 'example' => 'http_custom_cc', + ], + 'Fields' => [ + 'title' => '匹配对象相关属性列表', + 'description' => '描述匹配对象及其相关属性的列表。', + 'type' => 'array', + 'items' => [ + 'title' => '匹配对象相关属性', + 'description' => '匹配对象相关属性', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => '当前套餐是否支持该匹配对象。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MinPlan' => [ + 'description' => '如果当前套餐不支持该匹配对象，显示最小的支持该匹配项的套餐。', + 'type' => 'string', + 'example' => 'high', + ], + 'Label' => [ + 'title' => '匹配对象（展示）', + 'description' => '用于展示的匹配对象的标签。', + 'type' => 'string', + 'example' => 'Header', + ], + 'Key' => [ + 'title' => '匹配对象（参数）', + 'description' => '用于系统内部的匹配对象的参数。', + 'type' => 'string', + 'example' => 'http.request.headers', + ], + 'Sub' => [ + 'title' => '匹配对象是否有子字段', + 'description' => '指示匹配对象是否应该包含子字段。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SubTip' => [ + 'title' => '匹配对象子字段输入提示', + 'description' => '提供给用户的关于如何输入子字段的提示。', + 'type' => 'string', + 'example' => 'e.g. Content-Type', + ], + 'Selector' => [ + 'title' => '选择器', + 'description' => '选择器对象，定义如何选择匹配对象。', + 'type' => 'object', + 'properties' => [ + 'Kind' => [ + 'title' => '选择器种类', + 'description' => '选择器种类，如用于选择数据项还是其他。', + 'type' => 'string', + 'example' => 'data', + ], + 'Data' => [ + 'title' => '选择器种类为data时的可选数据列表', + 'description' => '选择器种类为data时的可选数据列表。', + 'type' => 'array', + 'items' => [ + 'title' => '选择器种类为data时的可选数据', + 'description' => '选择器种类为data时的可选数据。', + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'title' => '可选数据（展示）', + 'description' => '可选数据的展示标签。', + 'type' => 'string', + 'example' => 'China', + ], + 'Value' => [ + 'title' => '可选数据（参数）', + 'description' => '可选数据的参数值。', + 'type' => 'string', + 'example' => 'CN', + ], + ], + ], + ], + ], + ], + 'Logics' => [ + 'title' => '匹配对象适用的逻辑符属性列表', + 'description' => '逻辑符属性列表，定义匹配时使用的逻辑条件。', + 'type' => 'array', + 'items' => [ + 'title' => '匹配对象适用的逻辑符属性', + 'description' => '匹配对象适用的逻辑符属性。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => '当前套餐是否支持该匹配符。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MinPlan' => [ + 'description' => '如果当前套餐不支持该匹配符，显示最小的支持该匹配符的套餐。', + 'type' => 'string', + 'example' => 'high', + ], + 'Symbol' => [ + 'title' => '匹配符（参数）', + 'description' => '用于系统内部的匹配符的参数。', + 'type' => 'string', + 'example' => 'eq', + ], + 'Operator' => [ + 'title' => '匹配符（展示）', + 'description' => '用于展示的匹配符的标签。', + 'type' => 'string', + 'example' => 'Does not equal', + ], + 'Negative' => [ + 'title' => '是否取反', + 'description' => '指示是否对匹配结果取反。', + 'type' => 'boolean', + ], + 'Type' => [ + 'title' => '值类型：'."\n" + .'integer'."\n" + .'integer_slice'."\n" + .'string'."\n" + .'string_slice', + 'description' => '值的类型，例如：'."\n" + .'* integer：整型'."\n" + .'* integer_slice：整型数组'."\n" + .'* string：字符串型'."\n" + .'* string_slice：字符串型数组', + 'type' => 'string', + 'example' => 'string', + ], + 'Kind' => [ + 'title' => '值输入框类型'."\n" + .'select:single'."\n" + .'select:multi'."\n" + .'input:single'."\n" + .'input:multi'."\n" + .'switch', + 'description' => '值输入框类型，例如：'."\n" + .'* select:single：单选输入框'."\n" + .'* select:multi：多选输入框'."\n" + .'* input:single：单输入框'."\n" + .'* input:multi：多输入框', + 'type' => 'string', + 'example' => 'input:single', + ], + 'Attributes' => [ + 'title' => '可设置的属性，位域变量，低位到高位如下：'."\n" + .'位 描述'."\n" + .'1 大小写敏感', + 'description' => '可设置的属性，例如是否大小写敏感。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tip' => [ + 'title' => '值输入提升', + 'description' => '输入提示，帮助用户提供规则所需的合法值。', + 'type' => 'string', + 'example' => 'e.g. image/jpeg', + ], + 'Validator' => [ + 'title' => '验证器', + 'description' => '验证器对象，用于定义值的验证规则。', + 'type' => 'object', + 'properties' => [ + 'Length' => [ + 'title' => '值总体长度', + 'description' => '值的长度限制。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + 'Pattern' => [ + 'title' => '值为字符串或字符串数组类型时对单个值的正则表达式', + 'description' => '值的正则表达式模式，用于字符串验证。', + 'type' => 'string', + 'example' => '^example$', + ], + 'Range' => [ + 'title' => '值为数字或者数字数组时的范围', + 'description' => '值的数值范围，用于数字验证。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + 'ErrMsg' => [ + 'title' => '校验不通过时的错误信息', + 'description' => '验证不通过时的错误信息。', + 'type' => 'string', + 'example' => 'Enter a valid expression', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取WAF匹配引擎信息', + 'summary' => '获取指定站点在特定WAF阶段的匹配引擎信息，这些信息定义了WAF如何检测和处理不同类型的网络请求。', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-27T08:44:24.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:51.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:56:36.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafFilter', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafFilter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Filter\\": {\\n \\"Phase\\": \\"http_bot\\",\\n \\"Target\\": \\"characteristics\\",\\n \\"Type\\": \\"http_custom_cc\\",\\n \\"Fields\\": [\\n {\\n \\"Enable\\": false,\\n \\"MinPlan\\": \\"high\\",\\n \\"Label\\": \\"Header\\",\\n \\"Key\\": \\"http.request.headers\\",\\n \\"Sub\\": true,\\n \\"SubTip\\": \\"e.g. Content-Type\\",\\n \\"Selector\\": {\\n \\"Kind\\": \\"data\\",\\n \\"Data\\": [\\n {\\n \\"Label\\": \\"China\\",\\n \\"Value\\": \\"CN\\"\\n }\\n ]\\n },\\n \\"Logics\\": [\\n {\\n \\"Enable\\": false,\\n \\"MinPlan\\": \\"high\\",\\n \\"Symbol\\": \\"eq\\",\\n \\"Operator\\": \\"Does not equal\\",\\n \\"Negative\\": true,\\n \\"Type\\": \\"string\\",\\n \\"Kind\\": \\"input:single\\",\\n \\"Attributes\\": 1,\\n \\"Tip\\": \\"e.g. image/jpeg\\",\\n \\"Validator\\": {\\n \\"Length\\": {\\n \\"Equal\\": 1,\\n \\"GreaterThan\\": 1,\\n \\"GreaterThanOrEqual\\": 1,\\n \\"LessThan\\": 1,\\n \\"LessThanOrEqual\\": 1\\n },\\n \\"Pattern\\": \\"^example$\\",\\n \\"Range\\": {\\n \\"Equal\\": 1,\\n \\"GreaterThan\\": 1,\\n \\"GreaterThanOrEqual\\": 1,\\n \\"LessThan\\": 1,\\n \\"LessThanOrEqual\\": 1\\n },\\n \\"ErrMsg\\": \\"Enter a valid expression\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetWafQuota' => [ + 'summary' => '获取Web应用防火墙（WAF）相关资源的配额详情。这些配额定义了客户可以使用的对应资源的数量限制，例如托管规则组、自定义列表、自定义响应页面以及场景防护规则数量等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239612', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Paths', + 'in' => 'query', + 'schema' => [ + 'title' => 'WAF配额的路径，例：managed_rules_group、list、page、scene_policy', + 'description' => 'WAF配额的路径，例如：'."\n" + .'* managed_rules_group：表示WAF托管规则组的配额'."\n" + .'* list：表示自定义列表的配额'."\n" + .'* page：表示自定义响应页面的配额'."\n" + .'* scene_policy：表示场景防护的配额', + 'type' => 'string', + 'required' => false, + 'example' => 'page', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Quota' => [ + 'title' => 'WAF配额', + 'description' => '返回的配额信息。', + 'type' => 'object', + 'properties' => [ + 'ManagedRulesGroup' => [ + 'title' => '托管规则组相关配额', + 'description' => 'WAF托管规则组相关的配额信息。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '托管规则组开关', + 'description' => '表示WAF托管规则组是否启用。', + 'type' => 'boolean', + ], + 'NumberTotal' => [ + 'title' => '托管规则组数量配额', + 'description' => '表示允许的WAF托管规则组的总数量配额。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + ], + ], + 'List' => [ + 'title' => '自定义列表相关配额', + 'description' => '自定义列表相关的配额信息。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '自定义列表开关', + 'description' => '表示自定义列表是否启用。', + 'type' => 'boolean', + ], + 'NumberTotal' => [ + 'title' => '自定义列表数量配额', + 'description' => '允许的自定义列表的总数量配额。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + 'NumberItemsTotal' => [ + 'title' => '自定义列表中全部项目数量配额', + 'description' => '所有自定义列表中允许的项目总数量配额。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + 'NumberItemsPerList' => [ + 'title' => '每个自定义列表中项目数量配额', + 'description' => '每个自定义列表中允许的项目数量配额。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + 'Items' => [ + 'title' => '自定义列表中项目类型相关配额', + 'description' => '包含自定义列表中每种项目类型的配额信息的对象。', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '自定义列表中项目配额结构', + 'description' => '自定义列表中项目的配额信息的对象。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '对应自定义列表项目类型的开关', + 'description' => '对应自定义列表项目类型的开关。', + 'type' => 'boolean', + ], + 'Value' => [ + 'title' => '对应自定义列表中项目类型的格式限制', + 'description' => '对应自定义列表中项目类型的格式限制。', + '$ref' => '#/components/schemas/WafQuotaString', + ], + ], + ], + ], + ], + ], + 'Page' => [ + 'title' => '自定义响应页面相关配额', + 'description' => '自定义响应页面相关的配额信息。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '自定义响应页面开关', + 'description' => '表示自定义响应页面是否启用。', + 'type' => 'boolean', + ], + 'NumberTotal' => [ + 'title' => '自定义响应页面数量配额', + 'description' => '允许的自定义响应页面的总数量配额。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + 'ContentTypes' => [ + 'title' => '自定义响应页面Content-Type相关配额', + 'description' => '包含自定义响应页面中每种Content-Type的配额信息的对象。', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '自定义响应页面中ContentType对应类型配额结构', + 'description' => '自定义响应页面中Content-Type配额信息的对象。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '对应自定义响应页面Content-Type类型开关', + 'description' => '对应自定义响应页面Content-Type类型开关。', + 'type' => 'boolean', + ], + 'ContentLength' => [ + 'title' => '对应自定义响应页面Content-Type的内容长度配额', + 'description' => '对应自定义响应页面Content-Type的内容长度配额。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + ], + ], + ], + ], + ], + 'ScenePolicy' => [ + 'title' => '场景防护相关配额', + 'description' => '场景防护相关的配额信息。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '场景防护开关', + 'description' => '表示场景防护功能是否启用。', + 'type' => 'boolean', + ], + 'NumberTotal' => [ + 'title' => '场景防护规则数量配额', + 'description' => '允许的场景防护规则的总数量配额。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + ], + ], + 'Captcha' => [ + 'description' => '验证码规则相关的配额信息。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => '表示验证码规则是否启用。', + 'type' => 'boolean', + ], + 'NumberTotal' => [ + 'description' => '允许的验证码规则的总数量配额。', + '$ref' => '#/components/schemas/WafQuotaInteger', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取WAF资源相关配额', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:51.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:56:36.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafQuota', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Quota\\": {\\n \\"ManagedRulesGroup\\": {\\n \\"Enable\\": true,\\n \\"NumberTotal\\": {\\n \\"Equal\\": 1,\\n \\"GreaterThan\\": 1,\\n \\"GreaterThanOrEqual\\": 1,\\n \\"LessThan\\": 1,\\n \\"LessThanOrEqual\\": 1\\n }\\n },\\n \\"List\\": {\\n \\"Enable\\": true,\\n \\"NumberTotal\\": {\\n \\"Equal\\": 1,\\n \\"GreaterThan\\": 1,\\n \\"GreaterThanOrEqual\\": 1,\\n \\"LessThan\\": 1,\\n \\"LessThanOrEqual\\": 1\\n },\\n \\"NumberItemsTotal\\": {\\n \\"Equal\\": 1,\\n \\"GreaterThan\\": 1,\\n \\"GreaterThanOrEqual\\": 1,\\n \\"LessThan\\": 1,\\n \\"LessThanOrEqual\\": 1\\n },\\n \\"Items\\": {\\n \\"key\\": {\\n \\"Enable\\": true,\\n \\"Value\\": {\\n \\"Regexp\\": \\"^\\\\\\\\d+$\\"\\n }\\n }\\n }\\n },\\n \\"Page\\": {\\n \\"Enable\\": true,\\n \\"ContentTypes\\": {\\n \\"key\\": {\\n \\"Enable\\": true\\n }\\n }\\n },\\n \\"ScenePolicy\\": {\\n \\"Enable\\": true\\n },\\n \\"Captcha\\": {\\n \\"Enable\\": true\\n }\\n }\\n}","type":"json"}]', + ], + 'GetWafRule' => [ + 'summary' => '获取Web应用防火墙（WAF）中单个规则的详细信息。通过此接口，用户可以查询特定规则的配置和状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239626', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '规则ID', + 'description' => 'WAF规则的ID，可通过调用[ListWafRules](~~2878257~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20000001', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'UpdateTime' => [ + 'title' => '修改时间', + 'description' => '规则的最后修改时间。', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00Z', + ], + 'Id' => [ + 'title' => '规则ID', + 'description' => 'WAF规则的ID，可通过调用[ListWafRules](~~2878257~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2000001', + 'pattern' => '', + 'default' => '', + ], + 'Position' => [ + 'title' => '规则在规则集中所处的位置顺序', + 'description' => '规则在规则集中所处的位置顺序。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'title' => '规则名称', + 'description' => '规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + 'maxLength' => 128, + 'pattern' => '', + 'default' => '', + ], + 'Status' => [ + 'title' => '规则状态', + 'description' => '规则状态。', + 'type' => 'string', + 'example' => 'on', + ], + 'Phase' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段。', + 'type' => 'string', + 'required' => true, + 'example' => 'http_custom', + 'pattern' => '', + 'default' => '', + ], + 'Config' => [ + 'title' => '规则配置', + 'description' => '规则配置。', + '$ref' => '#/components/schemas/WafRuleConfig', + ], + 'RulesetId' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取单个WAF规则详情', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-17T07:08:14.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:50.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"UpdateTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"Id\\": 2000001,\\n \\"Position\\": 1,\\n \\"Name\\": \\"example\\",\\n \\"Status\\": \\"on\\",\\n \\"Phase\\": \\"http_custom\\",\\n \\"Config\\": {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n },\\n \\"Bypass\\": {\\n \\"Skip\\": \\"part\\",\\n \\"RegularRules\\": [\\n 100001\\n ],\\n \\"CustomRules\\": [\\n 20000001\\n ],\\n \\"RegularTypes\\": [\\n \\"sqli\\"\\n ],\\n \\"Tags\\": [\\n \\"http_custom\\"\\n ]\\n }\\n },\\n \\"ManagedList\\": \\"intelligence_crawler\\",\\n \\"ManagedRulesets\\": [\\n {\\n \\"ProtectionLevel\\": 4,\\n \\"Action\\": \\"deny\\",\\n \\"ManagedRules\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Id\\": 100001\\n }\\n ],\\n \\"AttackType\\": 11,\\n \\"NumberTotal\\": 100,\\n \\"NumberEnabled\\": 50\\n }\\n ],\\n \\"Sigchl\\": [\\n \\"sig\\"\\n ],\\n \\"Name\\": \\"example\\",\\n \\"AppSdk\\": {\\n \\"CustomSign\\": {\\n \\"Value\\": \\"examplesignvalue\\",\\n \\"Key\\": \\"sign\\"\\n },\\n \\"CustomSignStatus\\": \\"on\\",\\n \\"FeatureAbnormal\\": [\\n \\"wxbb_invalid_sign\\"\\n ]\\n },\\n \\"RateLimit\\": {\\n \\"Characteristics\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"OnHit\\": true,\\n \\"TTL\\": 10,\\n \\"Threshold\\": {\\n \\"ManagedRulesBlocked\\": 10,\\n \\"DistinctManagedRules\\": 10,\\n \\"ResponseStatus\\": {\\n \\"Ratio\\": 10,\\n \\"Count\\": 10,\\n \\"Code\\": 404\\n },\\n \\"Traffic\\": \\"10Gb\\",\\n \\"Request\\": 10\\n },\\n \\"Interval\\": 10\\n },\\n \\"Type\\": \\"http_custom\\",\\n \\"AppPackage\\": {\\n \\"PackageSigns\\": [\\n {\\n \\"Sign\\": \\"sign\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n },\\n \\"ManagedGroupId\\": 30000001,\\n \\"Timer\\": {\\n \\"Scopes\\": \\"permanent\\",\\n \\"Zone\\": 8,\\n \\"Periods\\": [\\n {\\n \\"Start\\": \\"2025-01-01T00:00:00Z\\",\\n \\"End\\": \\"2025-01-01T01:00:00Z\\"\\n }\\n ],\\n \\"WeeklyPeriods\\": [\\n {\\n \\"Days\\": \\"1\\",\\n \\"DailyPeriods\\": [\\n {\\n \\"Start\\": \\"00:00:00\\",\\n \\"End\\": \\"01:00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Expression\\": \\"ip.src eq 10.0.0.1\\",\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"Value\\": \\"10.0.0.1\\",\\n \\"Id\\": 20000001,\\n \\"Notes\\": \\"example notes\\"\\n },\\n \\"RulesetId\\": 0\\n}","type":"json"}]', + ], + 'GetWafRuleset' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239606', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '规则集ID', + 'description' => 'WAF规则集的ID，可通过调用[ListWafRulesets](~~2878359~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000001', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'query', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段，指定要查询的规则集阶段。', + 'type' => 'string', + 'required' => false, + 'example' => 'http_bot', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'UpdateTime' => [ + 'title' => '修改时间', + 'description' => '规则集的最后修改时间。', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00Z', + ], + 'Id' => [ + 'title' => '规则集ID', + 'description' => '规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000001', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '规则集名称', + 'description' => '规则集名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + 'maxLength' => 128, + 'pattern' => '', + 'default' => '', + ], + 'Status' => [ + 'title' => '规则集状态', + 'description' => '规则集状态。', + 'type' => 'string', + 'example' => 'on', + ], + 'Phase' => [ + 'title' => 'WAF阶段', + 'description' => '规则集适用的WAF运行阶段。', + 'type' => 'string', + 'required' => true, + 'example' => 'http_bot', + 'pattern' => '', + 'default' => '', + ], + 'Shared' => [ + 'title' => '规则集中的规则所共享的配置', + 'description' => '规则集中规则所共享的配置。', + '$ref' => '#/components/schemas/WafBatchRuleShared', + ], + 'Rules' => [ + 'title' => '规则集中的规则配置列表', + 'description' => '规则集中的规则配置列表。', + 'type' => 'array', + 'items' => [ + 'title' => '规则集中的规则配置', + 'description' => '规则集中的规则配置。', + '$ref' => '#/components/schemas/WafRuleConfig', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取单个WAF规则集详情', + 'summary' => '获取指定的WAF规则集详情。用户可以通过此接口查询特定规则集的配置和状态信息。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:50.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:56:35.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafRuleset', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafRuleset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"UpdateTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"Id\\": 10000001,\\n \\"Name\\": \\"example\\",\\n \\"Status\\": \\"on\\",\\n \\"Phase\\": \\"http_bot\\",\\n \\"Shared\\": {\\n \\"Target\\": \\"web\\",\\n \\"Mode\\": \\"automatic\\",\\n \\"CrossSiteId\\": 10000001,\\n \\"Name\\": \\"example\\",\\n \\"Match\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n }\\n },\\n \\"Expression\\": \\"ip.src eq 1.1.1.1\\"\\n },\\n \\"Rules\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n },\\n \\"Bypass\\": {\\n \\"Skip\\": \\"part\\",\\n \\"RegularRules\\": [\\n 100001\\n ],\\n \\"CustomRules\\": [\\n 20000001\\n ],\\n \\"RegularTypes\\": [\\n \\"sqli\\"\\n ],\\n \\"Tags\\": [\\n \\"http_custom\\"\\n ]\\n }\\n },\\n \\"ManagedList\\": \\"intelligence_crawler\\",\\n \\"ManagedRulesets\\": [\\n {\\n \\"ProtectionLevel\\": 4,\\n \\"Action\\": \\"deny\\",\\n \\"ManagedRules\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Id\\": 100001\\n }\\n ],\\n \\"AttackType\\": 11,\\n \\"NumberTotal\\": 100,\\n \\"NumberEnabled\\": 50\\n }\\n ],\\n \\"Sigchl\\": [\\n \\"sig\\"\\n ],\\n \\"Name\\": \\"example\\",\\n \\"AppSdk\\": {\\n \\"CustomSign\\": {\\n \\"Value\\": \\"examplesignvalue\\",\\n \\"Key\\": \\"sign\\"\\n },\\n \\"CustomSignStatus\\": \\"on\\",\\n \\"FeatureAbnormal\\": [\\n \\"wxbb_invalid_sign\\"\\n ]\\n },\\n \\"RateLimit\\": {\\n \\"Characteristics\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"OnHit\\": true,\\n \\"TTL\\": 10,\\n \\"Threshold\\": {\\n \\"ManagedRulesBlocked\\": 10,\\n \\"DistinctManagedRules\\": 10,\\n \\"ResponseStatus\\": {\\n \\"Ratio\\": 10,\\n \\"Count\\": 10,\\n \\"Code\\": 404\\n },\\n \\"Traffic\\": \\"10Gb\\",\\n \\"Request\\": 10\\n },\\n \\"Interval\\": 10\\n },\\n \\"Type\\": \\"http_custom\\",\\n \\"AppPackage\\": {\\n \\"PackageSigns\\": [\\n {\\n \\"Sign\\": \\"sign\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n },\\n \\"ManagedGroupId\\": 30000001,\\n \\"Timer\\": {\\n \\"Scopes\\": \\"permanent\\",\\n \\"Zone\\": 8,\\n \\"Periods\\": [\\n {\\n \\"Start\\": \\"2025-01-01T00:00:00Z\\",\\n \\"End\\": \\"2025-01-01T01:00:00Z\\"\\n }\\n ],\\n \\"WeeklyPeriods\\": [\\n {\\n \\"Days\\": \\"1\\",\\n \\"DailyPeriods\\": [\\n {\\n \\"Start\\": \\"00:00:00\\",\\n \\"End\\": \\"01:00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Expression\\": \\"ip.src eq 10.0.0.1\\",\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"Value\\": \\"10.0.0.1\\",\\n \\"Id\\": 20000001,\\n \\"Notes\\": \\"example notes\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListCacheReserveInstances' => [ + 'summary' => '查询当前用户的缓存保持实例列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238745', + 'abilityTreeNodes' => [ + 'FEATUREdcdn51XOHW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '缓存保持实例状态。支持：'."\n" + ."\n" + .'- **online**：正常服务状态。'."\n" + .'- **offline**：到期但未超期，处于不可用的状态。'."\n" + .'- **disable**：已释放状态。'."\n" + .'- **overdue**：欠费停机状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + 'enum' => [ + 'online', + 'offline', + 'disable', + 'all', + 'overdue', + ], + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '排序方式。取值：'."\n" + .'- **ExpireTime**：过期时间。'."\n" + .'- **CreateTime**：新购时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'ExpireTime', + 'enum' => [ + 'ExpireTime', + 'CreateTime', + 'default', + ], + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '排序方式。支持：'."\n" + .'- **asc**：升序。'."\n" + .'- **desc**：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。取值：**1~500**，默认为**500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sp-xcdn-96wblslz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '实例查询详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', + ], + 'InstanceInfo' => [ + 'description' => '缓存保持实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '缓存保持实例详情。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'sp-xcdn-96wblslz****', + ], + 'ExpireTime' => [ + 'description' => '实例到期时间。', + 'type' => 'string', + 'example' => '2024-10-05T16:00:00Z', + ], + 'Duration' => [ + 'description' => '实例的购买时长，单位：月。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => '实例的新购时间。', + 'type' => 'string', + 'example' => '2024-04-12T05:41:51Z', + ], + 'Status' => [ + 'description' => '实例状态。取值：'."\n" + .'- **online**：正常服务状态。'."\n" + .'- **offline**：到期但未超期，处于不可用的状态。'."\n" + .'- **disable**：已释放状态。'."\n" + .'- **overdue**：欠费停服状态。', + 'type' => 'string', + 'example' => 'online', + ], + 'CacheReserveRegion' => [ + 'description' => '缓存保持使用区域。', + 'type' => 'string', + 'example' => 'HK', + ], + 'CacheReserveCapacity' => [ + 'description' => '缓存保持容量。单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '512000', + ], + 'ChargeType' => [ + 'type' => 'string', + 'description' => '', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，默认**500**，取值：**1~500**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'TotalCount' => [ + 'description' => '总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + ], + 'title' => '查询缓存保持实例列表', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-21T03:25:57.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCacheReserveInstances', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCacheReserveInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\",\\n \\"InstanceInfo\\": [\\n {\\n \\"InstanceId\\": \\"sp-xcdn-96wblslz****\\",\\n \\"ExpireTime\\": \\"2024-10-05T16:00:00Z\\",\\n \\"Duration\\": 3,\\n \\"CreateTime\\": \\"2024-04-12T05:41:51Z\\",\\n \\"Status\\": \\"online\\",\\n \\"CacheReserveRegion\\": \\"HK\\",\\n \\"CacheReserveCapacity\\": 512000,\\n \\"ChargeType\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 500,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListCacheRules' => [ + 'summary' => '查询多条缓存配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257498', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。'."\n" + ."\n" + .'该参数可以不传，不传时不区分全局或者规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Configs' => [ + 'description' => '返回体配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395386449776640', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'BypassCache' => [ + 'description' => '设置绕过缓存模式。取值范围：'."\n" + .'- cache_all：所有请求都缓存。'."\n" + .'- bypass_all：所有请求都绕过缓存。', + 'type' => 'string', + 'example' => 'cache_all', + ], + 'BrowserCacheMode' => [ + 'description' => '浏览器缓存模式。取值范围：'."\n" + .'- no_cache：不缓存。'."\n" + .'- follow_origin：遵循源站缓存策略。'."\n" + .'- override_origin：代替源站缓存策略。', + 'type' => 'string', + 'example' => 'no_cache', + ], + 'BrowserCacheTtl' => [ + 'description' => '浏览器缓存过期时间，单位是秒。', + 'type' => 'string', + 'example' => '300', + ], + 'EdgeCacheMode' => [ + 'description' => '节点缓存模式。取值范围：'."\n" + .'- follow_origin：遵循源站缓存策略（如果存在），否则使用默认缓存策略。'."\n" + .'- no_cache：不缓存。'."\n" + .'- override_origin：代替源站缓存策略。'."\n" + .'- follow_origin_bypass：遵循源站缓存策略（如果存在），否则不缓存。'."\n" + .'- follow_origin_override：遵循源站缓存策略（如果存在），否则使用自定义缓存TTL。', + 'type' => 'string', + 'example' => 'follow_origin', + ], + 'EdgeCacheTtl' => [ + 'description' => '节点缓存过期时间，单位是秒。', + 'type' => 'string', + 'example' => '300', + ], + 'EdgeStatusCodeCacheTtl' => [ + 'description' => '状态码缓存过期时间，单位是秒。'."\n" + .'- 支持对指定状态码设置缓存过期时间，例如：404=10，表示对404状态码缓存10秒。'."\n" + .'- 支持对4xx、5xx系列状态码设置缓存过期时间，例如：4xx=10，表示对400系列的所有状态码都缓存10秒。', + 'type' => 'string', + 'example' => '4xx=10', + ], + 'SortQueryStringForCache' => [ + 'description' => '查询字符串排序。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'QueryStringMode' => [ + 'description' => '在生成缓存键的时候，对查询字符串的处理模式。取值范围：'."\n" + .'- ignore_all：全部忽略。'."\n" + .'- exclude_query_string：删除指定查询字符串。'."\n" + .'- reserve_all：默认值，全部保留。'."\n" + .'- include_query_string：保留指定查询字符串。', + 'type' => 'string', + 'example' => 'ignore_all', + ], + 'QueryString' => [ + 'description' => '需要保留或者删除的查询字符串，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'example', + ], + 'IncludeHeader' => [ + 'description' => '生成缓存键的时候，包括指定的标头名称及其值，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'example', + ], + 'IncludeCookie' => [ + 'description' => '生成缓存键的时候，包括指定的cookie名称及其值，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'cookie_exapmle', + ], + 'CacheReserveEligibility' => [ + 'description' => '缓存保持资格。用于控制用户请求在回源的时候是否绕过缓存保持节点。取值范围：'."\n" + .'- bypass_cache_reserve：请求绕过缓存保持。'."\n" + .'- eligible_for_cache_reserve：符合缓存保持资格。', + 'type' => 'string', + 'example' => 'bypass_cache_reserve', + ], + 'CheckPresenceHeader' => [ + 'description' => '生成缓存键的时候，检查header是否存在，如果存在，则在缓存键中加入header名称（header名称不区分大小写）。支持输入多个header名称，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'headername', + ], + 'CheckPresenceCookie' => [ + 'description' => '生成缓存键的时候，检查cookie是否存在，如果存在，则在缓存键中加入cookie名称（cookie名称不区分大小写）。支持输入多个cookie名称，多个值之间用空格分隔。', + 'type' => 'string', + 'example' => 'cookiename', + ], + 'UserDeviceType' => [ + 'description' => '生成缓存键的时候，加入客户端设备类型。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'UserGeo' => [ + 'description' => '生成缓存键的时候，加入客户端地理位置。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'UserLanguage' => [ + 'description' => '生成缓存键的时候，加入客户端语言类型。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'ServeStale' => [ + 'description' => '响应过期缓存。开启之后，在源服务器不可用的情况下，节点依然可以使用已缓存的过期文件响应用户请求。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'AdditionalCacheablePorts' => [ + 'description' => '在指定端口上开启缓存功能。取值范围：8880、2052、2082、2086、2095、2053、2083、2087、2096。', + 'type' => 'string', + 'example' => '2082', + ], + 'CacheDeceptionArmor' => [ + 'description' => '缓存欺骗防御。用于防御Web缓存欺骗攻击，通过校验的缓存内容才会被缓存下来。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'PostCache' => [ + 'title' => 'Post缓存功能开关。', + 'description' => 'Post缓存功能开关。', + 'type' => 'string', + 'example' => 'on', + ], + 'PostBodyCacheKey' => [ + 'title' => '缓存键的处理模式。', + 'description' => '缓存键的处理模式。', + 'type' => 'string', + 'example' => 'ignore', + ], + 'PostBodySizeLimit' => [ + 'description' => 'Body大小限制，值为数字，单位是KB，支持1～8KB大小的Body，值为空的时候，默认按8KB生效。', + 'type' => 'string', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 395386449776640,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"BypassCache\\": \\"cache_all\\",\\n \\"BrowserCacheMode\\": \\"no_cache\\",\\n \\"BrowserCacheTtl\\": \\"300\\",\\n \\"EdgeCacheMode\\": \\"follow_origin\\",\\n \\"EdgeCacheTtl\\": \\"300\\",\\n \\"EdgeStatusCodeCacheTtl\\": \\"4xx=10\\",\\n \\"SortQueryStringForCache\\": \\"on\\",\\n \\"QueryStringMode\\": \\"ignore_all\\",\\n \\"QueryString\\": \\"example\\",\\n \\"IncludeHeader\\": \\"example\\",\\n \\"IncludeCookie\\": \\"cookie_exapmle\\",\\n \\"CacheReserveEligibility\\": \\"bypass_cache_reserve\\",\\n \\"CheckPresenceHeader\\": \\"headername\\",\\n \\"CheckPresenceCookie\\": \\"cookiename\\",\\n \\"UserDeviceType\\": \\"on\\",\\n \\"UserGeo\\": \\"on\\",\\n \\"UserLanguage\\": \\"on\\",\\n \\"ServeStale\\": \\"on\\",\\n \\"AdditionalCacheablePorts\\": \\"2082\\",\\n \\"CacheDeceptionArmor\\": \\"on\\",\\n \\"PostCache\\": \\"on\\",\\n \\"PostBodyCacheKey\\": \\"ignore\\",\\n \\"PostBodySizeLimit\\": \\"1\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + 'title' => '查询站点缓存配置列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCacheRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListCacheRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'ListCertificates' => [ + 'summary' => '查询特定站点下的证书列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238842', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'ValidOnly', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅返回有效证书。', + 'type' => 'boolean', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'TotalCount' => [ + 'description' => '总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Result' => [ + 'description' => '结果数组。', + 'type' => 'array', + 'items' => [ + 'description' => '结果。', + 'type' => 'object', + 'properties' => [ + 'CasId' => [ + 'description' => '云证书Id。', + 'type' => 'string', + 'example' => '30000569', + ], + 'Id' => [ + 'description' => '证书Id。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838e****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Region' => [ + 'description' => '地域信息。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Status' => [ + 'description' => '证书状态。'."\n" + .'- OK：正常。'."\n" + .'- Expired：证书已过期。'."\n" + .'- Expiring：证书即将过期（30天内）。'."\n" + .'- Issued：免费证书-已签发。'."\n" + .'- Applying：免费证书-申请中。'."\n" + .'- ApplyFailed：免费证书-申请失败。'."\n" + .'- Canceled：免费证书-已取消。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Expiring' => '证书即将过期（30 天内）', + 'Issued' => '免费证书-已签发', + 'Expired' => '证书已过期', + 'Applying' => '免费证书-申请中', + 'OK' => '正常', + ], + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。'."\n" + .'- cas：云盾证书。'."\n" + .'- upload：自定义上传证书。'."\n" + .'- free：免费证书。'."\n" + .'- keyless：Keyless证书。', + 'type' => 'string', + 'enumValueTitles' => [ + 'cas' => '云盾证书', + 'upload' => '自定义上传证书', + 'keyless' => 'Keyless证书', + 'free' => '免费证书', + ], + 'example' => 'free', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'IssuerCN' => [ + 'description' => '证书发行商通用名。', + 'type' => 'string', + 'example' => 'GlobalSign Organization Validation CA - SHA256 - G3', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SigAlg' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubAlg' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-06-24 07:48:51', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-04-20 06:18:42', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babab022c5e9b27bf9c64d7f4b16****', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', + ], + 'DCV' => [ + 'description' => 'DCV信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'DCV信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'DCV ID。', + 'type' => 'string', + 'example' => 'bababf7cdd1546a2ad04c0def1f4****', + ], + 'Type' => [ + 'description' => 'DCV类型。可能值：DNS；HTTP。', + 'type' => 'string', + 'enumValueTitles' => [ + 'DNS' => 'DNS', + 'HTTP' => 'HTTP', + ], + 'example' => 'HTTP', + ], + 'Key' => [ + 'description' => 'DCV名称。DNS类型为TXT记录名；HTTP类型为URL。', + 'type' => 'string', + 'example' => 'http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow', + ], + 'Value' => [ + 'description' => 'DCV内容。', + 'type' => 'string', + 'example' => 'pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ', + ], + 'Status' => [ + 'description' => '验证状态。', + 'type' => 'string', + 'example' => 'pending', + ], + ], + ], + ], + 'ApplyCode' => [ + 'description' => '证书申请错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ApplyMessage' => [ + 'description' => '证书申请错误信息。', + 'type' => 'string', + 'example' => 'canceled', + ], + 'KeyServerId' => [ + 'description' => 'Keyless server ID，当Type为keyless时有效。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838e****'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Result\\": [\\n {\\n \\"CasId\\": \\"30000569\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838e****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"free\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"IssuerCN\\": \\"GlobalSign Organization Validation CA - SHA256 - G3\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SigAlg\\": \\"SHA256-RSA\\",\\n \\"PubAlg\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2022-06-24 07:48:51\\",\\n \\"UpdateTime\\": \\"2023-04-20 06:18:42\\",\\n \\"SerialNumber\\": \\"babab022c5e9b27bf9c64d7f4b16****\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\",\\n \\"DCV\\": [\\n {\\n \\"Id\\": \\"bababf7cdd1546a2ad04c0def1f4****\\",\\n \\"Type\\": \\"HTTP\\",\\n \\"Key\\": \\"http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow\\",\\n \\"Value\\": \\"pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ\\",\\n \\"Status\\": \\"pending\\"\\n }\\n ],\\n \\"ApplyCode\\": 2,\\n \\"ApplyMessage\\": \\"canceled\\",\\n \\"KeyServerId\\": \\"baba39055622c008b90285a8838e****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询站点证书列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCertificates', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'ListCertificatesByRecord' => [ + 'summary' => '查看匹配记录的站点证书列表，支持批量记录匹配。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239262', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123'."\n", + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com ', + ], + ], + [ + 'name' => 'ValidOnly', + 'in' => 'query', + 'schema' => [ + 'description' => '是否仅返回有效证书。0表示返回所有匹配证书；1表示仅返回有效证书。', + 'type' => 'boolean', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Detail', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回证书详情。0表示不返回证书详情；1表示返回证书详情。', + 'type' => 'boolean', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', + ], + 'TotalCount' => [ + 'description' => '总条数，数量和记录数相同。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Result' => [ + 'description' => '结果数组。', + 'type' => 'array', + 'items' => [ + 'description' => '结果。', + 'type' => 'object', + 'properties' => [ + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'Count' => [ + 'description' => '匹配记录的证书个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Certificates' => [ + 'description' => '匹配记录的证书信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'CasId' => [ + 'description' => '云证书Id。', + 'type' => 'string', + 'example' => '30000137', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babab022c5e9b27bf9c64d7f4b1667f4', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Region' => [ + 'description' => '证书存储区域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'cas' => '云盾证书', + 'upload' => '自定义上传证书', + 'keyless' => 'Keyless证书', + 'free' => '免费证书', + ], + 'example' => 'free', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-02-28 06:17:11', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-02-28 06:17:11', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'IssuerCN' => [ + 'description' => '证书发行商通用名。', + 'type' => 'string', + 'example' => 'GlobalSign Organization Validation CA - SHA256 - G3', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SigAlg' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubAlg' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-02-28 06:17:11', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-02-28 06:17:11', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', + ], + 'KeyServerId' => [ + 'description' => 'Keyless server ID，当Type为keyless时有效。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838e****'."\n", + ], + ], + ], + ], + 'ApplylingCount' => [ + 'description' => '正在申请的证书数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'description' => 'Record证书配置状态。可能值：none：未配置；configured：已配置；applying：正在申请；failed：申请失败。', + 'type' => 'string', + 'enumValueTitles' => [ + 'configured' => '已配置', + 'applying' => '正在申请', + 'none' => '未配置', + 'failed' => '申请失败', + ], + 'example' => 'none', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Required parameter RecordName missing. Specify RecordName and try again.', + 'description' => '缺少必填参数RecordName，请指定RecordName参数后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\",\\n \\"TotalCount\\": 12,\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Result\\": [\\n {\\n \\"RecordName\\": \\"www.example.com \\",\\n \\"Count\\": 3,\\n \\"Certificates\\": [\\n {\\n \\"CasId\\": \\"30000137\\",\\n \\"Id\\": \\"babab022c5e9b27bf9c64d7f4b1667f4\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"free\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-02-28 06:17:11\\",\\n \\"NotAfter\\": \\"2024-02-28 06:17:11\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"IssuerCN\\": \\"GlobalSign Organization Validation CA - SHA256 - G3\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SigAlg\\": \\"SHA256-RSA\\",\\n \\"PubAlg\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2023-02-28 06:17:11\\",\\n \\"UpdateTime\\": \\"2023-02-28 06:17:11\\",\\n \\"SerialNumber\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66\\",\\n \\"KeyServerId\\": \\"baba39055622c008b90285a8838e****\\\\n\\"\\n }\\n ],\\n \\"ApplylingCount\\": 1,\\n \\"Status\\": \\"none\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询匹配记录的站点证书列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCertificatesByRecord', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListCertificatesByRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'ListCiphers' => [ + 'summary' => '根据密码套件组名称，查询密码套件名称列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239324', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CiphersGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '密码套件组名称，可取值：all，strict，custom。', + 'type' => 'string', + 'required' => true, + 'example' => 'strict', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'TotalCount' => [ + 'description' => '密码套件总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'CiphersGroup' => [ + 'description' => '密码套件组名称。', + 'type' => 'string', + 'example' => 'all', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '密码套件名称。', + 'type' => 'string', + 'example' => 'ECDHE-ECDSA-AES256-GCM-SHA384', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询密码套件列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCiphers', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCiphers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"TotalCount\\": 16,\\n \\"CiphersGroup\\": \\"all\\",\\n \\"Result\\": [\\n \\"ECDHE-ECDSA-AES256-GCM-SHA384\\"\\n ]\\n}","type":"json"}]', + ], + 'ListClientCaCertificates' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239292', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围：1~500。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：20；最大值：100。 取值：1~100之间的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Result' => [ + 'description' => '客户端CA证书列表。', + 'type' => 'array', + 'items' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babab9db65ee5efcca9f3d41d4b5****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'upload', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-06-24 07:48:51', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-07-20 06:18:42', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babab022c5e9b27bf9c64d7f4b16****', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取客户端CA证书列表', + 'summary' => '获取指定站点下的客户端CA证书列表。', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-12T03:30:13.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListClientCaCertificates', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListClientCaCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"TotalCount\\": 16,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"babab9db65ee5efcca9f3d41d4b5****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"upload\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-06-24 07:48:51\\",\\n \\"UpdateTime\\": \\"2024-07-20 06:18:42\\",\\n \\"SerialNumber\\": \\"babab022c5e9b27bf9c64d7f4b16****\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListClientCertificates' => [ + 'summary' => '获取指定站点下客户端证书列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239148', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页面号码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + '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' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Result' => [ + 'description' => '客户端证书列表。', + 'type' => 'array', + 'items' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'active', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'dcdn', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-06-24 07:48:51', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-07-20 06:18:42', + ], + 'CACertificateId' => [ + 'description' => 'CA证书ID。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + 'SerialNumber' => [ + 'type' => 'string', + 'description' => '', + ], + 'FingerprintSha256' => [ + 'type' => 'string', + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取客户端证书列表', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-12T03:30:13.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListClientCertificates', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListClientCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"TotalCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"babab9db65ee5efcca9f3d41d4b50d66\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"active\\",\\n \\"Type\\": \\"dcdn\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-06-24 07:48:51\\",\\n \\"UpdateTime\\": \\"2024-07-20 06:18:42\\",\\n \\"CACertificateId\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"FingerprintSha256\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListCompressionRules' => [ + 'summary' => '查询压缩规则配置列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257666', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34003500310****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListRedirectRules](~~2867474~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + 'Configs' => [ + 'description' => '压缩规则配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '压缩规则配置详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****'."\n", + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'Gzip' => [ + 'description' => 'Gzip压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Brotli' => [ + 'description' => 'Brotli压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Zstd' => [ + 'description' => 'Zstd压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询压缩规则配置列表', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-12T02:25:41.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCompressionRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListCompressionRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 0,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"rule\\",\\n \\"Gzip\\": \\"on\\",\\n \\"Brotli\\": \\"on\\",\\n \\"Zstd\\": \\"on\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListCustomHostnames' => [ + 'summary' => '查询站点下的 SaaS 域名列表，包括 SaaS 域名的 ID、状态、域名验证信息等。支持根据 SaaS 域名的名称、站点 ID、绑定的记录 ID 等条件过滤。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239634', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4DMKZ4', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '关联站点ID。', + 'description' => '站点 ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '744571165985008', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定的源站记录ID。', + 'description' => '绑定的记录 ID，可以通过[ListRecords](~~2850265~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Hostname', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义主机名。', + 'description' => 'SaaS 域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom.site.com', + ], + ], + [ + 'name' => 'NameMatchType', + 'in' => 'query', + 'schema' => [ + 'title' => '记录名称的搜索匹配模式。默认为精确匹配。', + 'description' => 'SaaS域名的搜索匹配模式。默认为精确匹配。'."\n" + .'- **prefix**：前缀匹配。'."\n" + .'- **suffix**：后缀匹配。'."\n" + .'- **exact**：精确匹配。'."\n" + .'- **fuzzy**：模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'exact', + 'enum' => [ + 'prefix', + 'suffix', + 'exact', + 'fuzzy', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义主机名状态。', + 'description' => 'SaaS 域名状态。'."\n" + .'- **pending**: 待验证。'."\n" + .'- **active**: 已激活。'."\n" + .'- **conflicted**: 被占用。'."\n" + .'- **offline**: 已下线。', + 'type' => 'string', + 'required' => false, + 'example' => 'active', + 'enum' => [ + 'pending', + 'active', + 'conflicted', + 'offline', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页面页码（从1开始），默认1。', + 'description' => '页面页码（从1开始），默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页面大小，默认100，最大500。', + 'description' => '页面大小，默认100，最大500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'title' => '页面页码。', + 'description' => '页面页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小。', + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalCount' => [ + 'title' => '自定义主机名总数。', + 'description' => 'SaaS 域名总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Hostnames' => [ + 'title' => '查询到的自定义主机名信息列表。', + 'description' => '查询到的 SaaS 域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个 SaaS 域名信息。', + 'type' => 'object', + 'properties' => [ + 'HostnameId' => [ + 'title' => '自定义主机名ID。', + 'description' => 'SaaS 域名的 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'Hostname' => [ + 'title' => '自定义主机名。', + 'description' => 'SaaS 域名。', + 'type' => 'string', + 'example' => 'custom.site.com', + ], + 'SiteId' => [ + 'title' => '关联站点ID。', + 'description' => '站点 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '890601022130656', + ], + 'SiteName' => [ + 'title' => '关联站点名称。', + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RecordId' => [ + 'title' => '绑定的源站记录ID。', + 'description' => '记录 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3386032455886912', + ], + 'RecordName' => [ + 'title' => '绑定的源站记录名。', + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'origin.example.com', + ], + 'Status' => [ + 'title' => '自定义主机名状态。', + 'description' => 'SaaS 域名状态。'."\n" + .'- **pending**: 待验证。'."\n" + .'- **active**: 已激活。'."\n" + .'- **conflicted**: 被占用。'."\n" + .'- **offline**: 已下线。', + 'type' => 'string', + 'example' => 'active', + 'enum' => [ + 'pending', + 'active', + 'conflicted', + 'offline', + ], + ], + 'SslFlag' => [ + 'title' => 'SSL开关。', + 'description' => 'SSL 开关。'."\n" + .'- **on**: 开启 SSL。'."\n" + .'- **off**: 关闭 SSL。', + 'type' => 'string', + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + 'CertType' => [ + 'title' => '证书类型。', + 'description' => '证书类型。'."\n" + .'- **free**: 免费证书。'."\n" + .'- **upload**: 上传证书。'."\n" + .'- **cas**: 云盾证书。', + 'type' => 'string', + 'example' => 'free', + 'enum' => [ + 'free', + 'upload', + 'cas', + ], + ], + 'CertHttpKey' => [ + 'title' => '证书校验HTTP名称。', + 'description' => '证书验证 HTTP 地址。', + 'type' => 'string', + 'example' => 'http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc', + ], + 'CertHttpValue' => [ + 'title' => '证书校验HTTP内容。', + 'description' => '证书验证 HTTP 内容。', + 'type' => 'string', + 'example' => 'jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0', + ], + 'CertTxtKey' => [ + 'title' => '证书校验TXT名称。', + 'description' => '证书验证 TXT 名称。', + 'type' => 'string', + 'example' => ' '."\n" + .'_acme-challenge.custom.site.com'."\n", + ], + 'CertTxtValue' => [ + 'title' => '证书校验TXT内容。', + 'description' => '证书验证 TXT 内容。', + 'type' => 'string', + 'example' => ' '."\n" + .'lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM'."\n", + ], + 'VerifyHost' => [ + 'title' => '归属校验TXT名称。', + 'description' => '域名验证 TXT 名称。', + 'type' => 'string', + 'example' => '_esa_custom_hostname.custom.site.com'."\n", + ], + 'VerifyCode' => [ + 'title' => '归属校验TXT内容。', + 'description' => '域名验证 TXT 内容。', + 'type' => 'string', + 'example' => 'verify_16ab7f4d389d4dff6655f995c6a997bd'."\n", + ], + 'CertStatus' => [ + 'title' => '证书状态。', + 'description' => '证书状态。'."\n" + .'- **OK**: 正常。'."\n" + .'- **Applying**: 申请中。'."\n" + .'- **ApplyFailed**: 申请失败。'."\n" + .'- **Expiring**: 即将过期。'."\n" + .'- **Expired**: 已过期。', + 'type' => 'string', + 'example' => 'OK', + 'enum' => [ + 'OK', + 'Expired', + 'Expiring', + 'Applying', + 'ApplyFailed', + ], + ], + 'CertNotAfter' => [ + 'title' => '证书过期时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '证书过期时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2026-04-19T11:15:20Z'."\n", + ], + 'CertApplyMessage' => [ + 'title' => '免费证书申请错误说明。', + 'description' => '免费证书申请错误说明。', + 'type' => 'string', + 'example' => 'canceled', + ], + 'CertApplyCode' => [ + 'title' => '免费证书申请错误码。', + 'description' => '免费证书申请错误码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2'."\n", + ], + 'OfflineReason' => [ + 'title' => '下线原因。', + 'description' => 'SaaS 域名被下线的原因。'."\n" + .'- **expiration_ arrears**：订阅套餐到期或账号欠费。'."\n" + .'- **internally_disabled**：被系统内部停用。'."\n" + .'- **missing_icp**：域名缺少ICP。'."\n" + .'- **content_violation**：内容违规。'."\n" + .'- **proactively_disabled**：您主动停用或您设置的用量封顶停用。', + 'type' => 'string', + 'example' => 'missing_icp', + 'enum' => [ + 'proactively_disabled', + 'content_violation', + 'internally_disabled', + 'missing_icp', + 'expiration_arrears', + ], + ], + 'ConflictWith' => [ + 'title' => '冲突原因。', + 'description' => 'SaaS 域名被占用的原因。'."\n" + .'- **existing_custom_hostname**: 与现有 SaaS 域名冲突。'."\n" + .'- **existing_record**: 与现有站点记录冲突。'."\n" + .'- **existing_load_balancer**: 与现有负载均衡器冲突。'."\n" + .'- **existing_origin_pool**: 与现有源地址池冲突。', + 'type' => 'string', + 'example' => 'existing_custom_hostname', + 'enum' => [ + 'existing_custom_hostname', + 'existing_site', + 'existing_record', + 'existing_load_balancer', + 'existing_origin_pool', + ], + ], + 'CreateTime' => [ + 'title' => '创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'description' => 'SaaS 域名的创建时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2026-04-19T11:15:20Z', + ], + 'UpdateTime' => [ + 'title' => '更新时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'description' => 'SaaS 域名的更新时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2026-04-19T11:15:20Z', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 404 => [ + [ + 'errorCode' => 'CustomHostname.NotFound', + 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', + 'description' => '该自定义主机名不存在，请调整后重试。', + ], + [ + 'errorCode' => 'CustomHostname.ApplyCertFailed', + 'errorMessage' => 'Fail to apply a free cert for custom hostname. Please try again later.', + 'description' => '', + ], + [ + 'errorCode' => 'CustomHostname.SetCertFailed', + 'errorMessage' => 'Fail to deploy a cert for custom hostname. Please try again later.', + 'description' => '', + ], + ], + ], + 'title' => '查询 SaaS 域名列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"Hostnames\\": [\\n {\\n \\"HostnameId\\": 1234567890123,\\n \\"Hostname\\": \\"custom.site.com\\",\\n \\"SiteId\\": 890601022130656,\\n \\"SiteName\\": \\"example.com\\",\\n \\"RecordId\\": 3386032455886912,\\n \\"RecordName\\": \\"origin.example.com\\",\\n \\"Status\\": \\"active\\",\\n \\"SslFlag\\": \\"on\\",\\n \\"CertType\\": \\"free\\",\\n \\"CertHttpKey\\": \\"http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc\\",\\n \\"CertHttpValue\\": \\"jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0\\",\\n \\"CertTxtKey\\": \\"\\\\t\\\\n_acme-challenge.custom.site.com\\\\n\\",\\n \\"CertTxtValue\\": \\"\\\\t\\\\nlcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM\\\\n\\",\\n \\"VerifyHost\\": \\"_esa_custom_hostname.custom.site.com\\\\n\\",\\n \\"VerifyCode\\": \\"verify_16ab7f4d389d4dff6655f995c6a997bd\\\\n\\",\\n \\"CertStatus\\": \\"OK\\",\\n \\"CertNotAfter\\": \\"2026-04-19T11:15:20Z\\\\n\\",\\n \\"CertApplyMessage\\": \\"canceled\\",\\n \\"CertApplyCode\\": 2,\\n \\"OfflineReason\\": \\"missing_icp\\",\\n \\"ConflictWith\\": \\"existing_custom_hostname\\",\\n \\"CreateTime\\": \\"2026-04-19T11:15:20Z\\",\\n \\"UpdateTime\\": \\"2026-04-19T11:15:20Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListCustomResponseCodeRules' => [ + 'summary' => '查询站点的修改响应码配置列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257649', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '340035003106221', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '436490043994112', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example'."\n", + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Configs' => [ + 'description' => '修改响应码配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '修改响应码配置详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395386449776640', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'ReturnCode' => [ + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'PageId' => [ + 'description' => '响应页面。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，默认500，取值：1~500。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询修改响应码配置列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 395386449776640,\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleEnable\\": \\"on\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"ReturnCode\\": \\"200\\",\\n \\"PageId\\": \\"0\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 10,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListESAIPInfo' => [ + 'summary' => '批量查询IP是否为ESA产品解析结果IP。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '243691', + 'abilityTreeNodes' => [ + 'FEATUREdcdnWQK30N', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VipInfo', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '支持输入IPv4或者IPv6地址，输入多个IP地址的情况下，使用英文逗号分隔，单次最大支持输入20个IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '192.0.0.24,2408:8740:41FF:2:23::7FE,0.0.0.0,abcd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。'."\n" + ."\n" + .'示例值:'."\n" + .'D03F9502-6653-127C-8A5F-0647197*****', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Content' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => '输入参数中的IP地址信息。', + 'type' => 'string', + 'example' => '27.129.167.239', + ], + 'CdnIp' => [ + 'description' => '输入参数中的IP地址是否属于ESA节点的IP。'."\n" + .'- **true**：属于。'."\n" + .'- **false**：不属于。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ListESAIPInfo', + 'description' => '此接口用检测参数vipInfo集合中的vs_addr是否为vip。', + 'requestParamsDescription' => '参数为必传，不可为空。', + 'responseParamsDescription' => 'Ip为vipInfo中的vs_addr地址，CdnIp为判断结果', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '50', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListESAIPInfo', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListESAIPInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Content\\": [\\n {\\n \\"Ip\\": \\"27.129.167.239\\",\\n \\"CdnIp\\": \\"true\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEdgeContainerAppImageSecrets' => [ + 'summary' => '获取边缘容器应用的镜像秘钥列表', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + ], + ], + ], + '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' => '3558df77-8a7a-4060-a900-2d7949403836', + ], + 'ImageSecretList' => [ + 'description' => '镜像秘钥列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '镜像秘钥名称。', + 'type' => 'string', + 'example' => 'reg-123****', + ], + 'Registry' => [ + 'description' => '镜像仓库地址。', + 'type' => 'string', + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com', + ], + 'Username' => [ + 'description' => '镜像仓库用户名。', + 'type' => 'string', + 'example' => 'admin', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidParameter.Appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取边缘容器应用镜像秘钥列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerAppImageSecrets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3558df77-8a7a-4060-a900-2d7949403836\\",\\n \\"ImageSecretList\\": [\\n {\\n \\"Name\\": \\"reg-123****\\",\\n \\"Registry\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com\\",\\n \\"Username\\": \\"admin\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEdgeContainerAppRecords' => [ + 'summary' => '获取与边缘容器应用相关联的所有域名的列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239590', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '第几页。取值范围为：**1**~**100000**，默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**20**。取值范围：**1~500**之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OrderKey', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，取值：'."\n" + .'- **CreateTime**：域名创建时间。'."\n" + .'- **UpdateTime**：域名修改时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + 'default' => 'CreateTime', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向。取值：'."\n" + ."\n" + .'- **ASC**：升序排列。'."\n" + ."\n" + .'- **DESC**：降序排列。', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + 'default' => 'Desc', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'ver-1006157458290860032', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '关联的域名总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Records' => [ + 'description' => '描述关联域名的信息的数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-88068867578379****', + ], + 'Cname' => [ + 'description' => '关联域名对应的CNAME域名。', + 'type' => 'string', + 'example' => 'kdxceo****.yun****.com', + ], + 'ConfigId' => [ + 'description' => '关联域名的配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27522948436****', + ], + 'CreateTime' => [ + 'description' => '添加域名的创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'RecordId' => [ + 'description' => '关联域名的记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '266****', + ], + 'RecordName' => [ + 'description' => '关联域名名称。', + 'type' => 'string', + 'example' => 'a.example.com', + ], + 'UpdateTime' => [ + 'description' => '域名最近一次修改调度域ID或CNAME的时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2021-12-22T08:32:02Z', + ], + 'SchemdId' => [ + 'description' => '关联域名的调度域ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123456', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5407498413****', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '获取边缘容器应用的关联域名列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:56:38.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeContainerAppRecords', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerAppRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Records\\": [\\n {\\n \\"AppId\\": \\"app-88068867578379****\\",\\n \\"Cname\\": \\"kdxceo****.yun****.com\\",\\n \\"ConfigId\\": 0,\\n \\"CreateTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"RecordId\\": 0,\\n \\"RecordName\\": \\"a.example.com\\",\\n \\"UpdateTime\\": \\"2021-12-22T08:32:02Z\\",\\n \\"SchemdId\\": 123456,\\n \\"SiteId\\": 0\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEdgeContainerAppVersions' => [ + 'summary' => '获取边缘容器应用的版本列表，包括用户创建成功的所有应用列表信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239225', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。取值：**1~65535**之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '页大小。取值：**1~100**之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OrderKey', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，取值如下：'."\n" + .'- **Name**：版本名称。'."\n" + .'- **CreateTime**：版本创建时间。'."\n" + .'- **ModifyTime**：版本修改时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'Name', + 'default' => 'CreateTime', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向。取值：'."\n" + ."\n" + .'- **Asc**：升序排列'."\n" + ."\n" + .'- **Desc**：降序排列', + 'type' => 'string', + 'required' => false, + 'example' => 'Desc', + 'default' => 'Desc', + ], + ], + [ + 'name' => 'SearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊查找的类型，支持VersionId,Name。', + 'type' => 'string', + 'required' => false, + 'example' => 'VersionId', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '查询参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ver-100568263967926****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Versions' => [ + 'description' => '版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '描述版本信息对象。', + 'type' => 'object', + 'properties' => [ + 'LastPublishTime' => [ + 'description' => '该版本上次的发布时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-02-10T02:48:36Z'."\n", + ], + 'PublishTime' => [ + 'description' => '版本的本次发布时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-02-10T02:48:36Z', + ], + 'Status' => [ + 'description' => '当前版本的状态。取值：'."\n" + ."\n" + .'- **created**：创建成功。'."\n" + .'- **failed**：创建失败。'."\n" + .'- **creating**：创建中。', + 'type' => 'string', + 'example' => 'created', + ], + 'CreateTime' => [ + 'description' => '版本创建时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-11-10T02:53:16Z', + ], + 'AppId' => [ + 'description' => '应用版本归属的应用ID。', + 'type' => 'string', + 'example' => 'app-88068867578379****', + ], + 'VersionId' => [ + 'description' => '版本ID。', + 'type' => 'string', + 'example' => 'ver-87962637161651****', + ], + 'Name' => [ + 'description' => '版本名称。', + 'type' => 'string', + 'example' => 'version01', + ], + 'UpdateTime' => [ + 'description' => '版本的上次修改时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-16 10:51:00', + ], + 'Remarks' => [ + 'description' => '备注信息', + 'type' => 'string', + 'example' => 'test version', + ], + 'Containers' => [ + 'description' => '该版本包含的容器数组。', + 'type' => 'array', + 'items' => [ + 'description' => '该版本包含的容器数组。', + 'type' => 'object', + 'properties' => [ + 'EnvVariables' => [ + 'description' => '容器环境变量。', + 'type' => 'string', + 'example' => 'ENV=prod', + ], + 'Args' => [ + 'description' => '容器启动参数。', + 'type' => 'string', + 'example' => '-c a=1', + ], + 'Spec' => [ + 'description' => '容器规格。', + 'type' => 'string', + 'example' => '1C2G', + ], + 'Image' => [ + 'description' => '容器镜像地址。', + 'type' => 'string', + 'example' => 'nginx', + ], + 'Command' => [ + 'description' => '容器启动命令。', + 'type' => 'string', + 'example' => 'openresty -g \\"daemon off;\\"', + ], + 'ProbeType' => [ + 'description' => '容器探针类型。', + 'type' => 'string', + 'example' => 'httpGet', + ], + 'Name' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'container1', + ], + 'PreStop' => [ + 'description' => '容器停止前执行命令。', + 'type' => 'string', + 'example' => 'sh prestop.sh "echo hello world" ', + ], + 'PostStart' => [ + 'description' => '容器启动前执行命令。', + 'type' => 'string', + 'example' => 'sh poststart.sh "echo hello world" ', + ], + 'ProbeContent' => [ + 'description' => '描述容器探针的具体对象。', + 'type' => 'object', + 'properties' => [ + 'SuccessThreshold' => [ + 'description' => '容器的健康检查连续成功次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Host' => [ + 'description' => '容器健康检查的域名。', + 'type' => 'string', + 'example' => 'test.com', + ], + 'HttpHeaders' => [ + 'description' => '容器健康检查携带请求头。', + 'type' => 'string', + 'example' => '{\\"Content-Type\\":\\"application/json\\"}', + ], + 'Scheme' => [ + 'description' => '容器健康检查请求协议。', + 'type' => 'string', + 'example' => 'http', + ], + 'InitialDelaySeconds' => [ + 'description' => '容器探针初始化延迟时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Command' => [ + 'description' => '探针运行命令。', + 'type' => 'string', + 'example' => 'openresty -g "daemon off;', + ], + 'FailureThreshold' => [ + 'description' => '容器健康检查连续失败次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TimeoutSeconds' => [ + 'description' => '容器健康检查的超时时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Path' => [ + 'description' => '容器健康检查的路径。', + 'type' => 'string', + 'example' => '/health_check', + ], + 'Port' => [ + 'description' => '容器健康检查的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'PeriodSeconds' => [ + 'description' => '容器健康检查的间隔时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + 'required' => false, + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.OrderType', + 'errorMessage' => 'The specified OrderType is invalid. Please check the OrderType parameter. You may not have set it to either Asc or Desc. Please make the necessary changes and call the interface again.', + 'description' => 'OrderType参数无效。请检查OrderType参数，你有可能未设置为 Asc、Desc其中一种，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter.OrderKey', + 'errorMessage' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', + 'description' => 'OrderKey参数无效。请检查OrderKey参数，该参数不能赋值为非法字符如 @、#、% 等，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidPageSize.ValueNotSupported', + 'errorMessage' => 'The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500.', + 'description' => '请求PageSize值非法，默认取值为20，取值区间为1-500。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '获取边缘容器应用的版本列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-12T02:06:26.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeContainerAppVersions', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerAppVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"Versions\\": [\\n {\\n \\"LastPublishTime\\": \\"2023-02-10T02:48:36Z\\\\n\\",\\n \\"PublishTime\\": \\"2023-02-10T02:48:36Z\\",\\n \\"Status\\": \\"created\\",\\n \\"CreateTime\\": \\"2022-11-10T02:53:16Z\\",\\n \\"AppId\\": \\"app-88068867578379****\\",\\n \\"VersionId\\": \\"ver-87962637161651****\\",\\n \\"Name\\": \\"version01\\",\\n \\"UpdateTime\\": \\"2023-04-16 10:51:00\\",\\n \\"Remarks\\": \\"test version\\",\\n \\"Containers\\": [\\n {\\n \\"EnvVariables\\": \\"ENV=prod\\",\\n \\"Args\\": \\"-c a=1\\",\\n \\"Spec\\": \\"1C2G\\",\\n \\"Image\\": \\"nginx\\",\\n \\"Command\\": \\"openresty -g \\\\\\\\\\\\\\"daemon off;\\\\\\\\\\\\\\"\\",\\n \\"ProbeType\\": \\"httpGet\\",\\n \\"Name\\": \\"container1\\",\\n \\"PreStop\\": \\"sh prestop.sh \\\\\\"echo hello world\\\\\\" \\",\\n \\"PostStart\\": \\"sh poststart.sh \\\\\\"echo hello world\\\\\\" \\",\\n \\"ProbeContent\\": {\\n \\"SuccessThreshold\\": 1,\\n \\"Host\\": \\"test.com\\",\\n \\"HttpHeaders\\": \\"{\\\\\\\\\\\\\\"Content-Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"application/json\\\\\\\\\\\\\\"}\\",\\n \\"Scheme\\": \\"http\\",\\n \\"InitialDelaySeconds\\": 10,\\n \\"Command\\": \\"openresty -g \\\\\\"daemon off;\\",\\n \\"FailureThreshold\\": 3,\\n \\"TimeoutSeconds\\": 30,\\n \\"Path\\": \\"/health_check\\",\\n \\"Port\\": 80,\\n \\"PeriodSeconds\\": 5\\n }\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEdgeContainerApps' => [ + 'summary' => '获取边缘容器应用列表，包括用户该账号下创建的所有边缘应用。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239248', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值：**1**，取值范围：**1~65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。默认为：**20**，取值范围：**1~500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'OrderKey', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，不传则默认为空。取值：'."\n" + .'- **Name**：版本名称。'."\n" + .'- **CreateTime**：版本创建时间。'."\n" + .'- **ModifyTime**：版本修改时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + 'default' => 'CreateTime', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向，不传则默认为空。取值：'."\n" + ."\n" + .'- **Asc**：升序排列。'."\n" + ."\n" + .'- **Desc**：降序排列。', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc'."\n", + 'default' => 'Desc', + ], + ], + [ + 'name' => 'SearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊查找的类型，取值：'."\n" + .'- **AppId**：应用ID。'."\n" + .'- **Name**：应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'AppId', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词。', + 'type' => 'string', + 'required' => false, + 'example' => 'ver-1005682639679266816', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', + ], + 'PageNumber' => [ + 'description' => '当前页码。默认值;**1**，取值范围：**1~65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。取值范围：**1~500**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Apps' => [ + 'description' => '应用数组', + 'type' => 'array', + 'items' => [ + 'description' => '描述应用的对象。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '应用的状态信息，取值：'."\n" + .'- **creating**：创建中'."\n" + .'- **failed**：创建失败'."\n" + .'- **created**：创建成功', + 'type' => 'string', + 'example' => 'created', + ], + 'GatewayType' => [ + 'description' => '网关类型， 可能值：'."\n" + .'- **l7**：七层网关'."\n" + .'- **l4**：四层网关', + 'type' => 'string', + 'example' => 'l7', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-12-01T16:16:27.418298794+08:00', + ], + 'VersionCount' => [ + 'description' => '应用版本数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DomainName' => [ + 'description' => 'App所绑定的域名。', + 'type' => 'string', + 'example' => 'test.com', + ], + 'Remarks' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'test app', + ], + 'ServicePort' => [ + 'description' => '服务端端口号。范围：**1~65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-88068867578379****', + ], + 'TargetPort' => [ + 'description' => '后端端口，也是应用的服务端口。范围：**1~65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'QuicCid' => [ + 'description' => '是否开启quic支持。', + 'type' => 'string', + 'example' => 'false', + ], + 'Name' => [ + 'description' => '应用名。', + 'type' => 'string', + 'example' => 'app-test', + ], + 'UpdateTime' => [ + 'description' => '应用的上次修改时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-11-15T12:11:02Z', + ], + 'HealthCheck' => [ + 'description' => '表示健康检查信息的对象。', + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => '应用健康检查超时时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Type' => [ + 'description' => '健康检查类型，取值：'."\n" + .'- **l7**：七层健康检查探测。'."\n" + .'- **l4**：四层健康检查探测。', + 'type' => 'string', + 'example' => 'l7', + ], + 'Host' => [ + 'description' => '健康检查的域名。', + 'type' => 'string', + 'example' => 'test.com', + ], + 'Interval' => [ + 'description' => '应用健康检查的间隔时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SuccTimes' => [ + 'description' => '应用的健康检查连续成功次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Method' => [ + 'description' => '应用的健康检查的方法。', + 'type' => 'string', + 'example' => 'GET', + ], + 'HttpCode' => [ + 'description' => '应用的健康检查成功的状态码范围。', + 'type' => 'string', + 'example' => 'http_2XX', + ], + 'FailTimes' => [ + 'description' => '应用的健康检查连续失败次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Port' => [ + 'description' => '应用的健康检查端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8080', + ], + 'Uri' => [ + 'description' => '应用的健康检查的路径。', + 'type' => 'string', + 'example' => '/health_check', + ], + ], + ], + 'Percentage' => [ + 'description' => '创建进度百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.OrderType', + 'errorMessage' => 'The specified OrderType is invalid. Please check the OrderType parameter. You may not have set it to either Asc or Desc. Please make the necessary changes and call the interface again.', + 'description' => 'OrderType参数无效。请检查OrderType参数，你有可能未设置为 Asc、Desc其中一种，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter.OrderKey', + 'errorMessage' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', + 'description' => 'OrderKey参数无效。请检查OrderKey参数，该参数不能赋值为非法字符如 @、#、% 等，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InvalidParameter.PageNumber', + 'errorMessage' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', + 'description' => '参数 PageNumber 校验不通过。请仔细检查请求参数是否存在且为正整数。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidPageSize.ValueNotSupported', + 'errorMessage' => 'The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500.', + 'description' => '请求PageSize值非法，默认取值为20，取值区间为1-500。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '获取边缘容器应用列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-15T03:49:16.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeContainerApps', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2430E05E-1340-5773-B5E1-B743929F46F2\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"Apps\\": [\\n {\\n \\"Status\\": \\"created\\",\\n \\"GatewayType\\": \\"l7\\",\\n \\"CreateTime\\": \\"2022-12-01T16:16:27.418298794+08:00\\",\\n \\"VersionCount\\": 10,\\n \\"DomainName\\": \\"test.com\\",\\n \\"Remarks\\": \\"test app\\",\\n \\"ServicePort\\": 80,\\n \\"AppId\\": \\"app-88068867578379****\\",\\n \\"TargetPort\\": 80,\\n \\"QuicCid\\": \\"false\\",\\n \\"Name\\": \\"app-test\\",\\n \\"UpdateTime\\": \\"2023-11-15T12:11:02Z\\",\\n \\"HealthCheck\\": {\\n \\"Timeout\\": 60,\\n \\"Type\\": \\"l7\\",\\n \\"Host\\": \\"test.com\\",\\n \\"Interval\\": 5,\\n \\"SuccTimes\\": 1,\\n \\"Method\\": \\"GET\\",\\n \\"HttpCode\\": \\"http_2XX\\",\\n \\"FailTimes\\": 5,\\n \\"Port\\": 8080,\\n \\"Uri\\": \\"/health_check\\"\\n },\\n \\"Percentage\\": 100\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEdgeContainerRecords' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239659', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定记录名称过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'a.example.com', + ], + ], + [ + 'name' => 'RecordMatchType', + 'in' => 'query', + 'schema' => [ + 'description' => '按记录名称过滤，过滤匹配的模式：'."\n" + .'- **fuzzy**：模糊匹配。'."\n" + .'- **prefix**：前缀匹配。'."\n" + .'- **suffix**：后缀匹配。'."\n" + .'- **exact**：精确匹配（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认为：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值；**500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '记录总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Records' => [ + 'description' => '记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个记录信息。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '记录的创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'UpdateTime' => [ + 'description' => '记录的更新时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2021-12-22T08:32:02Z', + ], + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'a.example.com', + ], + 'RecordCname' => [ + 'description' => '记录的CNAME。当站点的接入方式为CNAME接入时，需要为记录配置的CNAME值。', + 'type' => 'string', + 'example' => 'a.example.com.cnamezone.com', + ], + 'SiteId' => [ + 'description' => '记录所属站点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '记录所属站点的名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询边缘容器记录列表', + 'summary' => '查询站点的边缘容器记录。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:56:37.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeContainerRecords', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 50,\\n \\"Records\\": [\\n {\\n \\"CreateTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"UpdateTime\\": \\"2021-12-22T08:32:02Z\\",\\n \\"RecordName\\": \\"a.example.com\\",\\n \\"RecordCname\\": \\"a.example.com.cnamezone.com\\",\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEdgeRoutinePlans' => [ + 'summary' => '查询可用的边缘函数套餐列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238723', + 'abilityTreeNodes' => [ + 'FEATUREdcdnZA9EPX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'PlanInfo' => [ + 'description' => '套餐列表。', + 'type' => 'array', + 'items' => [ + 'description' => '套餐详情。', + 'type' => 'object', + 'properties' => [ + 'PlanName' => [ + 'description' => '套餐名称。', + 'type' => 'string', + 'example' => 'test_plan', + ], + 'ErRoutineQuota' => [ + 'description' => '边缘函数数量配额。', + 'type' => 'string', + 'example' => '100', + ], + 'ErRoutineCodeVersionQuota' => [ + 'description' => '每个边缘函数的版本数量配额。', + 'type' => 'string', + 'example' => '20', + ], + 'ErRoutineRouteSiteCountQuota' => [ + 'description' => '每个边缘函数可绑定站点数量的配额。', + 'type' => 'string', + 'example' => '100', + ], + 'BillingMode' => [ + 'description' => '付费类型。支持：'."\n" + ."\n" + .'- **PREPAY**：预付费。'."\n" + .'- **POSTPAY**：后付费。', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'PaymentMethod' => [ + 'description' => '计费类型，支持：'."\n" + ."\n" + .'- **er_free**：免费；'."\n" + .'- **er_pay**：付费；', + 'type' => 'string', + 'example' => 'er_free', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。取值范围：**1~500**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询边缘函数套餐列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeRoutinePlans', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListEdgeRoutinePlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"PlanInfo\\": [\\n {\\n \\"PlanName\\": \\"test_plan\\",\\n \\"ErRoutineQuota\\": \\"100\\",\\n \\"ErRoutineCodeVersionQuota\\": \\"20\\",\\n \\"ErRoutineRouteSiteCountQuota\\": \\"100\\",\\n \\"BillingMode\\": \\"POSTPAY\\",\\n \\"PaymentMethod\\": \\"er_free\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 12,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListEdgeRoutineRecords' => [ + 'summary' => '查询站点下的边缘路由记录列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239603', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定记录名称过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'a.example.com', + ], + ], + [ + 'name' => 'RecordMatchType', + 'in' => 'query', + 'schema' => [ + 'description' => '按记录名称过滤，过滤匹配的模式：'."\n" + .'- **fuzzy**：模糊匹配。'."\n" + .'- **prefix**：前缀匹配。'."\n" + .'- **suffix**：后缀匹配。'."\n" + .'- **exact**：精确匹配（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'PageNumber' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '121', + ], + 'Records' => [ + 'description' => '记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个记录信息。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '记录的创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'UpdateTime' => [ + 'description' => '记录的更新时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-22T08:32:02Z', + ], + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'a.example.com', + ], + 'RecordCname' => [ + 'description' => '记录的CNAME。当站点的接入方式为CNAME接入时，需要为记录配置的CNAME值。', + 'type' => 'string', + 'example' => 'a.example.com.cnamezone.com', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5407498413****', + ], + 'SiteName' => [ + 'description' => '记录所属站点的名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询边缘路由记录列表', + 'description' => '> API调用频率：100次/秒。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:56:37.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeRoutineRecords', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListEdgeRoutineRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 121,\\n \\"Records\\": [\\n {\\n \\"CreateTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"UpdateTime\\": \\"2023-12-22T08:32:02Z\\",\\n \\"RecordName\\": \\"a.example.com\\",\\n \\"RecordCname\\": \\"a.example.com.cnamezone.com\\",\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListHttpIncomingRequestHeaderModificationRules' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257649', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '608665779308176', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用ListHttpIncomingRequestHeaderModificationRules接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '424371770570752', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置；'."\n" + .'- rule：查询规则配置；', + 'type' => 'string', + 'required' => false, + 'example' => 'rule', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7FB6EBC8-8849-5FC6-890E-3A761A5CD42D', + ], + 'Configs' => [ + 'description' => '修改HTTP入站请求头配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '修改HTTP入站请求头配置详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '429422870243328', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置；'."\n" + .'- rule：规则配置；', + 'type' => 'string', + 'example' => 'rule', + ], + 'RequestHeaderModification' => [ + 'description' => '修改请求头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改请求头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '请求头名称。', + 'type' => 'string', + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'example' => 'add', + ], + 'Value' => [ + 'description' => '请求头值。', + 'type' => 'string', + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，默认500，取值：1~500。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询修改HTTP入站请求头配置列表', + 'summary' => '查询站点的修改HTTP入站请求头配置列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListHttpIncomingRequestHeaderModificationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FB6EBC8-8849-5FC6-890E-3A761A5CD42D\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 429422870243328,\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleEnable\\": \\"on\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"rule\\",\\n \\"RequestHeaderModification\\": [\\n {\\n \\"Name\\": \\"headerName\\",\\n \\"Operation\\": \\"add\\",\\n \\"Value\\": \\"headerValue\\",\\n \\"Type\\": \\"static\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 10,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListHttpIncomingResponseHeaderModificationRules' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257655', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '624516866852544', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用ListHttpIncomingResponseHeaderModificationRules接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '432915173664768', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置；'."\n" + .'- rule：查询规则配置；', + 'type' => 'string', + 'required' => false, + 'example' => 'rule', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF02C6F6-DB59-5438-8C05-3CE42DFCB0AD', + ], + 'Configs' => [ + 'description' => '修改HTTP入站响应头配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '修改HTTP入站响应头配置详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '430559776208896', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'ResponseHeaderModification' => [ + 'description' => '修改响应头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改响应头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '响应头名称。', + 'type' => 'string', + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'example' => 'add', + ], + 'Value' => [ + 'description' => '响应头值。', + 'type' => 'string', + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，默认500，取值：1~500。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询修改HTTP入站响应头的配置列表', + 'summary' => '查询站点的修改HTTP入站响应头的配置列表，', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListHttpIncomingResponseHeaderModificationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF02C6F6-DB59-5438-8C05-3CE42DFCB0AD\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 430559776208896,\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"rule\\",\\n \\"ResponseHeaderModification\\": [\\n {\\n \\"Name\\": \\"headerName\\",\\n \\"Operation\\": \\"add\\",\\n \\"Value\\": \\"headerValue\\",\\n \\"Type\\": \\"static\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 10,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListHttpRequestHeaderModificationRules' => [ + 'summary' => '查询修改HTTP请求头配置列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257649', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****'."\n", + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListHttpRequestHeaderModificationRules](~~2867483~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置；'."\n" + .'- rule：查询规则配置；', + 'type' => 'string', + 'required' => false, + 'example' => 'rule', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', + ], + 'Configs' => [ + 'description' => '修改HTTP请求头配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '修改HTTP请求头详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****'."\n", + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置；'."\n" + .'- rule：规则配置；', + 'type' => 'string', + 'example' => 'global', + ], + 'RequestHeaderModification' => [ + 'description' => '修改请求头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改请求头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '请求头名称。', + 'type' => 'string', + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'example' => 'add', + ], + 'Value' => [ + 'description' => '请求头值。', + 'type' => 'string', + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，默认**500**，取值：**1~500**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询修改HTTP请求头配置列表', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:38.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListHttpRequestHeaderModificationRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListHttpRequestHeaderModificationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 0,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleEnable\\": \\"on\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"RequestHeaderModification\\": [\\n {\\n \\"Name\\": \\"headerName\\",\\n \\"Operation\\": \\"add\\",\\n \\"Value\\": \\"headerValue\\",\\n \\"Type\\": \\"static\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 10,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListHttpResponseHeaderModificationRules' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257655', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。'."\n" + ."\n" + .'该参数可以不传，不传时不区分全局或者规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '分页大小，默认500。取值范围：1~500之前的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'Configs' => [ + 'description' => '修改HTTP响应头列表。', + 'type' => 'array', + 'items' => [ + 'description' => '修改HTTP响应头详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****'."\n", + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'ResponseHeaderModification' => [ + 'description' => '修改响应头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '响应头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '响应头名称。', + 'type' => 'string', + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'example' => 'add', + ], + 'Value' => [ + 'description' => '响应头值。', + 'type' => 'string', + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询修改HTTP响应头的配置列表', + 'summary' => '查询站点的修改HTTP响应头的配置列表。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:39.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListHttpResponseHeaderModificationRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListHttpResponseHeaderModificationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 0,\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"rule\\",\\n \\"ResponseHeaderModification\\": [\\n {\\n \\"Name\\": \\"headerName\\",\\n \\"Operation\\": \\"add\\",\\n \\"Value\\": \\"headerValue\\",\\n \\"Type\\": \\"static\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 14,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListHttpsApplicationConfigurations' => [ + 'summary' => '查询多条HTTPS应用配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257534', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3528160969****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。'."\n" + ."\n" + .'该参数可以不传，不传时不区分全局或者规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名，可以查出规则名为所传字段的那条规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'Configs' => [ + 'description' => '返回体配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395386449776640', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'HttpsForce' => [ + 'description' => '是否开启强制HTTPS，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + ."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HttpsForceCode' => [ + 'description' => '强制HTTPS跳转状态码，取值范围：'."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 307'."\n" + .'- 308', + 'type' => 'string', + 'example' => '301', + ], + 'AltSvc' => [ + 'description' => 'Alt-Svc功能开关，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'AltSvcClear' => [ + 'description' => 'Alt-Svc头是否包含clear参数，默认关闭。取值：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'AltSvcPersist' => [ + 'description' => 'Alt-Svc头包是否含persist参数，默认关闭。取值：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'AltSvcMa' => [ + 'description' => 'Alt-Svc有效时间，单位是秒，默认为86400秒。', + 'type' => 'string', + 'example' => '86400', + ], + 'Hsts' => [ + 'description' => '是否开启HSTS，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HstsMaxAge' => [ + 'description' => 'HSTS过期时间，单位是秒。', + 'type' => 'string', + 'example' => '3600', + ], + 'HstsIncludeSubdomains' => [ + 'description' => '是否在HSTS中包括子域，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HstsPreload' => [ + 'description' => '是否开启HSTS预加载，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HttpsSniVerify' => [ + 'description' => '是否开启SNI校验，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HttpsNoSniDeny' => [ + 'description' => '是否开启拒绝无SNI的TLS握手请求，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HttpsSniWhitelist' => [ + 'description' => '指定允许的SNI白名单列表，多个以空格分隔。', + 'type' => 'string', + 'example' => 'abc edf', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询HTTPS应用配置列表', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-03T07:09:13.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListHttpsApplicationConfigurations', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListHttpsApplicationConfigurations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 395386449776640,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"HttpsForce\\": \\"on\\",\\n \\"HttpsForceCode\\": \\"301\\",\\n \\"AltSvc\\": \\"on\\",\\n \\"AltSvcClear\\": \\"on\\",\\n \\"AltSvcPersist\\": \\"on\\",\\n \\"AltSvcMa\\": \\"86400\\",\\n \\"Hsts\\": \\"on\\",\\n \\"HstsMaxAge\\": \\"3600\\",\\n \\"HstsIncludeSubdomains\\": \\"on\\",\\n \\"HstsPreload\\": \\"on\\",\\n \\"HttpsSniVerify\\": \\"on\\",\\n \\"HttpsNoSniDeny\\": \\"on\\",\\n \\"HttpsSniWhitelist\\": \\"abc edf\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + ], + 'ListHttpsBasicConfigurations' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257540', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。'."\n" + ."\n" + .'该参数可以不传，不传时不区分全局或者规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名，可以查出规则名为所传字段的那条规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + '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。', + 'type' => 'string', + 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Configs' => [ + 'description' => '返回体配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395386449776640', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'Https' => [ + 'description' => '是否开启HTTPS，默认开启。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + ."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tls10' => [ + 'description' => '是否开启TLS1.0，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tls11' => [ + 'description' => '是否开启TLS1.1，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tls12' => [ + 'description' => '是否开启TLS1.2，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tls13' => [ + 'description' => '是否开启TLS1.3，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'CiphersuiteGroup' => [ + 'description' => '加密套件组，默认使能全部加密套件。取值范围：'."\n" + .'- all：全部加密套件。'."\n" + .'- strict：强加密套件。'."\n" + .'- custom：自定义加密套件。', + 'type' => 'string', + 'example' => 'strict', + ], + 'Ciphersuite' => [ + 'description' => '自定义加密套件，表示当CiphersuiteGroup为custom时选取的具体加密算法。', + 'type' => 'string', + 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', + ], + 'OcspStapling' => [ + 'description' => '是否开启OCSP，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Http2' => [ + 'description' => '是否开启HTTP2，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Http3' => [ + 'description' => '是否开启HTTP3，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询HTTPS基础配置列表', + 'summary' => '查询多条HTTPS基础配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListHttpsBasicConfigurations', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListHttpsBasicConfigurations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 395386449776640,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"Https\\": \\"on\\",\\n \\"Tls10\\": \\"on\\",\\n \\"Tls11\\": \\"on\\",\\n \\"Tls12\\": \\"on\\",\\n \\"Tls13\\": \\"on\\",\\n \\"CiphersuiteGroup\\": \\"strict\\",\\n \\"Ciphersuite\\": \\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\",\\n \\"OcspStapling\\": \\"on\\",\\n \\"Http2\\": \\"on\\",\\n \\"Http3\\": \\"on\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + ], + 'ListImageTransforms' => [ + 'summary' => '查询多条站点图片转换配置列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257357', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过调用[ListSites](~~2850189~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListImageTransforms](~~2869056~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '352816096987136', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置；'."\n" + .'- rule：查询规则配置；'."\n" + ."\n" + .'该参数可以不传，不传时不区分全局或者规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'Configs' => [ + 'description' => '配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回体配置。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395386449776640', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Enable' => [ + 'description' => '开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'on' => 'on', + ], + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'test', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置；'."\n" + .'- rule：规则配置；', + 'type' => 'string', + 'enumValueTitles' => [ + 'rule' => 'rule', + 'global' => 'global', + ], + 'example' => 'global', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。取值：**1~500**，默认为**500**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'TotalPage' => [ + 'description' => '记录总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询多条站点图片转换配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListImageTransforms', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListImageTransforms', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 395386449776640,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"Enable\\": \\"on\\",\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.request.uri.path.file_name eq \\\\\\\\\\\\\\"jpg\\\\\\\\\\\\\\")\\",\\n \\"RuleName\\": \\"test\\",\\n \\"ConfigType\\": \\"global\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + ], + 'ListInstanceQuotas' => [ + 'summary' => '根据配额名称查询当前实例或者站点对应的套餐的配额详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238984', + 'abilityTreeNodes' => [ + 'FEATUREdcdnZA9EPX', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐实例ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'sp-xcdn-96wblslz****', + 'enum' => [], + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2882900****', + ], + ], + [ + 'name' => 'QuotaNames', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '套餐配额名称，多个用（,）隔开。支持：'."\n" + ."\n" + .'- **waf:phase:http_anti_scan:actions**：WAF扫描防护-动作枚举。'."\n" + .'- **waf:phase:http_bot:actions**：WAF BOT管理-所有动作枚举。'."\n" + .'- **waf:phase:http_bot:http_custom_cc_dev:characteristic:fields**：WAF BOT管理-自定义设备限速类型统计对象枚举。'."\n" + .'- **waf:phase:http_bot:http_custom_cc_ip:characteristic:fields**：WAF BOT管理-自定义IP限速类型统计对象枚举。'."\n" + .'- ****waf:phase:http_bot:match:symbols****：WAF BOT管理-匹配符枚举。'."\n" + .'- **waf:phase:http_bot:http_custom_cc:characteristic:fields**：WAF BOT管理--自定义会话限速类型统计对象枚举。'."\n" + .'- **waf:phase:http_bot:match:fields**：WAF BOT管理阶-匹配字段枚举。'."\n" + .'- **waf:phase:http_whitelist:match:symbols**：WAF白名单-匹配符枚举。'."\n" + .'- **waf:phase:http_whitelist:match:fields**：WAF白名单-匹配字段枚举。'."\n" + .'- **waf:phase:http_anti_scan:http_directory_traversal:characteristic:fields**：WAF扫描防护-目录遍历封禁类型统计对象枚举。'."\n" + .'- **waf:phase:http_anti_scan:http_high_frequency:characteristic:fields**：WAF扫描防护-高频扫描封禁类型统计对象枚举。'."\n" + .'- **waf:phase:http_anti_scan:match:symbols**：WAF扫描防护-匹配符枚举。'."\n" + .'- **waf:phase:http_anti_scan:match:fields**：WAF扫描防护-匹配字段枚举。'."\n" + .'- **waf:phase:http_managed:actions**：WAF托管规则-动作枚举。'."\n" + .'- **waf:phase:http_managed:group:reference:ids**：WAF托管规则-引用规则组枚举。'."\n" + .'- **waf:phase:http_ratelimit:actions**：WAF频次控制-动作枚举。'."\n" + .'- **waf:phase:http_ratelimit:ttls**：WAF频次控制-持续时间枚举。'."\n" + .'- **waf:phase:http_ratelimit:intervals**：WAF频次控制-统计时长。'."\n" + .'- **waf:phase:http_ratelimit:http_ratelimit:characteristic:fields**：WAF频次控制-控制类型规则-匹配特征枚举。'."\n" + .'- **waf:phase:http_ratelimit:match:symbols**：WAF频次控制规则阶段匹配符枚举。'."\n" + .'- **waf:phase:http_ratelimit:match:fields**：WAF频次控制规则阶段匹配字段枚举。'."\n" + .'- **waf:phase:http_custom:actions**：WAF自定义规则阶段动作枚举。'."\n" + .'- **waf:phase:http_custom:match:symbols**：WAF自定义规则阶段匹配符枚举。'."\n" + .'- **waf:phase:http_custom:match:fields**：WAF自定义规则阶段匹配字段。'."\n" + .'- **waiting_room|queuing_method**：等候室 - 排队方法。'."\n" + .'- **origin_rules|origin_scheme**：回源规则 - 回源协议。'."\n" + .'- **origin_rules|origin_sni**：回源规则 - 回源SNI。'."\n" + .'- **origin_rules|origin_host**：回源规则 - 回源host。'."\n" + .'- **fourlayeracceleration**：四层加速。'."\n" + .'- **rtlog_service**：实时日志功能开关。'."\n" + .'- **dashboard_traffic**：流量分析的增值能力。'."\n" + .'- **custom_name_server**：自定义NS名称。'."\n" + .'- **waf:phase:http_bot:enable**：WAF BOT管理开关。'."\n" + .'- **waf:phase:http_whitelist:enable**：WAF白名单开关。'."\n" + .'- **instantlog**：即时日志可用不可用。'."\n" + .'- **waf:phase:http_anti_scan:enable**：WAF扫描防护开关。'."\n" + .'- **waf:phase:http_managed:group:reference:enable**：WAF托管规则- 配置引用规则组开关。'."\n" + .'- **waf:phase:http_managed:enable**：WAF托管规则开关。'."\n" + .'- **waf:phase:http_ratelimit:on_hit:enable**：WAF频次控制 - 在命中缓存的请求上应用开关。'."\n" + .'- **ddos**：ddos实例。'."\n" + .'- **waf:phase:http_ratelimit:enable**：WAF频次控制规则阶段开关。'."\n" + .'- **waf:phase:http_custom:enable**：WAF自定义规则阶段开关。'."\n" + .'- **waf:phase:all:page:reference:enable**：WAF自定义响应页面开关。'."\n" + .'- **rules_support_regex**：规则引擎支持正则运算与否。'."\n" + .'- **waiting_room_event**：waitingroom - 计划事件。'."\n" + .'- **waiting_room_rule**：waitingroom - 绕过等候室。'."\n" + .'- **waiting_room|json_response**：waitingroom - 开启JSON响应。'."\n" + .'- **waiting_room|disable_session_renewal**：waitingroom- 禁用会话续订。'."\n" + .'- **origin_rules|dns_record**：回源规则 - dns记录。'."\n" + .'- **managed_transforms|add_client_geolocation_headers**：转换规则中是否可用真实客户端IP头。'."\n" + .'- **tiered_cache|regional_enable**：区域缓存。'."\n" + .'- **real_client_ip_header**：客户端IP头部。'."\n" + .'- **data_timerange**：数据查询时间-分钟。'."\n" + .'- **cache_rules|edge_cache_ttl**：缓存 - 节点TTL。'."\n" + .'- **cache_rules|browser_cache_ttl**：缓存 - 浏览器TTL。'."\n" + .'- **fourLayerRecordCount**：四层加速的记录数限制。'."\n" + .'- **waitingroomRuleCount**：一个waitingRoomId可以对应几个rule。'."\n" + .'- **waitingroomEventCount**：一个waitingRoomId可以对应几个event。'."\n" + .'- **waitingroom_custom_pathhost**：等候室 - 主机名和路径。'."\n" + .'- **er_routers**：函数路由。'."\n" + .'- **cache_rules|rule_quota**：缓存规则。'."\n" + .'- **configuration_rules|rule_quota**：配置规则。'."\n" + .'- **redirect_rules|rule_quota**：重定向规则。'."\n" + .'- **compression_rules|rule_quota**：压缩规则。'."\n" + .'- **origin_rules|rule_quota**：回源规则。'."\n" + .'- **waf:phase:http_bot:rulesets_per_instance:less_than_or_equal**：WAF BOT管理-每个实例中规则组最大数量。'."\n" + .'- **waf:phase:http_whitelist:rules_per_instance:less_than_or_equal**：WAF白名单-每个实例中规则最大数量。'."\n" + .'- **rtlog_quota**：实时日志的推送任务数quota。'."\n" + .'- **waf:phase:http_anti_scan:rulesets_per_instance:less_than_or_equal**：WAF扫描防护-每个实例中规则组最大数量。'."\n" + .'- **ddos_instance**：ddos实例数。'."\n" + .'- **waf:phase:http_ratelimit:rules_per_instance:less_than_or_equal**：WAF频次控制规则最大数量。'."\n" + .'- **waf:phase:http_custom:rules_per_instance:less_than_or_equal**：WAF自定义规则阶段每个实例中规则最大数量。'."\n" + .'- **ruleNestedConditionalCount**：规则的层级数。'."\n" + .'- **waiting_room**：等候室waitingroom。'."\n" + .'- **transition_rule**：转换规则。'."\n" + .'- **customHttpCert**：自定义证书个数。'."\n" + .'- **free_cert**：免费证书个数。'."\n" + .'- **preload**：预热。'."\n" + .'- **refresh_cache_tag**：刷新 - cache tag。'."\n" + .'- **refresh_ignore_param**：刷新 - 去参数刷新。'."\n" + .'- **refresh_directory**：刷新-按目录刷新。'."\n" + .'- **refresh_hostname**：刷新-按主机名。'."\n" + .'- **refresh_all**：刷新 - 清除所有缓存。'."\n" + .'- **refresh_file**：URL刷新。'."\n" + .'- **wildcard**：泛域名个数。'."\n" + .'- **recordCount**：七层记录数量。'."\n" + .'- **siteCount**：站点数量。'."\n" + .'- **https|rule_quota**：SSL/TLS规则数。', + 'type' => 'string', + 'required' => true, + 'example' => 'preload, free_cert', + 'enum' => [], + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247B78', + ], + 'InstanceId' => [ + 'description' => '套餐实例ID。', + 'type' => 'string', + 'example' => 'sp-xcdn-96wblslz****', + ], + 'Status' => [ + 'description' => '套餐实例状态。支持：'."\n" + ."\n" + .'- **online**：正常服务状态。'."\n" + .'- **offline**：到期但未超期，处于不可用的状态。'."\n" + .'- **disable**：已释放状态。', + 'type' => 'string', + 'example' => 'online', + ], + 'Quotas' => [ + 'description' => '套餐实例配额列表。', + 'type' => 'array', + 'items' => [ + 'description' => '套餐实例配额详情。', + 'type' => 'object', + 'properties' => [ + 'QuotaName' => [ + 'description' => '配额名称。', + 'type' => 'string', + 'example' => 'customHttpCert', + ], + 'QuotaValue' => [ + 'description' => '配额值。', + 'type' => 'string', + 'example' => '10', + ], + 'QuotaValueType' => [ + 'description' => '配额的阈值类型。取值：'."\n" + ."\n" + .'- **value**：枚举类型。配额的取值枚举范围。'."\n" + .'- **bool**：布尔类型。配额是否可用。'."\n" + .'- **num**：数值类型。配额使用数量上限。'."\n" + .'- **range**：范围类型。配额的取值大小范围。'."\n" + .'- **custom**：自定义类型。除以上四种配额阈值类型的其他类型。', + 'type' => 'string', + 'example' => 'bool', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'QuotaNotExist', + 'errorMessage' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', + 'description' => '套餐配额项不存在或购买套餐未生效，请确认后重试。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'ErService.HasOpened', + 'errorMessage' => 'You have already activated Edge Routine.', + 'description' => '您已开通边缘函数服务，无需重复开通。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + [ + 'errorCode' => 'UnsupportQuota', + 'errorMessage' => 'Unsupported quota is specified. Check and try again.', + 'description' => '当前操作不支持该配额，请检查传入的配额是否有效。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询实例的配额详情', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-15T09:23:51.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListInstanceQuotas', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListInstanceQuotas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\",\\n \\"InstanceId\\": \\"sp-xcdn-96wblslz****\\",\\n \\"Status\\": \\"online\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaName\\": \\"customHttpCert\\",\\n \\"QuotaValue\\": \\"10\\",\\n \\"QuotaValueType\\": \\"bool\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListInstanceQuotasWithUsage' => [ + 'summary' => '根据站点或者实例ID，查询对应实例套餐的某些配额以及当前的用量详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238752', + 'abilityTreeNodes' => [ + 'FEATUREdcdnZA9EPX', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐实例ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'sp-xcdn-96wblslz****', + 'enum' => [], + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232223****', + ], + ], + [ + 'name' => 'QuotaNames', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '套餐配额名称，多个用（,）隔开，一次最多可查询10个配额。支持：'."\n" + ."\n" + .'- **customHttpCert**：自定义证书个数。'."\n" + .'- **transition_rule**：转换规则。'."\n" + .'- **waiting_room**：等候室waitingroom。'."\n" + .'- **https|rule_quota**：SSL/TLS规则数。'."\n" + .'- **cache_rules|rule_quota**：缓存规则。'."\n" + .'- **configuration_rules|rule_quota**：配置规则。'."\n" + .'- **redirect_rules|rule_quota**：重定向规则。'."\n" + .'- **compression_rules|rule_quota**：压缩规则。'."\n" + .'- **origin_rules|rule_quota**：回源规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'customHttpCert', + 'enum' => [], + ], + ], + ], + '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' => '85H66C7B-671A-4297-9187-2C4477247A74', + ], + 'InstanceId' => [ + 'description' => '套餐实例ID。', + 'type' => 'string', + 'example' => 'sp-xcdn-96wblslz****', + ], + 'Status' => [ + 'description' => '套餐实例状态。支持：'."\n" + ."\n" + .'- **online**：正常服务状态。'."\n" + .'- **offline**：到期但未超期，处于不可用的状态。'."\n" + .'- **disable**：已释放状态。', + 'type' => 'string', + 'example' => 'online', + ], + 'Quotas' => [ + 'description' => '套餐实例配额及用量列表。', + 'type' => 'array', + 'items' => [ + 'description' => '套餐实例配额及用量详情。', + 'type' => 'object', + 'properties' => [ + 'QuotaName' => [ + 'description' => '配额名称。', + 'type' => 'string', + 'example' => 'redirect_rules|rule_quota', + ], + 'QuotaValue' => [ + 'description' => '配额值。', + 'type' => 'string', + 'example' => '10', + ], + 'Usage' => [ + 'description' => '配额已使用量。', + 'type' => 'string', + 'example' => '3', + ], + 'SiteUsage' => [ + 'description' => '实例绑定的各个站点的用量详情。', + 'type' => 'array', + 'items' => [ + 'description' => '单个站点用量详情。', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34818329392****', + ], + 'SiteUsage' => [ + 'description' => '当前站点的用量。', + 'type' => 'string', + 'example' => '1', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'test.top', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'QuotaNotExist', + 'errorMessage' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', + 'description' => '套餐配额项不存在或购买套餐未生效，请确认后重试。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'ErService.HasOpened', + 'errorMessage' => 'You have already activated Edge Routine.', + 'description' => '您已开通边缘函数服务，无需重复开通。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + [ + 'errorCode' => 'UnsupportQuota', + 'errorMessage' => 'Unsupported quota is specified. Check and try again.', + 'description' => '当前操作不支持该配额，请检查传入的配额是否有效。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询实例的配额以及用量', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-15T09:23:50.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-10-10T07:16:19.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListInstanceQuotasWithUsage', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListInstanceQuotasWithUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85H66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"InstanceId\\": \\"sp-xcdn-96wblslz****\\",\\n \\"Status\\": \\"online\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaName\\": \\"redirect_rules|rule_quota\\",\\n \\"QuotaValue\\": \\"10\\",\\n \\"Usage\\": \\"3\\",\\n \\"SiteUsage\\": [\\n {\\n \\"SiteId\\": 0,\\n \\"SiteUsage\\": \\"1\\",\\n \\"SiteName\\": \\"test.top\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListKvs' => [ + 'summary' => '列出账号下指定KV存储空间的所有键值对。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239076', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '调用[CreatevNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回的页大小。默认：**50**，最大：**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '50', + 'default' => '50', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '指定页码，PageNumber*PageSize最大不可超过50000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '10', + 'default' => '1', + ], + ], + [ + 'name' => 'Prefix', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查找前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'prefix-', + 'maxLength' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'PageSize' => [ + 'description' => '每页包含的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'PageNumber' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'Keys' => [ + 'description' => '本次遍历获取的键值对列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '键的名字。', + 'type' => 'string', + 'example' => 'Key1', + ], + 'UpdateTime' => [ + 'description' => '键的更新时间。', + 'type' => 'string', + 'example' => '2021-12-13T07:46:03Z', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出KV存储空间的键值对', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-20T13:49:27.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListKvs', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListKvs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"PageSize\\": 50,\\n \\"PageNumber\\": 100,\\n \\"TotalCount\\": 1024,\\n \\"Keys\\": [\\n {\\n \\"Name\\": \\"Key1\\",\\n \\"UpdateTime\\": \\"2021-12-13T07:46:03Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListLists' => [ + 'summary' => '列举账户下所有自定义的列表以及它们的详细信息，可以通过传入的查询参数进行筛选，以及进行分页处理来获取特定的列表集合。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239589', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'QueryArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询参数', + 'description' => '查询参数，以JSON格式传递，包含各种筛选条件。', + 'type' => 'object', + 'properties' => [ + 'IdLike' => [ + 'title' => '模糊查询列表ID', + 'description' => '模糊查询列表ID。', + 'type' => 'string', + 'required' => false, + 'example' => '40000001', + ], + 'NameLike' => [ + 'title' => '模糊查询列表名称', + 'description' => '模糊查询列表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + 'DescriptionLike' => [ + 'title' => '模糊查询列表描述', + 'description' => '模糊查询列表描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'a custom list', + ], + 'ItemLike' => [ + 'title' => '模糊查询列表内容', + 'description' => '模糊查询列表内容。', + 'type' => 'string', + 'required' => false, + 'example' => '10.1.1.1', + ], + 'NameItemLike' => [ + 'title' => '同时模糊查询列表内容和名称', + 'description' => '同时模糊查询列表内容和名称。', + 'type' => 'string', + 'required' => false, + 'example' => '10.1.1.1', + ], + 'Kind' => [ + 'description' => '自定义列表种类。', + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + ], + 'OrderBy' => [ + 'title' => '指定排序的列', + 'description' => '指定排序的列。', + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + 'Desc' => [ + 'title' => '是否倒序排列', + 'description' => '是否倒序排列。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + 'example' => 'ListLists', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页面号码', + 'description' => '页面号码，用于指定分页查询的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页面大小', + 'description' => '页面大小，用于指定分页查询的每页数量。', + 'type' => 'integer', + 'format' => 'int32', + '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。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'TotalCount' => [ + 'title' => '过滤后总记录数', + 'description' => '过滤后总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Usage' => [ + 'title' => '用户已使用量', + 'description' => '用户已使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Lists' => [ + 'title' => '列表信息列表', + 'description' => '列表信息数组，包含分页后的列表数据。', + 'type' => 'array', + 'items' => [ + 'title' => '列表信息', + 'description' => '列表信息。', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'title' => '修改时间', + 'description' => '列表的最后修改时间。', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00Z', + ], + 'Id' => [ + 'title' => '列表ID', + 'description' => '自定义列表的ID，可通过调用[ListLists](~~2850217~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40000001', + ], + 'Name' => [ + 'title' => '列表名称', + 'description' => '列表名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'Kind' => [ + 'title' => '列表种类', + 'description' => '列表种类。', + 'type' => 'string', + 'example' => 'ip', + ], + 'Description' => [ + 'title' => '列表描述', + 'description' => '列表描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'a custom list', + 'maxLength' => 1024, + 'pattern' => '', + 'default' => '', + ], + 'Length' => [ + 'title' => '列表内容数组长度', + 'description' => '列表内容数组长度，表示列表包含多少项。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '页面号码', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小', + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ItemsUsage' => [ + 'description' => 'item总使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"TotalCount\\": 5,\\n \\"Usage\\": 10,\\n \\"Lists\\": [\\n {\\n \\"UpdateTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"Id\\": 40000001,\\n \\"Name\\": \\"example\\",\\n \\"Kind\\": \\"ip\\",\\n \\"Description\\": \\"a custom list\\",\\n \\"Length\\": 100\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"ItemsUsage\\": 5000\\n}","type":"json"}]', + 'title' => '列举自定义列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:01:32.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:56:37.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListLists', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListLists', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListLoadBalancerOriginStatus' => [ + 'summary' => '查询负载均衡器下源站状态，一次可以传多个负载均衡器id，用逗号拼接。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238350', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1159101787****', + ], + ], + [ + 'name' => 'LoadBalancerIds', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器ID，查多个负载均衡器时，ID用逗号拼接，最多一次传100个负载均衡器ID，负载均衡器ID可通过调用[ListLoadBalancers](~~2868897~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '99874066052****,100892832360****', + ], + ], + [ + 'name' => 'PoolType', + 'in' => 'query', + 'schema' => [ + 'description' => '源地址池类型，负载均衡器下配置了各种源地址池，有默认地址池、兜底地址池、一级region地址池等，只有默认地址池下的源站状态，会影响负载均衡器本身的状态。传default_pool时表示只查负载均衡器下默认源地址池里的源站状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'default_pool', + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'OriginStatus' => [ + 'description' => '负载均衡器下源站状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源站状态信息。', + 'type' => 'object', + 'properties' => [ + 'LoadBalancerId' => [ + 'description' => '负载均衡器的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99874066052****', + ], + 'OriginId' => [ + 'description' => '源站ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99750209487****', + ], + 'PoolId' => [ + 'description' => '源地址池ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99750209487****', + ], + 'Status' => [ + 'description' => '源站状态：'."\n" + .'- 健康(healthy)：探测结果为可用。'."\n" + .'- 不健康(unhealthy)：探测结果为不可用。'."\n" + .'- 未知(unknown)：未知，监视器还未进行探测。'."\n" + .'- 未监控(undetected)：源站所属的负载均衡器未绑定监视器。', + 'type' => 'string', + 'example' => 'healthy', + ], + 'Reason' => [ + 'description' => '探测失败原因。', + 'type' => 'string', + 'example' => 'TCP connection error', + ], + 'PoolType' => [ + 'description' => '源站所属的源地址池，在此负载均衡器下的类型，只有default_pool（默认地址池）会显示，其他类型返回均为空字符串。', + 'type' => 'string', + 'example' => 'default_pool', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'LoadBalancerNotExist', + 'errorMessage' => 'The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.', + 'description' => '传入的站点负载均衡器无效或当前站点尚未开通负载均衡功能。请您检查负载均衡器名称配置的是否正确后重试，若尚未开通负载均衡功能请开通后重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询负载均衡器下源站状态', + 'description' => '查询负载均衡器下源站状态，一次可以传多个负载均衡器id，用逗号拼接，是针对配置了监视器的负载均衡器，会探测负载均衡器使用的源地址池下面的各个源站，并记录现在各个源站的状态。'."\n" + ."\n" + .'- 健康(healthy)：探测结果为可用。'."\n" + .'- 不健康(unhealthy)：探测结果为不可用。'."\n" + .'- 未知(unknown)：未知，监视器还未进行探测。'."\n" + .'- 未监控(undetected)：源站所属的负载均衡器未绑定监视器。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListLoadBalancerOriginStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListLoadBalancerOriginStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"OriginStatus\\": [\\n {\\n \\"LoadBalancerId\\": 0,\\n \\"OriginId\\": 0,\\n \\"PoolId\\": 0,\\n \\"Status\\": \\"healthy\\",\\n \\"Reason\\": \\"TCP connection error\\",\\n \\"PoolType\\": \\"default_pool\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListLoadBalancerRegions' => [ + 'summary' => '查询负载均衡器一/二级区域信息，获取可用于配置负载均衡器“基于国家/区域调度”策略的地理区域代码、含义等基本信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239637', + 'abilityTreeNodes' => [ + 'FEATUREdcdnWQK30N', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + ], + ], + ], + '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' => '81A5E222-24BF-17EF-9E80-A68D9B8F363D', + ], + 'Regions' => [ + 'description' => '区域信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '区域信息', + 'type' => 'object', + 'properties' => [ + 'RegionCode' => [ + 'description' => '一级区域代码', + 'type' => 'string', + 'example' => 'SEAS', + ], + 'RegionEnName' => [ + 'description' => '一级区域英文全称', + 'type' => 'string', + 'example' => 'South East Asia', + ], + 'RegionCnName' => [ + 'description' => '一级区域中文全称', + 'type' => 'string', + 'example' => '东南亚', + ], + 'SubRegions' => [ + 'description' => '二级区域信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '二级区域信息', + 'type' => 'object', + 'properties' => [ + 'SubRegionCode' => [ + 'description' => '二级区域代码', + 'type' => 'string', + 'example' => 'ID', + ], + 'SubRegionEnName' => [ + 'description' => '二级区域英文全称', + 'type' => 'string', + 'example' => 'Indonesia', + ], + 'SubRegionCnName' => [ + 'description' => '一级区域中文全称', + 'type' => 'string', + 'example' => '印度尼西亚', + ], + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '单页记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'TotalCount' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '记录总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'TotalPage' => [ + 'description' => '记录总页数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'QueryDBError', + 'errorMessage' => 'An internal exception occurred when query data, please try again later.', + 'description' => '查询数据时发生内部错误，请稍后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询负载均衡器区域信息', + 'description' => '通过 OpenAPI 创建负载均衡器“基于国家/区域调度”策略时，使用一级或二级区域的代码表示从此地理区域来源的流量。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListLoadBalancerRegions', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListLoadBalancerRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81A5E222-24BF-17EF-9E80-A68D9B8F363D\\",\\n \\"Regions\\": [\\n {\\n \\"RegionCode\\": \\"SEAS\\",\\n \\"RegionEnName\\": \\"South East Asia\\",\\n \\"RegionCnName\\": \\"东南亚\\",\\n \\"SubRegions\\": [\\n {\\n \\"SubRegionCode\\": \\"ID\\",\\n \\"SubRegionEnName\\": \\"Indonesia\\",\\n \\"SubRegionCnName\\": \\"印度尼西亚\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1024,\\n \\"TotalCount\\": 12,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListLoadBalancers' => [ + 'summary' => '查询站点下负载均衡器列表，返回站点下的负载均衡器信息。可以根据负载均衡器名称查询，支持分页。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238617', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，第几页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页大小，取值范转1-500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器名称，可以根据名称查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'lb.example.com', + ], + ], + [ + 'name' => 'MatchType', + 'in' => 'query', + 'schema' => [ + 'description' => '根据名称查询时，名称匹配策略：'."\n" + ."\n" + .'- fuzzy：模糊匹配；'."\n" + .'- exact：全匹配，等值查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，现在只支持按id排序，id表示按id升序，-id表示按id降序，id大小和创建时间正相关，不传时默认按id降序排列。', + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21655860979****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'LoadBalancers' => [ + 'description' => '数组格式，返回负载均衡器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '负载均衡器详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '负载均衡器的唯一标识ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '998676487607104', + ], + 'Name' => [ + 'description' => '负载均衡器的名称。', + 'type' => 'string', + 'example' => 'lb.example.com'."\n", + ], + 'SiteId' => [ + 'description' => '负载均衡器所归属的站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1159101787****', + ], + 'Enabled' => [ + 'description' => '负载均衡器是否启用。'."\n" + ."\n" + .'- true：启用。'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Ttl' => [ + 'description' => 'TTL值，DNS记录的生存时间，默认为30。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'SessionAffinity' => [ + 'description' => '会话保持，取值：'."\n" + .'- off：不开启。'."\n" + .'- ip：按IP方式会话保持。'."\n" + .'- cookie: 按cookie方式会话保持。', + 'type' => 'string', + 'example' => 'ip', + ], + 'FallbackPool' => [ + 'description' => '兜底地址池ID，当所有其他地址池不可用时，流量将被重定向至此地址池。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '96228666776****', + ], + 'SteeringPolicy' => [ + 'description' => '负载均衡策略。', + 'type' => 'string', + 'example' => 'order', + ], + 'Description' => [ + 'description' => '负载均衡器的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'AdaptiveRouting' => [ + 'description' => '跨地址池回源配置。', + 'type' => 'object', + 'properties' => [ + 'FailoverAcrossPools' => [ + 'description' => '是否跨地址池回源。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false: 否。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'DefaultPools' => [ + 'description' => '默认地址池ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '默认地址池。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '96228666776****', + ], + ], + 'RandomSteering' => [ + 'description' => '加权轮询配置，用于控制不同地址池的流量分配权重。', + 'type' => 'object', + 'properties' => [ + 'DefaultWeight' => [ + 'description' => '各后端服务器池的权重配置，键为池ID，值为权重系数。权重系数表示相对流量分配的比例。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50'."\n", + ], + 'PoolWeights' => [ + 'description' => '各后端服务器池的权重配置，键为池ID，值为权重系数。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => '权重的值，0-100的数字，0表示不往该源服务器调度流量。', + 'example' => '50'."\n", + ], + ], + ], + ], + 'Rules' => [ + 'description' => '规则配置列表，用于定义特定条件下的行为。', + 'type' => 'array', + 'items' => [ + 'description' => '规则集中的规则配置。', + 'type' => 'object', + 'properties' => [ + 'FixedResponse' => [ + 'description' => '匹配规则后执行响应指定内容。', + 'type' => 'object', + 'properties' => [ + 'ContentType' => [ + 'description' => 'HTTP Header中的Content-Type字段。', + 'type' => 'string', + 'example' => 'application/json'."\n", + ], + 'Location' => [ + 'description' => 'http返回中的location字段。', + 'type' => 'string', + 'example' => 'http://www.example.com/index.html'."\n", + ], + 'MessageBody' => [ + 'description' => '响应body值。', + 'type' => 'string', + 'example' => 'Hello World.'."\n", + ], + 'StatusCode' => [ + 'description' => '状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + 'Overrides' => [ + 'description' => '匹配规则后修改对应请求改写的负载均衡配置，配置的字段，会覆盖负载均衡器配置里相应的字段。', + 'type' => 'any', + 'example' => '{'."\n" + .' "adaptive_routing": {'."\n" + .' "failover_across_pools": true'."\n" + .' },'."\n" + .' "sub_region_pools": {'."\n" + .' "GB": ['."\n" + .' 96228666776****'."\n" + .' ],'."\n" + .' "US": ['."\n" + .' 96228666776****'."\n" + .' ]'."\n" + .' },'."\n" + .' "default_pools": ['."\n" + .' 96228666776****,'."\n" + .' 96228666776****'."\n" + .' ],'."\n" + .' "fallback_pool": 96228666776****,'."\n" + .' "location_strategy": {'."\n" + .' "mode": "resolver_ip",'."\n" + .' "prefer_ecs": "always"'."\n" + .' },'."\n" + .' "random_steering": {'."\n" + .' "default_weight": 30,'."\n" + .' "pool_weights": {'."\n" + .' "96228666776****": 70,'."\n" + .' "96228666776****": 80'."\n" + .' }'."\n" + .' },'."\n" + .' "region_pools": {'."\n" + .' "ENAM": ['."\n" + .' 96228666776****,'."\n" + .' 92843536908****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 92843536908****'."\n" + .' ]'."\n" + .' },'."\n" + .' "session_affinity": "cookie",'."\n" + .' "session_affinity_attributes": {'."\n" + .' "drain_duration": 100,'."\n" + .' "headers": ["none"],'."\n" + .' "require_all_headers": false,'."\n" + .' "samesite": "Auto",'."\n" + .' "secure": "Auto",'."\n" + .' "zero_downtime_failover": "sticky"'."\n" + .' },'."\n" + .' "session_affinity_ttl": 1800,'."\n" + .' "steering_policy": "dynamic_latency",'."\n" + .' "ttl": 30'."\n" + .' }', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => 'http.request.uri.path contains "/testing"'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'r2', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越大越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Terminates' => [ + 'description' => '是否终止执行后续规则。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否，默认值。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'Monitor' => [ + 'description' => '监视器配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监视器协议类型，如HTTP，用于健康检查，值为off时，表示不进行检查。', + 'type' => 'string', + 'example' => 'HTTP'."\n", + ], + 'Method' => [ + 'description' => '应用的健康检查的方法。', + 'type' => 'string', + 'example' => 'GET'."\n", + ], + 'Port' => [ + 'description' => '目标端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80'."\n", + ], + 'Path' => [ + 'description' => '路径。', + 'type' => 'string', + 'example' => '/'."\n", + ], + 'Interval' => [ + 'description' => '应用健康检查的间隔时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'ExpectedCodes' => [ + 'description' => '预期状态码，如200,202，成功的HTTP响应。', + 'type' => 'string', + 'example' => '200,202'."\n", + ], + 'FollowRedirects' => [ + 'description' => '是否跟随重定向。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConsecutiveUp' => [ + 'description' => '连续探测多少次成功算成功，如3。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ConsecutiveDown' => [ + 'description' => '连续探测多少次失败算失败，如5。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Header' => [ + 'description' => '探测时所带头部信息，HTTP头。', + 'type' => 'any', + 'example' => '{'."\n" + .' "host": ['."\n" + .' "example1.com",'."\n" + .' "example2.com"'."\n" + .' ]'."\n" + .' }', + ], + 'Timeout' => [ + 'description' => '应用健康检查超时时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'MonitoringRegion' => [ + 'description' => '探测点所在区域，默认为Global，'."\n" + ."\n" + .'- Global: 全球。'."\n" + .'- ChineseMainland: 中国内地。'."\n" + .'- OutsideChineseMainland: 全球（不包括中国内地）。', + 'type' => 'string', + 'example' => 'Global', + ], + ], + ], + 'Status' => [ + 'description' => '负载均衡器的状态。', + 'type' => 'string', + 'example' => 'healthy', + ], + 'SubRegionPools' => [ + 'description' => '二级region对应的地址池，多个二级region共用一批地址池时，可以多个二级region，使用逗号拼接作为key。', + 'type' => 'any', + 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', + ], + 'RegionPools' => [ + 'description' => '一级region对应的地址池。', + 'type' => 'any', + 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码，同请求参数的PageNumber。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '查询站点下负载均衡器', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-16T02:25:11.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-02-13T01:34:54.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListLoadBalancers', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListLoadBalancers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"LoadBalancers\\": [\\n {\\n \\"Id\\": 998676487607104,\\n \\"Name\\": \\"lb.example.com\\\\n\\",\\n \\"SiteId\\": 0,\\n \\"Enabled\\": false,\\n \\"Ttl\\": 30,\\n \\"SessionAffinity\\": \\"ip\\",\\n \\"FallbackPool\\": 0,\\n \\"SteeringPolicy\\": \\"order\\",\\n \\"Description\\": \\"test\\",\\n \\"AdaptiveRouting\\": {\\n \\"FailoverAcrossPools\\": true\\n },\\n \\"DefaultPools\\": [\\n 0\\n ],\\n \\"RandomSteering\\": {\\n \\"DefaultWeight\\": 50,\\n \\"PoolWeights\\": {\\n \\"key\\": 50\\n }\\n },\\n \\"Rules\\": [\\n {\\n \\"FixedResponse\\": {\\n \\"ContentType\\": \\"application/json\\\\n\\",\\n \\"Location\\": \\"http://www.example.com/index.html\\\\n\\",\\n \\"MessageBody\\": \\"Hello World.\\\\n\\",\\n \\"StatusCode\\": 200\\n },\\n \\"Overrides\\": \\"{\\\\n \\\\\\"adaptive_routing\\\\\\": {\\\\n \\\\\\"failover_across_pools\\\\\\": true\\\\n },\\\\n \\\\\\"sub_region_pools\\\\\\": {\\\\n \\\\\\"GB\\\\\\": [\\\\n 96228666776****\\\\n ],\\\\n \\\\\\"US\\\\\\": [\\\\n 96228666776****\\\\n ]\\\\n },\\\\n \\\\\\"default_pools\\\\\\": [\\\\n 96228666776****,\\\\n 96228666776****\\\\n ],\\\\n \\\\\\"fallback_pool\\\\\\": 96228666776****,\\\\n \\\\\\"location_strategy\\\\\\": {\\\\n \\\\\\"mode\\\\\\": \\\\\\"resolver_ip\\\\\\",\\\\n \\\\\\"prefer_ecs\\\\\\": \\\\\\"always\\\\\\"\\\\n },\\\\n \\\\\\"random_steering\\\\\\": {\\\\n \\\\\\"default_weight\\\\\\": 30,\\\\n \\\\\\"pool_weights\\\\\\": {\\\\n \\\\\\"96228666776****\\\\\\": 70,\\\\n \\\\\\"96228666776****\\\\\\": 80\\\\n }\\\\n },\\\\n \\\\\\"region_pools\\\\\\": {\\\\n \\\\\\"ENAM\\\\\\": [\\\\n 96228666776****,\\\\n 92843536908****\\\\n ],\\\\n \\\\\\"WNAM\\\\\\": [\\\\n 92843536908****\\\\n ]\\\\n },\\\\n \\\\\\"session_affinity\\\\\\": \\\\\\"cookie\\\\\\",\\\\n \\\\\\"session_affinity_attributes\\\\\\": {\\\\n \\\\\\"drain_duration\\\\\\": 100,\\\\n \\\\\\"headers\\\\\\": [\\\\\\"none\\\\\\"],\\\\n \\\\\\"require_all_headers\\\\\\": false,\\\\n \\\\\\"samesite\\\\\\": \\\\\\"Auto\\\\\\",\\\\n \\\\\\"secure\\\\\\": \\\\\\"Auto\\\\\\",\\\\n \\\\\\"zero_downtime_failover\\\\\\": \\\\\\"sticky\\\\\\"\\\\n },\\\\n \\\\\\"session_affinity_ttl\\\\\\": 1800,\\\\n \\\\\\"steering_policy\\\\\\": \\\\\\"dynamic_latency\\\\\\",\\\\n \\\\\\"ttl\\\\\\": 30\\\\n }\\",\\n \\"Rule\\": \\"http.request.uri.path contains \\\\\\"/testing\\\\\\"\\\\n\\",\\n \\"RuleName\\": \\"r2\\",\\n \\"RuleEnable\\": \\"on\\",\\n \\"Sequence\\": 1,\\n \\"Terminates\\": true\\n }\\n ],\\n \\"Monitor\\": {\\n \\"Type\\": \\"HTTP\\\\n\\",\\n \\"Method\\": \\"GET\\\\n\\",\\n \\"Port\\": 80,\\n \\"Path\\": \\"/\\\\n\\",\\n \\"Interval\\": 60,\\n \\"ExpectedCodes\\": \\"200,202\\\\n\\",\\n \\"FollowRedirects\\": true,\\n \\"ConsecutiveUp\\": 3,\\n \\"ConsecutiveDown\\": 5,\\n \\"Header\\": \\"{\\\\n \\\\\\"host\\\\\\": [\\\\n \\\\\\"example1.com\\\\\\",\\\\n \\\\\\"example2.com\\\\\\"\\\\n ]\\\\n }\\",\\n \\"Timeout\\": 5,\\n \\"MonitoringRegion\\": \\"Global\\"\\n },\\n \\"Status\\": \\"healthy\\",\\n \\"SubRegionPools\\": \\"{\\\\\\"AL,MO\\\\\\": [92298024898****],\\\\\\"CN-SH,CN-SX,CN-SC\\\\\\":[92304347804****,92843536908****]}\\",\\n \\"RegionPools\\": \\"{\\\\n \\\\\\"ENAM\\\\\\": [\\\\n 12345678****\\\\n ],\\\\n \\\\\\"WNAM\\\\\\": [\\\\n 23456789****,\\\\n 23456789****\\\\n ]\\\\n}\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"TotalPage\\": 10\\n}","type":"json"}]', + ], + 'ListManagedRulesGroups' => [ + 'summary' => '列举用户账户下所有WAF托管规则组。用户可以通过此接口获取所有规则组的列表以及它们的概要信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239646', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页面号码', + 'description' => '页面号码，用于指定分页查询的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页面大小', + 'description' => '页面大小，用于指定分页查询的每页数量。', + 'type' => 'integer', + 'format' => 'int32', + '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。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'TotalCount' => [ + 'title' => '过滤后的总记录数', + 'description' => '过滤后的总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ManagedRulesGroups' => [ + 'title' => '托管规则组信息列表', + 'description' => '托管规则组信息列表。', + 'type' => 'array', + 'items' => [ + 'title' => '托管规则组信息', + 'description' => '托管规则组信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '托管规则组名称', + 'description' => '托管规则组名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'RuleCount' => [ + 'description' => '托管规则组内规则个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '页面号码', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小', + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列举WAF托管规则组', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-26T15:07:29.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-29T05:46:33.000Z', + 'description' => '请求参数发生变更、响应参数发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:56:37.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListManagedRulesGroups', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListManagedRulesGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"TotalCount\\": 5,\\n \\"ManagedRulesGroups\\": [\\n {\\n \\"Name\\": \\"example\\",\\n \\"RuleCount\\": 1000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', + ], + 'ListNetworkOptimizations' => [ + 'summary' => '查询多条网络优化配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257562', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1231231221****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3528160969****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。'."\n" + ."\n" + .'该参数可以不传，不传时不区分全局或者规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名，可以查出规则名为所传字段的那条规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'Configs' => [ + 'description' => '返回体配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395386449776640', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'SmartRouting' => [ + 'description' => '是否开启智能路由服务，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Http2Origin' => [ + 'description' => '是否开启HTTP2回源，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Websocket' => [ + 'description' => '是否开启Websocket，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Grpc' => [ + 'description' => '是否开启GRPC，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'UploadMaxFilesize' => [ + 'description' => '最大上传文件大小，单位是MB，取值范围：100～500。', + 'type' => 'string', + 'example' => '500', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询网络优化配置列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListNetworkOptimizations', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListNetworkOptimizations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 395386449776640,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"SmartRouting\\": \\"on\\",\\n \\"Http2Origin\\": \\"on\\",\\n \\"Websocket\\": \\"on\\",\\n \\"Grpc\\": \\"on\\",\\n \\"UploadMaxFilesize\\": \\"500\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + ], + 'ListOriginCaCertificates' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261742', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**20**， 取值：**1~500**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + 'TotalCount' => [ + 'description' => '总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Result' => [ + 'description' => '结果。', + 'type' => 'array', + 'items' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'upload', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-11-26T16:00:00Z', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-06-24 07:48:51', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-07-20 06:18:42', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d**', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => 'ListOriginCaCertificates', + 'summary' => '查询源服务器CA证书列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListOriginCaCertificates', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListOriginCaCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"upload\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"NotBefore\\": \\"2023-11-26T16:00:00Z\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-06-24 07:48:51\\",\\n \\"UpdateTime\\": \\"2024-07-20 06:18:42\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListOriginClientCertificates' => [ + 'summary' => '查询域名粒度回源客户端证书列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261754', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + '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' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3558df77-8a7a-4060-a900-2d7949403836', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Result' => [ + 'description' => '证书信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'upload', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'DigiCert', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-06-24 07:48:51', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-07-20 06:18:42', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d**', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', + ], + 'Hostnames' => [ + 'description' => '绑定的域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'title' => '查询域名粒度回源客户端证书列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListOriginClientCertificates', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListOriginClientCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3558df77-8a7a-4060-a900-2d7949403836\\",\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"upload\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"DigiCert\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-06-24 07:48:51\\",\\n \\"UpdateTime\\": \\"2024-07-20 06:18:42\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\",\\n \\"Hostnames\\": [\\n \\"www.example.com\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListOriginPools' => [ + 'summary' => '查询站点下所有源地址池，支持分页，可以按源地址名称精确查询、模糊查询。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238398', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '页面大小，大于0的整数，最大500，超过500会置为500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '源地址池名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'pool1', + ], + ], + [ + 'name' => 'MatchType', + 'in' => 'query', + 'schema' => [ + 'description' => '按名称匹配查询类型，支持以下2种类型，默认为精确查询。'."\n" + ."\n" + .'- fuzzy：模糊查询。'."\n" + .'- exact：精确查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'exact', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序，支持按ID的升序、降序，默认按ID降序，ID和创建时间正相关。'."\n" + ."\n" + .'- id: 按ID降序。'."\n" + .'- id: 按ID升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '151538882642832', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'OriginPools' => [ + 'description' => '源地址池列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源地址池信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '源地址池ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1038520525196928', + ], + 'Name' => [ + 'description' => '源地址池名称，一个站点下源地址池名称唯一。', + 'type' => 'string', + 'example' => 'pool1', + ], + 'SiteId' => [ + 'description' => '源地址池所属的站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '216558609793952', + ], + 'RecordName' => [ + 'description' => '为源地址池分配的域名，可以用来作站点下记录的源站地址。', + 'type' => 'string', + 'example' => 'pool1.example.com'."\n", + ], + 'Enabled' => [ + 'description' => '源地址池是否启用：'."\n" + ."\n" + .'- true: 启用；'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'References' => [ + 'description' => '源地址池被引用信息，源地址池被负载均衡器配置或者被记录配置为源站时，被认为是引用。', + 'type' => 'object', + 'properties' => [ + 'LoadBalancers' => [ + 'description' => '使用此源地址池的负载均衡器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '使用此源地址池的负载均衡器信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '负载均衡器名字。', + 'type' => 'string', + 'example' => 'lb1.example.com'."\n", + ], + 'Id' => [ + 'description' => '负载均衡器ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '998740660522624'."\n", + ], + ], + ], + ], + 'DnsRecords' => [ + 'description' => '使用此源地址池为源站的七层记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '使用此源地址池为源站的七层记录信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'www.example.com'."\n", + ], + 'Id' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1042852886352704', + ], + ], + ], + ], + 'IPARecords' => [ + 'description' => '使用此源地址池为源站的四层记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '使用此源地址池为源站的四层记录信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'ipa.example.com'."\n", + ], + 'Id' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1042852886352704'."\n", + ], + ], + ], + ], + ], + ], + 'ReferenceLBCount' => [ + 'description' => '被多少个负载均衡器引用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Origins' => [ + 'description' => '源地址池里添加的源站信息。', + 'type' => 'array', + 'items' => [ + 'description' => '源地址池里添加的源站信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '源站ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '997502094872132', + ], + 'Name' => [ + 'description' => '源站名称。', + 'type' => 'string', + 'example' => 'origin1', + ], + 'Address' => [ + 'description' => '源站地址，如：www.example.com。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'Enabled' => [ + 'description' => '源站是否启用：'."\n" + ."\n" + .'- true: 启用；'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Weight' => [ + 'description' => '权重，0-100的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Type' => [ + 'description' => '源站类型：'."\n" + ."\n" + .'- ip_domain: ip或域名类型源站；'."\n" + .'- OSS：OSS地址源站；'."\n" + .'- S3：AWS S3源站。', + 'type' => 'string', + 'example' => 'S3', + ], + 'Header' => [ + 'description' => '回源时带的请求头，只支持Host。', + 'type' => 'any', + 'example' => '{'."\n" + .' "Host": ['."\n" + .' "example.com"'."\n" + .' ]'."\n" + .' }', + ], + 'AuthConf' => [ + 'description' => '鉴权信息，源站为OSS或者S3等源站需要鉴权时，需要传鉴权相关配置信息。', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'description' => '鉴权类型。'."\n" + ."\n" + .'- public：公共读写，源站为OSS或S3且为公共读写时使用；'."\n" + .'- private_same_account：私有同账号，源站为OSS，且鉴权类型为同账号私有鉴权时使用；'."\n" + .'- private_cross_account：私有跨账号，源站为OSS，且鉴权类型为跨账号私有鉴权时使用；'."\n" + .'- private：源站为S3，且鉴权类型为私有时使用。', + 'type' => 'string', + 'example' => 'public', + ], + 'AccessKey' => [ + 'description' => '私有鉴权时需要传的AccessKey。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'SecretKey' => [ + 'description' => '私有鉴权时需要传的SecretKey。', + 'type' => 'string', + 'example' => 'yourAccessKeySecret', + ], + 'Version' => [ + 'description' => '源站为AWS S3时需要传的签名版本。', + 'type' => 'string', + 'example' => 'v2', + ], + 'Region' => [ + 'description' => '源站为AWS S3时需要传的源站Region。', + 'type' => 'string', + 'example' => 'us-east-1'."\n", + ], + ], + ], + 'IpVersionPolicy' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.Coverage', + 'errorMessage' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', + 'description' => '您选择的加速区域不在当前套餐支持范围内，请更换为套餐支持的加速区域后重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询源地址池列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListOriginPools', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListOriginPools', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"OriginPools\\": [\\n {\\n \\"Id\\": 1038520525196928,\\n \\"Name\\": \\"pool1\\",\\n \\"SiteId\\": 216558609793952,\\n \\"RecordName\\": \\"pool1.example.com\\\\n\\",\\n \\"Enabled\\": false,\\n \\"References\\": {\\n \\"LoadBalancers\\": [\\n {\\n \\"Name\\": \\"lb1.example.com\\\\n\\",\\n \\"Id\\": 998740660522624\\n }\\n ],\\n \\"DnsRecords\\": [\\n {\\n \\"Name\\": \\"www.example.com\\\\n\\",\\n \\"Id\\": 1042852886352704\\n }\\n ],\\n \\"IPARecords\\": [\\n {\\n \\"Name\\": \\"ipa.example.com\\\\n\\",\\n \\"Id\\": 1042852886352704\\n }\\n ]\\n },\\n \\"ReferenceLBCount\\": 5,\\n \\"Origins\\": [\\n {\\n \\"Id\\": 997502094872132,\\n \\"Name\\": \\"origin1\\",\\n \\"Address\\": \\"www.example.com\\",\\n \\"Enabled\\": true,\\n \\"Weight\\": 50,\\n \\"Type\\": \\"S3\\",\\n \\"Header\\": \\"{\\\\n \\\\\\"Host\\\\\\": [\\\\n \\\\\\"example.com\\\\\\"\\\\n ]\\\\n }\\",\\n \\"AuthConf\\": {\\n \\"AuthType\\": \\"public\\",\\n \\"AccessKey\\": \\"yourAccessKeyID\\",\\n \\"SecretKey\\": \\"yourAccessKeySecret\\",\\n \\"Version\\": \\"v2\\",\\n \\"Region\\": \\"us-east-1\\\\n\\"\\n },\\n \\"IpVersionPolicy\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 10\\n}","type":"json"}]', + ], + 'ListOriginRules' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257559', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。'."\n" + ."\n" + .'该参数可以不传，不传时不区分全局或者规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'Configs' => [ + 'description' => '返回体配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '395386449776640', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'OriginHost' => [ + 'description' => '回源请求中携带的HOST。', + 'type' => 'string', + 'example' => 'origin.example.com'."\n", + ], + 'OriginScheme' => [ + 'description' => '回源请求使用的协议。取值范围：'."\n" + .'- http：使用HTTP协议回源。'."\n" + .'- https：使用HTTPS协议回源。'."\n" + .'- follow：跟随客户端协议回源。', + 'type' => 'string', + 'example' => 'http', + ], + 'OriginSni' => [ + 'description' => '回源请求中携带的SNI。', + 'type' => 'string', + 'example' => 'origin.example.com', + ], + 'DnsRecord' => [ + 'description' => '改写回源请求的DNS解析记录。', + 'type' => 'string', + 'example' => 'test.example.com'."\n", + ], + 'OriginHttpPort' => [ + 'description' => '使用HTTP协议回源时访问的源站端口。', + 'type' => 'string', + 'example' => '8080', + ], + 'OriginHttpsPort' => [ + 'description' => '使用HTTPS协议回源时访问的源站端口。', + 'type' => 'string', + 'example' => '4433', + ], + 'Range' => [ + 'description' => '使用range分片方式回源下载文件。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭'."\n" + .'- force：强制', + 'type' => 'string', + 'example' => 'on', + ], + 'OriginMtls' => [ + 'description' => 'mtls开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'OriginVerify' => [ + 'description' => '源站证书校验开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'RangeChunkSize' => [ + 'description' => 'range分片大小。', + 'type' => 'string', + 'example' => '1MB', + ], + 'OriginReadTimeout' => [ + 'description' => '源站读超时时间(秒)。', + 'type' => 'string', + 'example' => '10', + ], + 'Follow302Enable' => [ + 'description' => '回源302跟随开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Follow302MaxTries' => [ + 'description' => '302跟随次数上限，取值范围[1-5]。', + 'type' => 'string', + 'example' => '1', + ], + 'Follow302RetainArgs' => [ + 'description' => '保留原始请求参数开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Follow302RetainHeader' => [ + 'description' => '保留原始请求头开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Follow302TargetHost' => [ + 'description' => '修改302后的回源host。', + 'type' => 'string', + 'example' => 'test.com', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询站点回源规则配置列表', + 'summary' => '查询多条回源规则配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-17T08:47:33.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-04-01T01:57:04.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-03-20T05:57:46.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-02-27T09:16:40.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListOriginRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListOriginRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 395386449776640,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"OriginHost\\": \\"origin.example.com\\\\n\\",\\n \\"OriginScheme\\": \\"http\\",\\n \\"OriginSni\\": \\"origin.example.com\\",\\n \\"DnsRecord\\": \\"test.example.com\\\\n\\",\\n \\"OriginHttpPort\\": \\"8080\\",\\n \\"OriginHttpsPort\\": \\"4433\\",\\n \\"Range\\": \\"on\\",\\n \\"OriginMtls\\": \\"on\\",\\n \\"OriginVerify\\": \\"on\\",\\n \\"RangeChunkSize\\": \\"1MB\\",\\n \\"OriginReadTimeout\\": \\"10\\",\\n \\"Follow302Enable\\": \\"on\\",\\n \\"Follow302MaxTries\\": \\"1\\",\\n \\"Follow302RetainArgs\\": \\"on\\",\\n \\"Follow302RetainHeader\\": \\"on\\",\\n \\"Follow302TargetHost\\": \\"test.com\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + ], + 'ListPages' => [ + 'summary' => '列举用户已创建的所有自定义响应页面。该接口提供了分页功能，支持根据页码和页大小获取响应页面列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239580', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'QueryArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询参数，以JSON格式传递，包含各种筛选条件。', + 'type' => 'object', + 'properties' => [ + 'NameDescriptionLike' => [ + 'description' => '模糊查询自定义页面的名称或者描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页面号码', + 'description' => '页面号码，取值范围为：**1~100000**，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页面大小', + 'description' => '页面大小，默认20。', + 'type' => 'integer', + 'format' => 'int32', + '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。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Usage' => [ + 'title' => '用户已创建的自定义响应页面的数量', + 'description' => '用户已创建的自定义响应页面的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '本页的自定义响应页面数量', + 'description' => '过滤后的自定义响应页面数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Pages' => [ + 'title' => '数组，返回示例目录。', + 'description' => '自定义响应页面数组。数组中的每个对象包含页面的具体信息。', + 'type' => 'array', + 'items' => [ + 'title' => 'WafPageItemType', + 'description' => 'WafPageItemType', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'title' => '修改时间', + 'description' => '自定义响应页面的最后修改时间。', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00Z', + ], + 'Id' => [ + 'title' => '自定义响应页面的ID', + 'description' => '自定义响应页面的ID，可通过调用[ListPages](~~2850223~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000001', + ], + 'Name' => [ + 'title' => '自定义响应页面的名称', + 'description' => '自定义响应页面的名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'Kind' => [ + 'title' => '自定义响应页面的类型', + 'description' => '自定义响应页面的类型。', + 'type' => 'string', + 'example' => 'custom', + ], + 'Description' => [ + 'title' => '自定义响应页面描述', + 'description' => '自定义响应页面描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'a custom deny page', + 'maxLength' => 1024, + 'pattern' => '', + 'default' => '', + ], + 'ContentType' => [ + 'title' => 'HTTP Header中的Content-Type字段，如：text/html、application/json', + 'description' => 'HTTP Header中的Content-Type字段。', + 'type' => 'string', + 'required' => true, + 'example' => 'text/html', + 'pattern' => '', + 'default' => '', + ], + 'Content' => [ + 'title' => 'BASE64编码后的 Content-Type 对应的响应页面内容', + 'description' => 'BASE64编码后的Content-Type对应的响应页面内容。', + 'type' => 'string', + 'required' => true, + 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', + 'pattern' => '', + 'default' => '', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '页面号码', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小', + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列举自定义响应页面', + 'changeSet' => [ + [ + 'createdAt' => '2025-01-09T06:24:33.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:48.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:56:37.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListPages', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListPages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Usage\\": 10,\\n \\"TotalCount\\": 10,\\n \\"Pages\\": [\\n {\\n \\"UpdateTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"Id\\": 50000001,\\n \\"Name\\": \\"example\\",\\n \\"Kind\\": \\"custom\\",\\n \\"Description\\": \\"a custom deny page\\",\\n \\"ContentType\\": \\"text/html\\",\\n \\"Content\\": \\"PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', + ], + 'ListRecords' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239634', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => [ + 'description' => '记录名称。用于查询的过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'RecordMatchType', + 'in' => 'query', + 'schema' => [ + 'description' => '记录名称的搜索匹配模式。默认为精确匹配，取值：'."\n" + ."\n" + .'- **prefix**：前缀匹配。'."\n" + .'- **suffix**：后缀匹配。'."\n" + .'- **exact**：精确匹配。'."\n" + .'- **fuzzy**：模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '记录的源站类型，用于查询的过滤条件（仅CNAME记录可以通过该字段筛选），取值：'."\n" + .'- **OSS**：OSS源站。'."\n" + .'- **S3**：S3源站。'."\n" + .'- **LB**：负载均衡器源站。'."\n" + .'- **OP**：源地址池源站。'."\n" + .'- **Domain**：普通域名源站。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'BizName', + 'in' => 'query', + 'schema' => [ + 'description' => '记录加速时的业务场景，用于查询的过滤条件，取值：'."\n" + .'- **image_video**：视频图片。'."\n" + .'- **api**：api接口。'."\n" + .'- **web**：web网页。', + 'type' => 'string', + 'required' => false, + 'example' => 'web', + ], + ], + [ + 'name' => 'Proxied', + 'in' => 'query', + 'schema' => [ + 'description' => '记录是否开启代理加速，用于查询的过滤条件。取值：'."\n" + ."\n" + .'- **true**：开启代理。'."\n" + .'- **false**：关闭代理加速。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '记录的DNS记录类型，用于查询的过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'CNAME', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Records' => [ + 'description' => '记录的DNS信息，详情请参考[说明文档](~~2708761~~)[说明文档](https://www.alibabacloud.com/help/doc-detail/2708761.html)。', + 'type' => 'array', + 'items' => [ + 'description' => '单个记录信息。', + 'type' => 'object', + 'properties' => [ + 'BizName' => [ + 'description' => '记录加速时的业务场景，取值：'."\n" + .'- **image_video**：视频图片。'."\n" + .'- **api**：api接口。'."\n" + .'- **web**：web网页。', + 'type' => 'string', + 'example' => 'web', + ], + 'Data' => [ + 'description' => '记录的具体DNS信息。不同类型记录包含不同的信息。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '记录值或部分内容。A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI记录含有该参数。在不同类型的记录中，分别表示不同的含义：'."\n" + ."\n" + .'- **A/AAAA**：指向的ip地址。多个ip时，用半角逗号,分隔。至少需要有一个ipv4地址。'."\n" + .'- **CNAME**：指向的目标域名。'."\n" + .'- **NS**：指定域名的名称服务器。'."\n" + .'- **MX**: 有效的目标邮件服务器域名。'."\n" + .'- **TXT**：有效的文本字符串。'."\n" + .'- **CAA**：有效的证书颁发机构域名。'."\n" + .'- **SRV**：有效的目标主机域名。'."\n" + .'- **URI**: 有效的 URI 字符串。', + 'type' => 'string', + 'example' => 'CNAME', + ], + 'Priority' => [ + 'description' => '记录的优先级，范围为 **0~65535**。数值越小，优先级越高。MX、SRV、URI记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Flag' => [ + 'description' => '记录的标志位。CAA记录的Flag指示其优先级和处理方式，取值范围为**0~255**。CAA记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + 'Tags' => [ + 'type' => 'object', + 'description' => '', + ], + 'Weight' => [ + 'description' => '记录的权重，范围为**0~65535**。SRV、URI记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Port' => [ + 'description' => '记录的端口，范围为**0~65535**。SRV记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Type' => [ + 'description' => '记录的证书类型（在CERT记录中），或公钥类型（在SSHFP记录中）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'KeyTag' => [ + 'description' => '记录的公钥标识，范围为**0~65535**。CERT记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Algorithm' => [ + 'description' => '记录所采用的加密算法，范围为**0~255**。CERT、SSHFP记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Certificate' => [ + 'description' => '记录的公钥证书信息。CERT、SMIMEA和TLSA记录独有。', + 'type' => 'string', + 'example' => 'dGVzdGFkYWxrcw==', + ], + 'Usage' => [ + 'description' => '记录的用途标识，范围为**0~255**。SMIMEA和TLSA记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Selector' => [ + 'description' => '记录所使用的证书或公钥的类型，范围为**0~255**。SMIMEA和TLSA记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MatchingType' => [ + 'description' => '记录用于匹配或验证证书的算法策略，范围为**0~255**。SMIMEA和TLSA记录独有。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Fingerprint' => [ + 'description' => '记录的公钥指纹值。SSHFP记录独有。', + 'type' => 'string', + 'example' => 'abcdef1234567890', + ], + 'Tag' => [ + 'description' => '记录的标签。CAA记录的Tag表示其具体类型和用途。CAA记录独有。', + 'type' => 'string', + 'example' => 'issue', + ], + ], + 'example' => '{"value":"1.1.1.1"}', + ], + 'CreateTime' => [ + 'description' => '记录的创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'UpdateTime' => [ + 'description' => '记录的更新时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-06-07T10:02:59Z', + ], + 'Proxied' => [ + 'description' => '记录是否开启代理加速。取值：'."\n" + ."\n" + .'- **true**：开启代理。'."\n" + .'- **false**：关闭代理加速。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecordId' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'RecordSourceType' => [ + 'description' => 'CNAME记录的源站类型。添加CNAME记录时，需要填写此参数。取值：'."\n" + ."\n" + .'- **OSS**：OSS源站。'."\n" + .'- **S3**：S3源站。'."\n" + .'- **LB**：负载均衡器源站。'."\n" + .'- **OP**：源地址池源站。'."\n" + .'- **Domain**：普通域名源站。'."\n" + ."\n" + .'该参数不传或传空时，则默认为Domain，即普通域名源站类型。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'a.example.com', + ], + 'RecordType' => [ + 'description' => '记录的DNS类型。如**A/AAAA、CNAME、TXT**等。', + 'type' => 'string', + 'example' => 'A/AAAA', + ], + 'SiteId' => [ + 'description' => '记录所属站点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '记录所属站点的名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Ttl' => [ + 'description' => '记录的过期时间，单位秒。当取值为1时，表示记录的过期时间为自动。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'RecordCname' => [ + 'description' => '记录的CNAME。当站点的接入方式为CNAME接入时，需要为记录配置的CNAME值。', + 'type' => 'string', + 'example' => 'a.example.com.cnamezone.com', + ], + 'Comment' => [ + 'description' => '记录的备注。', + 'type' => 'string', + 'example' => 'this is a remark.', + ], + 'AuthConf' => [ + 'description' => 'CNAME记录的源站鉴权信息。', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'description' => '源站鉴权类型，不同的源站类型，支持的鉴权类型不同，源站类型是指本接口中的SourceType参数，现在源站类型为OSS和S3时，需要填写源站鉴权类型，可选值：'."\n" + .'- **public**：公共读，当源站类型为OSS或S3，且源站为公共读时为该参数。'."\n" + .'- **private**: 私有读，当源站类型为S3，且源站为私有读时为该参数。'."\n" + .'- **private_same_account**: 私有同账号读，当源站类型为OSS，在同一个阿里云账号下，且源站为私有读时为该参数。'."\n" + .'- **private_cross_account**: 私有跨账号读，当源站类型为OSS，不在同一个阿里云账号下，且源站为私有读时为该参数。', + 'type' => 'string', + 'example' => 'private', + ], + 'AccessKey' => [ + 'description' => '源站所属账号的AccessKey，当源站类型为OSS且源站鉴权类型为私有跨账号读，或者源站类型为S3且源站鉴权类型为私有读时有该参数。', + 'type' => 'string', + 'example' => 'u0Nkg5gBK***QF5wvKMM504JUHt', + ], + 'SecretKey' => [ + 'description' => '源站所属账号的SecretKey，当源站类型为OSS且源站鉴权类型为私有跨账号读，或者源站类型为S3且源站鉴权类型为私有读时有该参数。', + 'type' => 'string', + 'example' => 'VIxuvJSA2S03f***kp208dy5w7', + ], + 'Version' => [ + 'description' => '签名算法版本，当源站类型为S3且源站鉴权类型为私有读时有该参数，支持以下两种：'."\n" + .'- **v2**'."\n" + .'- **v4**'."\n" + ."\n" + .'不传时，默认为v4。', + 'type' => 'string', + 'example' => 'v4', + ], + 'Region' => [ + 'description' => '源站所属区域，当源站类型为S3时有该参数，源站所属的区域需要在S3的官方网站上获取。', + 'type' => 'string', + 'example' => 'us-east-1', + ], + ], + ], + 'HostPolicy' => [ + 'description' => '回源HOST策略，记录类型为CNAME时生效，设置回源时带HOST的策略，有两种模式：'."\n" + ."\n" + .'- **follow_hostname**: 跟随请求HOST。'."\n" + .'- **follow_origin_domain**: 跟随源站域名。', + 'type' => 'string', + 'example' => 'follow_origin_domain', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询解析记录列表', + 'summary' => '查询站点下解析记录列表，包括记录值、优先级、认证配置等。支持根据记录名称、记录类型等条件进行过滤。', + 'description' => '边缘容器、边缘函数与四层加速对应的DNS解析记录，将不会在此API中返回。', + 'changeSet' => [ + [ + 'createdAt' => '2025-08-21T09:39:51.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-11-19T01:42:00.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-23T08:53:22.000Z', + 'description' => '错误码发生变更、响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRecords', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"Records\\": [\\n {\\n \\"BizName\\": \\"web\\",\\n \\"Data\\": {\\n \\"Value\\": \\"CNAME\\",\\n \\"Priority\\": 0,\\n \\"Flag\\": 128,\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Weight\\": 0,\\n \\"Port\\": 80,\\n \\"Type\\": 0,\\n \\"KeyTag\\": 0,\\n \\"Algorithm\\": 0,\\n \\"Certificate\\": \\"dGVzdGFkYWxrcw==\\",\\n \\"Usage\\": 0,\\n \\"Selector\\": 0,\\n \\"MatchingType\\": 0,\\n \\"Fingerprint\\": \\"abcdef1234567890\\",\\n \\"Tag\\": \\"issue\\"\\n },\\n \\"CreateTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"UpdateTime\\": \\"2023-06-07T10:02:59Z\\",\\n \\"Proxied\\": true,\\n \\"RecordId\\": 1234567890123,\\n \\"RecordSourceType\\": \\"OSS\\",\\n \\"RecordName\\": \\"a.example.com\\",\\n \\"RecordType\\": \\"A/AAAA\\",\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Ttl\\": 30,\\n \\"RecordCname\\": \\"a.example.com.cnamezone.com\\",\\n \\"Comment\\": \\"this is a remark.\\",\\n \\"AuthConf\\": {\\n \\"AuthType\\": \\"private\\",\\n \\"AccessKey\\": \\"u0Nkg5gBK***QF5wvKMM504JUHt\\",\\n \\"SecretKey\\": \\"VIxuvJSA2S03f***kp208dy5w7\\",\\n \\"Version\\": \\"v4\\",\\n \\"Region\\": \\"us-east-1\\"\\n },\\n \\"HostPolicy\\": \\"follow_origin_domain\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListRedirectRules' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257660', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456******', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名，可以查出规则名为所传字段的那条规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '分页大小，默认**500**，取值：**1~500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Configs' => [ + 'description' => '重定向配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '重定向配置详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****'."\n", + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'rule', + ], + 'Type' => [ + 'description' => '重定向类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + 'TargetUrl' => [ + 'description' => '重定向后的目标URL。', + 'type' => 'string', + 'example' => 'http://www.exapmle.com/index.html'."\n", + ], + 'StatusCode' => [ + 'description' => '节点给客户端响应重定向地址时候使用的响应状态码。取值范围：'."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 303'."\n" + .'- 307'."\n" + .'- 308', + 'type' => 'string', + 'example' => '301', + ], + 'ReserveQueryString' => [ + 'description' => '保留查询字符串。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询重定向配置列表', + 'summary' => '查询站点的重定向配置列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRedirectRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListRedirectRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 0,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"rule\\",\\n \\"Type\\": \\"static\\",\\n \\"TargetUrl\\": \\"http://www.exapmle.com/index.html\\\\n\\",\\n \\"StatusCode\\": \\"301\\",\\n \\"ReserveQueryString\\": \\"on\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 10,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListRewriteUrlRules' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257644', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + .'- global：查询全局配置；'."\n" + .'- rule：查询规则配置；'."\n" + ."\n" + .'该参数可以不传，不传时不区分全局或者规则配置。此参数只有在传了functionName参数时才会生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '分页大小。取值：**1~500**，默认为**500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'Configs' => [ + 'description' => '重写URL配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '39538644977****', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.host eq "video.example.com")', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置；'."\n" + .'- rule：规则配置；', + 'type' => 'string', + 'example' => 'global', + ], + 'RewriteUriType' => [ + 'description' => '路径重写类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + 'Uri' => [ + 'description' => '重写后的目标URI。', + 'type' => 'string', + 'example' => '/image.example.com/index.html'."\n", + ], + 'RewriteQueryStringType' => [ + 'description' => '查询字符串重写类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'example' => 'static', + ], + 'QueryString' => [ + 'description' => '重写后的查询字符串。', + 'type' => 'string', + 'example' => 'example=123'."\n", + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询站点的重写URL配置列表', + 'summary' => '查询站点重写URL配置列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRewriteUrlRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListRewriteUrlRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 0,\\n \\"SiteVersion\\": 0,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\"video.example.com\\\\\\")\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"RewriteUriType\\": \\"static\\",\\n \\"Uri\\": \\"/image.example.com/index.html\\\\n\\",\\n \\"RewriteQueryStringType\\": \\"static\\",\\n \\"QueryString\\": \\"example=123\\\\n\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 8,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListRoutineCodeVersions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239374', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数程序名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码。默认值：1，最大取值2。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页大小。 取值：1~20 之间的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'description' => '模糊查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'CodeVersions' => [ + 'description' => 'Routine代码版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单条代码版本信息。', + 'type' => 'object', + 'properties' => [ + 'CodeDescription' => [ + 'description' => '代码版本描述。', + 'type' => 'string', + 'example' => 'test desc', + ], + 'CreateTime' => [ + 'description' => '代码版本创建时间。', + 'type' => 'string', + 'example' => '2024-04-16T09:42:47Z', + ], + 'CodeVersion' => [ + 'description' => '代码版本号。', + 'type' => 'string', + 'example' => '1723599747213377175', + ], + 'Status' => [ + 'description' => '代码版本状态。', + 'type' => 'string', + 'example' => 'Available', + ], + 'ExtraInfo' => [ + 'description' => '代码版本其他信息。', + 'type' => 'string', + 'example' => '{\\"approver\\":[\\"348678\\",\\"111133\\",\\"411544\\"]}', + ], + 'BuildId' => [ + 'description' => '代码版本构建Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25801233', + ], + 'ConfOptions' => [ + 'description' => '代码版本配置项。', + 'type' => 'object', + 'properties' => [ + 'NotFoundStrategy' => [ + 'description' => '代码版本配置项NotFoundStrategy。', + 'type' => 'string', + 'example' => 'SinglePageApplication', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询Routine代码版本列表', + 'summary' => '分页查询指定Routine程序的代码版本信息', + 'description' => '本接口用于查询指定 Routine 程序的代码版本列表，支持分页查询及模糊搜索。用户可以通过设置 `Name` 参数来指定 Routine 程序名，'."\n" + ."\n" + .'通过 `PageNumber` 和 `PageSize` 进行分页控制，以及使用 `SearchKeyWord` 进行关键词模糊匹配查询代码版本描述。'."\n" + ."\n" + .'返回结果将包含每个代码版本的修订号、描述、创建时间等详细信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRoutineCodeVersions', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListRoutineCodeVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"CodeVersions\\": [\\n {\\n \\"CodeDescription\\": \\"test desc\\",\\n \\"CreateTime\\": \\"2024-04-16T09:42:47Z\\",\\n \\"CodeVersion\\": \\"1723599747213377175\\",\\n \\"Status\\": \\"Available\\",\\n \\"ExtraInfo\\": \\"{\\\\\\\\\\\\\\"approver\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"348678\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"111133\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"411544\\\\\\\\\\\\\\"]}\\",\\n \\"BuildId\\": 25801233,\\n \\"ConfOptions\\": {\\n \\"NotFoundStrategy\\": \\"SinglePageApplication\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListRoutineRelatedRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266954', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页大小。 取值：1~20 之间的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'formData', + 'schema' => [ + 'description' => '模糊查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'RelatedRecords' => [ + 'description' => '边缘函数关联记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单条关联记录信息。', + 'type' => 'object', + 'properties' => [ + 'RecordName' => [ + 'description' => '记录名称。', + 'type' => 'string', + 'example' => 'test-record-1.example.com', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '54362329990032', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RecordId' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '509348423011904', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'DependedByOthers', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询边缘函数关联记录列表', + 'summary' => '查询边缘函数关联记录列表。', + 'description' => '用于查询指定边缘函数的关联记录列表，您可以通过设置分页参数来获取部分结果，或者使用模糊关键词来筛选特定的记录条目。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRoutineRelatedRecords', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListRoutineRelatedRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 16,\\n \\"RelatedRecords\\": [\\n {\\n \\"RecordName\\": \\"test-record-1.example.com\\",\\n \\"SiteId\\": 54362329990032,\\n \\"SiteName\\": \\"example.com\\",\\n \\"RecordId\\": 509348423011904\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListRoutineRoutes' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266195', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RoutineName', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + 'Configs' => [ + 'description' => '返回体配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '554889455535696', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'test.com', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****'."\n", + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RouteEnable' => [ + 'description' => '路由开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容。', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RouteName' => [ + 'description' => '路由名称。', + 'type' => 'string', + 'example' => 'test_route', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'RoutineName' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'example' => 'test-routine1'."\n", + ], + 'Bypass' => [ + 'description' => '旁路模式。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Mode' => [ + 'description' => '配置模式。取值范围：'."\n" + .'- simple：简单模式。'."\n" + .'- custom： 自定义模式。', + 'type' => 'string', + 'example' => 'simple', + ], + 'Fallback' => [ + 'description' => '异常回源开关，开启后若函数出现异常如CPU使用超限则请求回源。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '83', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询边缘程序的函数路由列表', + 'summary' => '查询边缘程序的函数路由列表。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-25T05:35:34.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2025-04-08T06:41:11.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRoutineRoutes', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListRoutineRoutes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"Configs\\": [\\n {\\n \\"SiteId\\": 554889455535696,\\n \\"SiteName\\": \\"test.com\\",\\n \\"ConfigId\\": 0,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RouteEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RouteName\\": \\"test_route\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"RoutineName\\": \\"test-routine1\\\\n\\",\\n \\"Bypass\\": \\"on\\",\\n \\"Mode\\": \\"simple\\",\\n \\"Fallback\\": \\"on\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 83,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + ], + 'ListScheduledPreloadExecutions' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239200', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '定时预热任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '665d3af3621bccf3fe29e1a4', + ], + ], + ], + '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' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', + ], + 'Executions' => [ + 'description' => '执行信息。', + 'type' => 'array', + 'items' => [ + 'description' => '执行信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'example' => '66599bd7397885b43804901c', + ], + 'StartTime' => [ + 'description' => '定时预热计划开始时间。', + 'type' => 'string', + 'example' => '2024-05-31T17:10:48.849+08:00', + ], + 'EndTime' => [ + 'description' => '定时预热计划结束时间。', + 'type' => 'string', + 'example' => '2024-05-31T18:10:48.849+08:00', + ], + 'Interval' => [ + 'description' => '定时预热计划每批执行间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'SliceLen' => [ + 'description' => '每批定时预热URL个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Status' => [ + 'description' => '定时预热计划的状态，包括如下状态。'."\n" + .'- **waiting**：等待被执行。'."\n" + .'- **running**：正在执行中。'."\n" + .'- **finished**：执行完成。'."\n" + .'- **failed**：执行失败。'."\n" + .'- **stopped**：暂停执行中。', + 'type' => 'string', + 'example' => 'running', + ], + 'JobId' => [ + 'description' => '预热任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '查询总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出指定定时预热任务下的执行计划', + 'summary' => '根据定时预热任务ID列出指定定时预热任务下的执行计划。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListScheduledPreloadExecutions', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListScheduledPreloadExecutions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ET5BF670-09D5-4D0B-BEBY-D96A2A528000\\",\\n \\"Executions\\": [\\n {\\n \\"Id\\": \\"66599bd7397885b43804901c\\",\\n \\"StartTime\\": \\"2024-05-31T17:10:48.849+08:00\\",\\n \\"EndTime\\": \\"2024-05-31T18:10:48.849+08:00\\",\\n \\"Interval\\": 60,\\n \\"SliceLen\\": 10,\\n \\"Status\\": \\"running\\",\\n \\"JobId\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"AliUid\\": \\"15685865xxx14622\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', + ], + 'ListScheduledPreloadJobs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238775', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '190007158391808', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务创建时间的查询开始时间范围，毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1717225276000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务创建时间的查询截止时间范围，毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1717225277000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '查询的起始位移条数。', + 'description' => '取第几页的数据。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '返回的任务数限制。', + 'description' => '分页大小，每页多少条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'TotalCount' => [ + 'description' => '过滤后的总记录数。', + 'type' => 'string', + 'example' => '5', + ], + 'Jobs' => [ + 'description' => '预热任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '预热任务信息。', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'title' => '阿里云UID', + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + 'CreatedAt' => [ + 'title' => '任务创建时间', + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2024-06-01T08:53:13Z', + ], + 'Domains' => [ + 'title' => '预热域名列表', + 'description' => '预热域名列表。', + 'type' => 'string', + 'example' => 'testurl.com', + ], + 'ErrorInfo' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'invalid domain:test.com', + ], + 'FailedFileOss' => [ + 'title' => '失败文件OSS地址', + 'description' => '失败文件OSS地址。', + 'type' => 'string', + 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', + ], + 'FileId' => [ + 'title' => 'URL列表文件ID（下载时使用）', + 'description' => 'URL列表文件ID（下载时使用）。', + 'type' => 'string', + 'example' => '665d3b48621bccf3fe29e1a7', + ], + 'Id' => [ + 'title' => '任务ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4'."\n", + ], + 'InsertWay' => [ + 'title' => 'URL插入方式', + 'description' => 'URL插入方式。', + 'type' => 'string', + 'example' => 'oss', + 'enum' => [ + 'file', + 'url', + ], + ], + 'Name' => [ + 'title' => '任务名称', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'SiteId' => [ + 'title' => '站点ID', + 'description' => '站点ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '190007158391808', + ], + 'TaskSubmitted' => [ + 'title' => '已提交的cdncm预热任务数', + 'description' => '已提交到系统进行预热任务的URL数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskType' => [ + 'title' => '任务类型（刷新/预热）', + 'description' => '任务类型（刷新/预热）。', + 'type' => 'string', + 'example' => 'preload', + 'enum' => [ + 'preload', + 'refresh', + 'path', + ], + ], + 'UrlCount' => [ + 'title' => 'URL总数', + 'description' => 'URL总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UrlSubmitted' => [ + 'title' => '已提交的URL数', + 'description' => '已提交的URL数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExecutionCount' => [ + 'description' => '预热计划个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'title' => '列出定时预热任务列表', + 'summary' => '列出站点下的定时预热任务列表。', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-13T08:02:14.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListScheduledPreloadJobs', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListScheduledPreloadJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"TotalCount\\": \\"5\\",\\n \\"Jobs\\": [\\n {\\n \\"AliUid\\": \\"15685865xxx14622\\",\\n \\"CreatedAt\\": \\"2024-06-01T08:53:13Z\\",\\n \\"Domains\\": \\"testurl.com\\",\\n \\"ErrorInfo\\": \\"invalid domain:test.com\\",\\n \\"FailedFileOss\\": \\"https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7\\",\\n \\"FileId\\": \\"665d3b48621bccf3fe29e1a7\\",\\n \\"Id\\": \\"665d3af3621bccf3fe29e1a4\\\\n\\",\\n \\"InsertWay\\": \\"oss\\",\\n \\"Name\\": \\"example\\",\\n \\"SiteId\\": 190007158391808,\\n \\"TaskSubmitted\\": 1,\\n \\"TaskType\\": \\"preload\\",\\n \\"UrlCount\\": 2,\\n \\"UrlSubmitted\\": 1,\\n \\"ExecutionCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSiteDeliveryTasks' => [ + 'summary' => '列出所有当前正在实时进行的日志任务投递情况。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238497', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => false, + 'example' => 'dcdn_log_access_l1', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可以通过调用[ListSites](~~2850189~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456***', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**20**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码：默认值：**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + 'TotalCount' => [ + 'description' => '实时日志项目总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '页码。默认值：**0**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PageSize' => [ + 'description' => '分页大小。默认值：**20**， 取值：**1~500**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Tasks' => [ + 'description' => '任务列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'cdn-test-task', + ], + 'DeliveryType' => [ + 'description' => '投递类型：'."\n" + ."\n" + .'- **sls**： 阿里云日志服务。'."\n" + .'- **http**： http服务。'."\n" + .'- **aws3**： 亚马逊s3服务。'."\n" + .'- **oss：** 阿里云对象存储服务。'."\n" + .'- **kafka：** kafka服务。'."\n" + .'- **aws3cmpt：** 亚马逊s3兼容服务。', + 'type' => 'string', + 'example' => 'sls', + ], + 'DataCenter' => [ + 'description' => '数据中心。取值：'."\n" + .'- **cn** ：中国内地。'."\n" + .'- **sg**： 全球（不包含中国内地）。', + 'type' => 'string', + 'example' => 'cn', + ], + 'BusinessType' => [ + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'example' => 'dcdn_log_access_l1', + ], + 'Status' => [ + 'description' => '状态。'."\n" + ."\n" + .'- **online**：推送中。'."\n" + ."\n" + .'- **offline**：暂停推送。', + 'type' => 'string', + 'example' => 'online', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '列出全部实时日志任务投递', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListSiteDeliveryTasks', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListSiteDeliveryTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"TotalCount\\": 20,\\n \\"PageNumber\\": 0,\\n \\"PageSize\\": 20,\\n \\"Tasks\\": [\\n {\\n \\"TaskName\\": \\"cdn-test-task\\",\\n \\"DeliveryType\\": \\"sls\\",\\n \\"DataCenter\\": \\"cn\\",\\n \\"BusinessType\\": \\"dcdn_log_access_l1\\",\\n \\"Status\\": \\"online\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSiteOriginClientCertificates' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261747', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + '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' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'TotalCount' => [ + 'description' => '实时日志项目总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'PageNumber' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Result' => [ + 'description' => '证书信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Name' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Type' => [ + 'description' => '证书类型。', + 'type' => 'string', + 'example' => 'upload', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-03-31 02:08:00', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-03-31 02:08:00', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'DigiCert', + ], + 'SAN' => [ + 'description' => '证书主题备用名。', + 'type' => 'string', + 'example' => 'www.example.com,*.example.com', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'PubkeyAlgorithm' => [ + 'description' => '证书公钥算法。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-06-24 07:48:51', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-09-22 05:33:13', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d**', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'title' => 'ListSiteOriginClientCertificates', + 'summary' => '查询站点粒度回源客户端证书列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"TotalCount\\": 90,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1024,\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Name\\": \\"yourCertName\\",\\n \\"Status\\": \\"OK\\",\\n \\"Type\\": \\"upload\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-03-31 02:08:00\\",\\n \\"NotAfter\\": \\"2024-03-31 02:08:00\\",\\n \\"Issuer\\": \\"DigiCert\\",\\n \\"SAN\\": \\"www.example.com,*.example.com\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"PubkeyAlgorithm\\": \\"RSA\\",\\n \\"CreateTime\\": \\"2024-06-24 07:48:51\\",\\n \\"UpdateTime\\": \\"2022-09-22 05:33:13\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSiteRoutes' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266194', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_route', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + '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。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + 'Configs' => [ + 'description' => '返回体配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****'."\n", + ], + 'SiteVersion' => [ + 'description' => '站点的版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RouteEnable' => [ + 'description' => '路由开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容。', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")', + ], + 'RouteName' => [ + 'description' => '路由名称。', + 'type' => 'string', + 'example' => 'test_route', + ], + 'ConfigType' => [ + 'description' => '配置类型，可以根据此参数查全局配置或者规则配置，取值范围：'."\n" + ."\n" + .'- global：查询全局配置。'."\n" + .'- rule：查询规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'RoutineName' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'example' => 'test-routine1', + ], + 'Bypass' => [ + 'description' => '旁路模式。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Mode' => [ + 'description' => '配置模式。取值范围：'."\n" + .'- simple：简单模式。'."\n" + .'- custom： 自定义模式。', + 'type' => 'string', + 'example' => 'simple', + ], + 'Fallback' => [ + 'type' => 'string', + 'description' => '', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询站点的函数路由列表', + 'summary' => '查询站点的函数路由列表。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-25T05:35:34.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListSiteRoutes', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListSiteRoutes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 0,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RouteEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\",\\n \\"RouteName\\": \\"test_route\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"RoutineName\\": \\"test-routine1\\",\\n \\"Bypass\\": \\"on\\",\\n \\"Mode\\": \\"simple\\",\\n \\"Fallback\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 10\\n}","type":"json"}]', + ], + 'ListSites' => [ + 'summary' => '用于查询当前用户下的站点列表 ，包括站点的名称、状态、配置等信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239591', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SiteName', + 'in' => 'query', + 'schema' => [ + 'description' => '站点名称。用于查询的过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'SiteSearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '站点名称的搜索匹配模式。默认为精确匹配，取值：'."\n" + ."\n" + .'- **prefix**：前缀匹配。'."\n" + .'- **suffix**：后缀匹配。'."\n" + .'- **exact**：精确匹配。'."\n" + .'- **fuzzy**：模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy', + 'enum' => [ + 'suffix', + 'exact', + 'prefix', + 'fuzzy', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'TagFilter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签过滤规则。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键，用于查询的过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值，用于查询的过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'aaa', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。用于查询的过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzd3styujvyei', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '站点状态。用于查询的过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'pending', + ], + ], + [ + 'name' => 'OnlyEnterprise', + 'in' => 'query', + 'schema' => [ + 'description' => '仅企业版，传**true**时代表仅查询企业版的站点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PlanSubscribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐订阅类型。取值：'."\n" + .'- **basicplan**: 基础版。'."\n" + .'- **standardplan**：标准版。'."\n" + .'- **advancedplan**：高级版。'."\n" + .'- **enterpriseplan**：企业版。', + 'type' => 'string', + 'required' => false, + 'example' => 'basicplan', + ], + ], + [ + 'name' => 'Coverage', + 'in' => 'query', + 'schema' => [ + 'description' => '加速区域。取值：'."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **global**：全球。'."\n" + .'- **overseas**：全球（不包含中国内地）。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + ], + ], + [ + 'name' => 'AccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '接入类型。取值：'."\n" + ."\n" + .'- **NS**：通过NS托管接入。'."\n" + ."\n" + .'- **CNAME**：通过CNAME接入。', + 'type' => 'string', + 'required' => false, + 'example' => 'NS', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，默认按照创建时间排序，支持'."\n" + .'- gmtCreate：站点创建时间'."\n" + .'- visitTime：站点访问时间', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'visitTime' => 'visitTime', + 'gmtCreate' => 'gmtCreate', + ], + 'example' => 'visitTime', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的站点个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总共站点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'Sites' => [ + 'description' => '查询到的站点信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccessType' => [ + 'description' => '站点接入类型。取值：'."\n" + ."\n" + .'- **NS**：通过NS接入。'."\n" + .'- **CNAME**：通过CNAME接入。', + 'type' => 'string', + 'example' => 'NS', + ], + 'CnameZone' => [ + 'description' => '站点的CNAME后缀。通过CNAME方式接入的站点，记录所需要配置CNAME的后缀。', + 'type' => 'string', + 'example' => 'example.cname.com', + ], + 'Coverage' => [ + 'description' => '站点加速区域。取值：'."\n" + ."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **global**：全球。'."\n" + .'- **overseas**：全球（不包含中国内地）。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'CreateTime' => [ + 'description' => '站点的创建时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'UpdateTime' => [ + 'description' => '站点的更新时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'InstanceId' => [ + 'description' => '站点绑定的套餐实例ID。', + 'type' => 'string', + 'example' => 'onBvtlmIyeXLbiDw81F9', + ], + 'NameServerList' => [ + 'description' => '站点分配的NS列表。使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'male1-1.ialicdn.com,female1-1.ialicdn.com', + ], + 'PlanName' => [ + 'description' => '套餐名称。', + 'type' => 'string', + 'example' => 'plan-168656498****', + ], + 'PlanSpecName' => [ + 'description' => '站点套餐的规格名称。', + 'type' => 'string', + 'example' => 'normal', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek26g6i6se6pna', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Status' => [ + 'description' => '站点状态。取值：'."\n" + .'- **pending**：站点待配置。'."\n" + .'- **active**：站点已激活。'."\n" + .'- **offline**：站点已下线。'."\n" + .'- **moved**：站点已被顶替。', + 'type' => 'string', + 'example' => 'pending', + ], + 'Tags' => [ + 'description' => '站点标签。', + 'type' => 'object', + 'example' => '{"tag1":"value1"}', + ], + 'VerifyCode' => [ + 'description' => '站点归属校验码。当站点通过CNAME接入时，需要配置的TXT校验码。', + 'type' => 'string', + 'example' => 'verify_d516cb3740f81f0cef77d162edd1****', + ], + 'VisitTime' => [ + 'description' => '站点的访问时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-12-24T02:01:11Z', + ], + 'OfflineReason' => [ + 'description' => '站点停用原因。取值：'."\n" + ."\n" + .'- **expiration_ arrears**：订阅套餐到期或账号欠费。'."\n" + .'- **internally_disabled**：被系统内部停用。'."\n" + .'- **missing_icp**：域名缺少ICP。'."\n" + .'- **content_violation**：内容违规。'."\n" + .'- **proactively_disabled**：您主动停用或您设置的用量封顶停用。', + 'type' => 'string', + 'example' => 'expiration_ arrears', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '查询站点列表', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-18T05:59:13.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-11-28T06:41:39.000Z', + 'description' => '请求参数发生变更、响应参数发生变更', + ], + [ + 'createdAt' => '2024-09-23T07:16:48.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListSites', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListSites', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 40,\\n \\"Sites\\": [\\n {\\n \\"AccessType\\": \\"NS\\",\\n \\"CnameZone\\": \\"example.cname.com\\",\\n \\"Coverage\\": \\"domestic\\",\\n \\"CreateTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"UpdateTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"InstanceId\\": \\"onBvtlmIyeXLbiDw81F9\\",\\n \\"NameServerList\\": \\"male1-1.ialicdn.com,female1-1.ialicdn.com\\",\\n \\"PlanName\\": \\"plan-168656498****\\",\\n \\"PlanSpecName\\": \\"normal\\",\\n \\"ResourceGroupId\\": \\"rg-aek26g6i6se6pna\\",\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Status\\": \\"pending\\",\\n \\"Tags\\": {\\n \\"tag1\\": \\"value1\\"\\n },\\n \\"VerifyCode\\": \\"verify_d516cb3740f81f0cef77d162edd1****\\",\\n \\"VisitTime\\": \\"2023-12-24T02:01:11Z\\",\\n \\"OfflineReason\\": \\"expiration_ arrears\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListTagResources' => [ + 'summary' => '根据地域ID以及资源类型查询标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239641', + 'abilityTreeNodes' => [ + 'FEATUREdcdn6S5O3S', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID，取值范围如下：'."\n" + .'- 中国站：cn-hangzhou'."\n" + .'- 国际站：ap-southeast-1', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。请输入站点ID或者DNS记录ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。请输入站点ID或者DNS记录ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123456xxxxx', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。最多可输入20个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。最多可输入20个标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '资源类型。取值范围如下：'."\n" + ."\n" + .'- 站点：site'."\n" + .'- DNS记录：record', + 'type' => 'string', + 'required' => true, + 'example' => 'site', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '下一个查询开始Token，用来返回更多结果。'."\n" + .'> 第一次查询不需要提供本参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的**NextToken**值以继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAZjtYxxxxxxxx', + ], + ], + [ + 'name' => 'MaxItem', + 'in' => 'query', + 'schema' => [ + 'description' => '最多个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + 'NextToken' => [ + 'description' => '下一个查询开始Token。NextToken为空，说明当页已显示完所有信息。', + 'type' => 'string', + 'example' => 'AAAAAYwsxxxxxxx', + ], + 'TagResources' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'env', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value', + ], + 'ResourceId' => [ + 'description' => '资源ID。请输入站点ID或者DNS记录ID。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'ResourceType' => [ + 'description' => '资源类型。取值范围如下：'."\n" + ."\n" + .'- 站点：site'."\n" + .'- DNS记录：record', + 'type' => 'string', + 'example' => 'site', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The specified TagValue is invalid.', + 'description' => 'TagValue参数无效。', + ], + [ + 'errorCode' => 'InvalidNextToken', + 'errorMessage' => 'The specified parameter NextToken is invalid.', + 'description' => '参数NextToken非法。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified resource does not exist or is released.', + 'description' => '资源不存在或已被释放。', + ], + ], + ], + 'title' => '查询标签', + 'changeSet' => [ + [ + 'createdAt' => '2025-08-21T07:40:23.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:41.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListTagResources', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"NextToken\\": \\"AAAAAYwsxxxxxxx\\",\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"env\\",\\n \\"TagValue\\": \\"value\\",\\n \\"ResourceId\\": \\"example.com\\",\\n \\"ResourceType\\": \\"site\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + ], + 'ListTransportLayerApplications' => [ + 'summary' => '查询站点对应的四层应用列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245119', + 'abilityTreeNodes' => [ + 'FEATUREdcdn2E10XY', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456******', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的页码。 起始值：1。 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。最大值为500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'MatchType', + 'in' => 'query', + 'schema' => [ + 'description' => '针对四层应用主机记录的查询类型，支持以下4种类型，默认为精确查询。'."\n" + ."\n" + .'- fuzzy：模糊查询。'."\n" + .'- exact：精确查询。'."\n" + .'- prefix：前缀匹配查询。'."\n" + .'- suffix：后缀匹配查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy', + 'enum' => [ + 'fuzzy', + 'prefix', + 'suffix', + 'exact', + ], + ], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => [ + 'description' => '四层应用的主机记录。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '四层应用总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Applications' => [ + 'description' => '四层应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '四层应用详情。', + 'type' => 'object', + 'properties' => [ + 'Rules' => [ + 'description' => '转发规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转发规则详情。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => '转发规则协议，取值：'."\n" + ."\n" + .'- TCP：TCP协议。'."\n" + .'- UDP：UDP协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'EdgePort' => [ + 'description' => '边缘端口。支持：'."\n" + ."\n" + .'- 单个端口，例如80。'."\n" + .'- 端口范围，例如 81-85，代表端口 81、82、83、84、85。'."\n" + .'- 端口和端口范围组合，端口、端口范围之间用逗号分隔，例如80,81-85,90，代表端口80、81、82、83、84、85、90。', + 'type' => 'string', + 'example' => '80', + ], + 'SourcePort' => [ + 'description' => '源站端口。支持：'."\n" + ."\n" + .'- 单个端口，当源站端口为单个端口时，支持任意合法的边缘端口组合。'."\n" + .'- 端口范围，仅当边缘端口为端口段时，源站端口才允许设置为端口范围且范围大小需要与边缘端口一致。例如边缘端口若为90-93，则不允许将源站端口设置为81-85，因为源站端口范围为5，边缘端口范围为3，两者不一致。', + 'type' => 'string', + 'example' => '80', + ], + 'Source' => [ + 'description' => '源站具体的值，需要与源站类型相匹配。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'Comment' => [ + 'description' => '规则的备注信息。', + 'type' => 'string', + 'example' => '测试', + ], + 'ClientIPPassThroughMode' => [ + 'description' => '客户端IP传递协议，支持：'."\n" + .'- **off**: 不传递。'."\n" + .'- **PPv1**: PROXY Protocol v1协议，支持TCP协议的客户端IP传递。'."\n" + .'- **PPv2**: PROXY Protocol v2协议，支持TCP和UDP协议的客户端IP传递。'."\n" + .'- **SPP**: Simple Proxy Protocol协议，支持UDP协议的客户端IP传递。', + 'type' => 'string', + 'example' => 'off', + ], + 'SourceType' => [ + 'description' => '源站类型，支持：'."\n" + .'- **ip**: IP。'."\n" + .'- **domain**: 域名。'."\n" + .'- **OP**: 源地址池。'."\n" + .'- **LB**: 负载均衡器。', + 'type' => 'string', + 'example' => 'ip', + ], + 'RuleId' => [ + 'description' => '四层加速规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20258028****', + ], + ], + ], + ], + 'ApplicationId' => [ + 'description' => '四层应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '170997271816****', + ], + 'RecordName' => [ + 'description' => '四层应用的域名。', + 'type' => 'string', + 'example' => 'test.example.com'."\n", + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36556540048****', + ], + 'RulesCount' => [ + 'description' => '四层加速应用包含的转发规则数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Cname' => [ + 'description' => '四层加速应用对应的CNAME域名。只有站点是CNAME方式接入时，该字段才不为空。', + 'type' => 'string', + 'example' => 'example.com.ialicdn.com'."\n", + ], + 'IpAccessRule' => [ + 'description' => 'IP访问规则开关，开启后，WAF中的 IP访问规则对四层应用生效。'."\n" + ."\n" + .'- on: 开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'Ipv6' => [ + 'description' => 'Ipv6开关。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'Status' => [ + 'description' => '四层应用状态'."\n" + ."\n" + .'- **deploying**：部署中，在此状态下不允许修改和删除。'."\n" + .'- **active**：已生效。', + 'type' => 'string', + 'enumValueTitles' => [ + 'deploying' => 'deploying', + 'active' => 'active', + ], + 'example' => 'active', + ], + 'CrossBorderOptimization' => [ + 'description' => '是否开启中国大陆网络接入优化，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'StaticIp' => [ + 'description' => '是否开启固定IP，默认关闭。取值范围：'."\n" + ."\n" + .'- on: 开启。'."\n" + .'- off: 关闭。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'StaticIpV4List' => [ + 'description' => '开启固定IP功能后，为此四层应用分配的固定IP，IPv4的地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个固定IPv4，包括IP地址和其状态。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '1.1.1.2', + ], + 'Status' => [ + 'description' => 'IP地址的状态，取值范围：'."\n" + ."\n" + .'- healthy：健康。'."\n" + .'- unhealthy：不健康。'."\n" + .'- unknown：'."\r".'IP准备中。', + 'type' => 'string', + 'enumValueTitles' => [ + 'healthy' => 'healthy', + 'unhealthy' => 'unhealthy', + 'unknown' => 'unknown', + ], + 'example' => 'healthy', + ], + ], + ], + 'required' => true, + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Applications\\": [\\n {\\n \\"Rules\\": [\\n {\\n \\"Protocol\\": \\"TCP\\",\\n \\"EdgePort\\": \\"80\\",\\n \\"SourcePort\\": \\"80\\",\\n \\"Source\\": \\"1.1.1.1\\",\\n \\"Comment\\": \\"测试\\",\\n \\"ClientIPPassThroughMode\\": \\"off\\",\\n \\"SourceType\\": \\"ip\\",\\n \\"RuleId\\": 0\\n }\\n ],\\n \\"ApplicationId\\": 0,\\n \\"RecordName\\": \\"test.example.com\\\\n\\",\\n \\"SiteId\\": 0,\\n \\"RulesCount\\": 1,\\n \\"Cname\\": \\"example.com.ialicdn.com\\\\n\\",\\n \\"IpAccessRule\\": \\"on\\",\\n \\"Ipv6\\": \\"on\\",\\n \\"Status\\": \\"active\\",\\n \\"CrossBorderOptimization\\": \\"on\\",\\n \\"StaticIp\\": \\"on\\",\\n \\"StaticIpV4List\\": [\\n {\\n \\"Address\\": \\"1.1.1.2\\",\\n \\"Status\\": \\"healthy\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询站点的四层加速应用列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListTransportLayerApplications', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'ListUploadTasks' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239070', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBCJPGN', + 'FEATUREdcdnRELTJV', + 'FEATUREdcdnEWYS3A', + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-11-29T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-06T12:00:00Z', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'- **file**：url文件刷新。'."\n" + .'- **preload**：文件预热。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **ignoreparams**：去参数刷新。', + 'type' => 'string', + 'required' => false, + 'example' => 'file', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6D****', + ], + 'Tasks' => [ + 'description' => '文件上传任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UploadTaskName' => [ + 'description' => '文件上传任务名。', + 'type' => 'string', + 'example' => 'purge_file_task', + ], + 'UploadId' => [ + 'description' => '文件上传任务ID。', + 'type' => 'string', + 'example' => '159253299357****', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-07-26T01:56:15Z', + ], + 'Status' => [ + 'description' => '任务状态。'."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：执行中。'."\n" + .'- **Failed**：执行失败。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'Type' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'- **file**：url文件刷新。'."\n" + .'- **preload**：文件预热。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **ignoreparams**：去参数刷新。', + 'type' => 'string', + 'example' => 'file', + ], + 'Description' => [ + 'description' => '文件上传任务执行失败后的错误提示信息。', + 'type' => 'string', + 'example' => 'invalid url', + ], + 'ErrorCode' => [ + 'description' => '错误码，多个用逗号隔开：'."\n" + ."\n" + .'- **InvalidUrl**：链接格式不正确。'."\n" + .'- **InvalidDomain**：域名归属校验不通过。'."\n" + .'- **QuotaExcess**：超出配额上限。'."\n" + .'- **OtherErrors**：其它错误。', + 'type' => 'string', + 'example' => 'InvalidUrl,InvalidDomain', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidStationParameter', + 'errorMessage' => 'The specified Station is invalid.', + 'description' => '指定的节点参数无效。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified taskId is invalid.', + 'description' => '指定的任务ID无效。', + ], + [ + 'errorCode' => 'InvalidParameters.InvalidUrls', + 'errorMessage' => 'The specified urls are invalid.', + 'description' => '请求的URL参数无效。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '列出文件上传任务', + 'summary' => '根据时间及类型列出文件上传任务的执行状态及运行信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUploadTasks', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUploadTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6D****\\",\\n \\"Tasks\\": [\\n {\\n \\"UploadTaskName\\": \\"purge_file_task\\",\\n \\"UploadId\\": \\"159253299357****\\",\\n \\"CreateTime\\": \\"2023-07-26T01:56:15Z\\",\\n \\"Status\\": \\"Complete\\",\\n \\"Type\\": \\"file\\",\\n \\"Description\\": \\"invalid url\\",\\n \\"ErrorCode\\": \\"InvalidUrl,InvalidDomain\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListUrlObservations' => [ + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264797', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34003500310****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '分页查询时设置的页码。 起始值：1。 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '分页大小，默认**500**，取值：**1~500**。', + 'type' => 'integer', + 'format' => 'int32', + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'Configs' => [ + 'description' => '对应的配置数据。', + 'type' => 'array', + 'items' => [ + 'description' => '配置详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35281609698****'."\n", + ], + 'Url' => [ + 'description' => '要监测的网页URL。', + 'type' => 'string', + 'example' => 'example.com/test', + ], + 'SdkType' => [ + 'description' => 'SDK集成方式。取值：'."\n" + ."\n" + .'- **automatic**：自动集成。'."\n" + .'- **manual**：手动集成。', + 'type' => 'string', + 'example' => 'manual', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询网页监测配置列表', + 'summary' => '查询网页观测配置列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUrlObservations', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUrlObservations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 0,\\n \\"Url\\": \\"example.com/test\\",\\n \\"SdkType\\": \\"manual\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListUserDeliveryTasks' => [ + 'summary' => '列出用户的全部任务投递记录，支持按业务类型筛选、分页查询。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239264', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => false, + 'example' => 'dcdn_log_access_l1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的个数，默认为20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '返回第几页的数据,默认为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1f94c47f-3a1a-4f69-8d6c-bfeee1b49aab', + ], + 'TotalCount' => [ + 'description' => '任务总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '68', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Tasks' => [ + 'description' => '任务列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'testoss11', + ], + 'DeliveryType' => [ + 'description' => '交付类型。', + 'type' => 'string', + 'example' => 'oss', + ], + 'DataCenter' => [ + 'description' => '数据中心。取值为：枚举值：'."\n" + .'- **cn**：中国内地'."\n" + .'- **sg**： 全球（不包含中国内地）', + 'type' => 'string', + 'example' => 'cn', + ], + 'BusinessType' => [ + 'description' => '业务类型。', + 'type' => 'string', + 'example' => 'dcdn_log_er', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'online', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询用户任务投递列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-18T01:07:11.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUserDeliveryTasks', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUserDeliveryTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1f94c47f-3a1a-4f69-8d6c-bfeee1b49aab\\",\\n \\"TotalCount\\": 68,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Tasks\\": [\\n {\\n \\"TaskName\\": \\"testoss11\\",\\n \\"DeliveryType\\": \\"oss\\",\\n \\"DataCenter\\": \\"cn\\",\\n \\"BusinessType\\": \\"dcdn_log_er\\",\\n \\"Status\\": \\"online\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListUserRatePlanInstances' => [ + 'summary' => '查询该用户已购买的套餐实例及其详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239044', + 'abilityTreeNodes' => [ + 'FEATUREdcdnZA9EPX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CheckRemainingSiteQuota', + 'in' => 'query', + 'schema' => [ + 'description' => '是否筛选有剩余站点配额的套餐实例。支持：'."\n" + ."\n" + .'- **true**：筛选有剩余站点配额的套餐实例。'."\n" + .'- **false**：查询用户下所有的套餐实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '套餐实例状态。支持：'."\n" + .'- **online**：正常服务状态。'."\n" + .'- **offline**：到期但未超期，处于不可用的状态。'."\n" + .'- **disable**：已释放状态。'."\n" + .'- **overdue**：欠费状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + 'enum' => [ + 'online', + 'offline', + 'disable', + 'all', + 'overdue', + ], + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '排序字段，默认按照新购时间排序。支持：'."\n" + ."\n" + .'- **CreateTime**：新购时间。'."\n" + .'- **ExpireTime**：到期时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + 'enum' => [ + 'ExpireTime', + 'CreateTime', + 'default', + ], + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '排序标识，默认为降序。支持：'."\n" + ."\n" + .'- **asc**：升序。'."\n" + .'- **desc**：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值为**1**。取值范围为：**1~100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐实例ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'sp-xcdn-96wblslz****', + ], + ], + [ + 'name' => 'RemainingExpireDays', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'exclusiveMinimum' => false, + 'description' => '', + ], + ], + [ + 'name' => 'SubscribeType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'entranceplan', + 'basicplan', + 'standardplan', + 'advancedplan', + 'enterpriseplan', + ], + 'description' => '', + ], + ], + [ + 'name' => 'PlanType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'PlanNameEn', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', + ], + 'InstanceInfo' => [ + 'description' => '查询到的该用户下符合条件的套餐实例。', + 'type' => 'array', + 'items' => [ + 'description' => '套餐实例详情。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '套餐实例ID。', + 'type' => 'string', + 'example' => 'sp-xcdn-96wblslz****', + ], + 'PlanName' => [ + 'description' => '套餐实例对应的套餐名称。', + 'type' => 'string', + 'example' => 'basic', + ], + 'PlanType' => [ + 'description' => '套餐实例对应的套餐类型，取值：'."\n" + .'- **normal**：固定版套餐。'."\n" + .'- **enterprise**：企业版套餐。', + 'type' => 'string', + 'example' => 'normal', + ], + 'SiteQuota' => [ + 'description' => '套餐实例下的站点数量配额。', + 'type' => 'string', + 'example' => '1', + ], + 'ExpireTime' => [ + 'description' => '套餐实例的到期时间。', + 'type' => 'string', + 'example' => 'YYYY-MM-DDThh:mm:ssZ ', + ], + 'Duration' => [ + 'description' => '套餐实例的购买时长，单位：月。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => '套餐实例的新购时间。', + 'type' => 'string', + 'example' => 'YYYY-MM-DDThh:mm:ssZ ', + ], + 'Sites' => [ + 'description' => '已经绑定到当前套餐实例下的站点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定的站点的详情。', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'SiteStatus' => [ + 'description' => '站点状态。取值：'."\n" + ."\n" + .'- **pending**：站点待配置。'."\n" + .'- **active**：站点已激活。'."\n" + .'- **offline**：站点已下线。'."\n" + .'- **moved**：站点已被顶替。', + 'type' => 'string', + 'example' => 'pending', + ], + ], + ], + ], + 'Status' => [ + 'description' => '套餐实例状态。取值：'."\n" + .'- **online**：正常服务状态。'."\n" + .'- **offline**：到期但未超期，处于不可用的状态。'."\n" + .'- **disable**：已释放状态。', + 'type' => 'string', + 'example' => 'online', + ], + 'Coverages' => [ + 'description' => '该站点可绑定的站点的加速区域范围，多个用（,）隔开。取值：'."\n" + ."\n" + .'- **domestic**：中国或中国内地。'."\n" + .'- **overseas**：全球（不包含中国或中国内地）。'."\n" + .'- **global**：全球（包含中国或中国内地）。', + 'type' => 'string', + 'example' => 'domestic,overseas', + ], + 'BillingMode' => [ + 'description' => '付费类型。支持：'."\n" + ."\n" + .'- **PREPAY**：预付费。'."\n" + .'- **POSTPAY**：后付费。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'PlanTraffic' => [ + 'type' => 'string', + 'description' => '', + ], + 'Layer4Traffic' => [ + 'type' => 'string', + 'description' => '', + ], + 'Layer4TrafficIntl' => [ + 'type' => 'string', + 'description' => '', + ], + 'CrossborderTraffic' => [ + 'type' => 'string', + 'description' => '', + ], + 'EdgeRoutineRquest' => [ + 'type' => 'string', + 'description' => '', + ], + 'StaticRequest' => [ + 'type' => 'string', + 'description' => '', + ], + 'SmartRoutingRequest' => [ + 'type' => 'string', + 'description' => '', + ], + 'EdgeWafRequest' => [ + 'type' => 'string', + 'description' => '', + ], + 'DdosInstanceLevel' => [ + 'type' => 'string', + 'description' => '', + ], + 'DdosBurstableDomesticProtection' => [ + 'type' => 'string', + 'description' => '', + ], + 'DdosBurstableOverseasProtection' => [ + 'type' => 'string', + 'description' => '', + ], + 'BotInstanceLevel' => [ + 'type' => 'string', + 'description' => '', + ], + 'BotRequest' => [ + 'type' => 'string', + 'description' => '', + ], + 'SubscribeType' => [ + 'type' => 'string', + 'description' => '', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '68', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询用户套餐实例列表', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-12T02:01:32.000Z', + 'description' => '请求参数发生变更、响应参数发生变更', + ], + [ + 'createdAt' => '2025-01-10T01:51:17.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-11-28T06:41:41.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-11-12T05:57:29.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUserRatePlanInstances', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUserRatePlanInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE\\",\\n \\"InstanceInfo\\": [\\n {\\n \\"InstanceId\\": \\"sp-xcdn-96wblslz****\\",\\n \\"PlanName\\": \\"basic\\",\\n \\"PlanType\\": \\"normal\\",\\n \\"SiteQuota\\": \\"1\\",\\n \\"ExpireTime\\": \\"YYYY-MM-DDThh:mm:ssZ \\",\\n \\"Duration\\": 3,\\n \\"CreateTime\\": \\"YYYY-MM-DDThh:mm:ssZ \\",\\n \\"Sites\\": [\\n {\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\",\\n \\"SiteStatus\\": \\"pending\\"\\n }\\n ],\\n \\"Status\\": \\"online\\",\\n \\"Coverages\\": \\"domestic,overseas\\",\\n \\"BillingMode\\": \\"PREPAY\\",\\n \\"PlanTraffic\\": \\"\\",\\n \\"Layer4Traffic\\": \\"\\",\\n \\"Layer4TrafficIntl\\": \\"\\",\\n \\"CrossborderTraffic\\": \\"\\",\\n \\"EdgeRoutineRquest\\": \\"\\",\\n \\"StaticRequest\\": \\"\\",\\n \\"SmartRoutingRequest\\": \\"\\",\\n \\"EdgeWafRequest\\": \\"\\",\\n \\"DdosInstanceLevel\\": \\"\\",\\n \\"DdosBurstableDomesticProtection\\": \\"\\",\\n \\"DdosBurstableOverseasProtection\\": \\"\\",\\n \\"BotInstanceLevel\\": \\"\\",\\n \\"BotRequest\\": \\"\\",\\n \\"SubscribeType\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 68,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + ], + 'ListUserRoutines' => [ + 'summary' => '分页获取用户创建的边缘函数列表及配额信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238899', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：1，最大取值10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。 取值：1~20 之间的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + ], + ], + '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' => '1234567890ABCDEF', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'QuotaRoutineNumber' => [ + 'description' => '套餐Routine quota数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'UsedRoutineNumber' => [ + 'description' => '已创建Routine数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Routines' => [ + 'description' => 'Routine列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Routine项数组。', + 'type' => 'object', + 'properties' => [ + 'RoutineName' => [ + 'description' => 'Routine名称。', + 'type' => 'string', + 'example' => 'hello', + ], + 'Description' => [ + 'description' => 'Routine描述。', + 'type' => 'string', + 'example' => 'ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg==', + ], + 'CreateTime' => [ + 'description' => '边缘函数Routine创建时间。', + 'type' => 'string', + 'example' => '2024-03-11T01:23:02.883361712Z', + ], + 'HasAssets' => [ + 'description' => '是否包含Assets文件标记。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DefaultRelatedRecord' => [ + 'description' => '默认接入访问记录。', + 'type' => 'string', + 'example' => 'serverless-test-2.154edaf6.er.aliyun-esa.net', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'ParameterNotExist', + 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', + 'description' => '输入参数不存在，请您核对后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询用户Routine列表', + 'description' => '该接口允许用户分页查询其账户下创建的所有边缘函数（Routine）列表，并提供当前套餐的Routine配额数量及已使用的数量。用户可以通过指定分页参数`PageNumber`和`PageSize`来控制返回结果的数量，使用`SearchKeyWord`进行模糊搜索以过滤特定的Routine名称。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUserRoutines', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListUserRoutines', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890ABCDEF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 3,\\n \\"QuotaRoutineNumber\\": 20,\\n \\"UsedRoutineNumber\\": 5,\\n \\"Routines\\": [\\n {\\n \\"RoutineName\\": \\"hello\\",\\n \\"Description\\": \\"ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg==\\",\\n \\"CreateTime\\": \\"2024-03-11T01:23:02.883361712Z\\",\\n \\"HasAssets\\": false,\\n \\"DefaultRelatedRecord\\": \\"serverless-test-2.154edaf6.er.aliyun-esa.net\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListUserWafRulesets' => [ + 'summary' => '查询指定实例下的WAF规则集列表，支持按阶段、名称等条件过滤。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239588', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'esa-xxxxxxx', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'query', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF阶段。', + 'type' => 'string', + 'required' => false, + 'example' => '● 自定义规则 - http_custom'."\n" + .'● 频次控制规则 - http_ratelimit'."\n" + .'● 托管规则 - http_managed'."\n" + .'● 白名单规则 - http_whitelist'."\n" + .'● 扫描防护规则 - http_anti_scan', + ], + ], + [ + 'name' => 'QueryArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询参数', + 'description' => '查询参数。', + 'type' => 'object', + 'properties' => [ + 'NameLike' => [ + 'title' => '模糊查询规则集名称', + 'description' => '模糊查询规则集名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + 'OrderBy' => [ + 'title' => '指定排序列', + 'description' => '指定排序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + 'Desc' => [ + 'title' => '是否倒序排列', + 'description' => '是否倒序排列。', + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页面号码', + 'description' => '页面号码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页面大小', + 'description' => '页面大小', + 'type' => 'integer', + 'format' => 'int32', + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'InstanceUsage' => [ + 'title' => '实例使用量', + 'description' => '实例使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '过滤后总记录数', + 'description' => '过滤后总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Rulesets' => [ + 'title' => '规则集信息列表', + 'description' => 'WAF规则集信息列表。', + 'type' => 'array', + 'items' => [ + 'title' => '规则集信息', + 'description' => 'WAF规则集信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '规则集ID', + 'description' => 'WAF规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'Position' => [ + 'description' => 'WAF规则集位置。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Phase' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF阶段。', + 'type' => 'string', + 'example' => 'http_custom', + ], + 'Name' => [ + 'title' => '规则集名称', + 'description' => 'WAF规则集名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'Description' => [ + 'description' => 'WAF规则集描述。', + 'type' => 'string', + 'example' => 'example', + ], + 'Status' => [ + 'title' => '规则集状态', + 'description' => 'WAF规则集状态。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '页面号码', + 'description' => '页面号码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小', + 'description' => '页面大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出用户WAF规则集', + 'description' => '## 请求说明'."\n" + .'- `InstanceId` 是必填参数，用于指定要查询的WAF实例。'."\n" + .'- `Phase` 参数允许用户根据WAF的不同处理阶段（如自定义规则、频次控制规则等）来筛选规则集。'."\n" + .'- 使用 `QueryArgs` 中的 `NameLike` 可以进行规则集名称的模糊搜索。'."\n" + .'- 分页信息通过 `PageNumber` 和 `PageSize` 控制，默认值分别为1和20。'."\n" + .'- 返回结果中包含请求ID、当前套餐使用量、总记录数以及具体的规则集详情列表。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"InstanceUsage\\": 10,\\n \\"TotalCount\\": 5,\\n \\"Rulesets\\": [\\n {\\n \\"Id\\": 10000001,\\n \\"Position\\": 1,\\n \\"Phase\\": \\"http_custom\\",\\n \\"Name\\": \\"example\\",\\n \\"Description\\": \\"example\\",\\n \\"Status\\": \\"on\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', + ], + 'ListVideoProcessings' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257666', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListVideoProcessings](~~ListVideoProcessings~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', + 'description' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + 'enum' => [ + 'global', + 'rule', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', + 'description' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '第几页，不传时默认为1', + 'description' => '第几页，不传时默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页几条，最大500，不传时默认500', + 'description' => '每页几条，最大500，不传时默认500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'Configs' => [ + 'description' => '配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置详情。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234123**', + ], + 'SiteVersion' => [ + 'description' => '站点配置的版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '规则执行顺序。数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleEnable' => [ + 'description' => '规则开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容。', + 'type' => 'string', + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'rule_example', + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- global：全局配置。'."\n" + .'- rule：规则配置。', + 'type' => 'string', + 'example' => 'global', + ], + 'VideoSeekEnable' => [ + 'description' => '拖拽播放功能开关。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + ."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'FlvVideoSeekMode' => [ + 'description' => 'FLV拖拽模式。取值范围：'."\n" + .'- by_byte：按字节拖拽。'."\n" + .'- by_time：按时间拖拽。', + 'type' => 'string', + 'example' => 'by_byte', + ], + 'Mp4SeekStart' => [ + 'description' => '自定义mp4开始参数。', + 'type' => 'string', + 'example' => 'start', + ], + 'Mp4SeekEnd' => [ + 'description' => '自定义mp4结束参数。', + 'type' => 'string', + 'example' => 'end', + ], + 'FlvSeekStart' => [ + 'description' => '自定义FLV开始参数。', + 'type' => 'string', + 'example' => 'start', + ], + 'FlvSeekEnd' => [ + 'description' => '自定义FLV结束参数 。', + 'type' => 'string', + 'example' => 'end', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + ], + ], + 'title' => '查询站点视频处理配置列表', + 'summary' => '查询站点视频处理配置列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListVideoProcessings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigId\\": 0,\\n \\"SiteVersion\\": 1,\\n \\"Sequence\\": 1,\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.host eq \\\\\\\\\\\\\\"video.example.com\\\\\\\\\\\\\\")\\\\n\\",\\n \\"RuleName\\": \\"rule_example\\",\\n \\"ConfigType\\": \\"global\\",\\n \\"VideoSeekEnable\\": \\"on\\",\\n \\"FlvVideoSeekMode\\": \\"by_byte\\",\\n \\"Mp4SeekStart\\": \\"start\\",\\n \\"Mp4SeekEnd\\": \\"end\\",\\n \\"FlvSeekStart\\": \\"start\\",\\n \\"FlvSeekEnd\\": \\"end\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 55,\\n \\"TotalPage\\": 3\\n}","type":"json"}]', + ], + 'ListWafManagedRules' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245026', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'WAF规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000001', + ], + ], + [ + 'name' => 'ManagedRuleset', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AttackType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ProtectionLevel' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Action' => [ + 'type' => 'string', + ], + 'ManagedRules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Action' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + [ + 'name' => 'AttackType', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞防护事件的攻击类型。取值：'."\n" + .'- SQL注入'."\n" + .'- 跨站脚本'."\n" + .'- 代码执行'."\n" + .'- CRLF'."\n" + .'- 本地文件包含'."\n" + .'- 远程文件包含'."\n" + .'- webshell'."\n" + .'- 跨站请求伪造'."\n" + .'- 其他'."\n" + .'- SEMA', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'ProtectionLevel', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => '', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型，将以此语言返回。取值范围：'."\n" + ."\n" + .'- **en**：英文。'."\n" + .'- **zh**：中文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'QueryArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询条件', + 'description' => '查询条件。', + 'type' => 'object', + 'properties' => [ + 'IdNameLike' => [ + 'title' => '模糊查询规则id或规则名称', + 'description' => '模糊查询规则id或规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + 'ProtectionLevels' => [ + 'description' => '规则防护等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则防护等级。取值：'."\n" + .'- 宽松'."\n" + .'- 中等'."\n" + .'- 严格'."\n" + .'- 超严格', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + 'Action' => [ + 'description' => '动作。', + 'type' => 'string', + 'required' => false, + 'example' => 'deny', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页号', + 'description' => '查询页号。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页大小', + 'description' => '查询页大小。', + 'type' => 'integer', + 'format' => 'int32', + '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。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'TotalCount' => [ + 'title' => '过滤后总规则数', + 'description' => '过滤后总规则数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Rules' => [ + 'description' => '托管规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '托管规则详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '托管规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + 'Name' => [ + 'description' => '托管规则名称。', + 'type' => 'string', + 'example' => 'SQL注入', + ], + 'ProtectionLevel' => [ + 'description' => '托管规则防护等级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Action' => [ + 'description' => '托管规则防护动作。', + 'type' => 'string', + 'example' => 'deny', + ], + 'Status' => [ + 'description' => '托管规则防护状态。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '页面号码', + 'description' => '页面号码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小', + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '列举WAF托管规则', + 'summary' => '列出Web应用防火墙（WAF）下的所有托管规则或根据特定条件筛选规则，用户可以使用此接口以分页形式查询WAF托管规则的详细信息。', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-12T07:30:12.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafManagedRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafManagedRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"TotalCount\\": 20,\\n \\"Rules\\": [\\n {\\n \\"Id\\": 100001,\\n \\"Name\\": \\"SQL注入\\",\\n \\"ProtectionLevel\\": 1,\\n \\"Action\\": \\"deny\\",\\n \\"Status\\": \\"on\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', + ], + 'ListWafPhases' => [ + 'summary' => '列举指定站点的WAF运行阶段及其关联的规则集信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239652', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '站点版本', + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Phases' => [ + 'title' => '规则集信息列表', + 'description' => 'WAF运行阶段列表。', + 'type' => 'array', + 'items' => [ + 'title' => '规则集信息', + 'description' => 'WAF运行阶段详情。', + 'type' => 'object', + 'properties' => [ + 'Phase' => [ + 'description' => 'WAF运行阶段名称。', + 'type' => 'string', + 'example' => 'http_custom', + ], + 'Rulesets' => [ + 'description' => 'WAF规则集列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则集详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'WAF规则集的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'Name' => [ + 'description' => 'WAF规则集名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'Shared' => [ + 'description' => 'WAF规则集中规则所共享的配置。', + '$ref' => '#/components/schemas/WafBatchRuleShared', + ], + 'Rules' => [ + 'description' => 'WAF规则集中的规则配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则集中的规则配置。', + '$ref' => '#/components/schemas/WafRuleConfig', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '列举WAF运行阶段', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:50.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:36.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafPhases', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafPhases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Phases\\": [\\n {\\n \\"Phase\\": \\"http_custom\\",\\n \\"Rulesets\\": [\\n {\\n \\"Id\\": 10000001,\\n \\"Name\\": \\"example\\",\\n \\"Shared\\": {\\n \\"Target\\": \\"web\\",\\n \\"Mode\\": \\"automatic\\",\\n \\"CrossSiteId\\": 10000001,\\n \\"Name\\": \\"example\\",\\n \\"Match\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n }\\n },\\n \\"Expression\\": \\"ip.src eq 1.1.1.1\\"\\n },\\n \\"Rules\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n },\\n \\"Bypass\\": {\\n \\"Skip\\": \\"part\\",\\n \\"RegularRules\\": [\\n 100001\\n ],\\n \\"CustomRules\\": [\\n 20000001\\n ],\\n \\"RegularTypes\\": [\\n \\"sqli\\"\\n ],\\n \\"Tags\\": [\\n \\"http_custom\\"\\n ]\\n }\\n },\\n \\"ManagedList\\": \\"intelligence_crawler\\",\\n \\"ManagedRulesets\\": [\\n {\\n \\"ProtectionLevel\\": 4,\\n \\"Action\\": \\"deny\\",\\n \\"ManagedRules\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Id\\": 100001\\n }\\n ],\\n \\"AttackType\\": 11,\\n \\"NumberTotal\\": 100,\\n \\"NumberEnabled\\": 50\\n }\\n ],\\n \\"Sigchl\\": [\\n \\"sig\\"\\n ],\\n \\"Name\\": \\"example\\",\\n \\"AppSdk\\": {\\n \\"CustomSign\\": {\\n \\"Value\\": \\"examplesignvalue\\",\\n \\"Key\\": \\"sign\\"\\n },\\n \\"CustomSignStatus\\": \\"on\\",\\n \\"FeatureAbnormal\\": [\\n \\"wxbb_invalid_sign\\"\\n ]\\n },\\n \\"RateLimit\\": {\\n \\"Characteristics\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"OnHit\\": true,\\n \\"TTL\\": 10,\\n \\"Threshold\\": {\\n \\"ManagedRulesBlocked\\": 10,\\n \\"DistinctManagedRules\\": 10,\\n \\"ResponseStatus\\": {\\n \\"Ratio\\": 10,\\n \\"Count\\": 10,\\n \\"Code\\": 404\\n },\\n \\"Traffic\\": \\"10Gb\\",\\n \\"Request\\": 10\\n },\\n \\"Interval\\": 10\\n },\\n \\"Type\\": \\"http_custom\\",\\n \\"AppPackage\\": {\\n \\"PackageSigns\\": [\\n {\\n \\"Sign\\": \\"sign\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n },\\n \\"ManagedGroupId\\": 30000001,\\n \\"Timer\\": {\\n \\"Scopes\\": \\"permanent\\",\\n \\"Zone\\": 8,\\n \\"Periods\\": [\\n {\\n \\"Start\\": \\"2025-01-01T00:00:00Z\\",\\n \\"End\\": \\"2025-01-01T01:00:00Z\\"\\n }\\n ],\\n \\"WeeklyPeriods\\": [\\n {\\n \\"Days\\": \\"1\\",\\n \\"DailyPeriods\\": [\\n {\\n \\"Start\\": \\"00:00:00\\",\\n \\"End\\": \\"01:00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Expression\\": \\"ip.src eq 10.0.0.1\\",\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"Value\\": \\"10.0.0.1\\",\\n \\"Id\\": 20000001,\\n \\"Notes\\": \\"example notes\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListWafRules' => [ + 'summary' => '列出Web应用防火墙（WAF）下的所有规则或根据特定条件筛选规则，用户可以使用此接口以分页形式查询WAF规则的详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239600', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'query', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF规则类型。取值：'."\n" + ."\n" + .'- http_anti_scan：扫描防护'."\n" + .'- http_bot：Bots', + 'type' => 'string', + 'required' => true, + 'example' => 'http_custom', + ], + ], + [ + 'name' => 'RulesetId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000001', + ], + ], + [ + 'name' => 'QueryArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询条件', + 'description' => '查询过滤条件。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '精确查询WAF规则ID', + 'description' => '精确查询WAF规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20000001', + ], + 'NameLike' => [ + 'title' => '模糊查询WAF规则名称', + 'description' => '模糊查询WAF规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + 'IdNameLike' => [ + 'title' => '模糊查询规则id或规则名称', + 'description' => '模糊查询WAF规则ID或名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + 'Status' => [ + 'title' => '精确查询WAF规则状态', + 'description' => '精确查询WAF规则状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'ConfigValueLike' => [ + 'description' => '模糊搜索IP访问控制中的值。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.1', + ], + 'OrderBy' => [ + 'title' => '根据指定的列对返回列表排序', + 'description' => '根据指定的列对返回列表排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'position', + ], + 'Desc' => [ + 'title' => '是否对排序结果取反', + 'description' => '是否对排序结果取反。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + 'example' => 'http_custom', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页号', + 'description' => '查询页号，用于分页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页大小', + 'description' => '查询页大小，用于分页。', + 'type' => 'integer', + 'format' => 'int32', + '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。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'SiteUsage' => [ + 'title' => '站点使用量。', + 'description' => '站点使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'InstanceUsage' => [ + 'title' => '站点对应实例中该WAF阶段已使用规则数量', + 'description' => '站点对应实例中该WAF阶段已使用规则数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '过滤后总规则数', + 'description' => '过滤后总规则数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Rules' => [ + 'title' => '返回规则列表', + 'description' => '返回规则列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'WafPageItemType', + 'description' => '规则详情。', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00Z', + ], + 'RulesetId' => [ + 'title' => '规则集ID', + 'description' => '规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'Id' => [ + 'title' => '规则ID', + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000001', + ], + 'Position' => [ + 'title' => '规则在对应规则集中所处的位置顺序', + 'description' => '规则在对应规则集中所处的位置顺序。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Phase' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF阶段。', + 'type' => 'string', + 'example' => 'http_custom', + ], + 'Type' => [ + 'title' => '规则类型', + 'description' => '规则类型。', + 'type' => 'string', + 'example' => 'http_custom', + ], + 'Name' => [ + 'title' => '规则名称', + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'Status' => [ + 'title' => '规则状态', + 'description' => '规则状态。', + 'type' => 'string', + 'example' => 'on', + ], + 'Fields' => [ + 'title' => '规则的匹配字段列表', + 'description' => '规则的匹配字段列表。', + 'type' => 'array', + 'items' => [ + 'title' => '规则的匹配字段值', + 'description' => '规则的匹配字段值。', + 'type' => 'string', + 'example' => 'ip.geoip.asnum', + ], + ], + 'CharacteristicsFields' => [ + 'title' => '频次控制类规则的统计对象列表', + 'description' => '频次控制类规则的统计对象列表。', + 'type' => 'array', + 'items' => [ + 'title' => '频次控制类规则的统计对象', + 'description' => '频次控制类规则的统计对象。', + 'type' => 'string', + 'example' => 'ip.src', + ], + ], + 'Action' => [ + 'title' => '规则对应的动作', + 'description' => '规则对应的动作。', + 'type' => 'string', + 'example' => 'deny', + ], + 'Skip' => [ + 'title' => '白名单类规则的跳过属性', + 'description' => '白名单类规则的跳过属性。', + 'type' => 'string', + 'example' => 'part', + ], + 'Tags' => [ + 'title' => '白名单类规则的跳过WAF阶段列表', + 'description' => '白名单类规则的跳过WAF阶段列表。', + 'type' => 'array', + 'items' => [ + 'title' => '白名单类规则的跳过WAF阶段值', + 'description' => '白名单类规则的跳过WAF阶段值。', + 'type' => 'string', + 'example' => 'http_custom', + ], + ], + 'Timer' => [ + 'title' => '规则生效时间配置', + 'description' => '规则生效时间配置。', + '$ref' => '#/components/schemas/WafTimer', + ], + 'Config' => [ + 'title' => '规则配置', + 'description' => '规则配置。', + '$ref' => '#/components/schemas/WafRuleConfig', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '页面号码', + 'description' => '页面号码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小', + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '列举WAF规则', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-12T06:17:42.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:50.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"SiteUsage\\": 5,\\n \\"InstanceUsage\\": 10,\\n \\"TotalCount\\": 20,\\n \\"Rules\\": [\\n {\\n \\"UpdateTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"RulesetId\\": 10000001,\\n \\"Id\\": 20000001,\\n \\"Position\\": 1,\\n \\"Phase\\": \\"http_custom\\",\\n \\"Type\\": \\"http_custom\\",\\n \\"Name\\": \\"example\\",\\n \\"Status\\": \\"on\\",\\n \\"Fields\\": [\\n \\"ip.geoip.asnum\\"\\n ],\\n \\"CharacteristicsFields\\": [\\n \\"ip.src\\"\\n ],\\n \\"Action\\": \\"deny\\",\\n \\"Skip\\": \\"part\\",\\n \\"Tags\\": [\\n \\"http_custom\\"\\n ],\\n \\"Timer\\": {\\n \\"Scopes\\": \\"permanent\\",\\n \\"Zone\\": 8,\\n \\"Periods\\": [\\n {\\n \\"Start\\": \\"2025-01-01T00:00:00Z\\",\\n \\"End\\": \\"2025-01-01T01:00:00Z\\"\\n }\\n ],\\n \\"WeeklyPeriods\\": [\\n {\\n \\"Days\\": \\"1\\",\\n \\"DailyPeriods\\": [\\n {\\n \\"Start\\": \\"00:00:00\\",\\n \\"End\\": \\"01:00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Config\\": {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n },\\n \\"Bypass\\": {\\n \\"Skip\\": \\"part\\",\\n \\"RegularRules\\": [\\n 100001\\n ],\\n \\"CustomRules\\": [\\n 20000001\\n ],\\n \\"RegularTypes\\": [\\n \\"sqli\\"\\n ],\\n \\"Tags\\": [\\n \\"http_custom\\"\\n ]\\n }\\n },\\n \\"ManagedList\\": \\"intelligence_crawler\\",\\n \\"ManagedRulesets\\": [\\n {\\n \\"ProtectionLevel\\": 4,\\n \\"Action\\": \\"deny\\",\\n \\"ManagedRules\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Id\\": 100001\\n }\\n ],\\n \\"AttackType\\": 11,\\n \\"NumberTotal\\": 100,\\n \\"NumberEnabled\\": 50\\n }\\n ],\\n \\"Sigchl\\": [\\n \\"sig\\"\\n ],\\n \\"Name\\": \\"example\\",\\n \\"AppSdk\\": {\\n \\"CustomSign\\": {\\n \\"Value\\": \\"examplesignvalue\\",\\n \\"Key\\": \\"sign\\"\\n },\\n \\"CustomSignStatus\\": \\"on\\",\\n \\"FeatureAbnormal\\": [\\n \\"wxbb_invalid_sign\\"\\n ]\\n },\\n \\"RateLimit\\": {\\n \\"Characteristics\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"OnHit\\": true,\\n \\"TTL\\": 10,\\n \\"Threshold\\": {\\n \\"ManagedRulesBlocked\\": 10,\\n \\"DistinctManagedRules\\": 10,\\n \\"ResponseStatus\\": {\\n \\"Ratio\\": 10,\\n \\"Count\\": 10,\\n \\"Code\\": 404\\n },\\n \\"Traffic\\": \\"10Gb\\",\\n \\"Request\\": 10\\n },\\n \\"Interval\\": 10\\n },\\n \\"Type\\": \\"http_custom\\",\\n \\"AppPackage\\": {\\n \\"PackageSigns\\": [\\n {\\n \\"Sign\\": \\"sign\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n },\\n \\"ManagedGroupId\\": 30000001,\\n \\"Timer\\": {\\n \\"Scopes\\": \\"permanent\\",\\n \\"Zone\\": 8,\\n \\"Periods\\": [\\n {\\n \\"Start\\": \\"2025-01-01T00:00:00Z\\",\\n \\"End\\": \\"2025-01-01T01:00:00Z\\"\\n }\\n ],\\n \\"WeeklyPeriods\\": [\\n {\\n \\"Days\\": \\"1\\",\\n \\"DailyPeriods\\": [\\n {\\n \\"Start\\": \\"00:00:00\\",\\n \\"End\\": \\"01:00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Expression\\": \\"ip.src eq 10.0.0.1\\",\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"Value\\": \\"10.0.0.1\\",\\n \\"Id\\": 20000001,\\n \\"Notes\\": \\"example notes\\"\\n }\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', + ], + 'ListWafRulesets' => [ + 'summary' => '列举出当前WAF运行阶段下的规则集列表，通过此接口查看分页查询规则集的基本信息和状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239588', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'query', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段，指定要查询的规则集阶段。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http_bot', + ], + ], + [ + 'name' => 'QueryArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询参数', + 'description' => '查询参数，以JSON格式传递，包含各种筛选条件。', + 'type' => 'object', + 'properties' => [ + 'NameLike' => [ + 'title' => '模糊查询规则集名称', + 'description' => '模糊查询规则集名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + 'AnyLike' => [ + 'title' => '模糊搜索规则集ID、规则集名称、规则ID、规则名称。', + 'description' => '模糊查询规则集ID、规则集名称、规则ID、规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + 'OrderBy' => [ + 'title' => '指定排序列', + 'description' => '指定排序的列。', + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + 'Desc' => [ + 'title' => '是否倒序排列', + 'description' => '是否倒序排列。', + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + 'example' => 'http_bot', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页面号码', + 'description' => '页面号码，分页查询时指定当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页面大小', + 'description' => '页面大小，分页查询时指定每页的记录数量。', + 'type' => 'integer', + 'format' => 'int32', + '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。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'SiteUsage' => [ + 'description' => '站点在该WAF运行阶段已使用的WAF规则集数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'InstanceUsage' => [ + 'title' => '实例使用量', + 'description' => '实例在该WAF运行阶段已使用的WAF规则集数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '过滤后总记录数', + 'description' => '过滤后总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Rulesets' => [ + 'title' => '规则集信息列表', + 'description' => '规则集信息列表，包含规则集的详细信息。', + 'type' => 'array', + 'items' => [ + 'title' => '规则集信息', + 'description' => '规则集信息', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'title' => '修改时间', + 'description' => '规则集的最后修改时间。', + 'type' => 'string', + 'example' => '2024-01-01T00:00:00Z', + ], + 'Id' => [ + 'title' => '规则集ID', + 'description' => 'WAF规则集的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'Name' => [ + 'title' => '规则集名称', + 'description' => '规则集名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'Status' => [ + 'title' => '规则集状态', + 'description' => '规则集状态。', + 'type' => 'string', + 'example' => 'on', + ], + 'Phase' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段。', + 'type' => 'string', + 'example' => 'http_bot', + ], + 'Types' => [ + 'title' => '规则类型列表', + 'description' => '规则类型列表。', + 'type' => 'array', + 'items' => [ + 'title' => '规则类型', + 'description' => '规则类型。', + 'type' => 'string', + 'example' => 'http_custom_cc', + ], + ], + 'Target' => [ + 'title' => 'http_bot中防护目标类型', + 'description' => 'http_bot中防护目标类型。', + 'type' => 'string', + 'example' => 'web', + ], + 'Fields' => [ + 'title' => '匹配对象列表', + 'description' => '匹配对象列表。', + 'type' => 'array', + 'items' => [ + 'title' => '匹配对象', + 'description' => '匹配对象。', + 'type' => 'string', + 'example' => 'http.request.headers', + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '页面号码', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页面大小', + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"SiteUsage\\": 5,\\n \\"InstanceUsage\\": 10,\\n \\"TotalCount\\": 5,\\n \\"Rulesets\\": [\\n {\\n \\"UpdateTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"Id\\": 10000001,\\n \\"Name\\": \\"example\\",\\n \\"Status\\": \\"on\\",\\n \\"Phase\\": \\"http_bot\\",\\n \\"Types\\": [\\n \\"http_custom_cc\\"\\n ],\\n \\"Target\\": \\"web\\",\\n \\"Fields\\": [\\n \\"http.request.headers\\"\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', + 'title' => '列举WAF规则集', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:50.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:41.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafRulesets', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafRulesets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'ListWafTemplateRules' => [ + 'summary' => '列出Web应用防火墙（WAF）中的模板规则。这些规则通常是预先定义的规则集，用于快速启用对常见攻击类型的防护。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239638', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'esa-site-aud6ftk57ym8', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'query', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段，用于筛选特定阶段的模板规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'http_anti_scan', + ], + ], + [ + 'name' => 'QueryArgs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '查询参数', + 'description' => '查询参数，用于根据规则类型等条件筛选模板规则。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '规则类型', + 'description' => '规则类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'http_directory_traversal', + ], + 'Kinds' => [ + 'description' => '模板种类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板种类。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'template' => 'template', + 'template-featured' => 'template-featured', + ], + 'example' => 'template', + ], + 'required' => false, + ], + ], + 'required' => false, + 'example' => 'http_anti_scan', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Rules' => [ + 'title' => '规则列表', + 'description' => '返回的模板规则列表。', + 'type' => 'array', + 'items' => [ + 'title' => '规则信息', + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '规则名称', + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'HTTP Directory Traversal Rule [Template]', + ], + 'Status' => [ + 'title' => '规则状态', + 'description' => '规则状态。', + 'type' => 'string', + 'example' => 'on', + ], + 'Type' => [ + 'title' => '规则类型', + 'description' => '规则类型。', + 'type' => 'string', + 'example' => 'http_directory_traversal', + ], + 'Phase' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段。', + 'type' => 'string', + 'example' => 'http_anti_scan', + ], + 'Config' => [ + 'title' => '规则配置', + 'description' => '规则配置。', + '$ref' => '#/components/schemas/WafRuleConfig', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '列举WAF模板规则', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-11T03:39:54.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-11-12T07:30:11.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:50.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:35.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafTemplateRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafTemplateRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Rules\\": [\\n {\\n \\"Name\\": \\"HTTP Directory Traversal Rule [Template]\\",\\n \\"Status\\": \\"on\\",\\n \\"Type\\": \\"http_directory_traversal\\",\\n \\"Phase\\": \\"http_anti_scan\\",\\n \\"Config\\": {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Actions\\": {\\n \\"Response\\": {\\n \\"Id\\": 50000001,\\n \\"Code\\": 403\\n },\\n \\"Bypass\\": {\\n \\"Skip\\": \\"part\\",\\n \\"RegularRules\\": [\\n 100001\\n ],\\n \\"CustomRules\\": [\\n 20000001\\n ],\\n \\"RegularTypes\\": [\\n \\"sqli\\"\\n ],\\n \\"Tags\\": [\\n \\"http_custom\\"\\n ]\\n }\\n },\\n \\"ManagedList\\": \\"intelligence_crawler\\",\\n \\"ManagedRulesets\\": [\\n {\\n \\"ProtectionLevel\\": 4,\\n \\"Action\\": \\"deny\\",\\n \\"ManagedRules\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\",\\n \\"Id\\": 100001\\n }\\n ],\\n \\"AttackType\\": 11,\\n \\"NumberTotal\\": 100,\\n \\"NumberEnabled\\": 50\\n }\\n ],\\n \\"Sigchl\\": [\\n \\"sig\\"\\n ],\\n \\"Name\\": \\"example\\",\\n \\"AppSdk\\": {\\n \\"CustomSign\\": {\\n \\"Value\\": \\"examplesignvalue\\",\\n \\"Key\\": \\"sign\\"\\n },\\n \\"CustomSignStatus\\": \\"on\\",\\n \\"FeatureAbnormal\\": [\\n \\"wxbb_invalid_sign\\"\\n ]\\n },\\n \\"RateLimit\\": {\\n \\"Characteristics\\": {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"Logic\\": \\"and\\",\\n \\"Criteria\\": [\\n {\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n }\\n ],\\n \\"MatchType\\": \\"ip.src\\",\\n \\"MatchOperator\\": \\"eq\\",\\n \\"MatchValue\\": \\"1.1.1.1\\",\\n \\"Negate\\": true,\\n \\"ConvertToLower\\": true\\n },\\n \\"OnHit\\": true,\\n \\"TTL\\": 10,\\n \\"Threshold\\": {\\n \\"ManagedRulesBlocked\\": 10,\\n \\"DistinctManagedRules\\": 10,\\n \\"ResponseStatus\\": {\\n \\"Ratio\\": 10,\\n \\"Count\\": 10,\\n \\"Code\\": 404\\n },\\n \\"Traffic\\": \\"10Gb\\",\\n \\"Request\\": 10\\n },\\n \\"Interval\\": 10\\n },\\n \\"Type\\": \\"http_custom\\",\\n \\"AppPackage\\": {\\n \\"PackageSigns\\": [\\n {\\n \\"Sign\\": \\"sign\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n },\\n \\"ManagedGroupId\\": 30000001,\\n \\"Timer\\": {\\n \\"Scopes\\": \\"permanent\\",\\n \\"Zone\\": 8,\\n \\"Periods\\": [\\n {\\n \\"Start\\": \\"2025-01-01T00:00:00Z\\",\\n \\"End\\": \\"2025-01-01T01:00:00Z\\"\\n }\\n ],\\n \\"WeeklyPeriods\\": [\\n {\\n \\"Days\\": \\"1\\",\\n \\"DailyPeriods\\": [\\n {\\n \\"Start\\": \\"00:00:00\\",\\n \\"End\\": \\"01:00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Expression\\": \\"ip.src eq 10.0.0.1\\",\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"Value\\": \\"10.0.0.1\\",\\n \\"Id\\": 20000001,\\n \\"Notes\\": \\"example notes\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListWafUsageOfRules' => [ + 'summary' => '该接口用于列举WAF规则使用情况。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239653', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Phase', + 'in' => 'query', + 'schema' => [ + 'title' => 'WAF阶段', + 'description' => 'WAF运行阶段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'http_custom', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Sites' => [ + 'description' => '站点使用量列表。', + 'type' => 'array', + 'items' => [ + 'description' => '站点使用量详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Usage' => [ + 'description' => 'WAF规则/WAF规则集的已使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'BatchConfigUsage' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'InstanceUsage' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '列举WAF规则的使用情况', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:49.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:41.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafUsageOfRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafUsageOfRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Sites\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"example.com\\",\\n \\"Usage\\": 1\\n }\\n ],\\n \\"BatchConfigUsage\\": 0,\\n \\"InstanceUsage\\": 0\\n}","type":"json"}]', + ], + 'ListWaitingRoomEvents' => [ + 'summary' => '查询等候室的等候室事件详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239610', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVCBH9N', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '7096621098****', + ], + ], + [ + 'name' => 'WaitingRoomId', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室ID，用于标识特定的等候室。可通过调用[ListWaitingRooms](~~2850279~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '6a51d5bc6460887abd129****', + ], + ], + [ + 'name' => 'WaitingRoomEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室事件ID，可选参数，用于查询特定等候室事件。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '89677721098****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '查询结果响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于追踪调用情况。', + 'type' => 'string', + 'example' => 'f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55', + ], + 'WaitingRoomEvents' => [ + 'description' => '等候室事件列表，包含每个事件的具体信息。', + 'type' => 'array', + 'items' => [ + 'description' => '等候室事件详情。', + 'type' => 'object', + 'properties' => [ + 'WaitingRoomEventId' => [ + 'description' => '事件ID，唯一标识一个等候室事件。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89677721098****'."\n", + ], + 'WaitingRoomId' => [ + 'description' => '关联的等候室ID。', + 'type' => 'string', + 'example' => '5c938a045c9ca46607163d34966****', + ], + 'Enable' => [ + 'description' => '事件启用状态。'."\n" + .'- **on** ：表示启用。'."\n" + .'- **off**：表示禁用。', + 'type' => 'string', + 'example' => 'on', + ], + 'Name' => [ + 'description' => '事件名称，自定义的事件描述。', + 'type' => 'string', + 'example' => '测试事件', + ], + 'TotalActiveUsers' => [ + 'description' => '活动用户总数。', + 'type' => 'string', + 'example' => '22', + ], + 'NewUsersPerMinute' => [ + 'description' => '每分钟新增用户数。', + 'type' => 'string', + 'example' => '11', + ], + 'SessionDuration' => [ + 'description' => '会话持续时间（单位：分钟）。', + 'type' => 'string', + 'example' => '3', + ], + 'DisableSessionRenewalEnable' => [ + 'description' => '禁用会话续订。支持：'."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'off', + ], + 'QueuingMethod' => [ + 'description' => '排队方式。取值：'."\n" + ."\n" + .'- **random**：随机。'."\n" + .'- **fifo**：先进先出。'."\n" + .'- **passthrough**：直通。'."\n" + .'- **reject-all**：拒绝全部。', + 'type' => 'string', + 'example' => 'fifo', + ], + 'QueuingStatusCode' => [ + 'description' => '等候室状态码。取值：'."\n" + ."\n" + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**', + 'type' => 'string', + 'example' => '200', + ], + 'JsonResponseEnable' => [ + 'description' => 'JSON响应。开启后accept请求头包含"application/json"会返回JSON数据。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'off', + ], + 'Description' => [ + 'description' => '事件的详细描述。', + 'type' => 'string', + 'example' => 'terraform-example', + ], + 'WaitingRoomType' => [ + 'description' => '等候室类型。支持以下类型：'."\n" + ."\n" + .'- **default**：默认类型。'."\n" + .'- **custom**：自定义类型。', + 'type' => 'string', + 'example' => 'custom', + ], + 'CustomPageHtml' => [ + 'description' => '用户自定义等候室页面内容，当等候室类型为自定义类型时，需要传入。传入的内容需要经过URL编码。', + 'type' => 'string', + 'example' => 'html-yets-maqi1111', + ], + 'StartTime' => [ + 'description' => '事件开始时间（Unix时间戳）。', + 'type' => 'string', + 'example' => '1719814398', + ], + 'EndTime' => [ + 'description' => '事件结束时间（Unix时间戳）。', + 'type' => 'string', + 'example' => '1719814497', + ], + 'PreQueueEnable' => [ + 'description' => '预排队开关。'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'PreQueueStartTime' => [ + 'description' => '预排队开始时间（Unix时间戳），若开启预排队功能则有效。', + 'type' => 'string', + 'example' => '1719814097', + ], + 'RandomPreQueueEnable' => [ + 'description' => '随机排队开关。'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Language' => [ + 'description' => '等候室页面的语言，当等候室类型为默认类型时，需要传入。支持以下类型：'."\n" + ."\n" + .'- **enus**：英文。'."\n" + .'- **zhcn**：中文简体。'."\n" + .'- **zhhk**：中文繁体。', + 'type' => 'string', + 'example' => 'zhcn', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询等候室事件列表', + 'description' => '通过此接口，您可以查询指定站点ID和等候室ID下所有相关的等候室事件详情。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:13:41.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWaitingRoomEvents', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWaitingRoomEvents', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55\\",\\n \\"WaitingRoomEvents\\": [\\n {\\n \\"WaitingRoomEventId\\": 0,\\n \\"WaitingRoomId\\": \\"5c938a045c9ca46607163d34966****\\",\\n \\"Enable\\": \\"on\\",\\n \\"Name\\": \\"测试事件\\",\\n \\"TotalActiveUsers\\": \\"22\\",\\n \\"NewUsersPerMinute\\": \\"11\\",\\n \\"SessionDuration\\": \\"3\\",\\n \\"DisableSessionRenewalEnable\\": \\"off\\",\\n \\"QueuingMethod\\": \\"fifo\\",\\n \\"QueuingStatusCode\\": \\"200\\",\\n \\"JsonResponseEnable\\": \\"off\\",\\n \\"Description\\": \\"terraform-example\\",\\n \\"WaitingRoomType\\": \\"custom\\",\\n \\"CustomPageHtml\\": \\"html-yets-maqi1111\\",\\n \\"StartTime\\": \\"1719814398\\",\\n \\"EndTime\\": \\"1719814497\\",\\n \\"PreQueueEnable\\": \\"on\\",\\n \\"PreQueueStartTime\\": \\"1719814097\\",\\n \\"RandomPreQueueEnable\\": \\"on\\",\\n \\"Language\\": \\"zhcn\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListWaitingRoomRules' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239649', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVCBH9N', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'WaitingRoomId', + 'in' => 'query', + 'schema' => [ + 'description' => '要绕过的等待室ID，可通过调用[ListWatingRooms](~~2850279~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '6a51d5bc6460887abd129****', + ], + ], + [ + 'name' => 'WaitingRoomRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '要更新的等候室绕过规则ID，可通过调用[ListWaitingRoomRules](~~2850279~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '37286782688****'."\n", + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名，可选，用于按等候室绕过规则名称查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '查询响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于追踪调用情况。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', + ], + 'WaitingRoomRules' => [ + 'description' => '等候室绕过规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '等候室绕过规则详情。', + 'type' => 'object', + 'properties' => [ + 'WaitingRoomRuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37286782688****', + ], + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'example' => 'ip', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询等候室绕过规则列表', + 'summary' => '查询等候室对应的等候室绕过规则列表。', + 'description' => '此API允许用户查询与特定站点关联的等候室绕过规则列表。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:13:41.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWaitingRoomRules', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWaitingRoomRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\",\\n \\"WaitingRoomRules\\": [\\n {\\n \\"WaitingRoomRuleId\\": 0,\\n \\"RuleName\\": \\"ip\\",\\n \\"RuleEnable\\": \\"on\\",\\n \\"Rule\\": \\"(http.request.uri.path.file_name eq \\\\\\\\\\\\\\"jpg\\\\\\\\\\\\\\")\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListWaitingRooms' => [ + 'summary' => '查询指定站点下已配置的所有等候室的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239611', + 'abilityTreeNodes' => [ + 'FEATUREdcdnO4KC7Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '120876698010528', + ], + ], + [ + 'name' => 'WaitingRoomId', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室ID，用于查询特定等候室的详情。', + 'type' => 'string', + 'required' => false, + 'example' => '6a51d5bc6460887abd1291dc7d4d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '查询响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于追踪API调用情况。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'WaitingRooms' => [ + 'description' => '等候室列表。', + 'type' => 'array', + 'items' => [ + 'description' => '等候室详情。', + 'type' => 'object', + 'properties' => [ + 'WaitingRoomId' => [ + 'description' => '等候室ID，唯一标识一个等候室。', + 'type' => 'string', + 'example' => '6a51d5bc6460887abd1291dc7d4d****'."\n", + ], + 'Enable' => [ + 'description' => '启用状态，取值：'."\n" + ."\n" + .'- **on**：启用。'."\n" + .'- **off**：禁用。', + 'type' => 'string', + 'example' => 'on', + ], + 'Name' => [ + 'description' => '等候室名称。', + 'type' => 'string', + 'example' => '测试等候室', + ], + 'QueueAllEnable' => [ + 'description' => '全部排队。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'HostNameAndPath' => [ + 'description' => '主机名和路径。', + 'type' => 'array', + 'items' => [ + 'description' => '主机名和路径详情。', + 'type' => 'object', + 'properties' => [ + 'Subdomain' => [ + 'description' => '子域名。', + 'type' => 'string', + 'example' => 'test.'."\n", + ], + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Path' => [ + 'description' => '路径', + 'type' => 'string', + 'example' => '/test', + ], + ], + ], + ], + 'CookieName' => [ + 'description' => '自定义Cookie名称。', + 'type' => 'string', + 'example' => '__aliwaitingroom_example', + ], + 'TotalActiveUsers' => [ + 'description' => '活跃用户总数。', + 'type' => 'string', + 'example' => '300', + ], + 'NewUsersPerMinute' => [ + 'description' => '每分钟新用户数。', + 'type' => 'string', + 'example' => '200', + ], + 'SessionDuration' => [ + 'description' => '会话持续时间，单位是分钟。', + 'type' => 'string', + 'example' => '3600', + ], + 'DisableSessionRenewalEnable' => [ + 'description' => '禁用会话续订。支持：'."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'QueuingMethod' => [ + 'description' => '排队方式。取值：'."\n" + ."\n" + .'- **random**：随机。'."\n" + .'- **fifo**：先进先出。'."\n" + .'- **passthrough**：直通。'."\n" + .'- **reject-all**：拒绝全部。', + 'type' => 'string', + 'example' => 'random', + ], + 'QueuingStatusCode' => [ + 'description' => '等候室状态码。取值：'."\n" + ."\n" + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**', + 'type' => 'string', + 'example' => '200', + ], + 'JsonResponseEnable' => [ + 'description' => 'JSON响应。开启后accept请求头包含"application/json"会返回json数据。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Description' => [ + 'description' => '等候室描述。', + 'type' => 'string', + 'example' => '测试等候室', + ], + 'WaitingRoomType' => [ + 'description' => '等候室类型，支持：'."\n" + ."\n" + .'- **default**：表示默认类型。'."\n" + .'- **custom**：表示自定义类型。', + 'type' => 'string', + 'example' => 'default', + ], + 'CustomPageHtml' => [ + 'description' => '自定义排队页面的HTML内容或标识符，仅当`WaitingRoomType`为`custom`时有效。传入的内容需要经过URL编码。', + 'type' => 'string', + 'example' => '自定义HTML内容或标识', + ], + 'Language' => [ + 'description' => '等候室页面的语言，当等候室类型为默认类型时，需要传入。支持以下类型：'."\n" + ."\n" + .'- **enus**：英文。'."\n" + .'- **zhcn**：中文简体。'."\n" + .'- **zhhk**：中文繁体。', + 'type' => 'string', + 'example' => 'zhcn', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Site.NotExist', + 'errorMessage' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询等候室列表', + 'description' => '此API允许您查询指定站点下所有等候室的配置详情，包括启用状态、名称、排队规则等信息。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:13:40.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWaitingRooms', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWaitingRooms', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"WaitingRooms\\": [\\n {\\n \\"WaitingRoomId\\": \\"6a51d5bc6460887abd1291dc7d4d****\\\\n\\",\\n \\"Enable\\": \\"on\\",\\n \\"Name\\": \\"测试等候室\\",\\n \\"QueueAllEnable\\": \\"on\\",\\n \\"HostNameAndPath\\": [\\n {\\n \\"Subdomain\\": \\"test.\\\\n\\",\\n \\"Domain\\": \\"example.com\\\\n\\",\\n \\"Path\\": \\"/test\\"\\n }\\n ],\\n \\"CookieName\\": \\"__aliwaitingroom_example\\",\\n \\"TotalActiveUsers\\": \\"300\\",\\n \\"NewUsersPerMinute\\": \\"200\\",\\n \\"SessionDuration\\": \\"3600\\",\\n \\"DisableSessionRenewalEnable\\": \\"on\\",\\n \\"QueuingMethod\\": \\"random\\",\\n \\"QueuingStatusCode\\": \\"200\\",\\n \\"JsonResponseEnable\\": \\"on\\",\\n \\"Description\\": \\"测试等候室\\",\\n \\"WaitingRoomType\\": \\"default\\",\\n \\"CustomPageHtml\\": \\"自定义HTML内容或标识\\",\\n \\"Language\\": \\"zhcn\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'OpenErService' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239354', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + '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' => '5CC228B4-7A67-4016-9C9F-4A4133494A91', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ErService.HasOpened', + 'errorMessage' => 'You have already activated Edge Routine.', + 'description' => '您已开通边缘函数服务，无需重复开通。', + ], + [ + 'errorCode' => 'InsufficientAvailableQuota', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号已欠费，请缴清欠费后再购买。', + ], + [ + 'errorCode' => 'NoRealNameAuthentication', + 'errorMessage' => 'You have not completed real-name authentication.', + 'description' => '您尚未进行实名认证！', + ], + [ + 'errorCode' => 'RiskControlRejection', + 'errorMessage' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', + 'description' => '为保护您的账户安全，下单被中止，详情请联系客服。', + ], + [ + 'errorCode' => 'RR309', + 'errorMessage' => 'The system has detected that your payment method is at risk. Please complete the verification through the link in the email and the in-station letter. Please place the order again after the verification is passed.', + 'description' => '系统检测到您的支付方式存在风险，请通过邮件和站内信中的链接完成验证，验证通过后请重新下单。', + ], + [ + 'errorCode' => 'RR307', + 'errorMessage' => 'Credit card verification is not complete. Please follow the guidance in the email and the internal message to complete the verification. Once verified, please place your order again.', + 'description' => '未完成信用卡验证，请通过邮件和站内信中引导自助完成验证，通过后请重新下单。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '开通边缘函数服务', + 'summary' => '开通用户边缘函数服务。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-18T03:30:35.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'OpenErService', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:OpenErService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC228B4-7A67-4016-9C9F-4A4133494A91\\"\\n}","type":"json"}]', + ], + 'PreloadCaches' => [ + 'summary' => '缓存预热。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239241', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '预热对象。', + 'type' => 'array', + 'items' => [ + 'description' => '单个预热对象。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.com/1.jpg?b=1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Headers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '预热请求默认携带的header是Accept-Encoding:gzip，如果您需要预热请求携带其他header，或者实现多副本预热，那么可以使用该参数来实现自定义预热header。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '请求头。', + 'example' => 'Accept-Encoding:gzip', + ], + ], + ], + ], + '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' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + 'TaskId' => [ + 'description' => '任务ID，当您创建预热任务时，会返回任务ID。', + 'type' => 'string', + 'example' => '16401427840', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidStationParameter', + 'errorMessage' => 'The specified Station is invalid.', + 'description' => '指定的节点参数无效。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified taskId is invalid.', + 'description' => '指定的任务ID无效。', + ], + [ + 'errorCode' => 'InvalidParameters.InvalidUrls', + 'errorMessage' => 'The specified urls are invalid.', + 'description' => '请求的URL参数无效。', + ], + [ + 'errorCode' => 'QuotaExceeded', + 'errorMessage' => 'You attempts have exceeded the daily limit.', + 'description' => '超出当日配额限制。今日提交数量已用完。您可以通过配额接口查询今日的可使用次数。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordNotBelongToSite', + 'errorMessage' => 'The record name passed in does not belong to the current site.', + 'description' => '传入的记录名不属于当前站点。', + ], + [ + 'errorCode' => 'PreloadQueueFull', + 'errorMessage' => 'The prefetch queue is full. Try again later.', + 'description' => '预热队列已满，需要等待队列消化后再重试。', + ], + ], + ], + 'title' => '预热URL', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-17T01:55:08.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-03-13T07:58:30.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-10-15T01:58:27.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PreloadCaches', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:PreloadCaches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n \\"TaskId\\": \\"16401427840\\"\\n}","type":"json"}]', + ], + 'PublishEdgeContainerAppVersion' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239213', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '版本ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ver-87962637161651****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'PublishEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布的环境，取值如下：'."\n" + ."\n" + .'- **prod**: 生产环境。'."\n" + .'- **staging**：预发环境。', + 'type' => 'string', + 'required' => true, + 'example' => 'prod', + ], + ], + [ + 'name' => 'Percentage', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布比例。取值：**1~100**，默认值：**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '100', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始进行发布的时间，不写则默认为当前时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-06-05T16:00:00Z', + ], + ], + [ + 'name' => 'Remarks', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息，默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test publish app', + 'maxLength' => 1024, + ], + ], + [ + 'name' => 'PublishType', + 'in' => 'query', + 'schema' => [ + 'description' => '发布类型，支持如下两种：'."\n" + .'- **percentage**：按照百分比发布。'."\n" + ."\n" + .'- **region**：按照区域发布。'."\n" + ."\n" + .'若不填写，默认使用百分比发布。', + 'type' => 'string', + 'required' => false, + 'example' => 'percentage', + 'default' => 'percentage', + 'enum' => [ + 'percentage', + 'region', + ], + ], + ], + [ + 'name' => 'Regions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '发布区域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '发布区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'jiangsu', + ], + 'required' => false, + ], + ], + [ + 'name' => 'FullRelease', + 'in' => 'query', + 'schema' => [ + 'description' => '是否全量发布。该字段仅当 PublishType设置为 region 时生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PublishEnv', + 'errorMessage' => 'The specified PublishEnv is invalid. Please check the PublishEnv parameter. It may not be set to either "prod" or "staging." Please make the necessary changes and call the interface again.', + 'description' => 'PublishEnv参数无效。请检查PublishEnv参数，你有可能未设置为prod、staging其中一种，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter.Percentage', + 'errorMessage' => 'The Percentage parameter is invalid. Please check the Percentage parameter, which should be in the range of 1-100. Modify it accordingly and call the interface again.', + 'description' => 'Percentage 参数无效。请检查Percentage参数，该参数范围为1-100，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.VersionId', + 'errorMessage' => 'The specified VersionId is invalid.  Please check the VersionId parameter. You may not have entered the parameter or the parameter does not start with ver-string. Please modify it and call the interface again.', + 'description' => 'VersionId参数无效。请检查VersionId参数，你有可能未输入该参数或者，参数并未以ver-字符串开头，请进行修改后，重新调用接口。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '发布边缘容器的指定版本', + 'summary' => '发布边缘容器的指定版本，用户可以通过此接口进行应用的版本迭代。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PublishEdgeContainerAppVersion', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:PublishEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'PurchaseCacheReserve' => [ + 'summary' => '调用PurchaseCacheReserve购买缓存保持实例。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '238733', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'QuotaGb', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存保持规格（单位：GB）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '512000', + ], + ], + [ + 'name' => 'CrRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存保持区域'."\n" + .'- HK：中国香港'."\n" + .'- CN-beijing：中国大陆-北京', + 'type' => 'string', + 'required' => false, + 'example' => 'HK', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动续费：'."\n" + .'- true：自动续费。'."\n" + .'- false：不自动续费。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '购买周期（单位：月）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '计费类型'."\n" + .'- PREPAY：预付费。'."\n" + .'- POSTPAY：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PREPAY', + 'enum' => [ + 'POSTPAY', + 'PREPAY', + ], + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动支付。默认值为false。'."\n" + .'- true：自动支付。'."\n" + .'- false：不自动支付。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '31223****11', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'xcdn-ad*****s11w'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CheckOrderFailed', + 'errorMessage' => 'Invalid order parameter.', + 'description' => '订单参数不合法。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidSiteICP', + 'errorMessage' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'description' => '您配置的站点未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + [ + 'errorCode' => 'InvalidSiteName', + 'errorMessage' => 'Invalid website name. Check and try again.', + 'description' => '您配置的站点名称不正确，请确保传入正确的站点名称后重试。', + ], + [ + 'errorCode' => 'SYSTEM.NoSpecificCodeFailed', + 'errorMessage' => 'Invalid subscription duration. Check and try again.', + 'description' => '您配置的套餐购买周期不正确，请检查后重试。', + ], + [ + 'errorCode' => 'CheckPlanFailed', + 'errorMessage' => 'Invalid plan name or code. Check and try again.', + 'description' => '您配置的套餐名或套餐Code不正确，请确保已传入正确的套餐名或套餐Code后重试。', + ], + [ + 'errorCode' => 'SubSiteUnavailable', + 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', + 'description' => '仅企业版支持以子域名创建站点，请升级您的套餐。', + ], + [ + 'errorCode' => 'InsufficientAvailableQuota', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号已欠费，请缴清欠费后再购买。', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号余额不足，请充值后再购买。', + ], + [ + 'errorCode' => 'InvalidComponent', + 'errorMessage' => 'The order parameters is invalid.', + 'description' => '订单配置参数不符合校验条件。', + ], + [ + 'errorCode' => 'RamAuthFailed', + 'errorMessage' => 'The sub-account has no operation permission.', + 'description' => '子账号无操作权限.', + ], + ], + ], + 'title' => '购买缓存保持实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PurchaseCacheReserve', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:PurchaseCacheReserve', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30423A7F-A83D-1E24-B80E-86DD25790758\\",\\n \\"OrderId\\": \\"31223****11\\",\\n \\"InstanceId\\": \\"xcdn-ad*****s11w\\\\n\\"\\n}","type":"json"}]', + ], + 'PurchaseRatePlan' => [ + 'summary' => '调用PurchaseRatePlan购买套餐。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '239597', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐名称。'."\n" + ."\n" + .'中国站'."\n" + ."\n" + .'- 免费版：entranceplan'."\n" + .'- 基础版：basic'."\n" + .'- 标准版：medium'."\n" + .'- 高级版：high'."\n" + ."\n" + .'国际站'."\n" + ."\n" + .'- Entrance：entranceplan_intl'."\n" + .'- Pro：basicplan_intl'."\n" + .'- Premium：vipplan_intl', + 'type' => 'string', + 'required' => false, + 'example' => 'basic', + ], + ], + [ + 'name' => 'PlanCode', + 'in' => 'query', + 'schema' => [ + 'description' => '套餐code。'."\n" + ."\n" + .'中国站'."\n" + ."\n" + .'- 免费版：entranceplan'."\n" + .'- 基础版：basicplan'."\n" + .'- 标准版：standardplan'."\n" + .'- 高级版：advancedplan'."\n" + ."\n" + .'国际站'."\n" + ."\n" + .'- Entrance：entranceplan'."\n" + .'- Pro: standardplan'."\n" + .'- Premium: advancedpla', + 'type' => 'string', + 'required' => false, + 'example' => 'basicplan', + ], + ], + [ + 'name' => 'SiteName', + 'in' => 'query', + 'schema' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + ], + [ + 'name' => 'Coverage', + 'in' => 'query', + 'schema' => [ + 'description' => '加速区域：'."\n" + .'- domestic：仅中国内地。'."\n" + .'- global：全球。'."\n" + .'- overseas：全球（不包含中国内地）。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + 'default' => 'overseas', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '站点接入类型：'."\n" + .'- NS：NS 接入。'."\n" + .'- CNAME：CNAME 接入。', + 'type' => 'string', + 'required' => false, + 'example' => 'CNAME', + 'default' => 'CNAME', + 'enum' => [ + 'CNAME', + 'NS', + ], + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动续费：'."\n" + .'- true：自动续费。'."\n" + .'- false：不自动续费。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '购买周期（单位：月）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '计费类型'."\n" + .'- PREPAY：预付费。'."\n" + .'- POSTPAY：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PREPAY', + 'enum' => [ + 'POSTPAY', + 'PREPAY', + ], + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '自动支付。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => '购买套餐数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '99', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Channel', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '123123', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'esa-site-ads11w', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CheckOrderFailed', + 'errorMessage' => 'Invalid order parameter.', + 'description' => '订单参数不合法。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidSiteICP', + 'errorMessage' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'description' => '您配置的站点未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + [ + 'errorCode' => 'InvalidSiteName', + 'errorMessage' => 'Invalid website name. Check and try again.', + 'description' => '您配置的站点名称不正确，请确保传入正确的站点名称后重试。', + ], + [ + 'errorCode' => 'SYSTEM.NoSpecificCodeFailed', + 'errorMessage' => 'Invalid subscription duration. Check and try again.', + 'description' => '您配置的套餐购买周期不正确，请检查后重试。', + ], + [ + 'errorCode' => 'CheckPlanFailed', + 'errorMessage' => 'Invalid plan name or code. Check and try again.', + 'description' => '您配置的套餐名或套餐Code不正确，请确保已传入正确的套餐名或套餐Code后重试。', + ], + [ + 'errorCode' => 'SubSiteUnavailable', + 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', + 'description' => '仅企业版支持以子域名创建站点，请升级您的套餐。', + ], + [ + 'errorCode' => 'InsufficientAvailableQuota', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号已欠费，请缴清欠费后再购买。', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号余额不足，请充值后再购买。', + ], + [ + 'errorCode' => 'InvalidComponent', + 'errorMessage' => 'The order parameters is invalid.', + 'description' => '订单配置参数不符合校验条件。', + ], + [ + 'errorCode' => 'RamAuthFailed', + 'errorMessage' => 'The sub-account has no operation permission.', + 'description' => '子账号无操作权限.', + ], + [ + 'errorCode' => 'BuyWithSiteAmountErr', + 'errorMessage' => 'Site-based purchase plans do not support bulk purchasing.', + 'description' => '带站点购买套餐不支持批量购买。', + ], + [ + 'errorCode' => 'EnterpriseAmountErr', + 'errorMessage' => 'Enterprise plans do not support bulk purchase.', + 'description' => '企业版套餐不支持批量购买。', + ], + [ + 'errorCode' => 'TrialService.HasOpened', + 'errorMessage' => 'You have already activated the trial service.', + 'description' => '您已开通试用服务，不能重复开通。', + ], + [ + 'errorCode' => 'UserQuantityExceed', + 'errorMessage' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', + 'description' => '您当前购买数量超过还可购买的数量余量，请重新选择数量！', + ], + [ + 'errorCode' => 'BASIC_INFO_UNCOMPLETED', + 'errorMessage' => 'You have not completed your personal basic information. Please complete the information and try again.', + 'description' => '您未完善个人基本信息，请完善信息后重新操作。（如果当前账号为托管子账号，请联系主账号点击此链接完善信息。） 去完善 ', + ], + [ + 'errorCode' => 'NoRealNameAuthentication', + 'errorMessage' => 'You have not completed real-name authentication.', + 'description' => '您尚未进行实名认证！', + ], + [ + 'errorCode' => 'NoAvaliablePaymentMethod', + 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'description' => '没有为您的帐户指定付款方式。我们建议您添加付款方式。', + ], + [ + 'errorCode' => 'CloudUserCannotBuyNotInnerCommodity', + 'errorMessage' => 'No group cloud product label, can not be purchased.', + 'description' => '无集团上云商品标签，无法购买。', + ], + [ + 'errorCode' => 'AccountStatusIllegal', + 'errorMessage' => 'The account status is illegal.', + 'description' => '账号状态不合法。', + ], + [ + 'errorCode' => 'ContainForbiddenLabelError', + 'errorMessage' => 'Placing an order is blocked due to an applied restriction label.', + 'description' => '存在禁止下单的标签，不可下单。', + ], + [ + 'errorCode' => 'AmountExceed.Entranceplan', + 'errorMessage' => 'The parameter Amount exceeds the number of entrance plan that can be purchased.', + 'description' => '参数Amount超过可购买免费版数量。', + ], + [ + 'errorCode' => 'QuotaExceed.FreePlan', + 'errorMessage' => 'Your account has reached the maximum allowed quota for free plan purchases.', + 'description' => '免费套餐可购数量Quota不足。', + ], + [ + 'errorCode' => 'PlanOrderUnpaid', + 'errorMessage' => 'You have an unpaid ESA order. Please complete or void the order at the User Center before placing another order.', + 'description' => '您有未支付的ESA订单，请在费用中心支付或作废后再下单。', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30423A7F-A83D-1E24-B80E-86DD25790758\\",\\n \\"OrderId\\": \\"123123\\",\\n \\"InstanceId\\": \\"esa-site-ads11w\\"\\n}","type":"json"}]', + 'title' => '套餐新购', + 'description' => '1. 套餐名称和套餐code从DescribeRatePlanPrice接口查询获取。'."\n" + .'2. 加速区域不是overseas时，站点必须已成功备案。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-18T03:30:35.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-06-13T03:33:33.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-04-08T06:39:34.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-02-20T05:44:58.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:40.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PurchaseRatePlan', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:PurchaseRatePlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'PurgeCaches' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238881', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBCJPGN', + 'FEATUREdcdnELTTM1', + 'FEATUREdcdnA9FG2P', + 'FEATUREdcdnRELTJV', + 'FEATUREdcdnEWYS3A', + 'FEATUREdcdn4QVGXU', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '刷新任务类型，取值：'."\n" + .'- **file**（默认值）：文件刷新。'."\n" + .'- **cachekey**：cachekey刷新。'."\n" + .'- **cachetag**：缓存标签刷新。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **ignoreParams**：去参数刷新。去参数指的是去除请求URL中?及?之后的参数，去参数刷新指的是用户先通过接口提交去参数后的URL，然后用户提交的待刷新URL将会与已缓存资源的URL进行去参数匹配，如果已缓存资源的URL去参数以后与待刷新URL匹配，那么CDN节点将对缓存资源执行刷新处理。'."\n" + .'- **hostname**：主机名刷新。'."\n" + .'- **purgeall**：刷新站点下所有缓存。', + 'type' => 'string', + 'required' => true, + 'example' => 'file', + 'enum' => [ + 'file', + 'cachetag', + 'directory', + 'ignoreparams', + 'hostname', + 'purgeall', + 'cachekey', + ], + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '刷新内容。', + 'type' => 'object', + 'properties' => [ + 'Files' => [ + 'description' => '文件刷新列表，类型为file时需要指定。', + 'type' => 'array', + 'items' => [ + 'description' => '文件刷新列表，类型为file时需要指定。'."\n" + ."\n" + .'> 每次最多1000条，每次最多包含10个不同域名。', + 'type' => 'any', + 'required' => false, + 'example' => '["http://a.com/1.jpg?b=1", "http://a.com/2.jpg?b=1"]', + ], + 'required' => false, + ], + 'CacheTags' => [ + 'description' => '缓存标记刷新列表，类型为cachetag时需要指定。', + 'type' => 'array', + 'items' => [ + 'description' => '缓存标记刷新列表，类型为cachetag时需要指定。'."\n" + ."\n" + .'> 每次最多30个。', + 'type' => 'string', + 'required' => false, + 'example' => '["tag1", "tag2"]', + ], + 'required' => false, + ], + 'Hostnames' => [ + 'description' => '主机名刷新列表，类型为hostname时需要指定。', + 'type' => 'array', + 'items' => [ + 'description' => '主机名刷新列表，类型为hostname时需要指定。'."\n" + .'> 每次最多10个域名。', + 'type' => 'string', + 'required' => false, + 'example' => '["a.com", "b.com"]', + ], + 'required' => false, + ], + 'IgnoreParams' => [ + 'description' => '忽略掉参数的文件列表，当类型为ignoreParams时需要指定。', + 'type' => 'array', + 'items' => [ + 'description' => '忽略掉参数的文件列表，当类型为ignoreParams时需要指定。'."\n" + ."\n" + .'> 每次最多100条，每次最多包含10个不同域名。', + 'type' => 'string', + 'required' => false, + 'example' => '["http://a.com/1.jpg", "http://a.com/2.jpg"]', + ], + 'required' => false, + ], + 'Directories' => [ + 'description' => '目录刷新列表，类型为directory时需要指定。', + 'type' => 'array', + 'items' => [ + 'description' => '目录刷新列表，类型为directory时需要指定。'."\n" + ."\n" + .'> 每次最多100条，每次最多包含10个不同域名。', + 'type' => 'string', + 'required' => false, + 'example' => '["http://a.com/path1/", "http://a.com/path2/"]', + ], + 'required' => false, + ], + 'PurgeAll' => [ + 'description' => '全站刷新标记。默认为false，当类型为purgeall时指定为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'CacheKeys' => [ + 'description' => 'cachekey刷新列表，类型为cachekey时需要指定。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '需要刷新的URL地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.com/1.jpg?b=1', + ], + 'Headers' => [ + 'description' => '刷新时指定cachekey对应的头部信息，当对应自定义cachekey功能开关开启时，将根据指定头部生成cachekey进行刷新。'."\n" + ."\n" + .'**UserGeo：国家/地区**'."\n" + ."\n" + .'- 国家/地区代码遵循 ISO 3166-2 标准。'."\n" + ."\n" + .'**UserDeviceType：设备类型，目前有如下三个枚举值**'."\n" + ."\n" + .'- desktop'."\n" + ."\n" + .'- tablet'."\n" + ."\n" + .'- mobile'."\n" + ."\n" + .'**UserLanguage：语言**'."\n" + ."\n" + .'- 语言代码遵循 ISO 639-1 标准或者 BCP47 标准，例如：输入zh，表示对语言为中文的内容进行刷新。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'cachekey头部对应的值信息。', + 'example' => '{"Url":"http://www.example.com/dog_picture.jpg","Headers":{"cat": "789", "Cookie": "test444=444;test333=333;test222=222", "UserGeo": "US", "UserDeviceType": "desktop","UserLanguage": "zh-CN"}}', + ], + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '当回源内容和源站资源对比后不一致时，是否刷新对应目录下的资源。默认为false。'."\n" + .'- **true**：刷新对应目录下的全部资源。'."\n" + .'- **false**：刷新对应目录下发生变更的资源。'."\n" + ."\n" + .'> '."\n" + .'> 生效范围：目录刷新、缓存标签刷新、去参数刷新、主机名刷新及刷新站点下所有缓存。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EdgeComputePurge', + 'in' => 'query', + 'schema' => [ + 'description' => '用于边缘计算缓存资源的刷新，例如允许对使用边缘函数CacheAPI接口缓存的内容进行刷新。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + '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' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', + ], + 'TaskId' => [ + 'description' => '任务ID，当您创建刷新或预热任务，会返回任务ID。', + 'type' => 'string', + 'example' => '15940956620', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidStationParameter', + 'errorMessage' => 'The specified Station is invalid.', + 'description' => '指定的节点参数无效。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified taskId is invalid.', + 'description' => '指定的任务ID无效。', + ], + [ + 'errorCode' => 'InvalidParameters.InvalidUrls', + 'errorMessage' => 'The specified urls are invalid.', + 'description' => '请求的URL参数无效。', + ], + [ + 'errorCode' => 'QuotaExceeded', + 'errorMessage' => 'You attempts have exceeded the daily limit.', + 'description' => '超出当日配额限制。今日提交数量已用完。您可以通过配额接口查询今日的可使用次数。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordNotBelongToSite', + 'errorMessage' => 'The record name passed in does not belong to the current site.', + 'description' => '传入的记录名不属于当前站点。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'System load fluctuates, please try again later.', + 'description' => '系统负载波动，请稍候重试。', + ], + ], + ], + 'title' => '刷新节点缓存', + 'summary' => '刷新节点上的文件内容。支持文件、目录、缓存标记、去参数、主机名及全站刷新。', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-13T07:58:30.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-02-10T01:55:17.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-12-06T02:11:35.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2024-10-15T01:58:27.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PurgeCaches', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:PurgeCaches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ET5BF670-09D5-4D0B-BEBY-D96A2A528000\\",\\n \\"TaskId\\": \\"15940956620\\"\\n}","type":"json"}]', + ], + 'PutKv' => [ + 'summary' => '设置KV存储空间的单个键值对，请求大小限制为2M。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238811', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namespace', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '需要设置的键名称，最长不超过512个字符，不能包含空格、反斜杠（/）。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_key', + ], + ], + [ + 'name' => 'Value', + 'in' => 'formData', + 'schema' => [ + 'description' => '键的内容，最大2 MB（2\\*1000\\*1000）。超过2M请使用[PutKvWithHighCapacity](~~2850486~~)', + 'type' => 'string', + 'required' => true, + 'example' => 'test_value', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => '过期时间（秒级时间戳，不能小于当前时间），同时设置Expiration和ExpirationTtl时，以ExpirationTtl为准。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1690081381', + ], + ], + [ + 'name' => 'ExpirationTtl', + 'in' => 'query', + 'schema' => [ + 'description' => '过期时间（相对时间，单位：秒），同时设置Expiration和ExpirationTtl时，以ExpirationTtl为准。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'Base64', + 'in' => 'query', + 'schema' => [ + 'description' => '当需要存储二进制值时指定此参数为true，同时Value参数需进行base64编码。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'Length' => [ + 'description' => '键值对中的值的长度。', + 'type' => 'string', + 'example' => '4', + ], + 'Value' => [ + 'description' => '键值对的内容， 超过256个字符长度，将取前100及后100字符并省略中间。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '设置KV存储空间的单个键值对', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-20T13:49:27.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '50', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PutKv', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:PutKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Length\\": \\"4\\",\\n \\"Value\\": \\"test\\"\\n}","type":"json"}]', + ], + 'PutKvWithHighCapacity' => [ + 'summary' => '设置KV存储空间的单个大容量键值对，最大支持25M的值内容。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238726', + 'abilityTreeNodes' => [ + 'FEATUREdcdnGMYWU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '调用[CreateKvNamespace](~~2850317~~)时指定的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_namesapce', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '需要设置的键名称，最长不超过512个字符，不能包含空格、反斜杠（/）。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_key', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '存储有需要设置的键值对的下载链接，此参数由调用SDK时自动生成，请使用SDK进行调用。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', + 'isFileTransferUrl' => true, + ], + ], + ], + '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' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', + ], + 'Length' => [ + 'description' => '键值对中的值的长度。', + 'type' => 'string', + 'example' => '4', + ], + 'Value' => [ + 'description' => '键的内容， 超过256个字符长度，将取前100及后100字符并省略中间。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified account is invalid.', + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'errorCode' => 'InvalidNameSpace.Malformed', + 'errorMessage' => 'The specified namespace is invalid.', + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified key is invalid.', + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'errorCode' => 'InvalidKey.ExceedsMaximum', + 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', + 'description' => '请求的Key的长度过大。', + ], + [ + 'errorCode' => 'InvalidValue.ExceedsMaximum', + 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'description' => '存入的值过大。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidKey.ExceedsCapacity', + 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'description' => '存储空间的容量超过限制。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidParameters', + 'errorMessage' => 'The specified authentication parameters are invalid.', + 'description' => '鉴权参数输入错误。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'InvalidAccount.NotFound', + 'errorMessage' => 'The specified account does not exist.', + 'description' => '指定的账号不存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.NotFound', + 'errorMessage' => 'The specified namespace does not exist.', + 'description' => '指定的存储空间不存在。', + ], + [ + 'errorCode' => 'InvalidKey.NotFound', + 'errorMessage' => 'The specified key does not exist.', + 'description' => '指定的键值对不存在。', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidNameSpace.Duplicate', + 'errorMessage' => 'The specified namespace already exists.', + 'description' => '指定的存储空间已经存在。', + ], + [ + 'errorCode' => 'InvalidNameSpace.QuotaFull', + 'errorMessage' => 'The maximum number of namespaces is exceeded.', + 'description' => '存储空间的个数超过容量限制。', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests are submitted.', + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'errorCode' => 'TooQuickRequests', + 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', + 'description' => '键值对的修改或者删除操作太频繁。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '设置KV存储空间的单个大容量键值对', + 'description' => '本接口与[PutKv](~~PutKv~~)的功能一样，只是允许上传更大请求体。当请求体较小时推荐直接使用[PutKv](~~PutKv~~)接口，从而减少服务端处理时间。本接口需要使用SDK进行调用。以golang SDK为例，需要使用PutKvWithHighCapacityAdvance函数进行调用。'."\n" + .'```'."\n" + .'func TestPutKvWithHighCapacity() {'."\n" + .' // 配置初始化'."\n" + .' cfg := new(openapi.Config)'."\n" + .' cfg.SetAccessKeyId("xxxxxxxxx")'."\n" + .' cfg.SetAccessKeySecret("xxxxxxxxxx")'."\n" + .' cli, err := NewClient(cfg)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + .' runtime := &util.RuntimeOptions{}'."\n" + ."\n" + .' // 构造待上传的键值对请求'."\n" + .' namespace := "test-put-kv"'."\n" + .' key := "test_PutKvWithHighCapacity_0"'."\n" + .' value := strings.Repeat("t", 10*1024*1024)'."\n" + .' rawReq := &PutKvRequest{'."\n" + .' Namespace: &namespace,'."\n" + .' Key: &key,'."\n" + .' Value: &value,'."\n" + .' }'."\n" + .' payload, err := json.Marshal(rawReq)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + ."\n" + .' // 如果payload大于2M，则调用大容量接口进行上传'."\n" + .' reqHighCapacity := &PutKvWithHighCapacityAdvanceRequest{'."\n" + .' Namespace: &namespace,'."\n" + .' Key: &key,'."\n" + .' UrlObject: bytes.NewReader([]byte(payload)),'."\n" + .' }'."\n" + ."\n" + .' resp, err := cli.PutKvWithHighCapacityAdvance(reqHighCapacity, runtime)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }'."\n" + .' return nil'."\n" + .'}', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-20T13:49:26.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '2', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PutKvWithHighCapacity', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:PutKvWithHighCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Length\\": \\"4\\",\\n \\"Value\\": \\"test\\"\\n}","type":"json"}]', + ], + 'RebuildEdgeContainerAppStagingEnv' => [ + 'summary' => '重新构建边缘容器应用的测试环境。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238564', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-88068867578379****', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '重建边缘容器应用的测试环境', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RebuildEdgeContainerAppStagingEnv', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:RebuildEdgeContainerAppStagingEnv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'ResetScheduledPreloadJob' => [ + 'summary' => '重置定时预热任务的进度，从头开始预热。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239114', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '定时预热任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '665d3af3621bccf3fe29e1a4'."\n", + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'AliUid' => [ + 'title' => '阿里云UID', + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + 'CreatedAt' => [ + 'title' => '任务创建时间', + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2024-06-02T02:23:26Z', + ], + 'Domains' => [ + 'title' => '预热域名列表', + 'description' => '预热域名列表。', + 'type' => 'string', + 'example' => 'testurl.com', + ], + 'ErrorInfo' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'invalid domain:test.com', + ], + 'FailedFileOss' => [ + 'title' => '失败文件OSS地址', + 'description' => '失败文件OSS地址。', + 'type' => 'string', + 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', + ], + 'FileId' => [ + 'title' => 'URL列表文件ID（下载时使用）', + 'description' => 'URL列表文件ID（下载时使用）。', + 'type' => 'string', + 'example' => '665d3b48621bccf3fe29e1a7', + ], + 'Id' => [ + 'title' => '任务ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'InsertWay' => [ + 'title' => 'URL插入方式', + 'description' => 'URL插入方式。', + 'type' => 'string', + 'example' => 'oss', + 'enum' => [ + 'file', + 'url', + ], + ], + 'Name' => [ + 'title' => '任务名称', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'example', + ], + 'SiteId' => [ + 'title' => '站点ID', + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '190007158391808', + ], + 'TaskSubmitted' => [ + 'title' => '已提交的cdncm预热任务数', + 'description' => '已提交到系统进行预热任务的URL数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskType' => [ + 'title' => '任务类型（刷新/预热）', + 'description' => '任务类型（刷新/预热）。', + 'type' => 'string', + 'example' => 'preload', + 'enum' => [ + 'preload', + 'refresh', + 'path', + ], + ], + 'UrlCount' => [ + 'title' => 'URL总数', + 'description' => 'URL总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UrlSubmitted' => [ + 'title' => '已提交的URL数', + 'description' => '已提交的URL数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '重置定时预热任务的进度', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ResetScheduledPreloadJob', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:ResetScheduledPreloadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"AliUid\\": \\"15685865xxx14622\\",\\n \\"CreatedAt\\": \\"2024-06-02T02:23:26Z\\",\\n \\"Domains\\": \\"testurl.com\\",\\n \\"ErrorInfo\\": \\"invalid domain:test.com\\",\\n \\"FailedFileOss\\": \\"https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7\\",\\n \\"FileId\\": \\"665d3b48621bccf3fe29e1a7\\",\\n \\"Id\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"InsertWay\\": \\"oss\\",\\n \\"Name\\": \\"example\\",\\n \\"SiteId\\": 190007158391808,\\n \\"TaskSubmitted\\": 1,\\n \\"TaskType\\": \\"preload\\",\\n \\"UrlCount\\": 2,\\n \\"UrlSubmitted\\": 1\\n}","type":"json"}]', + ], + 'RevokeClientCertificate' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239109', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com'."\n", + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '吊销客户端证书', + 'summary' => '吊销已激活的客户端证书。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RevokeClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:RevokeClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\"\\n}","type":"json"}]', + ], + 'RollbackEdgeContainerAppVersion' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239284', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID', + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-88068867578379****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'title' => '版本ID', + 'description' => '回滚到指定版本的版本ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ver-87962637161651****', + 'maxLength' => 64, + 'minLength' => 20, + ], + ], + [ + 'name' => 'Remarks', + 'in' => 'formData', + 'schema' => [ + 'title' => '备注信息', + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test rollback app', + 'maxLength' => 1024, + ], + ], + [ + 'name' => 'UsedPercent', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用百分比回滚。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Percentage', + 'in' => 'query', + 'schema' => [ + 'description' => '调整后的发布比例。取值：**1~100**，默认值：**0**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter.VersionId', + 'errorMessage' => 'The specified VersionId is invalid.  Please check the VersionId parameter. You may not have entered the parameter or the parameter does not start with ver-string. Please modify it and call the interface again.', + 'description' => 'VersionId参数无效。请检查VersionId参数，你有可能未输入该参数或者，参数并未以ver-字符串开头，请进行修改后，重新调用接口。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '回滚边缘容器应用', + 'summary' => '回滚边缘容器应用的某个版本，可以通过此接口快速回退异常版本，及时止损。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-08T08:08:06.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RollbackEdgeContainerAppVersion', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:RollbackEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', + ], + 'SetCertificate' => [ + 'summary' => '用于设置某站点下是否启用证书功能及更新证书信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239628', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID。可通过[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书名称，type为upload类型时需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourCertName', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'CasId', + 'in' => 'formData', + 'schema' => [ + 'description' => '云证书Id，type为cas的情况下需要输入该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30000478'."\n", + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书类型。'."\n" + ."\n" + .'- **cas**：证书中心证书'."\n" + ."\n" + .'- **upload**：自定义上传证书'."\n" + ."\n" + .'- **keyless**：keyless证书', + 'type' => 'string', + 'required' => true, + 'example' => 'cas', + 'enum' => [ + 'cas', + 'upload', + 'keyless', + ], + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书内容，type为upload类型时需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE-----', + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书私钥，type为upload类型时需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN PRIVATE KEY-----', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域，type为cas的情况下需要输入该参数。'."\n" + ."\n" + .'- 中国站账号传参数值：cn-hangzhou'."\n" + ."\n" + .'- 国际站账号传参数值：ap-southeast-1', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书Id，不支持 free 类型（通过接口ApplyCertificate创建）的证书 Id，可以支持 cas 和 upload 类型的证书 Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'babae7c40fef412d887688b91c9e****', + ], + ], + [ + 'name' => 'KeyServerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Keyless server ID，当Type为keyless时有效。', + 'type' => 'string', + 'required' => false, + 'example' => '1233112****', + ], + ], + ], + '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' => 'A666D44F-19D6-490E-97CF-1A64AB962C57', + ], + 'Id' => [ + 'description' => '证书Id', + 'type' => 'string', + 'example' => 'babae7c40fef412d887688b91c9e****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'Certificate.Duplicated', + 'errorMessage' => 'The certificate name already exists.', + 'description' => '证书重复。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InvalidCertificate.NotFound', + 'errorMessage' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.', + 'description' => '您提供的证书与该站点不匹配，请确认证书的有效性并重新发起请求。', + ], + [ + 'errorCode' => 'InvalidSSLPub', + 'errorMessage' => 'The specified Certificate is invalid.', + 'description' => 'Certificate错误，请重新填写。', + ], + [ + 'errorCode' => 'InvalidSSLPri', + 'errorMessage' => 'The specified PrivateKey is invalid.', + 'description' => 'PrivateKey错误，请填写正确的PrivateKey。', + ], + [ + 'errorCode' => 'CasId.MissingParameter', + 'errorMessage' => 'The CasId parameter is required.', + 'description' => 'CasId参数缺失。', + ], + [ + 'errorCode' => 'PrivateKey.MissingParameter', + 'errorMessage' => 'The PrivateKey parameter is required.', + 'description' => 'PrivateKey参数缺失。', + ], + [ + 'errorCode' => 'Certificate.MissingParameter', + 'errorMessage' => 'The Certificate parameter is required.', + 'description' => 'Certificate参数缺失。', + ], + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'UpdateFreeCertificate.NotSupport', + 'errorMessage' => 'The free certificate does not support the update operation.', + 'description' => '免费证书不支持更新操作。', + ], + [ + 'errorCode' => 'CertificateDomainNotMatchSite', + 'errorMessage' => 'The domain name in the specified certificate does not match the site.', + 'description' => '证书中的域名和当前站点不匹配。', + ], + [ + 'errorCode' => 'CertificateNotMatchPrivateKey', + 'errorMessage' => 'The specified certificate does not match the private key.', + 'description' => '指定的证书和私钥不匹配。', + ], + [ + 'errorCode' => 'CertQuotaCheckFailed', + 'errorMessage' => 'The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.', + 'description' => '自定义证书配额校验失败，上传证书数量超过套餐允许上限。', + ], + ], + 404 => [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"Id\\": \\"babae7c40fef412d887688b91c9e****\\"\\n}","type":"json"}]', + 'title' => '配置站点证书', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-13T01:37:33.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-01-09T05:44:49.000Z', + 'description' => '响应参数发生变更', + ], + [ + 'createdAt' => '2024-10-15T03:45:00.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-10-03T13:48:40.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T09:53:46.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-06T06:59:01.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:SetCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SetClientCertificateHostnames' => [ + 'summary' => '给指定的客户端CA证书绑定域名，不指定证书时，域名绑定到ESA CA证书。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239185', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Hostnames', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '绑定的域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户端CA证书ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'babab9db65ee5efcca9f3d41d4b50d**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com ', + ], + 'Id' => [ + 'description' => '客户端CA证书ID。', + 'type' => 'string', + 'example' => 'babab9db65ee5efcca9f3d41d4b50d**', + ], + 'Hostnames' => [ + 'description' => '绑定的域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + [ + [ + 'errorCode' => 'Certificate.NotFound', + 'errorMessage' => 'The specified certificate does not exist.', + 'description' => '指定的证书不存在。', + ], + ], + ], + 'title' => '设置客户端证书域名绑定', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-13T09:10:44.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetClientCertificateHostnames', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:SetClientCertificateHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Id\\": \\"babab9db65ee5efcca9f3d41d4b50d**\\",\\n \\"Hostnames\\": [\\n \\"www.example.com\\"\\n ],\\n \\"RequestId\\": \\"ET5BF670-09D5-4D0B-BEBY-D96A2A528000\\"\\n}","type":"json"}]', + ], + 'SetDdosMaxBurstGbps' => [ + 'summary' => '设置DDoS实例的国内最大防护带宽', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254004', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '实例ID，可通过调用[ListUserRatePlanInstances](~~2852398~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'esa-site-ads11w', + ], + ], + [ + 'name' => 'MaxBurstGbps', + 'in' => 'query', + 'schema' => [ + 'description' => 'DDoS实例的国内最大防护带宽，单位Gbps。', + 'type' => 'string', + 'required' => true, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'PlanNotSupportCnDdos', + 'errorMessage' => 'The plan corresponding to the current instance does not include ddos platform protection in mainland China, so the DDOS elastic protection value cannot be set. Please upgrade the package and try again.', + 'description' => '当前实例对应的套餐不包含中国大陆地区的ddos平台防护，因此不能设置DDOS弹性防护值，请升级套餐后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '设置DDoS实例的国内最大防护带宽', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'SetHttpDDoSAttackIntelligentProtection' => [ + 'summary' => '该接口用于设置HTTP DDoS深度学习和防护配置信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239326', + 'abilityTreeNodes' => [ + 'FEATUREdcdnO1ZP9O', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + [ + 'name' => 'AiMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP DDoS深度学习和防护模式。取值：'."\n" + .'- **observe**：观察'."\n" + .'- **defense**：拦截', + 'type' => 'string', + 'required' => true, + 'example' => 'defense', + 'enum' => [ + 'observe', + 'defense', + ], + ], + ], + [ + 'name' => 'AiTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP DDoS深度学习和防护等级。取值：'."\n" + .'- **level0**：非常宽松'."\n" + .'- **level30**：宽松'."\n" + .'- **level60**：正常'."\n" + .'- **level90**：严格', + 'type' => 'string', + 'required' => true, + 'example' => 'level60', + 'enum' => [ + 'level30', + 'level60', + 'level90', + 'level0', + ], + ], + ], + ], + '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' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'AiMode' => [ + 'description' => 'HTTP DDoS智能防护模式。取值：'."\n" + .'- **observe**：预警'."\n" + .'- **defense**：防护', + 'type' => 'string', + 'example' => 'defense', + ], + 'AiTemplate' => [ + 'description' => 'HTTP DDoS智能防护等级。取值：'."\n" + .'- **level0**：非常宽松'."\n" + .'- **level30**：宽松'."\n" + .'- **level60**：正常'."\n" + .'- **level90**：严格', + 'type' => 'string', + 'example' => 'level60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"SiteId\\": 0,\\n \\"AiMode\\": \\"defense\\",\\n \\"AiTemplate\\": \\"level60\\"\\n}","type":"json"}]', + 'title' => '设置HTTP DDoS深度学习和防护配置信息', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-19T03:35:34.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetHttpDDoSAttackIntelligentProtection', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:SetHttpDDoSAttackIntelligentProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'SetHttpDDoSAttackProtection' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239030', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + [ + 'name' => 'GlobalMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP DDoS攻击防护策略模式。取值：'."\n" + .'- **very weak**：表示非常宽松。'."\n" + .'- **weak**：表示宽松。'."\n" + .'- **default**：表示正常。'."\n" + .'- **hard**：表示严格。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + 'enum' => [ + 'weak', + 'default', + 'hard', + 'very weak', + ], + ], + ], + ], + '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' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456****', + ], + 'GlobalMode' => [ + 'description' => 'HTTP DDoS攻击防护策略模式。', + 'type' => 'string', + 'example' => 'default'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '设置HTTP DDoS攻击防护配置信息', + 'summary' => '该接口用于设置HTTP DDoS攻击防护策略模式。', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-19T03:35:34.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetHttpDDoSAttackProtection', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:SetHttpDDoSAttackProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"SiteId\\": 0,\\n \\"GlobalMode\\": \\"default\\\\n\\"\\n}","type":"json"}]', + ], + 'SetHttpDDoSAttackRuleAction' => [ + 'summary' => '设置HTTP DDoS攻击防护指定规则防护动作。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263689', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要操作的规则ID列表，多个ID用英文逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeHttpDDoSAttackRules](~~DescribeHttpDDoSAttackRules~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '100000', + 'minLength' => 1, + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'description' => '规则动作，取值：'."\n" + ."\n" + .'- **deny**：拦截。'."\n" + ."\n" + .'- **js**：JS验证。'."\n" + ."\n" + .'- **observe**：观察。', + 'type' => 'string', + 'required' => true, + 'example' => 'js', + 'enum' => [ + 'deny', + 'js', + 'observe', + ], + ], + ], + ], + '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' => 'C370DAF1-C838-4288-A1A0-9A87633D2***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'The specified SiteId is invalid.', + 'description' => '站点ID参数非法。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '设置HTTP DDoS攻击防护指定规则防护动作', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:SetHttpDDoSAttackRuleAction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D2***\\"\\n}","type":"json"}]', + ], + 'SetHttpDDoSAttackRuleStatus' => [ + 'summary' => '设置HTTP DDoS攻击防护指定规则防护状态', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '263688', + 'abilityTreeNodes' => [ + 'FEATUREdcdn5DYCZJ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'example' => '123456****', + ], + ], + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要操作的规则ID列表，多个ID用英文逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeHttpDDoSAttackRules](~~DescribeHttpDDoSAttackRules~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '87570', + 'minLength' => 1, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '规则状态'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => 'F7B84CF8-F8A4-53F8-9B91-2643FD72042B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'The specified SiteId is invalid.', + 'description' => '站点ID参数非法。', + ], + [ + 'errorCode' => 'ErrSiteIdNoteEnterprise', + 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + ], + 403 => [ + [ + 'errorCode' => 'SiteIdDDoSVersionCheckFailed', + 'errorMessage' => 'SiteId DDoS version check failed.', + 'description' => '站点对应DDoS版本检查失败。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '设置HTTP DDoS攻击防护指定规则防护状态', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:SetHttpDDoSAttackRuleStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7B84CF8-F8A4-53F8-9B91-2643FD72042B\\"\\n}","type":"json"}]', + ], + 'SetOriginClientCertificateHostnames' => [ + 'summary' => '为域名粒度回源客户端证书绑定域名。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261756', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'babaabcd****', + ], + ], + [ + 'name' => 'Hostnames', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '绑定的域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'SiteName' => [ + 'description' => '站点名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Hostnames' => [ + 'description' => '绑定的域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + ], + 'SiteId' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456789****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'Id.MissingParameter', + 'errorMessage' => 'The parameter Id is required.', + 'description' => '缺少必填参数Id。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '为域名粒度回源客户端证书绑定域名', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-31T09:21:09.000Z', + 'description' => '响应参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetOriginClientCertificateHostnames', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:SetOriginClientCertificateHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"SiteName\\": \\"example.com\\",\\n \\"Hostnames\\": [\\n \\"www.example.com\\"\\n ],\\n \\"SiteId\\": 0\\n}","type":"json"}]', + ], + 'StartScheduledPreloadExecution' => [ + 'summary' => '根据预热计划ID开启一个定时预热。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239332', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => '665d3b48621bccf3fe29e1a7', + ], + ], + ], + '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' => '65C66B7B-671A-8297-9187-2R5477247B76', + ], + 'Id' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'example' => '665d3b48621bccf3fe29e1a7', + ], + 'StartTime' => [ + 'description' => '定时预热计划开始时间。', + 'type' => 'string', + 'example' => '2024-05-31T17:10:48.849+08:00', + ], + 'EndTime' => [ + 'description' => '定时预热计划结束时间。', + 'type' => 'string', + 'example' => '2024-05-31T18:10:48.849+08:00', + ], + 'Interval' => [ + 'description' => '定时预热计划每批执行间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'SliceLen' => [ + 'description' => '每批定时预热URL个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Status' => [ + 'description' => '定时预热计划的状态，包括如下状态。'."\n" + .'- **waiting**：等待被执行。'."\n" + .'- **running**：正在执行中。'."\n" + .'- **finished**：执行完成。'."\n" + .'- **failed**：执行失败。'."\n" + .'- **stopped**：暂停执行中。', + 'type' => 'string', + 'example' => 'waiting', + ], + 'JobId' => [ + 'description' => '预热任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '开始单个定时预热计划', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StartScheduledPreloadExecution', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:StartScheduledPreloadExecution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\",\\n \\"Id\\": \\"665d3b48621bccf3fe29e1a7\\",\\n \\"StartTime\\": \\"2024-05-31T17:10:48.849+08:00\\",\\n \\"EndTime\\": \\"2024-05-31T18:10:48.849+08:00\\",\\n \\"Interval\\": 60,\\n \\"SliceLen\\": 10,\\n \\"Status\\": \\"waiting\\",\\n \\"JobId\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"AliUid\\": \\"15685865xxx14622\\"\\n}","type":"json"}]', + ], + 'StopScheduledPreloadExecution' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239019', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => '66599bd7397885b43804901c', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + 'Id' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'example' => '66599bd7397885b43804901c', + ], + 'StartTime' => [ + 'description' => '定时预热计划开始时间。', + 'type' => 'string', + 'example' => '2024-05-31T17:10:48.849+08:00', + ], + 'EndTime' => [ + 'description' => '定时预热计划结束时间。', + 'type' => 'string', + 'example' => '2024-05-31T18:10:48.849+08:00', + ], + 'Interval' => [ + 'description' => '定时预热计划每批执行间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'SliceLen' => [ + 'description' => '每批定时预热URL个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Status' => [ + 'description' => '定时预热计划的状态，包括如下状态。'."\n" + .'- **waiting**：等待被执行。'."\n" + .'- **running**：正在执行中。'."\n" + .'- **finished**：执行完成。'."\n" + .'- **failed**：执行失败。'."\n" + .'- **stopped**：暂停执行中。', + 'type' => 'string', + 'example' => 'stopped', + ], + 'JobId' => [ + 'description' => '预热任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '停止单个定时预热计划', + 'summary' => '根据预热计划ID停止单个定时预热计划。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StopScheduledPreloadExecution', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:StopScheduledPreloadExecution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"Id\\": \\"66599bd7397885b43804901c\\",\\n \\"StartTime\\": \\"2024-05-31T17:10:48.849+08:00\\",\\n \\"EndTime\\": \\"2024-05-31T18:10:48.849+08:00\\",\\n \\"Interval\\": 60,\\n \\"SliceLen\\": 10,\\n \\"Status\\": \\"stopped\\",\\n \\"JobId\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"AliUid\\": \\"15685865xxx14622\\"\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238938', + 'abilityTreeNodes' => [ + 'FEATUREdcdn6S5O3S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID，取值范围如下：'."\n" + ."\n" + .'- 中国站：cn-hangzhou'."\n" + .'- 国际站：ap-southeast-1', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。请输入站点ID或者DNS记录ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。请输入站点ID或者DNS记录ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。最多可输入20个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。最多可输入20个标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'env', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => true, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '资源类型。取值范围如下：'."\n" + ."\n" + .'- 站点：**site**'."\n" + .'- DNS记录：**record**', + 'type' => 'string', + 'required' => true, + 'example' => 'site', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + [ + 'errorCode' => 'Record.NotFound', + 'errorMessage' => 'The record does not exist. Check your configurations and try again.', + 'description' => '传入的请求记录不存在，请检查您的输入参数后重试。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '添加资源标签', + 'summary' => '调用TagResources添加资源标签。', + 'changeSet' => [ + [ + 'createdAt' => '2025-08-21T07:40:23.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'TagResources', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\"\\n}","type":"json"}]', + ], + 'UntagResources' => [ + 'summary' => '根据指定的资源ID删除资源标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239579', + 'abilityTreeNodes' => [ + 'FEATUREdcdn6S5O3S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID，取值范围如下：'."\n" + ."\n" + .'- 中国站：cn-hangzhou'."\n" + .'- 国际站：ap-southeast-1', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。请输入站点ID或者DNS记录ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。请输入站点ID或者DNS记录ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键。N的取值范围：**1**~**20**。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。N的取值范围：**1**~**20**。', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '资源类型。取值范围如下：'."\n" + ."\n" + .'- 站点：site'."\n" + .'- DNS记录：record', + 'type' => 'string', + 'required' => true, + 'example' => 'site', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '删除所有标签。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'默认取值为**false**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '85H66C7B-671A-4297-9187-2C4477247A74', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified resource does not exist or is released.', + 'description' => '资源不存在或已被释放。', + ], + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + [ + 'errorCode' => 'Record.NotFound', + 'errorMessage' => 'The record does not exist. Modify it and try again.', + 'description' => '该记录不存在，请调整后重试。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除资源标签', + 'changeSet' => [ + [ + 'createdAt' => '2025-08-21T07:40:23.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:40.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UntagResources', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85H66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'UpdateCacheReserveSpec' => [ + 'summary' => '缓存保持变配。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249938', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'esa-cr-9tuv*********', + ], + ], + [ + 'name' => 'TargetQuotaGb', + 'in' => 'query', + 'schema' => [ + 'description' => 'cache申请大小，单位GB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '计费类型'."\n" + .'- PREPAY：预付费。'."\n" + .'- POSTPAY：后付费。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PREPAY' => '预付费', + 'POSTPAY' => '后付费', + ], + 'example' => 'PREPAY', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '自动支付。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '40423A7F-A83D-1E24-B80E-86DD25790759'."\n", + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2223332122***'."\n", + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'esa-cr-9tuv*********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'CheckPlanFailed', + 'errorMessage' => 'Invalid plan name or code. Check and try again.', + 'description' => '您配置的套餐名或套餐Code不正确，请确保已传入正确的套餐名或套餐Code后重试。', + ], + [ + 'errorCode' => 'InvalidSiteICP', + 'errorMessage' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'description' => '您配置的站点未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + [ + 'errorCode' => 'InvalidSiteName', + 'errorMessage' => 'Invalid website name. Check and try again.', + 'description' => '您配置的站点名称不正确，请确保传入正确的站点名称后重试。', + ], + [ + 'errorCode' => 'SYSTEM.NoSpecificCodeFailed', + 'errorMessage' => 'Invalid subscription duration. Check and try again.', + 'description' => '您配置的套餐购买周期不正确，请检查后重试。', + ], + [ + 'errorCode' => 'Order.InstanceHasUnpaidOrder', + 'errorMessage' => 'You have an unpaid order. Complete the payment or cancel the order first.', + 'description' => '您购买套餐未支付，请支付或作废后再下单。', + ], + [ + 'errorCode' => 'InvalidInstance', + 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', + 'description' => '实例ID缺失或者参数无效，请确认实例ID无误后重试。', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号余额不足，请充值后再购买。', + ], + [ + 'errorCode' => 'InsufficientAvailableQuota', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号已欠费，请缴清欠费后再购买。', + ], + [ + 'errorCode' => 'UpdowngradeConfigNoChange', + 'errorMessage' => 'Failed to change the configuration because the new configuration you specified is the same as the current one in use. Specify a correct configuration and try again.', + 'description' => '升级或降配的配置未改变。', + ], + [ + 'errorCode' => 'InvalidComponent', + 'errorMessage' => 'The order parameters is invalid.', + 'description' => '订单配置参数不符合校验条件。', + ], + [ + 'errorCode' => 'RamAuthFailed', + 'errorMessage' => 'The sub-account has no operation permission.', + 'description' => '子账号无操作权限.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40423A7F-A83D-1E24-B80E-86DD25790759\\\\n\\",\\n \\"OrderId\\": \\"2223332122***\\\\n\\",\\n \\"InstanceId\\": \\"esa-cr-9tuv*********\\"\\n}","type":"json"}]', + 'title' => '缓存保持变配', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCacheReserveSpec', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UpdateCacheReserveSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'UpdateCacheRule' => [ + 'summary' => '修改缓存配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257965', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")', + ], + ], + [ + 'name' => 'BypassCache', + 'in' => 'query', + 'schema' => [ + 'description' => '设置绕过缓存模式。取值范围：'."\n" + .'- cache_all：所有请求都缓存。'."\n" + .'- bypass_all：所有请求都绕过缓存。', + 'type' => 'string', + 'required' => false, + 'example' => 'cache_all', + ], + ], + [ + 'name' => 'BrowserCacheMode', + 'in' => 'query', + 'schema' => [ + 'description' => '浏览器缓存模式。取值范围：'."\n" + .'- no_cache：不缓存。'."\n" + .'- follow_origin：遵循源站缓存策略。'."\n" + .'- override_origin：代替源站缓存策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'no_cache', + ], + ], + [ + 'name' => 'BrowserCacheTtl', + 'in' => 'query', + 'schema' => [ + 'description' => '浏览器缓存过期时间，单位是秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'EdgeCacheMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点缓存模式。取值范围：'."\n" + .'- follow_origin：遵循源站缓存策略（如果存在），否则使用默认缓存策略。'."\n" + .'- no_cache：不缓存。'."\n" + .'- override_origin：代替源站缓存策略。'."\n" + .'- follow_origin_bypass：遵循源站缓存策略（如果存在），否则不缓存。'."\n" + .'- follow_origin_override：遵循源站缓存策略（如果存在），否则使用自定义缓存TTL。', + 'type' => 'string', + 'required' => false, + 'example' => 'follow_origin', + ], + ], + [ + 'name' => 'EdgeCacheTtl', + 'in' => 'query', + 'schema' => [ + 'description' => '节点缓存过期时间，单位是秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'EdgeStatusCodeCacheTtl', + 'in' => 'query', + 'schema' => [ + 'description' => '状态码缓存过期时间，单位是秒。'."\n" + .'- 支持对指定状态码设置缓存过期时间，例如：404=10，表示对404状态码缓存10秒。'."\n" + .'- 支持对4xx、5xx系列状态码设置缓存过期时间，例如：4xx=10，表示对400系列的所有状态码都缓存10秒。', + 'type' => 'string', + 'required' => false, + 'example' => '4xx=10', + ], + ], + [ + 'name' => 'SortQueryStringForCache', + 'in' => 'query', + 'schema' => [ + 'description' => '查询字符串排序。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'QueryStringMode', + 'in' => 'query', + 'schema' => [ + 'description' => '在生成缓存键的时候，对查询字符串的处理模式。取值：'."\n" + .'- ignore_all：全部忽略。'."\n" + .'- exclude_query_string：删除指定查询字符串。'."\n" + .'- reserve_all：默认值，全部保留。'."\n" + .'- include_query_string：保留指定查询字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore_all', + ], + ], + [ + 'name' => 'QueryString', + 'in' => 'query', + 'schema' => [ + 'description' => '需要保留或者删除的查询字符串，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'IncludeHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，包括指定的标头名称及其值，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'headername', + ], + ], + [ + 'name' => 'IncludeCookie', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，包括指定的cookie名称及其值，支持输入多个值，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cookiename', + ], + ], + [ + 'name' => 'CacheReserveEligibility', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存保持资格。用于控制用户请求在回源的时候是否绕过缓存保持节点。取值范围：'."\n" + .'- bypass_cache_reserve：请求绕过缓存保持。'."\n" + .'- eligible_for_cache_reserve：符合缓存保持资格。', + 'type' => 'string', + 'required' => false, + 'example' => 'bypass_cache_reserve', + ], + ], + [ + 'name' => 'CheckPresenceHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，检查header是否存在，如果存在，则在缓存键中加入header名称（header名称不区分大小写）。支持输入多个header名称，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'headername', + ], + ], + [ + 'name' => 'CheckPresenceCookie', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，检查cookie是否存在，如果存在，则在缓存键中加入cookie名称（cookie名称不区分大小写）。支持输入多个cookie名称，多个值之间用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cookiename', + ], + ], + [ + 'name' => 'UserDeviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，加入客户端设备类型。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'UserGeo', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，加入客户端地理位置。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'UserLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '生成缓存键的时候，加入客户端语言类型。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'ServeStale', + 'in' => 'query', + 'schema' => [ + 'description' => '响应过期缓存。开启之后，在源服务器不可用的情况下，节点依然可以使用已缓存的过期文件响应用户请求。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AdditionalCacheablePorts', + 'in' => 'query', + 'schema' => [ + 'description' => '在指定端口上开启缓存功能。取值范围：8880、2052、2082、2086、2095、2053、2083、2087、2096。', + 'type' => 'string', + 'required' => false, + 'example' => '8880', + ], + ], + [ + 'name' => 'CacheDeceptionArmor', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存欺骗防御。用于防御Web缓存欺骗攻击，通过校验的缓存内容才会被缓存下来。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PostCache', + 'in' => 'query', + 'schema' => [ + 'title' => 'Post缓存功能开关。', + 'description' => 'Post缓存功能开关。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'PostBodySizeLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Body大小限制，值为数字，单位是KB，支持1～8KB大小的Body，值为空的时候，默认按8KB生效。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PostBodyCacheKey', + 'in' => 'query', + 'schema' => [ + 'title' => '缓存键的处理模式。', + 'description' => '缓存键的处理模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改站点缓存配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCacheRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'UpdateCacheTag' => [ + 'summary' => '修改站点缓存标签配置，在使用按缓存标签刷新功能时，用于指定源站响应信息中携带的CacheTag名称。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257332', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义CacheTag名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + 'enum' => [], + ], + ], + [ + 'name' => 'CaseInsensitive', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略大小写。取值范围：'."\n" + .'- on：开启，忽略大小写。'."\n" + .'- off：关闭，不忽略大小写。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改站点缓存标签配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCacheTag', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCacheTag', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'UpdateCnameFlattening' => [ + 'summary' => '修改站点CNAME拉平配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257389', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'FlattenMode', + 'in' => 'query', + 'schema' => [ + 'description' => '拉平模式。取值范围：'."\n" + .'- flatten_all：拉平所有。'."\n" + .'- flatten_at_root： 仅拉平根域。默认拉平根域。', + 'type' => 'string', + 'required' => true, + 'example' => 'flatten_all', + 'enum' => [ + 'flatten_all', + 'flatten_at_root', + ], + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改站点CNAME拉平配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCnameFlattening', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCnameFlattening', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'UpdateCompressionRule' => [ + 'summary' => '修改站点的压缩规则配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257664', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListCompressionRules](~~ListCompressionRules~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'Brotli', + 'in' => 'query', + 'schema' => [ + 'description' => 'Brotli压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Gzip', + 'in' => 'query', + 'schema' => [ + 'description' => 'Gzip压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Zstd', + 'in' => 'query', + 'schema' => [ + 'description' => 'Zstd压缩。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CE8EB0DE-3267-53D1-AB83-F36377D63FD0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改压缩规则配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-02-12T02:25:42.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCompressionRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE8EB0DE-3267-53D1-AB83-F36377D63FD0\\"\\n}","type":"json"}]', + ], + 'UpdateCrossBorderOptimization' => [ + 'summary' => '修改站点中国大陆网络接入优化配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257427', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启中国大陆网络接入优化，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'CanNotOpenCrossBorderOptimization', + 'errorMessage' => 'Can not open cross border optimization.', + 'description' => '不可以开通中国大陆网络接入优化。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改站点中国大陆网络接入优化配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCrossBorderOptimization', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCrossBorderOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'UpdateCustomHostname' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239650', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4DMKZ4', + ], + ], + 'parameters' => [ + [ + 'name' => 'HostnameId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '自定义主机名ID。', + 'description' => 'SaaS 域名的 ID，可通过调用[ListCustomHostnames](~~3018667~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '绑定的源站记录ID。', + 'description' => '待绑定记录的ID，可以通过[ListRecords](~~2850265~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'SslFlag', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => 'SSL开关。', + 'description' => 'SSL开关。'."\n" + .'- **on**: 开启 SSL。'."\n" + .'- **off**: 关闭 SSL。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'CertType', + 'in' => 'query', + 'schema' => [ + 'title' => '证书类型。', + 'description' => '证书类型，SslFlag 为 on 时需要输入该参数。'."\n" + .'- **free**: 免费证书。'."\n" + .'- **upload**: 上传证书。'."\n" + .'- **cas**: 云盾证书。', + 'type' => 'string', + 'required' => false, + 'example' => 'cas', + 'enum' => [ + 'free', + 'upload', + 'cas', + ], + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '证书公钥。', + 'description' => '证书内容，CertType 为 upload 时需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE-----', + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '证书私钥。', + 'description' => '证书私钥，CertType 为 upload 时需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN PRIVATE KEY-----', + ], + ], + [ + 'name' => 'CasId', + 'in' => 'query', + 'schema' => [ + 'title' => '云盾证书ID。', + 'description' => '云盾证书 ID，CertType 为 cas 时需要输入该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30000478'."\n", + ], + ], + [ + 'name' => 'CasRegion', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '云盾证书所在地域。', + 'description' => '云盾证书地域，CertType 为 cas 时需要输入该参数。'."\n" + .'- 中国站账号传参数值：cn-hangzhou。'."\n" + .'- 国际站账号传参数值：ap-southeast-1。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'Record.ServiceBusy', + 'errorMessage' => 'The record is being configured. Try again later.', + 'description' => '该记录正在配置中，请稍后再试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'CustomHostname.NotFound', + 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', + 'description' => '该自定义主机名不存在，请调整后重试。', + ], + [ + 'errorCode' => 'CustomHostname.ApplyCertFailed', + 'errorMessage' => 'Fail to apply a free cert for custom hostname. Please try again later.', + 'description' => '', + ], + [ + 'errorCode' => 'CustomHostname.SetCertFailed', + 'errorMessage' => 'Fail to deploy a cert for custom hostname. Please try again later.', + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '更新 SaaS 域名', + 'summary' => '更新 SaaS 域名，支持修改绑定的记录 ID、证书类型等。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'UpdateCustomResponseCodeRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257647', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '437375513708224', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example'."\n", + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ReturnCode', + 'in' => 'query', + 'schema' => [ + 'description' => '响应码。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '响应页面。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7518056-E30F-55F8-97DD-004D8030703B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'SiteFunction.WafPageNotExist', + 'errorMessage' => 'The custom page referenced in the custom response code configuration does not exist.', + 'description' => '自定义响应码配置中引用的自定义页面不存在。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '更新修改响应码配置', + 'summary' => '修改站点的修改响应码配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7518056-E30F-55F8-97DD-004D8030703B\\"\\n}","type":"json"}]', + ], + 'UpdateCustomScenePolicy' => [ + 'summary' => '修改指定的定制场景策略配置信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239280', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。取值：'."\n" + .'- **promotion**：重大活动', + 'type' => 'string', + 'required' => true, + 'example' => 'promotion', + 'enum' => [ + 'promotion', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '策略起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-03T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '策略结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-03T19:00:00Z'."\n", + ], + ], + [ + 'name' => 'Objects', + 'in' => 'query', + 'schema' => [ + 'description' => '要关联的站点ID信息，多个站点ID间使用英文逗号(,)分隔。'."\n" + ."\n" + .'> 该字段为待废弃字段，建议使用SiteIds字段替代。如果SiteIds字段有值，则接口操作以SiteIds字段内容为准，Objects字段内容不再生效。为避免接口调用更新操作歧义，SiteIds字段和Objects字段必须至少有一个有值。', + 'type' => 'string', + 'required' => false, + 'example' => '123456****,123457****'."\n", + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID，可通过调用[DescribeCustomScenePolicies](~~2850508~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '1', + 'exclusiveMinimum' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteIds', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '要关联的站点ID信息，多个站点ID间使用英文逗号(,)分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '123456****,123457****'."\n", + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Template' => [ + 'description' => '模板名称。取值：'."\n" + .'- **promotion**：重大活动', + 'type' => 'string', + 'example' => 'promotion', + ], + 'StartTime' => [ + 'description' => '策略起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-03T16:00:00Z'."\n", + ], + 'EndTime' => [ + 'description' => '策略结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-04-03T19:00:00Z'."\n", + ], + 'Objects' => [ + 'description' => '关联的站点ID信息列表。'."\n" + ."\n" + .'> 该字段为待废弃字段，建议读取SiteIds字段内容。', + 'type' => 'array', + 'items' => [ + 'description' => '站点ID信息。', + 'type' => 'string', + 'example' => '123456****', + ], + ], + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SiteIds' => [ + 'description' => '要关联的站点ID信息，多个站点ID间使用英文逗号(,)分隔。', + 'type' => 'string', + 'example' => '123456****,123457****'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'PolicyNameExist', + 'errorMessage' => 'The policy name already exists.', + 'description' => '策略名称已存在。', + ], + [ + 'errorCode' => 'CreateTimeError', + 'errorMessage' => 'The effective time of the same policy template cannot overlap.', + 'description' => '同一策略模板的有效时间不能重叠。', + ], + [ + 'errorCode' => 'PolicyNotExist', + 'errorMessage' => 'The policy does not exist.', + 'description' => '策略不存在。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectsAndSiteIds', + 'errorMessage' => 'The specified Objects and SiteIds variables cannot both be empty strings.', + 'description' => '指定的Objects 和 SiteIds变量不能都为空字符串。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '修改定制场景策略', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-03T09:31:40.000Z', + 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更', + ], + [ + 'createdAt' => '2025-03-12T02:36:32.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCustomScenePolicy', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:UpdateCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Name\\": \\"test\\",\\n \\"Template\\": \\"promotion\\",\\n \\"StartTime\\": \\"2023-04-03T16:00:00Z\\\\n\\",\\n \\"EndTime\\": \\"2023-04-03T19:00:00Z\\\\n\\",\\n \\"Objects\\": [\\n \\"123456****\\"\\n ],\\n \\"PolicyId\\": 1,\\n \\"SiteIds\\": \\"123456****,123457****\\\\n\\"\\n}","type":"json"}]', + ], + 'UpdateDevelopmentMode' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257405', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '功能开关。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + 'enum' => [], + ], + ], + ], + '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' => '65C66B7B-671A-8297-9187-2R5477247B76', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改站点开发模式配置', + 'summary' => '修改站点开发模式配置。功能开启的情况下，能够让所有请求都绕过边缘节点上的缓存组件，直接传递到源服务器，以便于能够实时查看源站服务器上的最新资源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateDevelopmentMode', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateDevelopmentMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\"\\n}","type":"json"}]', + ], + 'UpdateEdgeContainerAppLogRiver' => [ + 'summary' => '更新边缘容器应用日志采集配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249447', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~2852396~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-88068867578379****', + ], + ], + [ + 'name' => 'Stdout', + 'in' => 'query', + 'schema' => [ + 'description' => '开启容器的标准输出采集。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '容器的日志文件。', + 'type' => 'string', + 'required' => false, + 'example' => '/root/hello.log', + ], + ], + ], + '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' => '42DE97FA-45D2-5615-9A31-55D9EC0D7563', + ], + 'Stdout' => [ + 'description' => '开启容器的标准输出采集。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Path' => [ + 'description' => '容器的日志文件。', + 'type' => 'string', + 'example' => '/root/hello.log', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新边缘容器日志采集配置信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateEdgeContainerAppLogRiver', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateEdgeContainerAppLogRiver', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42DE97FA-45D2-5615-9A31-55D9EC0D7563\\",\\n \\"Stdout\\": true,\\n \\"Path\\": \\"/root/hello.log\\"\\n}","type":"json"}]', + ], + 'UpdateEdgeContainerAppResourceReserve' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264840', + 'abilityTreeNodes' => [ + 'FEATUREdcdnFPSR60', + ], + ], + 'parameters' => [ + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启资源预留。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Forever', + 'in' => 'query', + 'schema' => [ + 'description' => '是否永久开启预留，一旦开启，不允许设置预留截止时间。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DurationTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预留截止时间，该接口输入为UTC时间，输入北京时间需+8小时，例如当前为不北京时间 2006-01-02 06:04:05 , 则需要输入"2006-01-02T14:04:05Z"。', + 'type' => 'string', + 'required' => false, + 'example' => '2006-01-02T15:04:05Z', + ], + ], + [ + 'name' => 'ReserveSet', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '预留资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '预留区域对象。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '区域信息。中国内地支持大区、特别行政区级别输入，海外支持国家输入，下面为对应的参数映射：'."\n" + ."\n" + .'中国内地：'."\n" + ."\n" + .'- 华东：huadong'."\n" + .'- 华南：huanan'."\n" + .'- 华中：huazhong'."\n" + .'- 华北：huabei'."\n" + .'- 西北：xibei'."\n" + .'- 西南：xinan'."\n" + .'- 东北：dongbei'."\n" + ."\n" + .'特别行政区以及海外：'."\n" + .'- 中国台湾：tw'."\n" + .'- 中国澳门：mo'."\n" + .'- 中国香港：hk'."\n" + .'- 日本：jp'."\n" + .'- 美国：us'."\n" + .'- 泰国：th'."\n" + .'- 韩国：kr'."\n" + .'- 俄罗斯：ru'."\n" + .'- 新加坡：sg'."\n" + .'- 法国：fr'."\n" + .'- 西班牙：es'."\n" + .'- 意大利：it'."\n" + .'- 瑞典：se'."\n" + .'- 阿联酋：ae'."\n" + .'- 印尼：id'."\n" + .'- 智利：cl'."\n" + .'- 菲律宾：ph'."\n" + .'- 马来西亚：my'."\n" + .'- 越南：vn'."\n" + .'- 阿根廷：ar'."\n" + .'- 澳大利亚：au'."\n" + .'- 巴西：br'."\n" + .'- 哥伦比亚：co'."\n" + .'- 德国：de'."\n" + .'- 英国：gb'."\n" + .'- 秘鲁：pe'."\n" + .'- 沙特：sa'."\n" + .'- 荷兰：nl'."\n" + .'- 南非：za', + 'type' => 'string', + 'required' => false, + 'example' => 'huazhong', + ], + 'Isp' => [ + 'description' => '运营商，支持如下几种运营商，海外与特别行政区无需填入运营商：'."\n" + ."\n" + .'- 中国移动：cmcc'."\n" + .'- 中国电信：chinanet'."\n" + .'- 中国联通：unicom', + 'type' => 'string', + 'required' => false, + 'example' => 'cmcc', + ], + 'Replicas' => [ + 'description' => '容器副本数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，可使用[ListEdgeContainerApps](~~ListEdgeContainerApps~~)接口获取应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-88068867578379****', + ], + ], + ], + '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' => '1AB799CF-562A-5CAF-A99E-4354053D814F', + ], + 'Enable' => [ + 'description' => '是否开启资源预留。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Forever' => [ + 'description' => '是否永久开启预留。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DurationTime' => [ + 'description' => '预留截止时间，该接口输入为UTC时间，输入北京时间需+8小时，例如当前为不北京时间 2006-01-02 06:04:05 , 则需要输入"2006-01-02T14:04:05Z"。', + 'type' => 'string', + 'example' => '2006-01-02T15:04:05Z', + ], + 'ReserveSet' => [ + 'description' => '预留资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '预留区域对象。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '区域信息。中国内地支持大区、特别行政区级别输入，海外支持国家输入，下面为对应的参数映射：'."\n" + ."\n" + .'中国内地：'."\n" + ."\n" + .'- 华东：huadong'."\n" + .'- 华南：huanan'."\n" + .'- 华中：huazhong'."\n" + .'- 华北：huabei'."\n" + .'- 西北：xibei'."\n" + .'- 西南：xinan'."\n" + .'- 东北：dongbei'."\n" + ."\n" + .'特别行政区以及海外：'."\n" + .'- 中国台湾：tw'."\n" + .'- 中国澳门：mo'."\n" + .'- 中国香港：hk'."\n" + .'- 日本：jp'."\n" + .'- 美国：us'."\n" + .'- 泰国：th'."\n" + .'- 韩国：kr'."\n" + .'- 俄罗斯：ru'."\n" + .'- 新加坡：sg'."\n" + .'- 法国：fr'."\n" + .'- 西班牙：es'."\n" + .'- 意大利：it'."\n" + .'- 瑞典：se'."\n" + .'- 阿联酋：ae'."\n" + .'- 印尼：id'."\n" + .'- 智利：cl'."\n" + .'- 菲律宾：ph'."\n" + .'- 马来西亚：my'."\n" + .'- 越南：vn'."\n" + .'- 阿根廷：ar'."\n" + .'- 澳大利亚：au'."\n" + .'- 巴西：br'."\n" + .'- 哥伦比亚：co'."\n" + .'- 德国：de'."\n" + .'- 英国：gb'."\n" + .'- 秘鲁：pe'."\n" + .'- 沙特：sa'."\n" + .'- 荷兰：nl'."\n" + .'- 南非：za', + 'type' => 'string', + 'example' => 'huazhong', + ], + 'Isp' => [ + 'description' => '运营商，支持如下几种运营商，海外与特别行政区无需填入运营商：'."\n" + ."\n" + .'- 中国移动：cmcc'."\n" + .'- 中国电信：chinanet'."\n" + .'- 中国联通：unicom', + 'type' => 'string', + 'example' => 'cmcc', + ], + 'Replicas' => [ + 'description' => '容器副本数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'errorCode' => 'InvalidParameter.Appid', + 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidApp.NotFound', + 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'title' => '更新边缘容器应用资源预留配置', + 'summary' => '更新边缘容器资源预留配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateEdgeContainerAppResourceReserve', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateEdgeContainerAppResourceReserve', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AB799CF-562A-5CAF-A99E-4354053D814F\\",\\n \\"Enable\\": true,\\n \\"Forever\\": true,\\n \\"DurationTime\\": \\"2006-01-02T15:04:05Z\\",\\n \\"ReserveSet\\": [\\n {\\n \\"Region\\": \\"huazhong\\",\\n \\"Isp\\": \\"cmcc\\",\\n \\"Replicas\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'UpdateHttpIncomingRequestHeaderModificationRule' => [ + 'summary' => '修改HTTP入站请求头配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257647', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '568181195163328', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用ListHttpIncomingRequestHeaderModificationRules接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '419717024278528', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'RequestHeaderModification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改请求头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改请求头详情。', + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + 'enum' => [ + 'add', + 'modify', + 'del', + ], + ], + 'Name' => [ + 'description' => '请求头名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'headerName', + ], + 'Value' => [ + 'description' => '请求头值。', + 'type' => 'string', + 'required' => false, + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BFEF3861-8BB7-5B63-954C-6575EA7FB2CA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '更新修改HTTP入站请求头配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEF3861-8BB7-5B63-954C-6575EA7FB2CA\\"\\n}","type":"json"}]', + ], + 'UpdateHttpIncomingResponseHeaderModificationRule' => [ + 'summary' => '更新站点的修改HTTP入站响应头配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257652', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '498607398028944', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用ListHttpIncomingResponseHeaderModificationRules接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'ResponseHeaderModification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改响应头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改响应头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '响应头名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + 'enum' => [ + 'add', + 'modify', + 'del', + ], + ], + 'Value' => [ + 'description' => '响应头值。', + 'type' => 'string', + 'required' => false, + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '更新修改HTTP入站响应头配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'UpdateHttpRequestHeaderModificationRule' => [ + 'summary' => '修改HTTP请求头规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257647', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListHttpRequestHeaderModificationRules](~~2867483~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'RequestHeaderModification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改请求头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改请求头详情。', + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + 'enum' => [ + 'add', + 'modify', + 'del', + ], + ], + 'Name' => [ + 'description' => '请求头名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'headerName', + ], + 'Value' => [ + 'description' => '请求头值。', + 'type' => 'string', + 'required' => false, + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '更新修改HTTP请求头配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:38.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateHttpRequestHeaderModificationRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2430E05E-1340-5773-B5E1-B743929F46F2\\"\\n}","type":"json"}]', + ], + 'UpdateHttpResponseHeaderModificationRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257652', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456******', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListHttpResponseHeaderModificationRules](~~2867483~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'ResponseHeaderModification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改响应头，支持添加、删除、修改三种操作方式。', + 'type' => 'array', + 'items' => [ + 'description' => '修改响应头详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '响应头名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'headerName', + ], + 'Operation' => [ + 'description' => '操作方式。取值范围：'."\n" + ."\n" + .'- add：添加。'."\n" + .'- del：删除'."\n" + .'- modify：变更。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + 'enum' => [ + 'add', + 'modify', + 'del', + ], + ], + 'Value' => [ + 'description' => '响应头值。', + 'type' => 'string', + 'required' => false, + 'example' => 'headerValue', + ], + 'Type' => [ + 'description' => '值类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'InvalidValOfDelHeader', + 'errorMessage' => 'The delete header operation does not support setting value.', + 'description' => '删除头操作不支持设置value。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '更新修改HTTP响应头配置', + 'summary' => '更新站点的修改HTTP响应头配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:39.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateHttpResponseHeaderModificationRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'UpdateHttpsApplicationConfiguration' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257969', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")', + ], + ], + [ + 'name' => 'HttpsForce', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启强制HTTPS，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HttpsForceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '强制HTTPS跳转状态码，取值范围：'."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 307'."\n" + .'- 308', + 'type' => 'string', + 'required' => false, + 'example' => '301', + ], + ], + [ + 'name' => 'AltSvc', + 'in' => 'query', + 'schema' => [ + 'description' => '功能开关，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AltSvcClear', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alt-Svc头是否包含clear参数，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AltSvcPersist', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alt-Svc头包是否含persist参数，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AltSvcMa', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alt-Svc有效时间，单位是秒，默认为86400秒。', + 'type' => 'string', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'Hsts', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HSTS，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HstsMaxAge', + 'in' => 'query', + 'schema' => [ + 'description' => 'HSTS过期时间，单位是秒。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'HstsIncludeSubdomains', + 'in' => 'query', + 'schema' => [ + 'description' => '是否在HSTS中包括子域，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HstsPreload', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HSTS预加载，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'HttpsSniVerify', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启SNI校验，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HttpsNoSniDeny', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启拒绝无SNI的TLS握手请求，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'HttpsSniWhitelist', + 'in' => 'query', + 'schema' => [ + 'description' => '指定允许的SNI白名单列表，多个以空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc edf', + ], + ], + ], + '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' => '35C66C7B-671H-4297-9187-2C4477247A78', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改站点HTTPS应用配置', + 'summary' => '修改HTTPS应用配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-03T07:09:13.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateHttpsApplicationConfiguration', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', + ], + 'UpdateHttpsBasicConfiguration' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257970', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1231231221****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3528160969****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + ], + [ + 'name' => 'Https', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HTTPS，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Tls10', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启TLS1.0，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Tls11', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启TLS1.1，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Tls12', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启TLS1.2，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Tls13', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启TLS1.3，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'CiphersuiteGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '加密套件组，默认使用全部加密套件。取值范围：'."\n" + .'- all：全部加密套件。'."\n" + .'- strict：强加密套件。'."\n" + .'- custom：自定义加密套件。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'Ciphersuite', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义加密套件，表示当CiphersuiteGroup为custom时选取的具体加密算法。', + 'type' => 'string', + 'required' => false, + 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', + ], + ], + [ + 'name' => 'OcspStapling', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启OCSP，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Http2', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HTTP2，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Http3', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HTTP3，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改站点HTTPS基础配置', + 'summary' => '修改HTTPS基础配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateHttpsBasicConfiguration', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'UpdateIPv6' => [ + 'summary' => '修改站点IPv6配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257436', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可以通过调用[ListSites](~~2850189~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '开启Ipv6的区域，默认为x.x：'."\n" + ."\n" + .'- x.x: 全球。'."\n" + .'- cn.cn: 中国大陆。', + 'type' => 'string', + 'required' => false, + 'example' => 'x.x', + 'enum' => [ + 'x.x', + 'cn.cn', + ], + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改站点IPv6配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:33:22.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateIPv6', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateIPv6', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'UpdateImageTransform' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257354', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListImageTransforms](~~2869056~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启图片转换。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改站点图片转换配置', + 'summary' => '修改站点图片转换配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateImageTransform', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'UpdateList' => [ + 'summary' => '该接口用于更新自定义列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239583', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '列表ID', + 'description' => '自定义列表的ID，可通过调用[ListLists](~~2850217~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '40000001', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '列表名称', + 'description' => '更新后的列表名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '列表描述', + 'description' => '更新后的列表描述。', + 'type' => 'string', + 'required' => true, + 'example' => 'a custom list', + ], + ], + [ + 'name' => 'Items', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '列表内容', + 'description' => '更新后的列表内容项，以JSON数组格式提供。', + 'type' => 'array', + 'items' => [ + 'title' => '列表内容', + 'description' => '更新后的列表内容项。', + 'type' => 'string', + 'required' => false, + 'example' => '10.1.1.1', + ], + 'required' => true, + 'example' => 'a custom list', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'List.NotExist', + 'errorMessage' => 'The specified list does not exist.', + 'description' => '指定的列表不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新自定义列表', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:49.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T09:53:46.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'UpdateLoadBalancer' => [ + 'summary' => '修改已有的负载均衡器信息，需要带上负载均衡器ID来标识要修改哪个负载均衡器。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238302', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器是否启用。'."\n" + ."\n" + .'- true：启用。'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1159101787****', + ], + ], + [ + 'name' => 'AdaptiveRouting', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '跨地址池回源配置。', + 'type' => 'object', + 'properties' => [ + 'FailoverAcrossPools' => [ + 'description' => '是否跨地址池回源。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false: 否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DefaultPools', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '默认地址池ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '默认地址池ID，整型。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '96228666776****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'FallbackPool', + 'in' => 'query', + 'schema' => [ + 'description' => '兜底地址池ID，当所有其他池不可用时，流量将被导向此处。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '96228666776****', + ], + ], + [ + 'name' => 'RandomSteering', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '加权轮询配置，用于控制不同地址池的流量分配权重。', + 'type' => 'object', + 'properties' => [ + 'DefaultWeight' => [ + 'description' => '默认的轮询权重，用于所有没有单独指定权重的地址池。取值范围：0-100之间的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'PoolWeights' => [ + 'description' => '各后端服务器池的权重配置，键为池ID，值为权重系数。权重系数表示相对流量分配的比例。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + 'description' => '单个源地址池的权重，0-100的数字，0表示不往该源地址池调度流量。', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => '规则配置列表，用于定义特定条件下的行为覆盖。', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_1', + ], + 'Rule' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => 'http.request.method eq "GET" ', + ], + 'RuleEnable' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'FixedResponse' => [ + 'description' => '匹配规则后执行响应指定内容。', + 'type' => 'object', + 'properties' => [ + 'ContentType' => [ + 'description' => 'HTTP Header中的Content-Type字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'application/json', + ], + 'Location' => [ + 'description' => 'HTTP 返回中的Location字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com/index.html'."\n", + ], + 'MessageBody' => [ + 'description' => '响应Body值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hello World!'."\n", + ], + 'StatusCode' => [ + 'description' => '响应状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + 'required' => false, + ], + 'Overrides' => [ + 'description' => '匹配规则后修改对应请求改写的负载均衡配置，配置的字段，会覆盖负载均衡器配置里相应的字段。', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "adaptive_routing": {'."\n" + .' "failover_across_pools": true'."\n" + .' },'."\n" + .' "sub_region_pools": {'."\n" + .' "AL,AT": ['."\n" + .' 92298024898****,'."\n" + .' 92304347804****'."\n" + .' ],'."\n" + .' "BG,BY": ['."\n" + .' 92298024898****'."\n" + .' ]'."\n" + .' },'."\n" + .' "default_pools": ['."\n" + .' 92298024898****,'."\n" + .' 92304347804****'."\n" + .' ],'."\n" + .' "fallback_pool": 92298024898****,'."\n" + .' "location_strategy": {'."\n" + .' "mode": "resolver_ip",'."\n" + .' "prefer_ecs": "always"'."\n" + .' },'."\n" + .' "random_steering": {'."\n" + .' "default_weight": 0.3,'."\n" + .' "pool_weights": {'."\n" + .' "92298024898****": 0.7,'."\n" + .' "92304347804****": 0.8'."\n" + .' }'."\n" + .' },'."\n" + .' "region_pools": {'."\n" + .' "CN,SEAS": ['."\n" + .' 92298024898****,'."\n" + .' 92304347804****'."\n" + .' ],'."\n" + .' "SAF,SAS": ['."\n" + .' 92304347804****'."\n" + .' ]'."\n" + .' },'."\n" + .' "session_affinity": "ip",'."\n" + .' "steering_policy": "geo",'."\n" + .' "ttl": 30'."\n" + .' }', + ], + 'Sequence' => [ + 'description' => '规则执行顺序，可以不填，不填时以列表顺序执行，如果填的话，是大于0的整数。数值越大越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Terminates' => [ + 'description' => '是否终止执行后续规则。'."\n" + .'- true：是。'."\n" + .'- false：否，默认值。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'SessionAffinity', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '会话保持，取值：'."\n" + .'- off：不开启。'."\n" + .'- ip：按ip方式会话保持。'."\n" + .'- cookie: 按cookie方式会话保持。', + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + 'enum' => [], + ], + ], + [ + 'name' => 'SteeringPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'order'."\n", + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器的详细描述信息，便于管理和识别。', + 'type' => 'string', + 'required' => false, + 'example' => '负载均衡器描述'."\n", + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => 'TTL值，DNS记录的生存时间，默认为30，取值范围：10-600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'Monitor', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '监视器配置，用于健康检查。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监视器协议类型，如HTTP，用于健康检查，值为off时，表示不进行检查。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'Method' => [ + 'description' => '监视器请求方法，如GET，HTTP协议中的方法。', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + 'Port' => [ + 'description' => '源站端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'Path' => [ + 'description' => '监视器检查路径，如/healthcheck，HTTP请求路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/health'."\n", + ], + 'Interval' => [ + 'description' => '监视间隔，如60秒，检查频率。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'Timeout' => [ + 'description' => '应用健康检查超时时间，单位为秒，取值范围：1-10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'ExpectedCodes' => [ + 'description' => '预期状态码，如200,202，成功的HTTP响应。', + 'type' => 'string', + 'required' => false, + 'example' => '200,202', + ], + 'FollowRedirects' => [ + 'description' => '是否跟随重定向。'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ConsecutiveUp' => [ + 'description' => '连续探测多少次成功算成功，如3。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'ConsecutiveDown' => [ + 'description' => '连续探测多少次失败算失败，如5。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'Header' => [ + 'description' => '监视请求头配置。', + 'type' => 'any', + 'required' => false, + 'example' => ' {'."\n" + .' "host": ['."\n" + .' "example1.com",'."\n" + .' "example2.com"'."\n" + .' ]'."\n" + .' }', + ], + 'MonitoringRegion' => [ + 'description' => '探测点所在区域，默认为Global，'."\n" + ."\n" + .'- Global: 全球。'."\n" + .'- ChineseMainland: 中国内地。'."\n" + .'- OutsideChineseMainland: 全球（不包括中国内地）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OutsideChineseMainland' => 'OutsideChineseMainland', + 'ChineseMainland' => 'ChineseMainland', + 'Global' => 'Global', + ], + 'example' => 'Global', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '负载均衡器ID，可通过调用[ListLoadBalancers](~~2868897~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '95913670174****', + ], + ], + [ + 'name' => 'RegionPools', + 'in' => 'query', + 'schema' => [ + 'description' => '一级region对应的地址池。', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'SubRegionPools', + 'in' => 'query', + 'schema' => [ + 'description' => '二级region对应的地址池，多个二级region共用一批地址池时，可以多个二级region，使用逗号拼接作为key。', + 'type' => 'any', + 'required' => false, + 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '修改负载均衡器成功后的响应结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'LoadBalancerQuotaCheckFailed', + 'errorMessage' => 'Load balancer enable quota check failed.', + 'description' => '您当前的套餐无法使用负载均衡器相关功能，如需使用，请进行套餐升级。', + ], + [ + 'errorCode' => 'LoadBalancerNumberExceedQuotaLimit', + 'errorMessage' => 'The number of load balancers you have added has reached the limit of the plan quota. Please delete the unused load balancers or upgrade the plan and try again.', + 'description' => '您添加的负载均衡器数量已经达到套餐配额限制，请删除不使用的负载均衡器或者升级套餐后进行重试。', + ], + [ + 'errorCode' => 'LoadBalancerRuleQuotaCheckFailed', + 'errorMessage' => 'Your current plan does not support configuring load balancer custom rules, or the load balancer rules you have added exceed the plan quota limit. Please upgrade the plan or delete the rules that are no longer in use and try again.', + 'description' => '您当前的套餐不支持配置负载均衡器自定义规则，或者您已经添加的负载均衡器规则超过套餐配额限制，请升级套餐或者删除不再使用的规则后重试。', + ], + [ + 'errorCode' => 'LoadBalancerPolicyCheckFailed', + 'errorMessage' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', + 'description' => '您当前的套餐不支持使用该负载均衡器调度策略，请升级套餐后重试。', + ], + [ + 'errorCode' => 'LoadBalancerHealthDetectionQuotaCheckFailed', + 'errorMessage' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.', + 'description' => '您当前的套餐不允许配置负载均衡器的健康探测，请升级套餐后重试。', + ], + [ + 'errorCode' => 'LoadBalancerHealthDetectionIntervalCheckFailed', + 'errorMessage' => 'The configured load balancer health detection interval exceeds the quota range allowed by the plan. Please revise the interval within the range or upgrade the plan and try again.', + 'description' => '您配置的负载均衡器健康探测时间间隔超出了套餐允许的配额范围，请订正为范围内的间隔或者升级套餐后，进行重试。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'MonitorExpectedBodyInvalid', + 'errorMessage' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', + 'description' => '传入的监视器预期返回值不正确，长度不能大于102400字符，请您确认返回值后重试。', + ], + [ + 'errorCode' => 'MonitorExpectedCodesInvalid', + 'errorMessage' => 'Invalid expected status code for the probe.Make sure that you specify no more than 10 status codes in the probe settings, and each status code must be 3 to 4 characters in length.Examples: 200, 301, 3xx, 8000, and 88xx.', + 'description' => '传入的监视器预期返回码不合法。请注意：返回码的数量不能超过10个，且每个返回码的长度应不少于3个字符且不超过4个字符。例如：200、301、3xx、8000、88xx。', + ], + [ + 'errorCode' => 'MonitorHeaderInvalid', + 'errorMessage' => 'Invalid request header for the probe. You can add up to 10 request headers, each with 1 to 9 values. The combined length of all headers and values cannot exceed 6,000 characters. You cannot configure the User-Agent header.', + 'description' => '传入的监视器携带的请求头非法。请确保请求头数量不超过10个，每个请求头的值长度在1到10之间，并且不得使用User-Agent请求头（该请求头保留用于内部特定场景）。此外，所有请求头及其值的总长度不得超过6000个字符。请您检查并修正请求头配置后重试。', + ], + [ + 'errorCode' => 'MonitorMethodNotSupport', + 'errorMessage' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', + 'description' => '传入的监视器请求方法不支持，只支持以下方法：GET/HEAD。', + ], + [ + 'errorCode' => 'MonitorPathNotSupport', + 'errorMessage' => 'Invalid probe URL path.If you set the probe protocol to HTTP or HTTPS, make sure you specify a probe URL path that does not exceed 1,024 characters in length.', + 'description' => '传入的监听路径不支持。当监听类型为HTTP或HTTPS时，监听路径不能为空，且路径长度不得超过1024个字符，请您检查路径后重试。', + ], + [ + 'errorCode' => 'MonitorPortNotSupport', + 'errorMessage' => 'Invalid probe port. Specify a valid port from 1 to 65535 for the probe request. Then, try again.', + 'description' => '传入的监视器监听端口不支持，端口取值范围：[1-65535]，请您确保端口在取值范围内重试。', + ], + [ + 'errorCode' => 'MonitorRetriesInvalid', + 'errorMessage' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', + 'description' => '传入的监视器重试次数参数不支持，支持的重试次数取值范围为：[0-5]，请确保设置的重试次数在此范围内。', + ], + [ + 'errorCode' => 'MonitorTimeoutInvalid', + 'errorMessage' => 'Invalid timeout for the probe. Valid values are 1 to 10.', + 'description' => '传入的监视器超时时间超出取值范围，支持以下范围：[1-10]。', + ], + [ + 'errorCode' => 'MonitorTypeNotSupport', + 'errorMessage' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', + 'description' => '传入的监视器类型不支持，监视器只支持以下类型：off/HTTP/HTTPS/TCP/UDP/ICMP Ping/SMTP。', + ], + [ + 'errorCode' => 'OriginPoolNotExist', + 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', + 'description' => '传入的源地址池不存在，或该地址池不属于当前用户和站点，请您确认后重试。', + ], + [ + 'errorCode' => 'LoadBalancerNameConflict', + 'errorMessage' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', + 'description' => '负载均衡器名称或源地址池记录名已存在，请更换一个唯一的名字重试。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'LoadBalancerNotExist', + 'errorMessage' => 'The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.', + 'description' => '传入的站点负载均衡器无效或当前站点尚未开通负载均衡功能。请您检查负载均衡器名称配置的是否正确后重试，若尚未开通负载均衡功能请开通后重试。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + ], + 403 => [ + [ + 'errorCode' => 'QuotaExceeded', + 'errorMessage' => 'The quota is exceeded.', + 'description' => '额度不足', + ], + ], + [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改已有负载均衡器信息', + 'description' => '通过此接口，您可以修改负载均衡器的多项配置，包括但不限于负载均衡器的名称、是否开启加速、会话保持策略、以及与流量路由相关的各种高级设置。>某些参数的更改可能会影响现有服务的稳定性，请谨慎操作。>', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-16T02:25:11.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-02-13T01:34:54.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateLoadBalancer', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateLoadBalancer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\"\\n}","type":"json"}]', + ], + 'UpdateManagedTransform' => [ + 'summary' => '修改站点托管转换配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257446', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'AddClientGeolocationHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '添加访问者地理位置标头。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + 'enum' => [], + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'AddRealClientIpHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '添加包含真实客户端IP的 "ali-real-client-ip" 标头。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'RealClientIpHeaderName', + 'in' => 'query', + 'schema' => [ + 'description' => '真实客户端IP标头名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_header', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改站点托管转换配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-05-09T05:58:31.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateManagedTransform', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'UpdateNetworkOptimization' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257971', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '352816096987136', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true。'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")。', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")', + ], + ], + [ + 'name' => 'SmartRouting', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启智能路由服务，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Http2Origin', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启HTTP2回源，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Websocket', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启Websocket，默认开启。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Grpc', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启GRPC，默认关闭。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'UploadMaxFilesize', + 'in' => 'query', + 'schema' => [ + 'description' => '最大上传文件大小，单位是MB，取值范围：100～500。', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改站点网络优化配置', + 'summary' => '修改网络优化配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateNetworkOptimization', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateNetworkOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'UpdateOriginPool' => [ + 'summary' => '修改单个源地址池，传入源地址池ID指定单个源地址池，进行修改。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238439', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '源地址池ID，可通过调用[ListOriginPools](~~ListOriginPools~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1038520525196928', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '源地址池是否启用：'."\n" + ."\n" + .'- true: 启用；'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Origins', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源地址池里添加的源站信息，多个源站使用数组传值。', + 'type' => 'array', + 'items' => [ + 'description' => '源地址池里添加的源站信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '源站名称，一个源地址下源站名称唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'origin1', + ], + 'Address' => [ + 'description' => '源站地址，如：www.example.com。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + 'Enabled' => [ + 'description' => '源站是否启用：'."\n" + ."\n" + .'- true: 启用；'."\n" + .'- false：不启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Header' => [ + 'description' => '回源时带的请求头，只支持Host。', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "Host": ['."\n" + .' "example.com"'."\n" + .' ]'."\n" + .' }', + ], + 'Weight' => [ + 'description' => '权重，0-100的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'Type' => [ + 'description' => '源站类型：'."\n" + ."\n" + .'- ip_domain: ip或域名类型源站；'."\n" + .'- OSS：OSS地址源站；'."\n" + .'- S3：AWS S3源站。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + 'AuthConf' => [ + 'description' => '鉴权信息，源站为OSS或者S3等源站需要鉴权时，需要传鉴权相关配置信息。', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'description' => '鉴权类型。'."\n" + ."\n" + .'- public：公共读写，源站为OSS或S3且为公共读写时使用；'."\n" + .'- private_same_account：私有同账号，源站为OSS，且鉴权类型为同账号私有鉴权时使用；'."\n" + .'- private_cross_account：私有跨账号，源站为OSS，且鉴权类型为跨账号私有鉴权时使用；'."\n" + .'- private：源站为S3，且鉴权类型为私有时使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'public', + ], + 'AccessKey' => [ + 'description' => '私有鉴权时需要传的AccessKey。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAccessKeyID', + ], + 'SecretKey' => [ + 'description' => '私有鉴权时需要传的SecretKey。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAccessKeySecret', + ], + 'Version' => [ + 'description' => '源站为AWS S3时需要传的签名版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2', + ], + 'Region' => [ + 'description' => '源站为AWS S3时需要传的源站region。', + 'type' => 'string', + 'required' => false, + 'example' => 'us-east-1'."\n", + ], + ], + 'required' => false, + ], + 'IpVersionPolicy' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '216558609793952', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + 'Id' => [ + 'description' => '源地址池ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1038520525196928', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'SourceNumberExceedLimit', + 'errorMessage' => 'The number of sources in the origin pool exceeds the quota limit.', + 'description' => '您在源地址池中可创建的源站个数已达到套餐上限，请查看您的套餐配额，并升级套餐以获得更多配额。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'OriginPoolNotExist', + 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', + 'description' => '传入的源地址池不存在，或该地址池不属于当前用户和站点，请您确认后重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'OriginPoolNameConflict', + 'errorMessage' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.', + 'description' => '源地址池名称冲突，请确保新名称与现有源地址池及负载均衡器名称均不相同。', + ], + [ + 'errorCode' => 'SourceAddressInvalid', + 'errorMessage' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', + 'description' => '源站地址无效，请检查并确保输入的是正确的IP或域名格式。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.AddressConflict', + 'errorMessage' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', + 'description' => '传入的源站地址有冲突，在同一个源地址池中，不能存在重复的源站地址，请您确保源站地址的唯一性。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'SourceInBlackList', + 'errorMessage' => 'The source is in the black list.', + 'description' => '源站在黑名单中。', + ], + [ + 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', + 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的源服务器地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', + 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的源服务器地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'OriginPool.TypeNotSupport', + 'errorMessage' => 'The origin address pool type is not supported.', + 'description' => '源地址池类型不支持。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改单个源地址池', + 'changeSet' => [ + [ + 'createdAt' => '2025-05-20T11:43:19.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateOriginPool', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Id\\": 1038520525196928\\n}","type":"json"}]', + ], + 'UpdateOriginProtection' => [ + 'summary' => '修改源站防护功能，用来开启或关闭回源收敛。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250098', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4VDL9A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'OriginConverge', + 'in' => 'query', + 'schema' => [ + 'description' => '回源收敛开关'."\n" + ."\n" + .'- on：开启回源收敛。'."\n" + .'- off：关闭回源收敛。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'AutoConfirmIPList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '自动启用最新回源IP列表', + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => '4C6B5E5A-42FC-5DF2-986C-4DAAE3C55086', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'OriginProtectionNotExist', + 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', + 'description' => '站点没有配置源站防护，所以不能对其进行修改或删除。', + ], + [ + 'errorCode' => 'FunctionArgConflict.OriginProtection', + 'errorMessage' => 'The automatic enabling of the latest back-to-source IP list and the back-to-source convergence are mutually exclusive functions and cannot be enabled at the same time.', + 'description' => '源站防护的自动启用最新回源 IP 列表与回源收敛是两个互斥的功能，无法同时开启。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改源站防护功能', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-21T06:58:57.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateOriginProtection', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C6B5E5A-42FC-5DF2-986C-4DAAE3C55086\\"\\n}","type":"json"}]', + ], + 'UpdateOriginProtectionIpWhiteList' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250107', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4VDL9A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + ], + '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' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OriginProtectionNotExist', + 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', + 'description' => '站点没有配置源站防护，所以不能对其进行修改或删除。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '确认更新站点回源IP白名单到最新版本', + 'summary' => '确认更新站点回源IP白名单到最新版本。', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-21T06:58:57.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateOriginProtectionIpWhiteList', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateOriginProtectionIpWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', + ], + 'UpdateOriginRule' => [ + 'summary' => '修改站点回源规则配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257994', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5407498413****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true。'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")。', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")', + ], + ], + [ + 'name' => 'OriginHost', + 'in' => 'query', + 'schema' => [ + 'description' => '回源请求中携带的HOST。', + 'type' => 'string', + 'required' => false, + 'example' => 'origin.example.com'."\n", + ], + ], + [ + 'name' => 'OriginScheme', + 'in' => 'query', + 'schema' => [ + 'description' => '回源请求使用的协议。取值范围：'."\n" + .'- http：使用HTTP协议回源。'."\n" + .'- https：使用HTTPS协议回源。'."\n" + .'- follow：跟随客户端协议回源。', + 'type' => 'string', + 'required' => false, + 'example' => 'http', + ], + ], + [ + 'name' => 'OriginSni', + 'in' => 'query', + 'schema' => [ + 'description' => '回源请求中携带的SNI。', + 'type' => 'string', + 'required' => false, + 'example' => 'origin.example.com'."\n", + ], + ], + [ + 'name' => 'DnsRecord', + 'in' => 'query', + 'schema' => [ + 'description' => '改写回源请求的DNS解析记录。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.example.com'."\n", + ], + ], + [ + 'name' => 'OriginHttpPort', + 'in' => 'query', + 'schema' => [ + 'description' => '使用HTTP协议回源时访问的源站端口。', + 'type' => 'string', + 'required' => false, + 'example' => '8080', + ], + ], + [ + 'name' => 'OriginHttpsPort', + 'in' => 'query', + 'schema' => [ + 'description' => '使用HTTPS协议回源时访问的源站端口。', + 'type' => 'string', + 'required' => false, + 'example' => '4433', + ], + ], + [ + 'name' => 'Range', + 'in' => 'query', + 'schema' => [ + 'description' => '使用range分片方式回源下载文件。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。'."\n" + .'- force：强制。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'OriginMtls', + 'in' => 'query', + 'schema' => [ + 'description' => 'mtls开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'OriginVerify', + 'in' => 'query', + 'schema' => [ + 'description' => '源站证书校验开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'RangeChunkSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'range分片大小。取值范围：'."\n" + .'- 512KB'."\n" + .'- 1MB'."\n" + .'- 2MB'."\n" + .'- 4MB', + 'type' => 'string', + 'required' => false, + 'example' => '1MB', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OriginReadTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '源站读超时时间（秒）。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Follow302Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '回源302跟随开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Follow302MaxTries', + 'in' => 'query', + 'schema' => [ + 'description' => '302跟随次数上限，取值范围[1-5]。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Follow302RetainArgs', + 'in' => 'query', + 'schema' => [ + 'description' => '保留原始请求参数开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Follow302RetainHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '保留原始请求头开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Follow302TargetHost', + 'in' => 'query', + 'schema' => [ + 'description' => '修改302后的回源host。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改站点回源规则配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-17T08:47:33.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-04-01T01:57:04.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-20T05:57:46.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2025-02-27T09:16:40.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateOriginRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'UpdatePage' => [ + 'summary' => '更新用户已创建的自定义响应页面，可以通过此接口修改页面名称、描述、内容类型及内容本身。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239594', + 'abilityTreeNodes' => [ + 'FEATUREdcdnL8HX1L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '自定义响应页面的ID', + 'description' => '自定义响应页面的ID，可通过调用[ListPages](~~2850223~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '50000001', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '自定义响应页面的名称', + 'description' => '自定义响应页面的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '自定义响应页面的描述', + 'description' => '自定义响应页面的描述。', + 'type' => 'string', + 'required' => true, + 'example' => 'a custom deny page', + ], + ], + [ + 'name' => 'ContentType', + 'in' => 'formData', + 'schema' => [ + 'title' => 'HTTP Header中的Content-Type字段，如：text/html、application/json', + 'description' => 'HTTP Header中的Content-Type字段，例如：'."\n" + .'* text/html'."\n" + .'* application/json', + 'type' => 'string', + 'required' => true, + 'example' => 'text/html', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'title' => 'BASE64编码后的 Content-Type 对应的响应页面内容', + 'description' => 'BASE64编码后的 Content-Type 对应的响应页面内容。', + 'type' => 'string', + 'required' => true, + 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', + ], + ], + ], + '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' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Page.NotExist', + 'errorMessage' => 'The specified custom error page does not exist or is not recognized by the system.Check whether the error page identifier is correct and matches an error page that has been created and registered in the system\'s error handling framework.If you want to create a new error page, make sure that the creation process is complete.', + 'description' => '指定的自定义错误页面不存在，或者未被系统识别。请确保错误页面的标识符是正确的，并且该页面已经被妥善地在系统的错误处理框架中创建和注册。如果打算新增一个错误页面，请验证创建过程是否已成功完成。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新自定义响应页面', + 'changeSet' => [ + [ + 'createdAt' => '2024-12-26T15:07:29.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-25T07:02:48.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:39.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdatePage', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdatePage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'UpdateRatePlanSpec' => [ + 'summary' => '调用UpdateRatePlanSpec修改套餐规格。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239593', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'xcdn-91fknmb80f0g', + ], + ], + [ + 'name' => 'TargetPlanName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标套餐名称。'."\n" + ."\n" + .'中国站'."\n" + ."\n" + .'- 免费版：entranceplan'."\n" + .'- 基础版：basic'."\n" + .'- 标准版：medium'."\n" + .'- 高级版：high'."\n" + ."\n" + .'国际站'."\n" + ."\n" + .'- Entrance：entranceplan_intl'."\n" + .'- Pro：basicplan_intl'."\n" + .'- Premium：vipplan_intl', + 'type' => 'string', + 'required' => false, + 'example' => 'basic', + ], + ], + [ + 'name' => 'TargetPlanCode', + 'in' => 'query', + 'schema' => [ + 'description' => '目标套餐Code。'."\n" + ."\n" + .'中国站'."\n" + ."\n" + .'- 免费版：entranceplan'."\n" + .'- 基础版：basicplan'."\n" + .'- 标准版：standardplan'."\n" + .'- 高级版：advancedplan'."\n" + ."\n" + .'国际站'."\n" + ."\n" + .'- Entrance：entranceplan'."\n" + .'- Pro: standardplan'."\n" + .'- Premium: advancedpla', + 'type' => 'string', + 'required' => false, + 'example' => 'entranceplan', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '变配类型：'."\n" + .'- DOWNGRADE：降配。'."\n" + .'- UPGRADE：升配。', + 'type' => 'string', + 'required' => false, + 'example' => 'UPGRADE', + 'enum' => [ + 'UPGRADE', + ], + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '计费类型'."\n" + .'- PREPAY：预付费。'."\n" + .'- POSTPAY：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PREPAY', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '自动支付。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758'."\n", + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2223332122***', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'xcdn-as23ds***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'CheckPlanFailed', + 'errorMessage' => 'Invalid plan name or code. Check and try again.', + 'description' => '您配置的套餐名或套餐Code不正确，请确保已传入正确的套餐名或套餐Code后重试。', + ], + [ + 'errorCode' => 'InvalidSiteICP', + 'errorMessage' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'description' => '您配置的站点未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + [ + 'errorCode' => 'InvalidSiteName', + 'errorMessage' => 'Invalid website name. Check and try again.', + 'description' => '您配置的站点名称不正确，请确保传入正确的站点名称后重试。', + ], + [ + 'errorCode' => 'SYSTEM.NoSpecificCodeFailed', + 'errorMessage' => 'Invalid subscription duration. Check and try again.', + 'description' => '您配置的套餐购买周期不正确，请检查后重试。', + ], + [ + 'errorCode' => 'Order.InstanceHasUnpaidOrder', + 'errorMessage' => 'You have an unpaid order. Complete the payment or cancel the order first.', + 'description' => '您购买套餐未支付，请支付或作废后再下单。', + ], + [ + 'errorCode' => 'InvalidInstance', + 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', + 'description' => '实例ID缺失或者参数无效，请确认实例ID无误后重试。', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号余额不足，请充值后再购买。', + ], + [ + 'errorCode' => 'InsufficientAvailableQuota', + 'errorMessage' => 'Your account balance is insufficient.', + 'description' => '您的账号已欠费，请缴清欠费后再购买。', + ], + [ + 'errorCode' => 'UpdowngradeConfigNoChange', + 'errorMessage' => 'Failed to change the configuration because the new configuration you specified is the same as the current one in use. Specify a correct configuration and try again.', + 'description' => '升级或降配的配置未改变。', + ], + [ + 'errorCode' => 'InvalidComponent', + 'errorMessage' => 'The order parameters is invalid.', + 'description' => '订单配置参数不符合校验条件。', + ], + [ + 'errorCode' => 'RamAuthFailed', + 'errorMessage' => 'The sub-account has no operation permission.', + 'description' => '子账号无操作权限.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30423A7F-A83D-1E24-B80E-86DD25790758\\\\n\\",\\n \\"OrderId\\": \\"2223332122***\\",\\n \\"InstanceId\\": \\"xcdn-as23ds***\\"\\n}","type":"json"}]', + 'title' => '套餐变配', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:13:39.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRatePlanSpec', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UpdateRatePlanSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'UpdateRecord' => [ + 'summary' => '更新DNS解析记录，支持多种记录类型及源站鉴权配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239650', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '记录的ID，可以通过[ListRecords](~~2850265~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '记录的过期时间，单位秒。范围为**30~86400**，或为1。当取值为1时，表示记录的过期时间为自动。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Proxied', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '是否代理加速', + 'description' => '记录是否开启代理加速。只有CNAME记录与A/AAAA记录可以开启代理加速。取值：'."\n" + .'- **true**：开启代理。'."\n" + .'- **false**：关闭代理加速。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '记录的DNS信息。不同类型的记录，该字段需要传的内容也不同，请参考[说明文档](~~2708761~~)[说明文档](https://www.alibabacloud.com/help/doc-detail/2708761.html)。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '记录值或部分内容。添加A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI记录时，该参数必填。在不同类型的记录中，分别表示不同的含义：'."\n" + ."\n" + .'- **A/AAAA**：指向的Ip地址。多个Ip时，用","分隔。至少需要有一个Ipv4地址。'."\n" + .'- **CNAME**：指向的目标域名。'."\n" + .'- **NS**：指定域名的名称服务器。'."\n" + .'- **MX**: 有效的目标邮件服务器域名。'."\n" + .'- **TXT**：有效的文本字符串。'."\n" + .'- **CAA**：有效的证书颁发机构域名。'."\n" + .'- **SRV**：有效的目标主机域名。'."\n" + .'- **URI**: 有效的 URI 字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'Priority' => [ + 'description' => '记录的优先级，范围为**0~65535**。数值越小，优先级越高。添加MX、SRV、URI记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Flag' => [ + 'description' => '记录的标志位。CAA记录的Flag指示其优先级和处理方式，取值范围为**0~255**。添加CAA记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '128', + ], + 'Tag' => [ + 'description' => '记录的标签。CAA记录的Tag表示其具体类型和用途。添加CAA记录时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'issue', + ], + 'Weight' => [ + 'description' => '记录的权重，范围为**0~65535**。添加SRV、URI记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Port' => [ + 'description' => '记录的端口，范围为**0~65535**。添加SRV记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Type' => [ + 'description' => '记录的证书类型（在CERT记录中），或公钥类型（在SSHFP记录中）。添加CERT、SSHFP记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'KeyTag' => [ + 'description' => '记录的公钥标识，范围为**0~65535**。添加CERT记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Algorithm' => [ + 'description' => '记录所采用的加密算法，范围为**0~255**。添加CERT、SSHFP记录时，该字段必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Certificate' => [ + 'description' => '记录的公钥证书信息。添加CERT、SMIMEA和TLSA记录时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'dGVzdGFkYWxrcw==', + ], + 'Usage' => [ + 'description' => '记录的用途标识，范围为**0~255**。添加SMIMEA和TLSA时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Selector' => [ + 'description' => '记录所使用的证书或公钥的类型，范围为**0~255**。添加SMIMEA和TLSA时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MatchingType' => [ + 'description' => '记录用于匹配或验证证书的算法策略，范围为**0~255**。添加SMIMEA和TLSA记录时，该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Fingerprint' => [ + 'description' => '记录的公钥指纹值。添加SSHFP记录时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef1234567890', + ], + ], + 'required' => true, + 'example' => '{'."\n" + .' "value":"2.2.2.2"'."\n" + .'}', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'CNAME记录的源站类型。添加CNAME记录时，需要填写此参数。取值：'."\n" + ."\n" + .'- **OSS**：OSS源站。'."\n" + .'- **S3**：S3源站。'."\n" + .'- **LB**：负载均衡器源站。'."\n" + .'- **OP**：源地址池源站。'."\n" + .'- **Domain**：普通域名源站。'."\n" + ."\n" + .'该参数不传或传空时，则默认为Domain，即普通域名源站类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'BizName', + 'in' => 'query', + 'schema' => [ + 'description' => '记录加速时的业务场景，不开启加速的记录不需要传，取值：'."\n" + .'- **video_image**：视频图片。'."\n" + .'- **api**：api接口。'."\n" + .'- **web**：web网页。', + 'type' => 'string', + 'required' => false, + 'example' => 'web', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '记录的备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a remark.', + ], + ], + [ + 'name' => 'AuthConf', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'CNAME记录的源站鉴权信息。', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'description' => '源站鉴权类型，不同的源站类型，支持的鉴权类型不同，源站类型是指本接口中的SourceType参数，现在源站类型为OSS和S3时，需要填写源站鉴权类型，可选值：'."\n" + ."\n" + .'- **public**：公共读，当源站类型为OSS或S3，且源站为公共读时，选此值。'."\n" + .'- **private**: 私有读，当源站类型为S3，且源站为私有读时，选此值。'."\n" + .'- **private_same_account**: 私有同账号读，当源站类型为OSS，在同一个阿里云账号下，且源站为私有读时，选此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'private', + ], + 'SecretKey' => [ + 'description' => '源站所属账号的SecretKey，当源站类型为OSS且源站鉴权类型为私有跨账号读，或者源站类型为S3且源站鉴权类型为私有读时，需要填写此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', + ], + 'AccessKey' => [ + 'description' => '源站所属账号的AccessKey，当源站类型为OSS且源站鉴权类型为私有跨账号读，或者源站类型为S3且源站鉴权类型为私有读时，需要填写此值。', + 'type' => 'string', + 'required' => false, + 'example' => 'VIxuvJSA2S03f******kp208dy5w7', + ], + 'Region' => [ + 'description' => '签名算法版本，当源站类型为S3且源站鉴权类型为私有读时需要，支持以下两种：'."\n" + ."\n" + .'- **v2**'."\n" + ."\n" + .'- **v4**'."\n" + ."\n" + .'不传时，默认为v4。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2', + ], + 'Version' => [ + 'description' => '源站所属区域，当源站类型为S3时，需要填写此值，源站所属的区域需要在S3的官方网站上获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'us-east-1', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'HostPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '回源HOST策略，记录类型为CNAME时生效，设置回源时带HOST的策略，有两种模式：'."\n" + ."\n" + .'- **follow_hostname**: 跟随主机记录。'."\n" + .'- **follow_origin_domain**: 跟随源站域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'follow_origin_domain', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordData', + 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', + 'description' => '记录内容参数错误，请根据接口文档调整参数内容。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'Record.Reserved', + 'errorMessage' => 'Another operation on the record is in progress. Try again later.', + 'description' => '记录操作正在进行中，请稍等重试。', + ], + [ + 'errorCode' => 'Record.ServiceBusy', + 'errorMessage' => 'The record is being configured. Try again later.', + 'description' => '该记录正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'Record.Conflict', + 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidBiz', + 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', + 'description' => '业务类型的值为空或传入参数错误。', + ], + [ + 'errorCode' => 'Record.RecordValueContainSourceInBlacklist', + 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', + 'description' => '记录值包含黑名单地址，详情可提交工单咨询。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', + 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', + 'description' => '若添加站点同名记录，请将主机记录命名为@，若添加其他记录，主机记录后缀需要和站点名完全一致。请调整后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordNameExceedLimit', + 'errorMessage' => 'The length of the record name exceeds the maximum limit.', + 'description' => '记录名称不能超过200个字符。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidHostPolicy', + 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', + 'description' => '回源Host的参数错误。', + ], + [ + 'errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', + 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', + 'description' => 'CNAME方式接入的站点仅支持添加A/AAAA、CNAME类型记录。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordCommentExceedLimit', + 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', + 'description' => '记录的备注信息大于50个字符。', + ], + [ + 'errorCode' => 'QuotaExceed.WildCardRecord', + 'errorMessage' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', + 'description' => '泛域名记录的数量超限，请联系销售增加额度。', + ], + [ + 'errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', + 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', + 'description' => '创建或编辑A/AAAA记录时，记录值包含了无效IP。', + ], + [ + 'errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', + 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', + 'description' => '创建或编辑A/AAAA记录时，IP数量超限，一个主机记录仅支持8个IPv4和4个IPv6 IP，请调整后重试。', + ], + [ + 'errorCode' => 'Record.CAARecordFlagExceedLimit', + 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CAA记录的flag参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CAARecordTagExceedLimit', + 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', + 'description' => '创建或编辑CAA记录信息时，Tag值传入了issue、issuewild、iodef以外的非法字符。', + ], + [ + 'errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', + 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录的algorithm参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CERTRecordKeyTagExceedLimit', + 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录的keyTag参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.CERTRecordTypeExceedLimit', + 'errorMessage' => 'The CERT record type is out of range.', + 'description' => '创建或编辑DNS记录信息时，CERT记录type参数超出了范围。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedIPASource', + 'errorMessage' => 'The CNAME record cannot be the origin of the added Layer 4 application. Check the values of other Layer 4 proxy records and try again.', + 'description' => 'CNAME记录不能是已经添加的四层应用的源站，请检查其他四层代理记录的记录值并重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', + 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', + 'description' => 'CNAME记录不能是已经添加的源地址池的源站，请检查后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedRecordSource', + 'errorMessage' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.', + 'description' => 'CNAME记录不能是已经添加的记录的源站，请检查其他记录的记录值并重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedIPARecord', + 'errorMessage' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.', + 'description' => 'CNAME记录的记录值不能与其他已经存在的四层代理记录名完全相同。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', + 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', + 'description' => 'CNAME记录的记录值不能与其他已经存在的CNAME记录名完全相同。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', + 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', + 'description' => 'CNAME记录的记录值不能和主机记录完全一样，请调整后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueExceedLimit', + 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', + 'description' => '记录值不能超过253个字符，请删减后重试。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueInvalidDomainUnderline', + 'errorMessage' => 'Record values (DNS-only records) generally start with an underscore, a lowercase letter a-z, and the numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.', + 'description' => '记录值（仅DNS的记录）一般需以下划线 _、小写字母 a-z 、数字 0-9开头。记录中间部分可用小写字母、数字或连字符 -，长度在 0 到 61 个字符之间。', + ], + [ + 'errorCode' => 'Record.CNameRecordValueInvalidRecordDomain', + 'errorMessage' => 'Record values (records with agent acceleration enabled) must start with a lowercase letter a-z and numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.', + 'description' => '记录值（开启代理加速的记录）一般需以小写字母 a-z 、数字 0-9开头。记录中间部分可用小写字母、数字或连字符 -，长度在 0 到 61 个字符之间。', + ], + [ + 'errorCode' => 'Record.EmptyRecordValue', + 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', + 'description' => '记录值为空，请正确填写后重试。', + ], + [ + 'errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', + 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', + 'description' => '创建或编辑CERT记录信息时，CERT记录的证书值不是base64编码后的值。', + ], + [ + 'errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', + 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', + 'description' => '创建或编辑SSHFP记录信息时，指纹fingerprint值不是16进制编码的。', + ], + [ + 'errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', + 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', + 'description' => '创建或编辑CAA记录信息时，CAA记录的标签Tag，只能是分号或分号分隔的合法域名。', + ], + [ + 'errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', + 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以mailto:为前缀时，后面必须接一个合法的email地址。', + ], + [ + 'errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', + 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', + 'description' => '创建或编辑SMIMEA记录信息时，SMIMEA记录的证书值不是base64编码后的值。', + ], + [ + 'errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', + 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', + 'description' => '创建或编辑TLSA记录信息时，传入的证书值不是16进制编码的。', + ], + [ + 'errorCode' => 'Record.InvalidURLWithURIRecord', + 'errorMessage' => 'The URI record value must be a valid URL address.', + 'description' => '创建或编辑URI记录信息时，记录值必须是一个合法的URL地址。', + ], + [ + 'errorCode' => 'Record.NoRecordNameConflictWithNSRecord', + 'errorMessage' => 'No record name can conflict with an NS record name.', + 'description' => '任何记录名不能和NS记录名冲突。', + ], + [ + 'errorCode' => 'Record.NSRecordCannotEqualSiteName', + 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', + 'description' => '不允许添加和站点名称完全同名的NS记录。', + ], + [ + 'errorCode' => 'Record.OSSSourceInvalidAuthType', + 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', + 'description' => '记录的OSS源站鉴权类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.ParseJSONRecordValueFailed', + 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', + 'description' => '记录值的JSON格式不正确，请调整后重试。', + ], + [ + 'errorCode' => 'Record.PoolSourceNotExistPool', + 'errorMessage' => 'If the source station type of the record is source address pool, the input source address pool does not exist.', + 'description' => '记录的源站类型为源地址池的情况下，输入的源地址池不存在。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', + 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', + 'description' => 'A/AAAA、CNAME记录之间不能重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithIPAName', + 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能和四层代理记录重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithLBName', + 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能与负载均衡记录重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithNSRecord', + 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', + 'description' => '创建或编辑DNS记录信息时，NS记录名不能和任何其他类型记录名重名。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithPoolName', + 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', + 'description' => '创建或编辑DNS记录信息时，记录名称不能和源地址池记录名重名。', + ], + [ + 'errorCode' => 'Record.RecordNameInBlacklist', + 'errorMessage' => 'The record name is in blacklist.', + 'description' => '记录名在黑名单中，无法添加。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthRegion', + 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', + 'description' => '记录的S3源站所属区域不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthType', + 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', + 'description' => '记录的S3源站鉴权类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.S3SourceInvalidAuthVersion', + 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', + 'description' => '记录的S3源站的鉴权签名算法版本不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.SourceAccessKeyExceedLimit', + 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', + 'description' => '记录源站的 AccessKey 参数值的字符长度超出了范围。', + ], + [ + 'errorCode' => 'Record.SourceEmptyAK', + 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', + 'description' => '记录的源站所属账号的 AccessKey 为空。', + ], + [ + 'errorCode' => 'Record.SourceEmptyAuthConf', + 'errorMessage' => 'The authentication information of the origin station is empty.', + 'description' => '记录的源站的鉴权信息为空。', + ], + [ + 'errorCode' => 'Record.SourceEmptySecretKey', + 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', + 'description' => '记录的源站所属账号的 SecretKey 为空。', + ], + [ + 'errorCode' => 'Record.SourceSecretKeyExceedLimit', + 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', + 'description' => '记录源站的 SecretKey 参数值的字符长度超出了范围。', + ], + [ + 'errorCode' => 'Record.SRVRecordInvalidRecordName', + 'errorMessage' => 'SRV host record name is not valid. The SRV host record name must begin with an underscore (-) followed by a lowercase letter (a-z), a number (0-9), and a hyphen (-), followed by 1 arbitrary character, followed by an underscore (-) and a lowercase letter, number, or hyphen.', + 'description' => 'SRV主机记录名称不合法。SRV主机记录名称必须以下划线（-）开头，后跟小写字母（a-z）、数字（0-9）、连字符（-），后接1个任意字符，再跟1个下划线（-）和小写字母、数字或连字符。', + ], + [ + 'errorCode' => 'Record.SRVRecordPortExceedLimit', + 'errorMessage' => 'The SRV record port is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的SRV记录端口超出了范围。', + ], + [ + 'errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', + 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', + 'description' => '创建或编辑DNS记录信息时，SSHFP记录的algorithm参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.TTLExceedLimit', + 'errorMessage' => 'The TTL parameter value for a record is out of range.', + 'description' => '创建或编辑DNS记录信息时，记录的TTL参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.TXTRecordValueExceedLimit', + 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', + 'description' => '创建或编辑DNS记录信息时，TXT记录值不能超过450个字符。', + ], + [ + 'errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', + 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', + 'description' => '创建或编辑DNS记录信息时，SSHFP记录Type参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', + 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', + 'description' => '主机记录名称非法。主机记录内不能包含连续的点号。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', + 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', + 'description' => '主机记录名称非法，SRV记录名称禁止使用星号。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidATChar', + 'errorMessage' => 'Illegal host record name. The at symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.', + 'description' => '主机记录名称非法。@符号只能出现在主机记录的首位，且后面只能跟.符号，不允许接其他字符串。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', + 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', + 'description' => '主机记录名称非法。主机记录值不能以点号、中划线开头或结尾。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidStartSymbol', + 'errorMessage' => 'Illegal host record name. The asterisk is only allowed in the first place of the host record, and only the following dot is allowed after the asterisk.', + 'description' => '主机记录名称非法。星号只允许在主机记录首位，并且星号后面只允许跟点。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', + 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', + 'description' => '主机记录名称非法。用\'.\'号分隔的每段字符数量不能超过63个。', + ], + [ + 'errorCode' => 'Record.UnsupportedSourceType', + 'errorMessage' => 'The recorded source station type is not in the supported range.', + 'description' => '记录的源站类型不在支持的范围内。', + ], + [ + 'errorCode' => 'Record.UnsupportedType', + 'errorMessage' => 'The record type parameter is unsupported.', + 'description' => '记录类型错误，请检查记录类型参数。', + ], + [ + 'errorCode' => 'Record.ValidProxiedForSpecifedRecordType', + 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', + 'description' => '创建或编辑记录时，代理状态开启了代理加速，仅A/AAAA、CNAME类型支持开启代理加速。', + ], + [ + 'errorCode' => 'Record.RecordUsageExceedLimit', + 'errorMessage' => 'The usage parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的usage参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordSelectorExceedLimit', + 'errorMessage' => 'The selector parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的selector参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordMatchingTypeExceedLimit', + 'errorMessage' => 'The matchingType parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的matchingType参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordPriorityExceedLimit', + 'errorMessage' => 'The record priority parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的记录优先级参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordWeightExceedLimit', + 'errorMessage' => 'The record weight parameter value filled in is out of range.', + 'description' => '创建或编辑DNS记录信息时，填入的记录权重参数值超出了范围。', + ], + [ + 'errorCode' => 'Record.RecordNameConflictWithSameRecordType', + 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', + 'description' => '记录冲突，存在记录值相同的同名主机记录。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameInvalidUnderLine', + 'errorMessage' => 'The host record name contains an illegal underscore. The underscore is only supported at the beginning of the TXT, CNAME, MX, SRV, and NS records. Proxy acceleration cannot be enabled, and records can only be added in the DNS mode.', + 'description' => '主机记录名称包含了非法下划线。下划线仅可在TXT、CNAME、MX、SRV、NS的记录中的开头处支持，且不能开启代理加速，仅能以DNS方式添加记录。', + ], + [ + 'errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', + 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', + 'description' => '以CNAME方式接入的站点，提交了未开启加速的记录。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameOnlyContainSymbol', + 'errorMessage' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.', + 'description' => '主机记录值不能以各类符号单独存在，可加入任何小写字母或数字。'."\n", + ], + [ + 'errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', + 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', + 'description' => '创建或编辑CAA记录信息时，Tag值不能以mailto: http://或者mailto: https:// 开头。', + ], + [ + 'errorCode' => 'Record.WildcardConflictForSpecifiedRecordType', + 'errorMessage' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.', + 'description' => 'A/AAAA,CNAME记录不能同时添加all和星号前缀的记录。', + ], + [ + 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', + 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', + 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'SameNameRecordExceedLimit', + 'errorMessage' => 'The number of records with the same name exceeds the upper limit.', + 'description' => '同名称的记录数量超过上限。', + ], + [ + 'errorCode' => 'Record.UnmatchedRecordNameOnlyRangeChars', + 'errorMessage' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, some special characters are supported as valid characters in host records.', + 'description' => '主机记录字符非法。主机记录值合法字符仅支持小写字母a-z、大写字母A-Z、数字0-9、\'-\' 、\'_\' 、\'.\'、\'*\'、\'@\'。'."\n", + ], + [ + 'errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', + 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以http://或https://为前缀时，后面必须接一个合法的URL地址。'."\n", + ], + [ + 'errorCode' => 'Record.ProxiedAsCustomHostnameSource', + 'errorMessage' => 'Failed to disable proxy the record because it is the origin server of existing custom hostnames.Remove all references to the record and try again.', + 'description' => '该记录是已有自定义主机名的源站，不允许关闭代理。请移除所有对该记录的引用后重试。', + ], + ], + 404 => [ + [ + 'errorCode' => 'Record.NotFound', + 'errorMessage' => 'The record does not exist. Check your configurations and try again.', + 'description' => '传入的请求记录不存在，请检查您的输入参数后重试。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '更新解析记录', + 'description' => '此API允许您更新DNS记录，包括但不限于A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI等类型。您可以通过传递相应的记录值、优先级、标志位等字段来修改记录内容。对于需要鉴权的CNAME源站（如OSS、S3），API还支持配置源站鉴权信息，确保安全访问。'."\n" + ."\n" + .'### 注意事项'."\n" + ."\n" + .'- 记录值（Value）与记录类型需匹配，如CNAME记录应对应目标域名。'."\n" + .'- 某些记录类型（如MX、SRV）需指定优先级（Priority）。'."\n" + .'- CAA记录需提供Flag、Tag等特定字段。'."\n" + .'- 更新CERT、SSHFP等安全记录时，需准确设置Type、Algorithm等字段。'."\n" + .'- 使用OSS或S3作为源站时，根据权限配置AuthConf中的鉴权详情。', + 'requestParamsDescription' => '记录的Data字段包含记录的DNS信息。不同类型的记录，该字段需要传的内容也不同，请参考[说明文档](https://help.aliyun.com/document_detail/2708761.html)[说明文档](https://www.alibabacloud.com/help/doc-detail/2708761.html)。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-10T06:18:46.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-10-10T12:01:10.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-24T08:28:18.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-23T08:53:22.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRecord', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'UpdateRedirectRule' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257658', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListRedirectRules](~~2867474~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3528160969****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '重定向类型。取值范围：'."\n" + ."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'static' => 'static', + 'dynamic' => 'dynamic', + ], + 'example' => 'static', + 'enum' => [ + 'static', + 'dynamic', + ], + ], + ], + [ + 'name' => 'TargetUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '重定向后的目标URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.exapmle.com/index.html'."\n", + ], + ], + [ + 'name' => 'StatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点给客户端响应重定向地址时候使用的响应状态码。取值范围：'."\n" + ."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 303'."\n" + .'- 307'."\n" + .'- 308', + 'type' => 'string', + 'required' => false, + 'example' => '301', + 'enum' => [ + '301', + '302', + '303', + '307', + '308', + ], + ], + ], + [ + 'name' => 'ReserveQueryString', + 'in' => 'query', + 'schema' => [ + 'description' => '保留查询字符串。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '更新重定向配置', + 'summary' => '修改站点的重定向配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:38.000Z', + 'description' => '错误码发生变更、请求参数发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRedirectRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\"\\n}","type":"json"}]', + ], + 'UpdateRewriteUrlRule' => [ + 'summary' => '修改站点的重写URL配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257642', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListRewriteUrlRules](~~2867480~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3528160969****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'example=123'."\n", + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'RewriteUriType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '路径重写类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'static' => 'static', + 'dynamic' => 'dynamic', + ], + 'example' => 'static', + 'enum' => [], + ], + ], + [ + 'name' => 'Uri', + 'in' => 'query', + 'schema' => [ + 'description' => '重写后的目标URI。', + 'type' => 'string', + 'required' => false, + 'example' => '/image/example.jpg'."\n", + ], + ], + [ + 'name' => 'RewriteQueryStringType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询字符串重写类型。取值范围：'."\n" + .'- static：静态模式。'."\n" + .'- dynamic：动态模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'static' => 'static', + 'dynamic' => 'dynamic', + ], + 'example' => 'static', + 'enum' => [], + ], + ], + [ + 'name' => 'QueryString', + 'in' => 'query', + 'schema' => [ + 'description' => '重写后的查询字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'example=123'."\n", + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'VerifyExpressionError', + 'errorMessage' => 'Dynamic expression is invalid.', + 'description' => '动态表达式不合法。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改重写URL配置', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-10T07:02:38.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2025-03-27T02:58:48.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRewriteUrlRule', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\"\\n}","type":"json"}]', + ], + 'UpdateRoutineConfigDescription' => [ + 'summary' => '修改边缘函数Routine描述信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239144', + 'abilityTreeNodes' => [ + 'FEATUREdcdn75UYDO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Routine描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'description of this routine', + ], + ], + ], + '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' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', + ], + 'Status' => [ + 'description' => '接口操作结果，成功或失败。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'RoutineNotExist', + 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'errorCode' => 'InternalOperationError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'RoutineUserServiceStatusHalt', + 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改边缘函数描述', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateRoutineConfigDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'UpdateRoutineRoute' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266196', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456******', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'RouteName', + 'in' => 'query', + 'schema' => [ + 'description' => '路由名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_route', + ], + ], + [ + 'name' => 'RouteEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '路由开关。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容。', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq \\"video.example.com\\")'."\n", + ], + ], + [ + 'name' => 'RoutineName', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘函数Routine名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-routine1', + ], + ], + [ + 'name' => 'Bypass', + 'in' => 'query', + 'schema' => [ + 'description' => '旁路模式。取值范围：'."\n" + .'- on：开启'."\n" + .'- off：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Fallback', + 'in' => 'query', + 'schema' => [ + 'description' => '异常回源开关，开启后若函数出现异常如CPU使用超限则请求回源。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'InvalidRoutine', + 'errorMessage' => 'The name of routine is invalid.', + 'description' => '边缘函数名称不合法。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改边缘函数路由配置', + 'summary' => '修改边缘函数路由配置。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-25T05:35:34.000Z', + 'description' => '请求参数发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRoutineRoute', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateRoutineRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', + ], + 'UpdateScheduledPreloadExecution' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239314', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => '66599bd7397885b43804901c', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '定时预热计划开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-05-31T17:10:48.849+08:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '定时预热计划结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-05-31T18:10:48.849+08:00', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'formData', + 'schema' => [ + 'description' => '定时预热计划每批执行间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'SliceLen', + 'in' => 'formData', + 'schema' => [ + 'description' => '每批定时预热URL个数。', + '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' => '15C66C7B-671A-4297-9187-2C4477247A123425345', + ], + 'Id' => [ + 'description' => '预热计划ID。', + 'type' => 'string', + 'example' => '66599bd7397885b43804901c', + ], + 'StartTime' => [ + 'description' => '定时预热计划开始时间。', + 'type' => 'string', + 'example' => '2024-05-31T17:10:48.849+08:00', + ], + 'EndTime' => [ + 'description' => '定时预热计划结束时间。', + 'type' => 'string', + 'example' => '2024-05-31T18:10:48.849+08:00', + ], + 'Interval' => [ + 'description' => '定时预热计划每批执行间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'SliceLen' => [ + 'description' => '每批定时预热URL个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Status' => [ + 'description' => '定时预热计划的状态，包括如下状态。'."\n" + .'- **waiting**：等待被执行。'."\n" + .'- **running**：正在执行中。'."\n" + .'- **finished**：执行完成。'."\n" + .'- **failed**：执行失败。'."\n" + .'- **stopped**：暂停执行中。', + 'type' => 'string', + 'example' => 'running', + ], + 'JobId' => [ + 'description' => '预热任务ID。', + 'type' => 'string', + 'example' => '665d3af3621bccf3fe29e1a4', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '15685865xxx14622', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'errorCode' => 'InvalidJob.JobCountOfSiteFull', + 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ObjectId', + 'errorMessage' => 'Invalid task ID or execution plan ID.', + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'errorCode' => 'MissingOssUrl', + 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'errorCode' => 'MissingUrlList', + 'errorMessage' => 'Enter the URLs you want to prefetch.', + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidUid.PermissionDenied', + 'errorMessage' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + ], + [ + [ + 'errorCode' => 'InvalidJob.NotFound', + 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'errorCode' => 'LogNotFound', + 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'errorCode' => 'InvalidExecution.NotFound', + 'errorMessage' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + ], + ], + 'title' => '更新单个定时预热计划', + 'summary' => '根据预热计划ID更新一个定时预热。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateScheduledPreloadExecution', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateScheduledPreloadExecution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\",\\n \\"Id\\": \\"66599bd7397885b43804901c\\",\\n \\"StartTime\\": \\"2024-05-31T17:10:48.849+08:00\\",\\n \\"EndTime\\": \\"2024-05-31T18:10:48.849+08:00\\",\\n \\"Interval\\": 60,\\n \\"SliceLen\\": 10,\\n \\"Status\\": \\"running\\",\\n \\"JobId\\": \\"665d3af3621bccf3fe29e1a4\\",\\n \\"AliUid\\": \\"15685865xxx14622\\"\\n}","type":"json"}]', + ], + 'UpdateSeoBypass' => [ + 'summary' => '修改站点放行搜索引擎爬虫配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257452', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改站点放行搜索引擎爬虫配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSeoBypass', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateSeoBypass', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + ], + 'UpdateSiteAccessType' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239615', + 'abilityTreeNodes' => [ + 'FEATUREdcdnMF1S4U', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'AccessType', + 'in' => 'query', + 'schema' => [ + 'description' => '修改到的站点接入类型。取值：'."\n" + ."\n" + .'- **NS**：表示使用托管NS的方式接入。'."\n" + .'- **CNAME** ：表示使用配置CNAME的方式接入。', + 'type' => 'string', + 'required' => true, + 'example' => 'NS', + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'Site.UpdateAccessTypeUnable', + 'errorMessage' => 'Failed to change the DNS setup for the website. Check whether the website has configurations or DNS records that are incompatible with the target DNS setup option.', + 'description' => '无法更新站点的接入类型，请检查是否有目标接入类型不支持的配置或记录。', + ], + [ + 'errorCode' => 'VerifyNameServerFailed', + 'errorMessage' => 'The NS verification failed. Please configure the NS provided by ESA on the domain name management platform and try again.', + 'description' => 'NS校验失败，请您在域名管理平台配置为ESA提供的NS后，再进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改站点接入方式', + 'summary' => '根据站点ID和站点接入类型修改站点的接入方式。', + 'description' => '在从NS接入修改到CNAME接入时，存在一些限制：'."\n" + ."\n" + .'- 需要保证站点下仅存在开启加速的A/AAAA、CNAME记录。'."\n" + ."\n" + .'- 需要站点没有开启“DNS透传模式”、“自定义NS”功能。', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-05T03:27:37.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:39.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteAccessType', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteAccessType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'UpdateSiteCoverage' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239596', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过调用[ListSites](~~2850189~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Coverage', + 'in' => 'query', + 'schema' => [ + 'description' => '修改到的目标加速区域。取值：'."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **global**：全球。'."\n" + .'- **overseas**：全球（不包含中国内地）。', + 'type' => 'string', + 'required' => true, + 'example' => 'global', + 'enum' => [ + 'domestic', + 'global', + 'overseas', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'InvalidParameter.Coverage', + 'errorMessage' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', + 'description' => '您选择的加速区域不在当前套餐支持范围内，请更换为套餐支持的加速区域后重试。', + ], + [ + 'errorCode' => 'SiteHasTransportLayerApplications', + 'errorMessage' => 'The current site has an existing four-layer accelerated application, and the current operation is not allowed. If necessary, please contact customer service.', + 'description' => '当前站点有已经存在的四层加速应用，不允许进行当前操作，如有需要，请联系客服。', + ], + [ + 'errorCode' => 'IpaNotActive', + 'errorMessage' => 'The ipa application is not active.', + 'description' => '当前应用正在部署中。', + ], + [ + 'errorCode' => 'InvalidSiteICP', + 'errorMessage' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'description' => '您配置的站点未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改站点加速区域', + 'summary' => '修改单个站点的加速区域。更新站点的加速配置，以适应流量分布变化或提升特定地区用户的访问体验。', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-23T01:46:45.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-10-15T05:52:17.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-24T09:13:34.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:39.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteCoverage', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\"\\n}","type":"json"}]', + ], + 'UpdateSiteCustomLog' => [ + 'summary' => '更新站点日志抓取时的自定义请求头、响应头及Cookie字段配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238355', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'site id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11223****', + ], + ], + [ + 'name' => 'RequestHeaders', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '请求头参数', + 'type' => 'array', + 'items' => [ + 'description' => '请求头参数的单个值', + 'type' => 'string', + 'required' => false, + 'example' => 'x-acs-request-id', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResponseHeaders', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '响应头参数', + 'type' => 'array', + 'items' => [ + 'description' => '响应头参数的单个值', + 'type' => 'string', + 'required' => false, + 'example' => 'X_Swift_Error', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'cookie参数', + 'type' => 'array', + 'items' => [ + 'description' => 'cookie参数的单个值', + 'type' => 'string', + 'required' => false, + 'example' => 'sessionId', + ], + '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' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'RealTimeLog.NameCheckFail', + 'errorMessage' => 'Real-time log name field validity check failed.', + 'description' => '您输入的实时日志配置字段包含非法字符，请删除非法字符后重试，允许的字符包含数字、字母、下划线"_"和空格" "', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改站点自定义日志字段', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteCustomLog', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteCustomLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ET5BF670-09D5-4D0B-BEBY-D96A2A528000\\"\\n}","type":"json"}]', + ], + 'UpdateSiteDeliveryTask' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238989', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'cdn-test-task', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456****', + ], + ], + [ + 'name' => 'FieldName', + 'in' => 'formData', + 'schema' => [ + 'description' => '想要修改的投递字段列表，用英文逗号分割。', + 'type' => 'string', + 'required' => true, + 'example' => 'ClientIP,UserAgent', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'formData', + 'schema' => [ + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => false, + 'example' => 'dcdn_log_er', + ], + ], + [ + 'name' => 'DiscardRate', + 'in' => 'formData', + 'schema' => [ + 'description' => '丢弃率。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.0', + ], + ], + [ + 'name' => 'FilterVer', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改实时日志任务投递', + 'summary' => '对用户的实时日志任务投递进行修改。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-24T01:43:11.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-10-18T01:07:11.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteDeliveryTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', + ], + 'UpdateSiteDeliveryTaskStatus' => [ + 'summary' => '修改实时日志任务投递状态。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239089', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'cdn-test-task', + ], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456****', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'description' => '开启/停用任务投递。', + 'type' => 'string', + 'required' => true, + 'example' => 'online', + ], + ], + ], + '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' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'cdn-test-task', + ], + 'Status' => [ + 'description' => '任务状态，取值：'."\n" + ."\n" + .'- **online**：推送中。'."\n" + ."\n" + .'- **offline**：已停用。', + 'type' => 'string', + 'example' => 'online', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '实时日志任务投递状态修改', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteDeliveryTaskStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteDeliveryTaskStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"TaskName\\": \\"cdn-test-task\\",\\n \\"Status\\": \\"online\\"\\n}","type":"json"}]', + ], + 'UpdateSiteNameExclusive' => [ + 'summary' => '修改站点名称独占配置。开启该功能后，其他的账号不再能创建当前站点的同名站点或子站点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257454', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '功能开关。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改站点名称独占配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteNameExclusive', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteNameExclusive', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'UpdateSitePause' => [ + 'summary' => '修改站点暂停配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257464', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****'."\n", + ], + ], + [ + 'name' => 'Paused', + 'in' => 'query', + 'schema' => [ + 'description' => '用于临时暂停整个站点的代理加速功能，开启后所有DNS记录都将直接返回记录值给客户端。取值范围：'."\n" + .'- true：暂停站点加速。'."\n" + .'- false：站点正常加速。', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + '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' => '6abd807e-ed2a-44de-ac54-ac38a62472e6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6abd807e-ed2a-44de-ac54-ac38a62472e6\\"\\n}","type":"json"}]', + 'title' => '修改站点暂停配置', + 'description' => '该API仅适用于NS方式接入的站点。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSitePause', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateSitePause', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + ], + 'UpdateSiteVanityNS' => [ + 'summary' => '修改单个站点的自定义NS服务器名称。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239620', + 'abilityTreeNodes' => [ + 'FEATUREdcdnMF1S4U', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过调用[ListSites](~~2850189~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'VanityNSList', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义NS名称列表。支持2～5个自定义NS名称，多个用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'ns1.example.com,ns2.example.com', + ], + ], + ], + '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' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ApplyVanityNSError', + 'errorMessage' => 'Failed to apply for vanity NS resources. Please contact customer service.', + 'description' => '申请自定义NS资源失败，请联系客服处理。', + ], + [ + 'errorCode' => 'OperationDenied.VanityNSUnavailable', + 'errorMessage' => 'Only sites in NS access type can use vanity nameservers. Convert your site to NS access type and try again.', + 'description' => '仅NS方式接入的站点可以使用自定义NS，请调整您的站点接入方式后重试。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidVanityNSNum', + 'errorMessage' => 'Enter 2 to 5 vanity nameservers. Correct them and try again.', + 'description' => '自定义NS需要2~5个名称，请调整后重新提交。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidVanityNSName', + 'errorMessage' => 'A vanity nameserver must be an absolute domain name. Correct it and try again.', + 'description' => '自定义NS名称需输入完整域名，请调整后重新提交。', + ], + [ + 'errorCode' => 'InvalidParameter.VanityNSNameDuplicate', + 'errorMessage' => 'The vanity nameservers are duplicated. Please delete it and try again.', + 'description' => '存在重复的自定义NS名称，请删除后重新提交。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.CustomNS', + 'errorMessage' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.', + 'description' => '当前套餐不支持配置自定义NS，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'Record.Conflict', + 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordsExceedLimit', + 'errorMessage' => 'The number of incoming records exceeds the maximum limit.', + 'description' => '传入的记录数量超过了最大数量限制。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改站点的自定义NS服务器', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-05T03:27:36.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:39.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteVanityNS', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteVanityNS', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + ], + 'UpdateTieredCache' => [ + 'summary' => '修改站点多级缓存配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257320', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可以通过调用[ListSites](~~2850189~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'CacheArchitectureMode', + 'in' => 'query', + 'schema' => [ + 'description' => '多级缓存架构模式。取值范围：'."\n" + .'- edge：边缘缓存层。'."\n" + .'- edge_smart：边缘缓存层+智能缓存层。'."\n" + .'- edge_regional：边缘缓存层+区域缓存层。'."\n" + .'- edge_regional_smart：边缘缓存层+区域缓存层+智能缓存层。', + 'type' => 'string', + 'required' => true, + 'example' => 'edge_smart', + 'enum' => [ + 'edge', + 'edge_smart', + 'edge_regional', + 'edge_regional_smart', + ], + ], + ], + ], + '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' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'Failed to check the configured function parameters.', + 'description' => '配置的功能参数检查失败', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改站点多级缓存配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateTieredCache', + ], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + ], + 'UpdateTransportLayerApplication' => [ + 'summary' => '修改指定站点下四层应用的转发规则等配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245118', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVFT29S', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '四层应用ID，可通过调用[ListTransportLayerApplications](~~ListTransportLayerApplications~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '165503967****', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '转发规则列表。规则详情。每一条规则，除备注外，其他参数为必填。', + 'type' => 'array', + 'items' => [ + 'description' => '规则详情。每一条规则，除备注外，其他参数为必填。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => '转发规则协议，支持：'."\n" + ."\n" + .'- TCP：TCP协议。'."\n" + .'- UDP：UDP协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + 'enum' => [ + 'TCP', + 'UDP', + ], + ], + 'EdgePort' => [ + 'description' => '边缘端口。支持：'."\n" + ."\n" + .'- 单个端口，例如80。'."\n" + .'- 端口范围，例如 81-85，代表端口 81、82、83、84、85。'."\n" + .'- 端口和端口范围组合，端口、端口范围之间用逗号分隔，例如80,81-85,90，代表端口80、81、82、83、84、85、90。'."\n" + .'- 单个规则的边缘端口以及多个规则之间的边缘端口不允许重叠。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + 'SourceType' => [ + 'description' => '源站类型，支持：'."\n" + .'- **ip**: IP。'."\n" + .'- **domain**: 域名。'."\n" + .'- **OP**: 源地址池。'."\n" + .'- **LB**: 负载均衡器。', + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + 'enum' => [ + 'ip', + 'domain', + 'LB', + 'OP', + ], + ], + 'SourcePort' => [ + 'description' => '源站端口。支持：'."\n" + ."\n" + .'- 单个端口，当源站端口为单个端口时，支持任意合法的边缘端口组合。'."\n" + .'- 端口范围，仅当边缘端口为端口段时，源站端口才允许设置为端口范围且范围大小需要与边缘端口一致。例如边缘端口若为90-93，则不允许将源站端口设置为81-85，因为源站端口范围为5，边缘端口范围为3，两者不一致。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + 'ClientIPPassThroughMode' => [ + 'description' => '客户端IP传递协议，支持：'."\n" + .'- **off**: 不传递。'."\n" + .'- **PPv1**: PROXY Protocol v1协议，支持TCP协议的客户端IP传递。'."\n" + .'- **PPv2**: PROXY Protocol v2协议，支持TCP和UDP协议的客户端IP传递。'."\n" + .'- **SPP**: Simple Proxy Protocol协议，支持UDP协议的客户端IP传递。', + 'type' => 'string', + 'required' => false, + 'example' => 'SPP', + 'enum' => [ + 'off', + 'PPv1', + 'PPv2', + 'SPP', + ], + ], + 'Source' => [ + 'description' => '源站具体的值。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1', + ], + 'Comment' => [ + 'description' => '规则的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IpAccessRule', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP访问规则开关，开启后，WAF中的 IP访问规则对四层应用生效。'."\n" + ."\n" + .'- on: 开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'Ipv6', + 'in' => 'query', + 'schema' => [ + 'description' => 'Ipv6开关。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'CrossBorderOptimization', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启中国大陆网络接入优化，默认关闭。取值范围：'."\n" + ."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'StaticIp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '成功请求的响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9e5448c7-edaf-49aa-9887-0fcd0832306c', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordData', + 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', + 'description' => '记录内容参数错误，请根据接口文档调整参数内容。', + ], + [ + 'errorCode' => 'InvalidParameter.RecordType', + 'errorMessage' => 'Invalid record type. Adjust your configurations based on the API documentation.', + 'description' => '记录类型错误，请根据接口文档调整参数内容。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'QuotaExceed.RecordCount', + 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', + 'description' => '记录数量已达上限，请删除部分记录后重试或升级套餐。', + ], + [ + 'errorCode' => 'Record.Conflict', + 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'TransportLayerApplicationNotExist', + 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', + 'description' => '当前操作的四层加速应用不存在，请修改后重试。', + ], + [ + 'errorCode' => 'TransportLayerRulesExceedLimit', + 'errorMessage' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', + 'description' => '您配置的转发规则已经超过了最大限制，请删除无用的转发规则后进行重试。', + ], + [ + 'errorCode' => 'SourceCircleExist', + 'errorMessage' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.InvalidRecordName', + 'errorMessage' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', + 'description' => '您输入的记录名称不符合规范，请根据产品文档调整记录名称。', + ], + [ + 'errorCode' => 'EdgePortsOverlap', + 'errorMessage' => 'There is overlap between multiple edge ports, please check and try again after modification.', + 'description' => '多个边缘端口之间存在重叠，请检查后进行修改重试。', + ], + [ + 'errorCode' => 'InvalidParameter.ClientIpPassThroughMode', + 'errorMessage' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', + 'description' => '无效的客户端IP传递协议，请参考接口文档，传入合法的参数。', + ], + [ + 'errorCode' => 'InvalidParameter.RuleSource', + 'errorMessage' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', + 'description' => '转发规则的源站不存在或者不合法，请传入正确的源站后进行重试。', + ], + [ + 'errorCode' => 'InvalidParameter.Port', + 'errorMessage' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', + 'description' => '无效的边缘端口或者源站端口，请按照接口文档中的要求，传入合法的端口。', + ], + [ + 'errorCode' => 'InvalidParameter.Protocol', + 'errorMessage' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', + 'description' => '无效的端口协议，请按照接口文档的要求，传入合法的端口协议。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'errorCode' => 'IpaNotActive', + 'errorMessage' => 'The ipa application is not active.', + 'description' => '当前应用正在部署中。', + ], + [ + 'errorCode' => 'Record.NoResource', + 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', + 'description' => '为记录分配资源失败，请提工单处理。', + ], + [ + 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', + 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', + 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新四层加速应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateTransportLayerApplication', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9e5448c7-edaf-49aa-9887-0fcd0832306c\\"\\n}","type":"json"}]', + ], + 'UpdateUrlObservation' => [ + 'summary' => '更新网页监测配置。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264795', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListUrlObservations](~~ListUrlObservations~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'SdkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SDK集成方式。取值：'."\n" + ."\n" + .'- **automatic**：自动集成。'."\n" + .'- **manual**：手动集成。', + 'type' => 'string', + 'required' => true, + 'example' => 'manual', + 'enum' => [ + 'automatic', + 'manual', + ], + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ArgQuotaCheckFailed', + 'errorMessage' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'ConfExceedLimit', + 'errorMessage' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新网页监测配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateUrlObservation', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateUrlObservation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\"\\n}","type":"json"}]', + ], + 'UpdateUserDeliveryTask' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239266', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '任务名', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'FieldName', + 'in' => 'formData', + 'schema' => [ + 'description' => '选择字段,以\',\'分割。', + 'type' => 'string', + 'required' => true, + 'example' => 'ClientRequestID,ClientRequestHost', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'formData', + 'schema' => [ + 'description' => '实时日志类型，取值：'."\n" + ."\n" + .'- **dcdn_log_access_l1（默认值）**：访问日志。'."\n" + .'- **dcdn_log_er**：边缘函数日志。'."\n" + .'- **dcdn_log_waf**：安全防护日志。'."\n" + .'- **dcdn_log_ipa**：四层加速日志。', + 'type' => 'string', + 'required' => false, + 'example' => 'dcdn_log_er', + ], + ], + [ + 'name' => 'DiscardRate', + 'in' => 'formData', + 'schema' => [ + 'description' => '丢弃率不填则默认为0。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Details', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + [ + 'name' => 'FilterVer', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改用户任务投递配置', + 'summary' => '修改用户的任务投递配置，允许设置任务名、选择字段、指定实时日志类型和调整丢弃率。', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-24T01:43:11.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-12-26T08:21:56.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-10-18T01:07:11.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateUserDeliveryTask', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateUserDeliveryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', + ], + 'UpdateUserDeliveryTaskStatus' => [ + 'summary' => '上线和下线一个用户任务投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238917', + 'abilityTreeNodes' => [ + 'FEATUREdcdn9K10I1', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '业务类型字段', + 'description' => '任务名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'description' => '只允许修改Method，内容为\'online\' 或 \'offline\'。', + 'type' => 'string', + 'required' => true, + 'example' => 'online', + ], + ], + ], + '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' => '34DCBC8A-****-****-****-6DAA11D7DDBD', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'test_project', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'online', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal exception occurred, please try again later.', + 'description' => '触发内部异常，请稍后再试。', + ], + ], + 403 => [ + [ + 'errorCode' => 'EsaService.NotOpen', + 'errorMessage' => 'ESA service has not opend.', + 'description' => '边缘安全加速服务(ESA)未开通', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '上下线任务投递状态', + 'description' => '本接口允许用户根据任务名称（TaskName）及操作方法（Method）来上线或下线一个任务的数据投递功能。操作方法需明确指定为 "online"（上线）或 "offline"（下线）。响应将返回任务的最新状态及操作结果详情。', + 'changeSet' => [ + [ + 'createdAt' => '2024-10-18T01:07:11.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-27T05:57:02.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateUserDeliveryTaskStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateUserDeliveryTaskStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"TaskName\\": \\"test_project\\",\\n \\"Status\\": \\"online\\"\\n}","type":"json"}]', + ], + 'UpdateUserWafRuleset' => [ + 'summary' => '用于修改指定实例下的WAF规则集配置，包括位置、名称等信息。', + 'description' => '## 请求说明'."\n" + .'- 本接口允许用户对已有的WAF规则集进行更新操作，支持修改规则集的位置、名称、描述、状态以及表达式。'."\n" + .'- 只需传入需要修改的参数字段；如果某个参数不需要修改，则不必传递对应的参数key。'."\n" + .'- 注意：确保在调用此API前已经获取了正确的`InstanceId`和`Id`值，否则可能导致请求失败。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + 'FEATUREdcdnBQ0J3E', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'esa-xxxxxxx', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000001', + ], + ], + [ + 'name' => 'Position', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集位置。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Expression', + 'in' => 'formData', + 'schema' => [ + 'description' => 'WAF规则集表达式。', + 'type' => 'string', + 'required' => false, + 'example' => 'ip.src == 1.1.1.1', + ], + ], + [ + 'name' => 'Shared', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'WAF规则集共享配置。', + 'required' => false, + '$ref' => '#/components/schemas/WafBatchRuleShared', + ], + ], + [ + 'name' => 'Rules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'WAF规则集下的规则配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'WAF规则集下的规则配置。', + 'required' => false, + '$ref' => '#/components/schemas/WafRuleConfig', + ], + 'required' => false, + 'example' => '['."\n" + .' {'."\n" + .' "Id": 20000001,'."\n" + .' "Name": "rule1",'."\n" + .' "Expression": "ip.src eq 1.1.1.1",'."\n" + .' "Action": "deny"'."\n" + .' }'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Rule.Config.Noncompliance', + 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', + 'description' => '指定的规则配置未满足既定的合规性标准。请检查规则设置，查找任何不符合或违反预期标准的差异，并进行必要的调整，以确保所有规则均得到正确验证。', + ], + [ + 'errorCode' => 'Rule.Config.Malformed', + 'errorMessage' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', + 'description' => '指定的规则配置格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致，并予以纠正，以符合预期的配置架构。', + ], + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Ruleset.NotExist', + 'errorMessage' => 'The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system\'s rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect.', + 'description' => '指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确，并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体，请确保其创建和注册的必要步骤已经成功执行，以便其可用。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx-xxxx-xxxx\\"\\n}","type":"json"}]', + 'title' => '更新用户WAF规则集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateUserWafRuleset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'UpdateVideoProcessing' => [ + 'summary' => '修改站点视频处理配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257664', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。可通过调用[ListVideoProcessings](~~ListVideoProcessings~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '35281609698****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule_example', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => false, + 'example' => '(http.host eq "video.example.com")', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '规则执行顺序，数值越小越优先执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VideoSeekEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '拖拽播放功能开关。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'FlvVideoSeekMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'FLV拖拽模式。取值范围：'."\n" + .'- by_byte：按字节拖拽。'."\n" + .'- by_time：按时间拖拽。', + 'type' => 'string', + 'required' => false, + 'example' => 'by_byte', + ], + ], + [ + 'name' => 'Mp4SeekStart', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义mp4开始参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'start', + ], + ], + [ + 'name' => 'Mp4SeekEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义mp4结束参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'end', + ], + ], + [ + 'name' => 'FlvSeekStart', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义FLV开始参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'start', + ], + ], + [ + 'name' => 'FlvSeekEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义FLV结束参数 。', + 'type' => 'string', + 'required' => false, + 'example' => 'end', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3558df77-8a7a-4060-a900-2d7949403836', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApplyVipError', + 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'errorCode' => 'CanNotSetSequence', + 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'errorCode' => 'CacheReserveSiteExceedLimit', + 'errorMessage' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'errorCode' => 'VersionNotValid', + 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InvalidParameter.Configs', + 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionName', + 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'IllegalOperation.VersionManagement', + 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.VersionManagement', + 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'CachceReserveInstanceCheckFalied', + 'errorMessage' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改站点视频处理配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateVideoProcessing', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3558df77-8a7a-4060-a900-2d7949403836\\"\\n}","type":"json"}]', + ], + 'UpdateWafRule' => [ + 'summary' => '该接口用于更新Web应用防火墙（WAF）中的单个规则。通过此接口，用户可以修改特定规则的配置和状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239582', + 'abilityTreeNodes' => [ + 'FEATUREdcdnV3YEJ8', + 'FEATUREdcdnUTRW1O', + 'FEATUREdcdnSU2QP6', + 'FEATUREdcdnV3G3FZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '规则ID', + 'description' => 'WAF规则的ID，可通过调用[ListWafRules](~~2878257~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20000001', + ], + ], + [ + 'name' => 'Position', + 'in' => 'formData', + 'schema' => [ + 'title' => '规则在规则集中的位置顺序', + 'description' => '规则在规则集中的位置顺序。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '规则状态', + 'description' => '规则状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '规则配置', + 'description' => '规则配置。', + 'required' => false, + '$ref' => '#/components/schemas/WafRuleConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Id' => [ + 'description' => 'WAF规则的ID，可通过调用[ListWafRules](~~2878257~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'Rule.NotExist', + 'errorMessage' => 'The specified rule does not exist.', + 'description' => '指定的规则在当前上下文或系统配置中不存在。请确认规则标识符的存在，并确保它已被正确定义或实现。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Rule.Config.Malformed', + 'errorMessage' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', + 'description' => '指定的规则配置格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致，并予以纠正，以符合预期的配置架构。', + ], + [ + 'errorCode' => 'Rule.Config.Noncompliance', + 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', + 'description' => '指定的规则配置未满足既定的合规性标准。请检查规则设置，查找任何不符合或违反预期标准的差异，并进行必要的调整，以确保所有规则均得到正确验证。', + ], + [ + 'errorCode' => 'Rule.Position.Invalid', + 'errorMessage' => 'The specified position for the rule is invalid.Check and adjust the configuration to make sure it meets the requirements.', + 'description' => '指定的规则位置无效或超出了可接受范围。请核实规则位置参数，并作出适当更正，以确保符合既定边界或序列要求。', + ], + [ + 'errorCode' => 'Rule.Name.AlreadyExists', + 'errorMessage' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', + 'description' => '指定的规则名称在系统配置中已存在，不能重复使用。请选择一个不与现有规则名称冲突的独特规则名称，或在必要时考虑更改现有规则的名称，以消除任何可能的歧义，并确保每个规则标识符的唯一性。', + ], + [ + 'errorCode' => 'Expression.Invalid', + 'errorMessage' => 'The specified expression is invalid: %s.', + 'description' => '指定的表达式是无效的。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新WAF规则', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:49.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:33.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWafRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWafRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 20000001\\n}","type":"json"}]', + ], + 'UpdateWafRuleset' => [ + 'summary' => '根据WAF规则集的ID更新WAF规则集。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239645', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBQ0J3E', + 'FEATUREdcdn1OLUH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'title' => '站点ID', + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '站点版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '规则集ID', + 'description' => 'WAF规则集的ID，可通过调用[ListWafRulesets](~~2878359~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000001', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '规则集状态', + 'description' => '要更改的规则集的目标状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'SpecifiedVersionReadOnly', + 'errorMessage' => 'The specified version number is read-only and cannot be modified.', + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + ], + 403 => [ + [ + 'errorCode' => '%s.NotSupport', + 'errorMessage' => 'The specified resource type %s is not supported.', + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'errorCode' => '%s.OverQuota', + 'errorMessage' => 'The quantity of %s exceeds the quota.', + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'errorCode' => '%s.WrongValueMatched', + 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'errorCode' => 'Ruleset.NotExist', + 'errorMessage' => 'The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system\'s rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect.', + 'description' => '指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确，并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体，请确保其创建和注册的必要步骤已经成功执行，以便其可用。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新WAF规则集', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-25T07:02:49.000Z', + 'description' => '错误码发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:38.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWafRuleset', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWafRuleset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + ], + 'UpdateWaitingRoom' => [ + 'summary' => '更新指定等候室的配置信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239629', + 'abilityTreeNodes' => [ + 'FEATUREdcdnO4KC7Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '7096621098****', + ], + ], + [ + 'name' => 'WaitingRoomId', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室ID，可通过调用[ListWaitingRooms](~~2850279~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '6a51d5bc6460887abd129****', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室启用状态。取值：'."\n" + ."\n" + .' - **on**: 启用等候室'."\n" + .' - **off**: 禁用等候室', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室的名称。', + 'type' => 'string', + 'required' => false, + 'example' => '节假日促销等候室', + ], + ], + [ + 'name' => 'QueueAllEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '全部排队。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'HostNameAndPath', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '主机名和路径。', + 'type' => 'array', + 'items' => [ + 'description' => '主机名和路径详情。', + 'type' => 'object', + 'properties' => [ + 'Subdomain' => [ + 'description' => '子域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.', + ], + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com'."\n", + ], + 'Path' => [ + 'description' => '路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/test'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'CookieName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义Cookie名称。', + 'type' => 'string', + 'required' => false, + 'example' => '__aliwaitingroom_example'."\n", + ], + ], + [ + 'name' => 'TotalActiveUsers', + 'in' => 'query', + 'schema' => [ + 'description' => '活跃用户总数。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'NewUsersPerMinute', + 'in' => 'query', + 'schema' => [ + 'description' => '每分钟新用户数。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'SessionDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '用户会话持续时间（分钟）。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'DisableSessionRenewalEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '禁用会话续订。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'QueuingMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '排队方式。取值：'."\n" + ."\n" + .'- **random**：随机。'."\n" + .'- **fifo**：先进先出。'."\n" + .'- **passthrough**：直通。'."\n" + .'- **reject-all**：拒绝全部。', + 'type' => 'string', + 'required' => false, + 'example' => 'random', + 'enum' => [ + 'fifo', + 'random', + 'passthrough', + 'reject-all', + ], + ], + ], + [ + 'name' => 'QueuingStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室状态码。取值：'."\n" + ."\n" + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**', + 'type' => 'string', + 'required' => false, + 'example' => '200', + 'enum' => [ + '200', + '202', + '429', + ], + ], + ], + [ + 'name' => 'JsonResponseEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'JSON响应。开启后accept请求头包含"application/json"会返回JSON数据。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '等候室描述。', + 'type' => 'string', + 'required' => false, + 'example' => '特别活动排队页面', + ], + ], + [ + 'name' => 'WaitingRoomType', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室类型。支持以下类型：'."\n" + ."\n" + .'- **default**：默认类型。'."\n" + .'- **custom**：自定义类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'enum' => [ + 'default', + 'custom', + ], + ], + ], + [ + 'name' => 'CustomPageHtml', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '用户自定义等候室页面内容，当等候室类型为自定义类型时，需要传入。传入的内容需要经过base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'SGVsbG8gd29ybGQ=', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '等候室页面的语言，当等候室类型为默认类型时，需要传入。支持以下类型：'."\n" + ."\n" + .'- **enus**：英文。'."\n" + .'- **zhcn**：中文简体。'."\n" + .'- **zhhk**：中文繁体。', + 'type' => 'string', + 'required' => false, + 'example' => 'zhcn', + 'enum' => [ + 'enus', + 'zhcn', + 'zhhk', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的唯一标识符。', + 'type' => 'string', + 'example' => '0195619f-eab3-4a66-ac00-ed53d913e72e', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'WaitingRoomNotExist', + 'errorMessage' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.', + 'description' => '您要修改的等候室不存在或不属于您，请确认后重试。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '更新等候室', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:13:38.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWaitingRoom', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWaitingRoom', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0195619f-eab3-4a66-ac00-ed53d913e72e\\"\\n}","type":"json"}]', + ], + 'UpdateWaitingRoomEvent' => [ + 'summary' => '更新等候室事件的相关配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239617', + 'abilityTreeNodes' => [ + 'FEATUREdcdnVCBH9N', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****'."\n", + ], + ], + [ + 'name' => 'WaitingRoomEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室事件ID，可通过调用[ListWaitingRoomEvents](~~2850279~~)接口获取', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '89677721098****', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '启用状态。取值：'."\n" + ."\n" + .' - **on**: 启用等候室事件'."\n" + ."\n" + .' - **off**: 禁用等候室事件', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '等待室的事件名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试事件2', + ], + ], + [ + 'name' => 'TotalActiveUsers', + 'in' => 'query', + 'schema' => [ + 'description' => '活跃用户总数。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'NewUsersPerMinute', + 'in' => 'query', + 'schema' => [ + 'description' => '每分钟新用户数。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'SessionDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '用户会话持续时间（分钟）。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'DisableSessionRenewalEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '禁用会话续订。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'QueuingMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '排队方式。取值：'."\n" + ."\n" + .'- **random**：随机。'."\n" + .'- **fifo**：先进先出。'."\n" + .'- **passthrough**：直通。'."\n" + .'- **reject-all**：拒绝全部。', + 'type' => 'string', + 'required' => false, + 'example' => 'fifo', + 'enum' => [ + 'fifo', + 'random', + 'passthrough', + 'reject-all', + ], + ], + ], + [ + 'name' => 'QueuingStatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室状态码。取值：'."\n" + ."\n" + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**', + 'type' => 'string', + 'required' => false, + 'example' => '200', + 'enum' => [ + '200', + '202', + '429', + ], + ], + ], + [ + 'name' => 'JsonResponseEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'JSON响应开关。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '等候室描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://yywyyw.com', + ], + ], + [ + 'name' => 'WaitingRoomType', + 'in' => 'query', + 'schema' => [ + 'description' => '等候室类型。支持以下类型：'."\n" + ."\n" + .'- **default**：默认类型。'."\n" + .'- **custom**：自定义类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + 'enum' => [ + 'default', + 'custom', + ], + ], + ], + [ + 'name' => 'CustomPageHtml', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '用户自定义等候室页面内容，当等候室类型为自定义类型时，需要传入。传入的内容需要经过base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'SGVsbG8gd29ybGQ=', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '事件开始时间的时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '1719763200', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '事件结束时间的时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '1719849600', + ], + ], + [ + 'name' => 'PreQueueEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '预排队开关。'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'PreQueueStartTime', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '预排队开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '1719763200', + ], + ], + [ + 'name' => 'RandomPreQueueEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '随机排队开关。'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '默认语言设置。取值包括：'."\n" + ."\n" + .' - **enus**: 英文。'."\n" + .'- **zhcn**: 中文简体。'."\n" + .'- **zhhk**: 中文繁体。', + 'type' => 'string', + 'required' => false, + 'example' => 'enus', + 'enum' => [ + 'enus', + 'zhcn', + 'zhhk', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应成功时返回的信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求唯一标识。', + 'type' => 'string', + 'example' => '0195619f-eab3-4a66-ac00-ed53d913e72e', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'description' => '传入的ConfigId不存在。', + ], + [ + 'errorCode' => 'WaitingRoomEventNotExist', + 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', + 'description' => '您要修改的等候室事件不存在，请检查并传入正确的等候室事件。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新等候室事件', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-21T03:40:42.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:39.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWaitingRoomEvent', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWaitingRoomEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0195619f-eab3-4a66-ac00-ed53d913e72e\\"\\n}","type":"json"}]', + ], + 'UpdateWaitingRoomRule' => [ + 'summary' => '更新指定站点的等候室绕过规则配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239642', + 'abilityTreeNodes' => [ + 'FEATUREdcdnA885EB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456****', + ], + ], + [ + 'name' => 'WaitingRoomRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '要更新的等候室绕过规则ID，可通过调用[ListWaitingRoomRules](~~2850279~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8987739839****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。添加全局配置的时候不需要设置该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'RuleEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '规则开关。添加全局配置的时候不需要设置该参数。取值范围：'."\n" + .'- on：开启。'."\n" + .'- off：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'Rule', + 'in' => 'query', + 'schema' => [ + 'description' => '规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：'."\n" + .'- 匹配所有传入请求：值设置为true'."\n" + .'- 匹配指定请求：值设置为自定义表达式，例如：(http.host eq \\"video.example.com\\")', + 'type' => 'string', + 'required' => true, + 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应成功时返回的信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，用于追踪请求处理进度。', + 'type' => 'string', + 'example' => '9bfe9d95-7bf6-469d-a628-ed7bc9f25073', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CompileRuleError', + 'errorMessage' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'errorCode' => 'SiteConfigLengthExceedLimit', + 'errorMessage' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'errorCode' => 'RuleRegexQuotaCheckFailed', + 'errorMessage' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'NestedRuleQuotaCheckFailed', + 'errorMessage' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'FunctionConflict', + 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgName', + 'errorMessage' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'errorCode' => 'InvalidParameter.ArgValue', + 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'errorCode' => 'InstanceNotExist', + 'errorMessage' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'errorCode' => 'LockFailed', + 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'errorCode' => 'WaitingRoomRuleNotExist', + 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', + 'description' => '您要修改的等候室绕过规则不存在，请检查并传入正确的等候室绕过规则。', + ], + [ + 'errorCode' => 'FunctionQuotaCheckFailed', + 'errorMessage' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.FunctionArg', + 'errorMessage' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgName is required for this function.', + 'description' => '配置特定功能时，缺少必传参数。', + ], + ], + 404 => [ + [ + 'errorCode' => 'SiteNotFound', + 'errorMessage' => 'The website does not exist or does not belong to you.', + 'description' => '站点不存在，或者不属于你。', + ], + ], + ], + 'title' => '修改等候室绕过规则', + 'description' => '通过此接口可以修改站点中特定等待室的规则设置，包括规则名称、启用状态及规则内容等。', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-21T03:40:42.000Z', + 'description' => '请求参数发生变更', + ], + [ + 'createdAt' => '2024-09-18T06:13:39.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWaitingRoomRule', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWaitingRoomRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9bfe9d95-7bf6-469d-a628-ed7bc9f25073\\"\\n}","type":"json"}]', + ], + 'UploadClientCaCertificate' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239190', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN CERTIFICATE-----', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourCertName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'baba39055622c008b90285a8838ed09a', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-12-01T02:13:07Z', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-12-01T02:13:07Z', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'ValidityDays' => [ + 'description' => '证书有效天数。', + 'type' => 'string', + 'example' => '300', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '上传客户端CA证书', + 'summary' => '上传客户端CA证书。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadClientCaCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadClientCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"Status\\": \\"OK\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"NotBefore\\": \\"2023-12-01T02:13:07Z\\",\\n \\"NotAfter\\": \\"2024-12-01T02:13:07Z\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SerialNumber\\": \\"babab9db65ee5efcca9f3d41d4b50d66\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"ValidityDays\\": \\"300\\"\\n}","type":"json"}]', + ], + 'UploadFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239245', + 'abilityTreeNodes' => [ + 'FEATUREdcdnBCJPGN', + 'FEATUREdcdnRELTJV', + 'FEATUREdcdnEWYS3A', + 'FEATUREdcdn4TTNAL', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储刷新或者预热文件的URL。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://xxxxx.oss-cn-shenzhen.aliyuncs.com/test_oss_file?Expires=1708659191&OSSAccessKeyId=**********&Signature=**********', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '刷新/预热任务类型，取值：'."\n" + .'- **file**（默认值）：文件刷新。'."\n" + .'- **preload**：文件预热。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **ignoreParams**：去参数刷新。', + 'type' => 'string', + 'required' => true, + 'example' => 'file', + 'enum' => [ + 'file', + 'preload', + 'directory', + 'ignoreparams', + ], + ], + ], + [ + 'name' => 'UploadTaskName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '上传任务名。', + 'type' => 'string', + 'required' => true, + 'example' => 'purge_task_2024_11_11', + 'maxLength' => 128, + ], + ], + ], + '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' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', + ], + 'UploadId' => [ + 'description' => '文件上传任务ID，后续可通过此ID提交、查询任务。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '159253299357****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'description' => '请填写ObjectType参数。', + ], + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The specified parameters are invalid.', + 'description' => '参数非法。', + ], + [ + 'errorCode' => 'ExceedFileUpload', + 'errorMessage' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.', + 'description' => '您上传的文件大小超出了限制，请选择小于10MB的文件重新进行上传。', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests.Please try again later.', + 'description' => '请求过于频繁，请稍后重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '上传刷新或者预热文件', + 'summary' => '上传刷新或预热文件以提高访问速度。', + 'description' => '> '."\n" + .'> - 文件大小最大10MB。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadFile', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadFile', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"UploadId\\": 0\\n}","type":"json"}]', + ], + 'UploadOriginCaCertificate' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261740', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'formData', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~ListSites~~)接口查询获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890***', + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN CERTIFICATE-----', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com ', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-12-01T02:13:07Z', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-12-01T02:13:07Z', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1daa', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'ValidityDays' => [ + 'description' => '证书有效天数。', + 'type' => 'string', + 'example' => '365', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '上传源服务器CA证书', + 'summary' => '上传源服务器CA证书。', + 'description' => '源地址下可以添加多个源站，支持域名、IP、OSS、S3等类型的源站，支持OSS和S3类型源站的回源鉴权。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadOriginCaCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadOriginCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Status\\": \\"OK\\",\\n \\"CommonName\\": \\"www.example.com \\",\\n \\"NotBefore\\": \\"2023-12-01T02:13:07Z\\",\\n \\"NotAfter\\": \\"2024-12-01T02:13:07Z\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1daa\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"ValidityDays\\": \\"365\\"\\n}","type":"json"}]', + ], + 'UploadOriginClientCertificate' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261751', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID，可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN CERTIFICATE-----', + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书私钥。', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN PRIVATE KEY-----', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-12-01T02:13:07Z', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-12-01T02:13:07Z', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1daa', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'ValidityDays' => [ + 'description' => '证书有效天数。', + 'type' => 'string', + 'example' => '365', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'CertificateNotMatchPrivateKey', + 'errorMessage' => 'The specified certificate does not match the private key.', + 'description' => '指定的证书和私钥不匹配。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'title' => '上传域名粒度回源客户端证书', + 'summary' => '上传域名粒度回源客户端证书。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadOriginClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Status\\": \\"OK\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"NotBefore\\": \\"2023-12-01T02:13:07Z\\",\\n \\"NotAfter\\": \\"2024-12-01T02:13:07Z\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1daa\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"ValidityDays\\": \\"365\\"\\n}","type":"json"}]', + ], + 'UploadSiteOriginClientCertificate' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261744', + 'abilityTreeNodes' => [ + 'FEATUREdcdnX7NWEB', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456789****', + ], + ], + [ + 'name' => 'Certificate', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN CERTIFICATE-----', + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书私钥。', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN PRIVATE KEY-----', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'Id' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'babaabcd****', + ], + 'Status' => [ + 'description' => '证书状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'NotBefore' => [ + 'description' => '证书有效期开始时间。', + 'type' => 'string', + 'example' => '2023-12-01T02:13:07Z', + ], + 'NotAfter' => [ + 'description' => '证书有效期截止时间。', + 'type' => 'string', + 'example' => '2024-12-01T02:12:49Z', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'GlobalSign nv-sa', + ], + 'SerialNumber' => [ + 'description' => '证书序列号。', + 'type' => 'string', + 'example' => 'babaded901474b9693acf530e0fb1d**', + ], + 'FingerprintSha256' => [ + 'description' => '证书Sha256指纹。', + 'type' => 'string', + 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca**', + ], + 'SignatureAlgorithm' => [ + 'description' => '证书签名算法。', + 'type' => 'string', + 'example' => 'SHA256-RSA', + ], + 'ValidityDays' => [ + 'description' => '证书有效天数。', + 'type' => 'string', + 'example' => '365', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + 'description' => '证书状态错误。', + ], + [ + 'errorCode' => 'InvalidParameter.SiteId', + 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'errorCode' => 'MissingSiteId', + 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'errorCode' => 'QuotaCheckFailed.Function', + 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'CertificateNotMatchPrivateKey', + 'errorMessage' => 'The specified certificate does not match the private key.', + 'description' => '指定的证书和私钥不匹配。', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized.InvalidTime', + 'errorMessage' => 'The specified authentication time is invalid.', + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'errorCode' => 'Unauthorized.InvalidToken', + 'errorMessage' => 'Token authentication failed.', + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + ], + ], + 'title' => '上传站点粒度回源客户端证书', + 'summary' => '上传站点粒度回源客户端证书。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadSiteOriginClientCertificate', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadSiteOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Status\\": \\"OK\\",\\n \\"CommonName\\": \\"www.example.com\\",\\n \\"NotBefore\\": \\"2023-12-01T02:13:07Z\\",\\n \\"NotAfter\\": \\"2024-12-01T02:12:49Z\\",\\n \\"Issuer\\": \\"GlobalSign nv-sa\\",\\n \\"SerialNumber\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca**\\",\\n \\"SignatureAlgorithm\\": \\"SHA256-RSA\\",\\n \\"ValidityDays\\": \\"365\\"\\n}","type":"json"}]', + ], + 'VerifyCustomHostname' => [ + 'summary' => '校验 SaaS 域名归属，通过校验的站点将自动被激活。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239650', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4DMKZ4', + ], + ], + 'parameters' => [ + [ + 'name' => 'HostnameId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '自定义主机名ID。', + 'description' => 'SaaS 域名的 ID，可通过调用[ListCustomHostnames](~~3018667~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'Passed' => [ + 'title' => '验证是否通过。', + 'description' => '校验是否通过。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'CustomHostname.VerifyUnpassed', + 'errorMessage' => 'The custom hostname ownership verification failed. Complete the verification and try again.', + 'description' => '自定义主机名归属校验未通过，请您确保自定义主机名归属权校验通过后重试。', + ], + ], + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + 'description' => '输入参数规范校验失败。', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'errorCode' => 'Instance.NotOnline', + 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'errorCode' => 'Record.ServiceBusy', + 'errorMessage' => 'The record is being configured. Try again later.', + 'description' => '该记录正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'CustomHostname.InvalidICP', + 'errorMessage' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'description' => '您配置的自定义主机名未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + [ + 'errorCode' => 'CustomHostname.ConflictWithExistingResource', + 'errorMessage' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.', + 'description' => '自定义主机名和已有资源冲突，例如站点、记录、负载均衡器、源地址池、自定义主机名和四层代理等', + ], + ], + 404 => [ + [ + 'errorCode' => 'CustomHostname.NotFound', + 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', + 'description' => '该自定义主机名不存在，请调整后重试。', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '校验 SaaS 域名归属', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Passed\\": true\\n}","type":"json"}]', + ], + 'VerifySite' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239614', + 'abilityTreeNodes' => [ + 'FEATUREdcdn4W8FYZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点ID。可通过调用[ListSites](~~2850189~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567890123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', + ], + 'Passed' => [ + 'description' => '校验是否通过。取值：'."\n" + ."\n" + .'- **true**：校验通过。'."\n" + .'- **false**：校验失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'errorCode' => 'Site.ServiceBusy', + 'errorMessage' => 'This website is being configured. Try again later.', + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'errorCode' => 'Site.Conflict', + 'errorMessage' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', + 'description' => '站点冲突，多个账户下存在相同名称的站点，请删除或更名后重试。', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '校验站点归属', + 'summary' => '校验站点归属，通过校验的站点将自动被激活。', + 'description' => '1. 对于NS接入的站点，校验站点当前的NS服务器是否为阿里云分配的NS。'."\n" + .'2. 对于CNAME接入的站点，校验站点是否配置了名称为_esaauth.[站点名称]，内容为站点校验码（见站点信息中的VerifyCode字段）的TXT记录。', + 'changeSet' => [ + [ + 'createdAt' => '2024-09-18T06:13:38.000Z', + 'description' => '错误码发生变更', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'VerifySite', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:VerifySite', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\",\\n \\"Passed\\": true\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'regionName' => '新加坡', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'esa.ap-southeast-1.aliyuncs.com', + 'endpoint' => 'esa.ap-southeast-1.aliyuncs.com', + 'vpc' => 'esa-vpc.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'regionName' => '华东1（杭州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'esa.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'esa.cn-hangzhou.aliyuncs.com', + 'vpc' => 'esa-vpc.cn-hangzhou.aliyuncs.com', + ], + ], + 'errorCodes' => [ + [ + 'code' => '%s.NotSupport', + 'message' => 'The specified resource type %s is not supported.', + 'http_code' => 403, + 'description' => '不支持指定的资源类型。如需使用该类型资源，请与我们联系。', + ], + [ + 'code' => '%s.OverQuota', + 'message' => 'The quantity of %s exceeds the quota.', + 'http_code' => 403, + 'description' => '该资源的数量超出了配额所规定的范围，如需申请更多的额度，请与我们联系。', + ], + [ + 'code' => '%s.WrongValueMatched', + 'message' => 'The value of specified parameter %s can not pass the matching check.', + 'http_code' => 403, + 'description' => '指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值，请与我们联系。', + ], + [ + 'code' => 'AccountBlacklist', + 'message' => 'Account blacklist restrictions, please submit a work order to contact customer service for processing.', + 'http_code' => 400, + 'description' => '账号黑名单限制，请提交工单联系客服处理。', + ], + [ + 'code' => 'AccountStatusIllegal', + 'message' => 'The account status is illegal.', + 'http_code' => 400, + 'description' => '账号状态不合法。', + ], + [ + 'code' => 'ActiveSiteNotExist', + 'message' => 'Failed to match an active website based on the hostname you specified. Check whether the hostname is correct or activate the website first.', + 'http_code' => 400, + 'description' => '您尝试绑定的记录名未找到对应的已激活站点，请检查记录名或先激活相关站点。', + ], + [ + 'code' => 'AppAlreadyExist', + 'message' => 'The containerized application name already exists. Specify another name.', + 'http_code' => 400, + 'description' => '容器应用名称已存在，请重新设置名称。', + ], + [ + 'code' => 'ApplyCertificateNotAllowed', + 'message' => 'The certificate application is not allowed for current site.', + 'http_code' => 400, + 'description' => '当前站点不允许申请免费证书，请确保站点已激活。对于申请泛域名证书，请确保当前站点是以NS方式接入。', + ], + [ + 'code' => 'ApplyVanityNSError', + 'message' => 'Failed to apply for vanity NS resources. Please contact customer service.', + 'http_code' => 400, + 'description' => '申请自定义NS资源失败，请联系客服处理。', + ], + [ + 'code' => 'ApplyVipError', + 'message' => 'Failed to apply for ip resources, please contact customer service.', + 'http_code' => 400, + 'description' => '申请IP资源失败，请联系客服。', + ], + [ + 'code' => 'ArgQuotaCheckFailed', + 'message' => 'The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.', + 'http_code' => 400, + 'description' => '当前套餐不支持配置受限参数，请检查输入的参数。', + ], + [ + 'code' => 'BASIC_INFO_UNCOMPLETED', + 'message' => 'You have not completed your personal basic information. Please complete the information and try again.', + 'http_code' => 400, + 'description' => '您未完善个人基本信息，请完善信息后重新操作。（如果当前账号为托管子账号，请联系主账号点击此链接完善信息。） 去完善 ', + ], + [ + 'code' => 'BillingMode.NotChanged', + 'message' => 'Failed to change the plan because the new plan you specified is the same as the current one in use. Specify a correct plan and try again.', + 'http_code' => 400, + 'description' => '当前产品的计费模式与您请求的计费模式相同，请检查并传入正确的计费模式参数。', + ], + [ + 'code' => 'BillingMode.Overdue', + 'message' => 'Failed to change the plan because you have overdue payments.Top up your account and try again.', + 'http_code' => 400, + 'description' => '欠费状态下，不允许修改其计费类型。请您保持账户费用大于0后重试。', + ], + [ + 'code' => 'BillingMode.OverLimit', + 'message' => 'Failed to change the plan. You are only allowed to change your plan once within 24 hours.', + 'http_code' => 400, + 'description' => '24小时内最多允许修改计费类型一次。', + ], + [ + 'code' => 'BuyWithSiteAmountErr', + 'message' => 'Site-based purchase plans do not support bulk purchasing.', + 'http_code' => 400, + 'description' => '带站点购买套餐不支持批量购买。', + ], + [ + 'code' => 'CachceReserveInstanceCheckFalied', + 'message' => 'If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.', + 'http_code' => 400, + 'description' => '站点使用了回源白名单节点，而缓存保持实例不在回源白名单中的情况下，无法为站点关联缓存保持实例。如果您希望同时使用两个功能，请联系客服咨询详情。', + ], + [ + 'code' => 'CacheReserveSiteExceedLimit', + 'message' => 'The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.', + 'http_code' => 400, + 'description' => '缓存保持实例绑定的站点数量超过上限。', + ], + [ + 'code' => 'CanNotSetSequence', + 'message' => 'Non-regular configuration, you cannot set Sequence parameters.', + 'http_code' => 400, + 'description' => '全局配置中不允许设置Sequence参数。', + ], + [ + 'code' => 'Captcha.Configuration.AlreadyExists', + 'message' => 'The specified captcha configuration already exists in the system.', + 'http_code' => 403, + 'description' => '指定的验证码配置规则（Method + URI）在系统中已存在，不能重复使用。请提供一个不与现有配置规则冲突的独特组合，或修改现有的配置规则以消除可能的冲突，确保每个验证码配置规则的唯一性。', + ], + [ + 'code' => 'Captcha.NotExist', + 'message' => 'The specified captcha rule does not exist.', + 'http_code' => 404, + 'description' => '请求的验证码规则不存在，请确认规则ID是否正确。', + ], + [ + 'code' => 'CasId.MissingParameter', + 'message' => 'The CasId parameter is required.', + 'http_code' => 400, + 'description' => 'CasId参数缺失。', + ], + [ + 'code' => 'CertId.MissingParameter', + 'message' => 'The parameter CertId is required.', + 'http_code' => 400, + 'description' => '缺少必填参数CertId。', + ], + [ + 'code' => 'Certificate.Duplicated', + 'message' => 'The certificate name already exists.', + 'http_code' => 400, + 'description' => '证书重复。', + ], + [ + 'code' => 'Certificate.MissingParameter', + 'message' => 'The Certificate parameter is required.', + 'http_code' => 400, + 'description' => 'Certificate参数缺失。', + ], + [ + 'code' => 'Certificate.NotFound', + 'message' => 'The specified certificate does not exist.', + 'http_code' => 404, + 'description' => '指定的证书不存在。', + ], + [ + 'code' => 'Certificate.StatusError', + 'message' => 'The status of the certificate is invalid.', + 'http_code' => 400, + 'description' => '证书状态错误。', + ], + [ + 'code' => 'CertificateDomainNotMatchSite', + 'message' => 'The domain name in the specified certificate does not match the site.', + 'http_code' => 400, + 'description' => '证书中的域名和当前站点不匹配。', + ], + [ + 'code' => 'CertificateNotMatchPrivateKey', + 'message' => 'The specified certificate does not match the private key.', + 'http_code' => 400, + 'description' => '指定的证书和私钥不匹配。', + ], + [ + 'code' => 'CertList.NotFound', + 'message' => 'The specified CertList does not exist.', + 'http_code' => 400, + 'description' => '查询的证书列表不存在。', + ], + [ + 'code' => 'CertQuotaCheckFailed', + 'message' => 'The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.', + 'http_code' => 400, + 'description' => '自定义证书配额校验失败，上传证书数量超过套餐允许上限。', + ], + [ + 'code' => 'CheckCertificateQuotaFailed', + 'message' => 'Failed to query the quota of free certificates. Try again later.', + 'http_code' => 400, + 'description' => '获取免费证书配额失败，请稍后重试。', + ], + [ + 'code' => 'CheckCertificateQuotaFailed', + 'message' => 'Failed to query the number of used free certificates. Try again later.', + 'http_code' => 400, + 'description' => '获取免费类型证书用量失败，请稍后重试。', + ], + [ + 'code' => 'CheckOrderFailed', + 'message' => 'Invalid order parameter.', + 'http_code' => 400, + 'description' => '订单参数不合法。', + ], + [ + 'code' => 'CheckPlanFailed', + 'message' => 'Invalid plan name or code. Check and try again.', + 'http_code' => 400, + 'description' => '您配置的套餐名或套餐Code不正确，请确保已传入正确的套餐名或套餐Code后重试。', + ], + [ + 'code' => 'ClientCertificate.OverLimit', + 'message' => 'You are allowed to create 20 client certificates at most under current site.', + 'http_code' => 400, + 'description' => '当前站点下最多创建20张客户端证书。', + ], + [ + 'code' => 'CloudUserCannotBuyNotInnerCommodity', + 'message' => 'No group cloud product label, can not be purchased.', + 'http_code' => 400, + 'description' => '无集团上云商品标签，无法购买。', + ], + [ + 'code' => 'CodeVersionInUse', + 'message' => 'Failed to delete the code version because it is being used. Before you delete it, roll back to the previous version.', + 'http_code' => 400, + 'description' => '代码版本正在使用中，无法直接删除，请先将此版本回滚到上一版本，然后再尝试删除操作。', + ], + [ + 'code' => 'CodeVersionNumberExceedQuotaLimit', + 'message' => 'The maximum number of code versions in your plan has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'http_code' => 400, + 'description' => '您的代码版本数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多的代码版本配额数量。', + ], + [ + 'code' => 'CompileRuleError', + 'message' => 'Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.', + 'http_code' => 400, + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'code' => 'ConfExceedLimit', + 'message' => 'The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.', + 'http_code' => 400, + 'description' => '当前功能的配置项数量已经超过系统设定的上限。', + ], + [ + 'code' => 'ConfigConflicts', + 'message' => 'Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.', + 'http_code' => 400, + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'code' => 'ContainForbiddenLabelError', + 'message' => 'Placing an order is blocked due to an applied restriction label.', + 'http_code' => 400, + 'description' => '存在禁止下单的标签，不可下单。', + ], + [ + 'code' => 'CreateESASlsProjectFailed', + 'message' => 'Failed to create the task that delivers real-time logs to SLS. Check your configurations and try again.', + 'http_code' => 403, + 'description' => '创建实时日志SLS投递任务失败，请检查配置后重试。', + ], + [ + 'code' => 'CreateFunctionFailed', + 'message' => 'The configuration of the new site function failed. Please check the CreateSiteFunction interface document and check the parameters.', + 'http_code' => 400, + 'description' => '新增站点功能配置失败，请查看CreateSiteFunction接口文档，检查传参。', + ], + [ + 'code' => 'CreateRealTimeLogSlrError', + 'message' => 'You do not have permissions to create a service-linked role.Contact your account administrator to attach the AliyunServiceRoleForESARealtimeLogPushSLS policy or a custom policy that grants permissions to create a service-linked role to the current user.Service: <"/><"/>esarealtimelogpushsls.dcdnservices.aliyuncs.com<"/><"/>.', + 'http_code' => 400, + 'description' => '您没有权限创建服务关联角色。请联系您阿里云账户的管理员，以授予您 AliyunServiceRoleForESARealtimeLogPushSLS 策略或用于创建服务关联角色的自定义策略。服务名称："esarealtimelogpushsls.dcdnservices.aliyuncs.com"。操作：ram:CreateServiceLinkedRole。', + ], + [ + 'code' => 'CreateTimeError', + 'message' => 'The effective time of the same policy template cannot overlap.', + 'http_code' => 400, + 'description' => '同一策略模板的有效时间不能重叠。', + ], + [ + 'code' => 'DependedByOthers', + 'message' => 'Failed to call the service. Try again later or contact technical support.', + 'http_code' => 400, + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'code' => 'DnsSecDenied', + 'message' => 'Only sites accessed by NS can enable DNSSEC.', + 'http_code' => 400, + 'description' => '只有NS接入的站点才能开启DNSSEC功能。', + ], + [ + 'code' => 'Domain.NotSupport.Waf', + 'message' => 'Failed to enable WAF for the domain due to incompatible scheduling domain configurations or properties. Check and adjust your configurations and try again. If the problem persists, contact technical support.', + 'http_code' => 403, + 'description' => '域名因调度配置域或属性不兼容，无法接入WAF保护，建议检查并调整相关设置后重试，问题持续存在请联系客服。', + ], + [ + 'code' => 'DomainInRiskList', + 'message' => 'The domain you added may be at risk. If you have any questions, please submit a ticket.', + 'http_code' => 400, + 'description' => '您所添加的域名可能存在风险，如有任何疑问，请提交工单。', + ], + [ + 'code' => 'DomainNameOverLimit', + 'message' => 'A maximum of 500 domains are supported for each request.', + 'http_code' => 400, + 'description' => '一次最多只支持500个域名，请减少域名重新请求。', + ], + [ + 'code' => 'DuplicateRequirementTicket', + 'message' => 'Repeated demand order.', + 'http_code' => 400, + 'description' => '你已经提交过需求单了，无需重复提交。', + ], + [ + 'code' => 'EdgeContainer.HasOpened', + 'message' => 'You have already activated Edge Container.', + 'http_code' => 400, + 'description' => 'You have already activated Edge Container.', + ], + [ + 'code' => 'EdgePortsOverlap', + 'message' => 'There is overlap between multiple edge ports, please check and try again after modification.', + 'http_code' => 400, + 'description' => '多个边缘端口之间存在重叠，请检查后进行修改重试。', + ], + [ + 'code' => 'EnterpriseAmountErr', + 'message' => 'Enterprise plans do not support bulk purchase.', + 'http_code' => 400, + 'description' => '企业版套餐不支持批量购买。', + ], + [ + 'code' => 'ErrSiteIdNoteEnterprise', + 'message' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', + 'http_code' => 400, + 'description' => '当前站点非企业版套餐，无法使用该功能，请升级站点为企业版套餐。', + ], + [ + 'code' => 'ErService.HasOpened', + 'message' => 'You have already activated Edge Routine.', + 'http_code' => 400, + 'description' => '您已开通边缘函数服务，无需重复开通。', + ], + [ + 'code' => 'ErService.NotOpen', + 'message' => 'Er service has not opend.', + 'http_code' => 403, + 'description' => '您没有开通边缘函数服务。', + ], + [ + 'code' => 'EsaService.NotOpen', + 'message' => 'ESA service has not opend.', + 'http_code' => 403, + 'description' => '边缘安全加速服务(ESA)未开通', + ], + [ + 'code' => 'ExceedFileUpload', + 'message' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.', + 'http_code' => 400, + 'description' => '您上传的文件大小超出了限制，请选择小于10MB的文件重新进行上传。', + ], + [ + 'code' => 'Expression.Invalid', + 'message' => 'Expression syntax error or data type mismatched.', + 'http_code' => 403, + 'description' => '表达式语法错误或数据类型不匹配，请您检查表格式。', + ], + [ + 'code' => 'Expression.Invalid', + 'message' => 'The specified expression is invalid: %s.', + 'http_code' => 403, + 'description' => '指定的表达式是无效的。', + ], + [ + 'code' => 'Forbidden', + 'message' => 'You are not authorized to operate this resource, or this API does not support RAM.', + 'http_code' => 403, + 'description' => '未授权在该资源上操作，或者该API不支持RAM。', + ], + [ + 'code' => 'FunctionConflict', + 'message' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', + 'http_code' => 400, + 'description' => '当前配置的功能与其它功能存在冲突，如需要配置请先删除冲突的功能配置。', + ], + [ + 'code' => 'FunctionQuotaCheckFailed', + 'message' => 'The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.', + 'http_code' => 400, + 'description' => '当前套餐不支持配置受限功能，请检查套餐相关的功能描述。', + ], + [ + 'code' => 'HostnameNumberExceedLimit', + 'message' => 'The maximum number of hostnames associated with the CA certificate you specified has been reached.', + 'http_code' => 400, + 'description' => 'CA证书域名绑定数量超限，每张CA证书最多允许绑定50个域名。', + ], + [ + 'code' => 'Id.MissingParameter', + 'message' => 'The parameter Id is required.', + 'http_code' => 400, + 'description' => '缺少必填参数Id。', + ], + [ + 'code' => 'IllegalOperation.VersionManagement', + 'message' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', + 'http_code' => 400, + 'description' => '当前进行版本管理操作时，存在与其互斥的功能或环境设置，请先调整相关配置后再尝试。', + ], + [ + 'code' => 'Instance.NotOnline', + 'message' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', + 'http_code' => 400, + 'description' => '您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。', + ], + [ + 'code' => 'Instance.ReleaseFailed', + 'message' => 'Instance release failed.', + 'http_code' => 400, + 'description' => '实例释放失败。', + ], + [ + 'code' => 'Instance.UpdateSpecError', + 'message' => 'The security instance can only be changed after 31 days of purchase, and can only be changed once a natural month.', + 'http_code' => 400, + 'description' => '安全实例购买满 31 天后才能变配，一个自然月只能变配 1 次。', + ], + [ + 'code' => 'InstanceNotExist', + 'message' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', + 'http_code' => 400, + 'description' => '实例不存在，请检查提供的实例ID是否正确或该实例是否属于您的账户。', + ], + [ + 'code' => 'InsufficientAvailableQuota', + 'message' => 'Your account balance is insufficient.', + 'http_code' => 400, + 'description' => '您的账号已欠费，请缴清欠费后再购买。', + ], + [ + 'code' => 'InsufficientBalance', + 'message' => 'Your account balance is insufficient.', + 'http_code' => 400, + 'description' => '您的账号余额不足，请充值后再购买。', + ], + [ + 'code' => 'InternalError', + 'message' => 'An internal exception occurred, please try again later.', + 'http_code' => 400, + 'description' => '触发内部异常，请稍后再试。', + ], + [ + 'code' => 'InternalError', + 'message' => 'Failed to call the service. Try again later or contact technical support.', + 'http_code' => 500, + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'code' => 'InternalException', + 'message' => 'Failed to call the service. Try again later or contact technical support.', + 'http_code' => 400, + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'code' => 'InternalOperationError', + 'message' => 'Failed to call the service. Try again later or contact technical support.', + 'http_code' => 400, + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'code' => 'Invalid.Parameter', + 'message' => 'Invalid request parameters for querying standard logs. Check and try again.', + 'http_code' => 400, + 'description' => '查询离线日志，请求参数不正确，请核对参数正确性重试。', + ], + [ + 'code' => 'Invalid.Value', + 'message' => 'Invalid value in the key-value pair. Make sure the value is Base64-encoded.', + 'http_code' => 400, + 'description' => 'KV数据中的Value值无效，请确保您的Value值已经过Base64编码。', + ], + [ + 'code' => 'InvalidAccount.Malformed', + 'message' => 'The specified account is invalid.', + 'http_code' => 400, + 'description' => '账号输入不对，比如输入为空。', + ], + [ + 'code' => 'InvalidAccount.NotFound', + 'message' => 'The specified account does not exist.', + 'http_code' => 404, + 'description' => '指定的账号不存在。', + ], + [ + 'code' => 'InvalidApp.NotFound', + 'message' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + 'http_code' => 404, + 'description' => '您传入的应用ID对应的应用不存在，请检查后重试。', + ], + [ + 'code' => 'InvalidArgName', + 'message' => 'The parameter name does not exist, please check the function interface document.', + 'http_code' => 400, + 'description' => '不存在的参数名，请查看功能接口文档。', + ], + [ + 'code' => 'InvalidCertificate.NotFound', + 'message' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.', + 'http_code' => 400, + 'description' => '您提供的证书与该站点不匹配，请确认证书的有效性并重新发起请求。', + ], + [ + 'code' => 'InvalidComponent', + 'message' => 'The order parameters is invalid.', + 'http_code' => 400, + 'description' => '订单配置参数不符合校验条件。', + ], + [ + 'code' => 'InvalidConfigId', + 'message' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', + 'http_code' => 400, + 'description' => '传入的ConfigId不存在。', + ], + [ + 'code' => 'InvalidEndTime.Malformed', + 'message' => 'The specified EndTime is invalid.', + 'http_code' => 400, + 'description' => '请提供正确的结束时间格式。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：yyyy-MM-ddTHH:mm:ssZ。', + ], + [ + 'code' => 'InvalidEndTime.Mismatch', + 'message' => 'The specified EndTime is earlier than the StartTime.', + 'http_code' => 400, + 'description' => '您填入的结束时间早于开始时间，请检查后重试。', + ], + [ + 'code' => 'InvalidExecution.CountFull', + 'message' => 'The maximum number of prefetch plans has been reached. Delete some completed tasks and try again.', + 'http_code' => 400, + 'description' => '预热计划数量已达上限， 请您删除部分已完成的预热任务后重试。', + ], + [ + 'code' => 'InvalidExecution.NotFound', + 'message' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', + 'http_code' => 404, + 'description' => '执行计划不存在，请检查执行ID、开始时间或结束时间等参数是否准确无误。', + ], + [ + 'code' => 'InvalidFunctions.Malformed', + 'message' => 'The specified Functions is invalid.', + 'http_code' => 400, + 'description' => '不支持该配置，请重新填写。', + ], + [ + 'code' => 'InvalidInstance', + 'message' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', + 'http_code' => 400, + 'description' => '实例ID缺失或者参数无效，请确认实例ID无误后重试。', + ], + [ + 'code' => 'InvalidJob.JobCountOfSiteFull', + 'message' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', + 'http_code' => 400, + 'description' => '站点预热任务已达上限，无法添加更多任务，请先清理多余任务后重试。', + ], + [ + 'code' => 'InvalidJob.NotFound', + 'message' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', + 'http_code' => 404, + 'description' => '任务不存在，请检查任务ID是否正确或该任务是否已被删除。', + ], + [ + 'code' => 'InvalidKey.ExceedsCapacity', + 'message' => 'The maximum storage capacity of the Edge KV namespace has been reached. Delete unwanted key-value pairs to save the storage.', + 'http_code' => 403, + 'description' => '边缘存储的存储空间（Namespace）容量超过限制，请清理Namespace中无需使用的Key，从而减少Namespace中的存储消耗。', + ], + [ + 'code' => 'InvalidKey.ExceedsCapacity', + 'message' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', + 'http_code' => 403, + 'description' => '存储空间的容量超过限制。', + ], + [ + 'code' => 'InvalidKey.ExceedsMaximum', + 'message' => 'The size of the key cannot exceed 512 bytes.', + 'http_code' => 400, + 'description' => '请求的Key的长度过大。', + ], + [ + 'code' => 'InvalidKey.Malformed', + 'message' => 'The specified key is invalid.', + 'http_code' => 400, + 'description' => 'Key名输入错误，比如输入空字符串。', + ], + [ + 'code' => 'InvalidKey.NotFound', + 'message' => 'The specified key does not exist.', + 'http_code' => 404, + 'description' => '指定的键值对不存在。', + ], + [ + 'code' => 'InvalidKey.QuotaFull', + 'message' => 'The total number of IP exceeds the quota.', + 'http_code' => 406, + 'description' => 'ip总数量超过配额。', + ], + [ + 'code' => 'InvalidKey.TooManyDimensions', + 'message' => 'Request contains too many dimensions.', + 'http_code' => 400, + 'description' => '您的查询维度过多，请仔细检查请求参数并减少查询维度，详细信息参见“OpenAPI文档”。', + ], + [ + 'code' => 'InvalidNameSpace.Duplicate', + 'message' => 'The specified namespace already exists.', + 'http_code' => 406, + 'description' => '指定的存储空间已经存在。', + ], + [ + 'code' => 'InvalidNameSpace.Malformed', + 'message' => 'The specified namespace is invalid.', + 'http_code' => 400, + 'description' => '存储空间名输入错误，比如输入空字符串。', + ], + [ + 'code' => 'InvalidNameSpace.NotFound', + 'message' => 'The specified namespace does not exist.', + 'http_code' => 404, + 'description' => '指定的存储空间不存在。', + ], + [ + 'code' => 'InvalidNameSpace.QuotaFull', + 'message' => 'The maximum number of namespaces is exceeded.', + 'http_code' => 406, + 'description' => '存储空间的个数超过容量限制。', + ], + [ + 'code' => 'InvalidNextToken', + 'message' => 'The specified parameter NextToken is invalid.', + 'http_code' => 400, + 'description' => '参数NextToken非法。', + ], + [ + 'code' => 'InvalidPageSize.ValueNotSupported', + 'message' => 'The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500.', + 'http_code' => 400, + 'description' => '请求PageSize值非法，默认取值为20，取值区间为1-500。', + ], + [ + 'code' => 'InvalidParameter', + 'message' => 'Invalid parameter. Check the parameter configuration.', + 'http_code' => 400, + 'description' => '参数正确性校验失败，请检查的参数内容。', + ], + [ + 'code' => 'InvalidParameter', + 'message' => 'Parameter verification failed. Check your configurations and try again.', + 'http_code' => 400, + 'description' => '输入的参数校验不通过，请您核对参数的正确性后重试。', + ], + [ + 'code' => 'InvalidParameter', + 'message' => 'The specified parameter is invalid.', + 'http_code' => 400, + 'description' => '输入参数规范校验失败。', + ], + [ + 'code' => 'InvalidParameter.AddressConflict', + 'message' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', + 'http_code' => 400, + 'description' => '传入的源站地址有冲突，在同一个源地址池中，不能存在重复的源站地址，请您确保源站地址的唯一性。', + ], + [ + 'code' => 'InvalidParameter.ApiItems.Api', + 'message' => 'The parameter apiItems api is invalid.', + 'http_code' => 400, + 'description' => '参数apiItems api参数不合法。', + ], + [ + 'code' => 'InvalidParameter.ApiItems.Host', + 'message' => 'The parameter apiItems host is invalid.', + 'http_code' => 400, + 'description' => '参数apiItems host不合法。', + ], + [ + 'code' => 'InvalidParameter.ApiShield.Quota', + 'message' => 'This website does not have the permission to view API security features.', + 'http_code' => 400, + 'description' => '该站点没有API安全功能查看权限。', + ], + [ + 'code' => 'InvalidParameter.appid', + 'message' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'http_code' => 400, + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'code' => 'InvalidParameter.Appid', + 'message' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', + 'http_code' => 400, + 'description' => '传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。', + ], + [ + 'code' => 'InvalidParameter.ArgName', + 'message' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', + 'http_code' => 400, + 'description' => '传入的ArgName无效，请检查您提供的站点配置参数，确保它们与官方文档中列出的支持功能及参数名称相匹配。', + ], + [ + 'code' => 'InvalidParameter.ArgValue', + 'message' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', + 'http_code' => 400, + 'description' => '参数值无效，请检查输入是否符合规定格式及长度限制。', + ], + [ + 'code' => 'InvalidParameter.ClientIpPassThroughMode', + 'message' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', + 'http_code' => 400, + 'description' => '无效的客户端IP传递协议，请参考接口文档，传入合法的参数。', + ], + [ + 'code' => 'InvalidParameter.CnameSiteRecordNoProxied', + 'message' => 'A non-proxied record was added for a website using a CNAME setup.', + 'http_code' => 400, + 'description' => '以CNAME方式接入的站点，提交了未开启加速的记录。', + ], + [ + 'code' => 'InvalidParameter.CnameSiteRecordUnsupport', + 'message' => 'The current record type is not supported for a website connected by CNAME setup.', + 'http_code' => 400, + 'description' => 'CNAME方式接入的站点仅支持添加A/AAAA、CNAME类型记录。', + ], + [ + 'code' => 'InvalidParameter.ConfigIds', + 'message' => 'Invalid ConfigId. Specify an existing Configld and make sure it is in the valid format.', + 'http_code' => 400, + 'description' => '传入的ConfigId无效，请确保传递的是已存在且格式正确的ConfigId序列。', + ], + [ + 'code' => 'InvalidParameter.Configs', + 'message' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', + 'http_code' => 400, + 'description' => '配置参数错误，请检查站点功能设置项是否遵循规定格式及要求。', + ], + [ + 'code' => 'InvalidParameter.Coverage', + 'message' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', + 'http_code' => 400, + 'description' => '您选择的加速区域不在当前套餐支持范围内，请更换为套餐支持的加速区域后重试。', + ], + [ + 'code' => 'InvalidParameter.Dimension', + 'message' => 'The specified Dimension is invalid.', + 'http_code' => 400, + 'description' => '您的查询维度有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。'."\n", + ], + [ + 'code' => 'InvalidParameter.DomainNotBelongingUser', + 'message' => 'The domain name passed in does not belong to the current user.', + 'http_code' => 400, + 'description' => '传入的域名不属于当前用户。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'Duplicate domain names are specified for parameter Domains. Remove one of them and try again.', + 'http_code' => 400, + 'description' => '指定的Domains参数中包含重复域名，请去重后重试。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'The maximum number of domain names specified by parameter Domains has been reached. Adjust your configurations and try again.', + 'http_code' => 400, + 'description' => 'Domains参数中包含的域名数超过配额，请重新指定后重试。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'You have already submitted a certificate application for the domain name.', + 'http_code' => 400, + 'description' => '您已提交该域名证书申请任务，请勿重复提交。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'One or more domain names specified by parameter Domains do not belong to the current website. Check and try again.', + 'http_code' => 400, + 'description' => '指定参数Domains中包含的域名存在不属于当前站点的情况，请检查后重试。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'The domain specified in Domains parameter is not a valid domain name, please check and try again.', + 'http_code' => 400, + 'description' => 'Domains参数中存在无效的域名，请检查后重试。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'The site you configured is currently accessed in the CNAME mode. Please switch to the NS mode and try again.', + 'http_code' => 400, + 'description' => '您配置的站点当前是CNAME方式接入，请切换成以NS方式接入后重试。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'The maximum number of domain names specified by parameter Domains has been reached. Adjust your configurations and try again. The upper limit of lets.encrypt type domain name is 50, the upper limit of digicert.single type domain name is 10, and the upper limit of digicert.wildcard type domain name is 1.', + 'http_code' => 400, + 'description' => 'Domains参数中包含的域名数超过配额，请重新指定后重试。lets_encrypt类型域名上限为50，digicert_single类型域名上限为10，digicert_wildcard类型域名上限为1。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'The site which is configured in CNAME mode does not support wildcard domain certificate application.', + 'http_code' => 400, + 'description' => 'CNAME站点不支持申请泛域名免费证书。', + ], + [ + 'code' => 'InvalidParameter.DomainsExceedLimit', + 'message' => 'The number of incoming domain names exceeds the maximum limit.', + 'http_code' => 400, + 'description' => '传入的域名数量超过了最大数量限制。'."\n", + ], + [ + 'code' => 'InvalidParameter.DomainSourceTypeNotSupport', + 'message' => 'The underlying source type of the domain is not supported.', + 'http_code' => 400, + 'description' => '域名的基础源站类型不支持。', + ], + [ + 'code' => 'InvalidParameter.EmptyAKSK', + 'message' => 'AK,SK information cannot be empty.', + 'http_code' => 400, + 'description' => 'AK,SK信息不能为空。', + ], + [ + 'code' => 'InvalidParameter.EndpointId', + 'message' => 'The parameter EndpointId is invalid.', + 'http_code' => 400, + 'description' => '参数EndpointId 不合法。', + ], + [ + 'code' => 'InvalidParameter.ExistedHandlingTask', + 'message' => 'There is a task in process, waiting for execution to complete.', + 'http_code' => 400, + 'description' => '存在处理中的任务，等待执行完成。', + ], + [ + 'code' => 'InvalidParameter.Field', + 'message' => 'The specified Field is invalid.', + 'http_code' => 400, + 'description' => '您的查询指标有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。', + ], + [ + 'code' => 'InvalidParameter.FunctionName', + 'message' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', + 'http_code' => 400, + 'description' => '您所输入的功能名称不存在，请参照功能配置文档选择正确的功能名进行操作。', + ], + [ + 'code' => 'InvalidParameter.FuzzySearch', + 'message' => 'The parameter fuzzySearch is invalid.', + 'http_code' => 400, + 'description' => '参数fuzzySearch不合法。', + ], + [ + 'code' => 'InvalidParameter.HealthCheckFailTimes', + 'message' => 'Specified parameter HealthCheckFailTimes is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckFailTimes 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckHost', + 'message' => 'Specified parameter HealthCheckHost is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckHost 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckHttpCode', + 'message' => 'Specified parameter HealthCheckHttpCode is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckHttpCode 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckInterval', + 'message' => 'Specified parameter HealthCheckInterval is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckInterval 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckMethod', + 'message' => 'Specified parameter HealthCheckMethod is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckMethod 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckPort', + 'message' => 'Specified parameter HealthCheckPort is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckPort 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckSuccTimes', + 'message' => 'Specified parameter HealthCheckSuccTimes is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckSuccTimes 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckTimeout', + 'message' => 'Specified parameter HealthCheckTimeout is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckTimeout 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckType', + 'message' => 'Specified parameter HealthCheckType is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckType 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HealthCheckURI', + 'message' => 'Specified parameter HealthCheckURI is not valid.', + 'http_code' => 400, + 'description' => '参数 HealthCheckURI 格式不正确', + ], + [ + 'code' => 'InvalidParameter.HttpHeaders', + 'message' => 'The specified HttpHeaders is invalid. Please check the HttpHeaders parameter. Please make the necessary changes and call the interface again.', + 'http_code' => 400, + 'description' => 'HttpHeaders参数无效。请检查HttpHeaders参数是否填写，该参数不能包含 @ # 等非法字符，请进行修改后，重新调用接口。', + ], + [ + 'code' => 'InvalidParameter.Image', + 'message' => 'The specified Image is invalid. Please check the Image parameter and make the necessary modifications and call the interface again.', + 'http_code' => 400, + 'description' => 'Image参数非法。请检查Image参数，该参数不能赋值为非法字符如 @、#、% 等，请进行修改后，重新调用接口。', + ], + [ + 'code' => 'InvalidParameter.InvalidBiz', + 'message' => 'the value of the business type is empty or the incoming parameter is invalid.', + 'http_code' => 400, + 'description' => '业务类型的值为空或传入参数错误。', + ], + [ + 'code' => 'InvalidParameter.InvalidBiz', + 'message' => 'The incoming parameter value of the business type is empty or incorrect.', + 'http_code' => 400, + 'description' => '业务类型的值为空或传入参数错误。', + ], + [ + 'code' => 'InvalidParameter.InvalidDSRecordName', + 'message' => 'Please add/import an NS record with the same name before adding this DS record.', + 'http_code' => 400, + 'description' => '请先添加/导入同名的NS记录，再添加该DS记录。', + ], + [ + 'code' => 'InvalidParameter.InvalidHostPolicy', + 'message' => 'The host parameter in the origin fetch request is invalid.', + 'http_code' => 400, + 'description' => '回源Host的参数错误。', + ], + [ + 'code' => 'InvalidParameter.InvalidRecordName', + 'message' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', + 'http_code' => 400, + 'description' => '您输入的记录名称不符合规范，请根据产品文档调整记录名称。', + ], + [ + 'code' => 'InvalidParameter.InvalidRecordName', + 'message' => 'The DNS record name you entered does not meet the required specifications. Please adjust the record name according to the product documentation.', + 'http_code' => 400, + 'description' => '您输入的记录名称不符合规范，请根据产品文档调整记录名称。', + ], + [ + 'code' => 'InvalidParameter.InvalidRecordNameSuffix', + 'message' => 'If you add other records, the suffix of the host record must be the same as the site name.', + 'http_code' => 400, + 'description' => '若添加站点同名记录，请将主机记录命名为@，若添加其他记录，主机记录后缀需要和站点名完全一致。请调整后进行重试。', + ], + [ + 'code' => 'InvalidParameter.InvalidSiteEnvironmentName', + 'message' => 'The specified site environment name is invalid.', + 'http_code' => 400, + 'description' => '站点环境名称非法。', + ], + [ + 'code' => 'InvalidParameter.InvalidVanityNSName', + 'message' => 'A vanity nameserver must be an absolute domain name. Correct it and try again.', + 'http_code' => 400, + 'description' => '自定义NS名称需输入完整域名，请调整后重新提交。', + ], + [ + 'code' => 'InvalidParameter.InvalidVanityNSNum', + 'message' => 'Enter 2 to 5 vanity nameservers. Correct them and try again.', + 'http_code' => 400, + 'description' => '自定义NS需要2~5个名称，请调整后重新提交。', + ], + [ + 'code' => 'InvalidParameter.LoadBalancerNameInvalid', + 'message' => 'Invalid load balancer name. Make sure that you specify a valid subdomain name under your website domain for the load balancer.', + 'http_code' => 400, + 'description' => '您配置的负载均衡器名称不正确，请您确保该名称是站点下的有效子域名。', + ], + [ + 'code' => 'InvalidParameter.MethodFilter', + 'message' => 'The parameter methodFilter is invalid.', + 'http_code' => 400, + 'description' => '参数methodFilter不合法。', + ], + [ + 'code' => 'InvalidParameter.Name', + 'message' => 'The specified Name is invalid. Please check the Name parameter, which must be between 6 and 128 characters. Kindly make the necessary modifications and call the interface again.', + 'http_code' => 400, + 'description' => 'Name 参数无效。请检查Name参数，该参数范围为6-128个字符之间，请进行修改后，重新调用接口。', + ], + [ + 'code' => 'InvalidParameter.NotFoundDomain', + 'message' => 'The incoming domain name or some domain names cannot be found based on the user and product type.', + 'http_code' => 400, + 'description' => '根据用户及产品类型，找不到传入的域名或部分域名。', + ], + [ + 'code' => 'InvalidParameter.NotMatchedCoverage', + 'message' => 'The domain name and the coverage of the site are inconsistent.', + 'http_code' => 400, + 'description' => '域名、站点的加速区域不一致。', + ], + [ + 'code' => 'InvalidParameter.NotMatchedRootDomain', + 'message' => 'The domain name does not match the root domain name information for the site.', + 'http_code' => 400, + 'description' => '域名与站点的根域名信息不匹配。', + ], + [ + 'code' => 'InvalidParameter.NotSupportedDomainBiz', + 'message' => 'The business type of the domain name is not supported.', + 'http_code' => 400, + 'description' => '域名的业务类型不支持的。', + ], + [ + 'code' => 'InvalidParameter.NotSupportedDomainStatus', + 'message' => 'The status of the domain name is not allowed.', + 'http_code' => 400, + 'description' => '域名的状态是不允许的。', + ], + [ + 'code' => 'InvalidParameter.NotSupportedMultiChannelDomain', + 'message' => 'The multi-channel domain are not supported.', + 'http_code' => 400, + 'description' => '不支持多渠道域名。', + ], + [ + 'code' => 'InvalidParameter.NotSupportVendor', + 'message' => 'Do not support the vendor, please select the vendor supported.', + 'http_code' => 400, + 'description' => '不支持的厂商，请选择已支持的厂商。', + ], + [ + 'code' => 'InvalidParameter.ObjectId', + 'message' => 'Invalid task ID or execution plan ID.', + 'http_code' => 400, + 'description' => '您提供的任务或执行计划ID不正确，请检查ID是否有效且输入无误。', + ], + [ + 'code' => 'InvalidParameter.ObjectsAndSiteIds', + 'message' => 'The specified Objects and SiteIds variables cannot both be empty strings.', + 'http_code' => 400, + 'description' => '指定的Objects 和 SiteIds变量不能都为空字符串。', + ], + [ + 'code' => 'InvalidParameter.OrderKey', + 'message' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', + 'http_code' => 400, + 'description' => 'OrderKey参数无效。请检查OrderKey参数，该参数不能赋值为非法字符如 @、#、% 等，请进行修改后，重新调用接口。', + ], + [ + 'code' => 'InvalidParameter.OrderType', + 'message' => 'The specified OrderType is invalid. Please check the OrderType parameter. You may not have set it to either Asc or Desc. Please make the necessary changes and call the interface again.', + 'http_code' => 400, + 'description' => 'OrderType参数无效。请检查OrderType参数，你有可能未设置为 Asc、Desc其中一种，请进行修改后，重新调用接口。', + ], + [ + 'code' => 'InvalidParameter.PageNumber', + 'message' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', + 'http_code' => 400, + 'description' => '参数 PageNumber 校验不通过。请仔细检查请求参数是否存在且为正整数。', + ], + [ + 'code' => 'InvalidParameter.Percentage', + 'message' => 'The Percentage parameter is invalid. Please check the Percentage parameter, which should be in the range of 1-100. Modify it accordingly and call the interface again.', + 'http_code' => 400, + 'description' => 'Percentage 参数无效。请检查Percentage参数，该参数范围为1-100，请进行修改后，重新调用接口。', + ], + [ + 'code' => 'InvalidParameter.Port', + 'message' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', + 'http_code' => 400, + 'description' => '无效的边缘端口或者源站端口，请按照接口文档中的要求，传入合法的端口。', + ], + [ + 'code' => 'InvalidParameter.Protocol', + 'message' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', + 'http_code' => 400, + 'description' => '无效的端口协议，请按照接口文档的要求，传入合法的端口协议。', + ], + [ + 'code' => 'InvalidParameter.PublishEnv', + 'message' => 'The specified PublishEnv is invalid. Please check the PublishEnv parameter. It may not be set to either "prod" or "staging." Please make the necessary changes and call the interface again.', + 'http_code' => 400, + 'description' => 'PublishEnv参数无效。请检查PublishEnv参数，你有可能未设置为prod、staging其中一种，请进行修改后，重新调用接口。', + ], + [ + 'code' => 'InvalidParameter.RecordCommentExceedLimit', + 'message' => 'The number of incoming record comment exceeds the maximum limit.', + 'http_code' => 400, + 'description' => '记录的备注信息大于50个字符。', + ], + [ + 'code' => 'InvalidParameter.RecordData', + 'message' => 'Invalid record content. Adjust your configurations based on the API documentation.', + 'http_code' => 400, + 'description' => '记录内容参数错误，请根据接口文档调整参数内容。', + ], + [ + 'code' => 'InvalidParameter.RecordNameExceedLimit', + 'message' => 'The length of the record name exceeds the maximum limit.', + 'http_code' => 400, + 'description' => '记录名称不能超过200个字符。', + ], + [ + 'code' => 'InvalidParameter.RecordNotBelongToSite', + 'message' => 'The record name passed in does not belong to the current site.', + 'http_code' => 400, + 'description' => '传入的记录名不属于当前站点。', + ], + [ + 'code' => 'InvalidParameter.RecordsExceedLimit', + 'message' => 'The number of incoming records exceeds the maximum limit.', + 'http_code' => 400, + 'description' => '传入的记录数量超过了最大数量限制。', + ], + [ + 'code' => 'InvalidParameter.RecordType', + 'message' => 'Invalid record type. Adjust your configurations based on the API documentation.', + 'http_code' => 400, + 'description' => '记录类型错误，请根据接口文档调整参数内容。', + ], + [ + 'code' => 'InvalidParameter.RuleSource', + 'message' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', + 'http_code' => 400, + 'description' => '转发规则的源站不存在或者不合法，请传入正确的源站后进行重试。', + ], + [ + 'code' => 'InvalidParameter.SiteEnvironmentRuleDuplicate', + 'message' => 'The specified site environment rule is the same as an existing environment.', + 'http_code' => 400, + 'description' => '站点环境规则与已有环境相同。', + ], + [ + 'code' => 'InvalidParameter.SiteId', + 'message' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'http_code' => 400, + 'description' => 'SiteId参数无效，无法通过指定的SiteId获取对应的站点名称，请确认SiteId后重试。', + ], + [ + 'code' => 'InvalidParameter.SiteId', + 'message' => 'The specified SiteId is invalid.', + 'http_code' => 400, + 'description' => '站点ID参数非法。', + ], + [ + 'code' => 'InvalidParameter.SiteName', + 'message' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', + 'http_code' => 400, + 'description' => '站点名称无效，请重新输入站点名称，可以包含字母和数字，不能包含特殊字符。', + ], + [ + 'code' => 'InvalidParameter.SiteVersionDescExceedLimit', + 'message' => 'The specified site version description exceeds the maximum length.', + 'http_code' => 400, + 'description' => '站点版本描述超过最大长度。', + ], + [ + 'code' => 'InvalidParameter.StateFilter', + 'message' => 'The parameter stateFilter is invalid.', + 'http_code' => 400, + 'description' => '参数stateFilter不合法。', + ], + [ + 'code' => 'InvalidParameter.TagValue', + 'message' => 'The specified TagValue is invalid.', + 'http_code' => 400, + 'description' => 'TagValue参数无效。', + ], + [ + 'code' => 'InvalidParameter.TimeRange', + 'message' => 'The specified time range exceeds the limit. Adjust it and try again.', + 'http_code' => 400, + 'description' => '您配置的数据查询时间范围过长，请调整数据查询时间范围后重试。', + ], + [ + 'code' => 'InvalidParameter.Type', + 'message' => 'The specified Type parameter is invalid, please check and try again.', + 'http_code' => 400, + 'description' => '您配置的Type参数有误，请您检查后重试。证书申请Type支持lets_encrypt，digicert_single，digicert_wildcard。', + ], + [ + 'code' => 'InvalidParameter.UnSatisfiedDomainSources', + 'message' => 'The basic origin sources of the domain is not satisfied.', + 'http_code' => 400, + 'description' => '域名基础源站信息不满足。', + ], + [ + 'code' => 'InvalidParameter.VanityNSNameDuplicate', + 'message' => 'The vanity nameservers are duplicated. Please delete it and try again.', + 'http_code' => 400, + 'description' => '存在重复的自定义NS名称，请删除后重新提交。', + ], + [ + 'code' => 'InvalidParameter.VersionId', + 'message' => 'The specified VersionId is invalid.  Please check the VersionId parameter. You may not have entered the parameter or the parameter does not start with ver-string. Please modify it and call the interface again.', + 'http_code' => 400, + 'description' => 'VersionId参数无效。请检查VersionId参数，你有可能未输入该参数或者，参数并未以ver-字符串开头，请进行修改后，重新调用接口。', + ], + [ + 'code' => 'InvalidParameters', + 'message' => 'The specified parameters are invalid.', + 'http_code' => 400, + 'description' => '参数非法。', + ], + [ + 'code' => 'InvalidParameters.InvalidUrls', + 'message' => 'The specified urls are invalid.', + 'http_code' => 400, + 'description' => '请求的URL参数无效。', + ], + [ + 'code' => 'InvalidParameter_ApiItems_Api', + 'message' => 'The parameter apiItems api is invalid.', + 'http_code' => 400, + 'description' => '参数apiItems api参数不合法。', + ], + [ + 'code' => 'InvalidParameter_ApiItems_Host', + 'message' => 'The parameter apiItems host is invalid.', + 'http_code' => 400, + 'description' => '参数apiItems host不合法。', + ], + [ + 'code' => 'InvalidParameter_ApiShieldQuota', + 'message' => 'This website does not have the permission to view API security features.', + 'http_code' => 400, + 'description' => '该站点没有API安全功能查看权限', + ], + [ + 'code' => 'InvalidParameter_EndpointId', + 'message' => 'The EndpointId is invalid.', + 'http_code' => 400, + 'description' => '参数EndpointId 不合法', + ], + [ + 'code' => 'InvalidParameter_FuzzySearch', + 'message' => 'The parameter fuzzySearch is invalid.', + 'http_code' => 400, + 'description' => '参数fuzzySearch不合法。', + ], + [ + 'code' => 'InvalidParameter_MethodFilter', + 'message' => 'The parameter methodFilter is invalid.', + 'http_code' => 400, + 'description' => '参数methodFilter不合法。', + ], + [ + 'code' => 'InvalidParameter_StateFilter', + 'message' => 'The parameter stateFilter is invalid.', + 'http_code' => 400, + 'description' => '参数stateFilter不合法。', + ], + [ + 'code' => 'InvalidRegionId.Malformed', + 'message' => 'The specified RegionId is invalid.', + 'http_code' => 400, + 'description' => 'RegionId参数非法。', + ], + [ + 'code' => 'InvalidResourceId.NotFound', + 'message' => 'The specified resource does not exist or is released.', + 'http_code' => 404, + 'description' => '资源不存在或已被释放。', + ], + [ + 'code' => 'InvalidRoutine', + 'message' => 'The name of routine is invalid.', + 'http_code' => 400, + 'description' => '边缘函数名称不合法。', + ], + [ + 'code' => 'InvalidSiteICP', + 'message' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'http_code' => 400, + 'description' => '您配置的站点未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + [ + 'code' => 'InvalidSiteName', + 'message' => 'Invalid website name. Check and try again.', + 'http_code' => 400, + 'description' => '您配置的站点名称不正确，请确保传入正确的站点名称后重试。', + ], + [ + 'code' => 'InvalidSSLPri', + 'message' => 'The specified PrivateKey is invalid.', + 'http_code' => 400, + 'description' => 'PrivateKey错误，请填写正确的PrivateKey。', + ], + [ + 'code' => 'InvalidSSLPub', + 'message' => 'The specified Certificate is invalid.', + 'http_code' => 400, + 'description' => 'Certificate错误，请重新填写。', + ], + [ + 'code' => 'InvalidStartTime.Malformed', + 'message' => 'The specified StartTime parameter is invalid.', + 'http_code' => 400, + 'description' => '请提供正确的开始时间格式。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + ], + [ + 'code' => 'InvalidStartTime.ValueNotSupported', + 'message' => 'The StartTime cannot exceed 31 days before the current time.', + 'http_code' => 400, + 'description' => '请求参数StartTime不允许比当前时间小31天', + ], + [ + 'code' => 'InvalidStationParameter', + 'message' => 'The specified Station is invalid.', + 'http_code' => 400, + 'description' => '指定的节点参数无效。', + ], + [ + 'code' => 'InvalidTaskId.Malformed', + 'message' => 'The specified taskId is invalid.', + 'http_code' => 400, + 'description' => '指定的任务ID无效。', + ], + [ + 'code' => 'InvalidTime', + 'message' => 'The query time cannot exceed the last 3 days.', + 'http_code' => 400, + 'description' => '查询时间不能超过最近3天。', + ], + [ + 'code' => 'InvalidTime.Malformed', + 'message' => 'Specified start time or end time is malformed.', + 'http_code' => 400, + 'description' => '您指定的时间格式有误，时间需要符合yyyy-MM-ddTHH:mm:ssZ格式。请您正确输入后重试。', + ], + [ + 'code' => 'InvalidUid.PermissionDenied', + 'message' => 'You do not have the permissions to perform this operation on this resource. Check whether the specified UID is correct and has the required permissions.', + 'http_code' => 403, + 'description' => '您无权操作此资源，请确认UID是否正确且具备相应权限。', + ], + [ + 'code' => 'InvalidValOfDelHeader', + 'message' => 'The delete header operation does not support setting value.', + 'http_code' => 400, + 'description' => '删除头操作不支持设置value。', + ], + [ + 'code' => 'InvalidValue.ExceedsMaximum', + 'message' => 'The size of the value cannot exceed 2,000,000 bytes.', + 'http_code' => 400, + 'description' => '存入的值过大。', + ], + [ + 'code' => 'InvalidVersion.NotFound', + 'message' => 'The version does not exist.', + 'http_code' => 400, + 'description' => '这个版本号不存在。'."\n", + ], + [ + 'code' => 'IpaNotActive', + 'message' => 'The ipa application is not active.', + 'http_code' => 400, + 'description' => '当前应用正在部署中。', + ], + [ + 'code' => 'IpaResourceUnavailable', + 'message' => 'The resource is unavailable.', + 'http_code' => 400, + 'description' => '没有足够的资源可供新域名接入。', + ], + [ + 'code' => 'List.BeingBound', + 'message' => 'The specified list is being bound.', + 'http_code' => 403, + 'description' => '指定的列表正在被一个或多个防护规则绑定。', + ], + [ + 'code' => 'List.Name.AlreadyExist', + 'message' => 'The specified list name already exists.', + 'http_code' => 403, + 'description' => '指定的列表名称已存在。', + ], + [ + 'code' => 'List.NotExist', + 'message' => 'The specified list does not exist.', + 'http_code' => 403, + 'description' => '指定的列表不存在。', + ], + [ + 'code' => 'LoadBalancerHealthDetectionIntervalCheckFailed', + 'message' => 'The configured load balancer health detection interval exceeds the quota range allowed by the plan. Please revise the interval within the range or upgrade the plan and try again.', + 'http_code' => 400, + 'description' => '您配置的负载均衡器健康探测时间间隔超出了套餐允许的配额范围，请订正为范围内的间隔或者升级套餐后，进行重试。', + ], + [ + 'code' => 'LoadBalancerHealthDetectionQuotaCheckFailed', + 'message' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.', + 'http_code' => 400, + 'description' => '您当前的套餐不允许配置负载均衡器的健康探测，请升级套餐后重试。', + ], + [ + 'code' => 'LoadBalancerNameConflict', + 'message' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', + 'http_code' => 400, + 'description' => '负载均衡器名称或源地址池记录名已存在，请更换一个唯一的名字重试。', + ], + [ + 'code' => 'LoadBalancerNotExist', + 'message' => 'The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.', + 'http_code' => 400, + 'description' => '传入的站点负载均衡器无效或当前站点尚未开通负载均衡功能。请您检查负载均衡器名称配置的是否正确后重试，若尚未开通负载均衡功能请开通后重试。', + ], + [ + 'code' => 'LoadBalancerNotExist', + 'message' => 'The load balancer does not exist.', + 'http_code' => 400, + 'description' => '传入的负载均衡器ID不存在，请您确认ID后重试。', + ], + [ + 'code' => 'LoadBalancerNumberExceedQuotaLimit', + 'message' => 'The number of load balancers you have added has reached the limit of the plan quota. Please delete the unused load balancers or upgrade the plan and try again.', + 'http_code' => 400, + 'description' => '您添加的负载均衡器数量已经达到套餐配额限制，请删除不使用的负载均衡器或者升级套餐后进行重试。', + ], + [ + 'code' => 'LoadBalancerPolicyCheckFailed', + 'message' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', + 'http_code' => 400, + 'description' => '您当前的套餐不支持使用该负载均衡器调度策略，请升级套餐后重试。', + ], + [ + 'code' => 'LoadBalancerQuotaCheckFailed', + 'message' => 'Load balancer enable quota check failed.', + 'http_code' => 400, + 'description' => '您当前的套餐无法使用负载均衡器相关功能，如需使用，请进行套餐升级。', + ], + [ + 'code' => 'LoadBalancerRuleQuotaCheckFailed', + 'message' => 'Your current plan does not support configuring load balancer custom rules, or the load balancer rules you have added exceed the plan quota limit. Please upgrade the plan or delete the rules that are no longer in use and try again.', + 'http_code' => 400, + 'description' => '您当前的套餐不支持配置负载均衡器自定义规则，或者您已经添加的负载均衡器规则超过套餐配额限制，请升级套餐或者删除不再使用的规则后重试。', + ], + [ + 'code' => 'LockFailed', + 'message' => 'The system is handling requests you previously submitted. Try again later.', + 'http_code' => 400, + 'description' => '您有其他请求正在处理中，请稍后再进行重试。', + ], + [ + 'code' => 'LogNotFound', + 'message' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', + 'http_code' => 404, + 'description' => '未找到日志，请检查任务ID、执行ID等是否正确和有效。', + ], + [ + 'code' => 'LogserviceNotFound', + 'message' => 'Log Service has not been activated.', + 'http_code' => 403, + 'description' => '没有开通实时日志服务。', + ], + [ + 'code' => 'LogstoreNotExist', + 'message' => 'Logstore does not exist.', + 'http_code' => 404, + 'description' => 'Logstore不存在。', + ], + [ + 'code' => 'ManagedRulesGroup.BeingBound', + 'message' => 'Failed to delete the WAF managed rule group because it has been associated with one or more rules. Disassociate the rules and try again.', + 'http_code' => 403, + 'description' => '您无法删除该WAF托管规则组，因为它当前已与其他规则绑定，请先解除绑定再进行删除。', + ], + [ + 'code' => 'ManagedRulesGroup.Name.Invalid', + 'message' => 'Invalid name for the WAF managed rule group. Try again with a valid name.', + 'http_code' => 403, + 'description' => '您所输入的WAF托管规则组名称无效，请使用有效的名称重新尝试。', + ], + [ + 'code' => 'ManagedRulesGroup.NotExist', + 'message' => 'The specified WAF managed rule group does not exist or is not recognized by the system. Make sure that you specify a correct WAF managed rule group ID and that the rule group has been created.', + 'http_code' => 403, + 'description' => '指定的WAF托管规则组不存在或未被系统识别，请确保标识符正确并验证创建过程是否成功。', + ], + [ + 'code' => 'Match.Malformed', + 'message' => 'The specified parameter match is malformed or does not adhere to the required format.', + 'http_code' => 403, + 'description' => '指定的参数Match格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致，并予以纠正，以符合预期的配置架构。', + ], + [ + 'code' => 'MigrateTask.SpecificFunctionNotFound', + 'message' => 'When importing domain name configurations, you need to pass in the specific feature configurations, but they are not received.', + 'http_code' => 400, + 'description' => '导入域名配置时，需要传入特定的功能配置，但是未收到。', + ], + [ + 'code' => 'MigrateTask.Unsupported', + 'message' => 'The following conditions are not supported in the migration task:'."\n" + .'1. Unadapted vendors do not support it for the time being'."\n" + .'2. Non-API mode, does not support repeated execution'."\n" + .'3. Tasks that are not successful, failed or partially failed are not supported for repeated execution.'."\n" + .'Check and re-execute according to the prompt message.', + 'http_code' => 400, + 'description' => '以下情况在导入域名配置工具中是不被支持的，根据提示信息检查，重新执行：'."\n" + .'1. 未适配的厂商暂不支持'."\n" + .'2. 非API方式，不支持重复执行'."\n" + .'3. 不是成功、失败、部分失败的任务，不支持重复执行', + ], + [ + 'code' => 'MissingConfigId', + 'message' => 'Required parameter ConfigId missing. Specify ConfigId and try again.', + 'http_code' => 400, + 'description' => '缺少必填参数ConfigId，请指定ConfigId参数后重试。', + ], + [ + 'code' => 'MissingOssUrl', + 'message' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', + 'http_code' => 400, + 'description' => 'OssUrl字段缺失，请确保已提供有效的OSS预热任务链接。', + ], + [ + 'code' => 'MissingParameter', + 'message' => 'Required parameter RecordName missing. Specify RecordName and try again.', + 'http_code' => 400, + 'description' => '缺少必填参数RecordName，请指定RecordName参数后重试。', + ], + [ + 'code' => 'MissingParameter', + 'message' => 'The specified ArgName is required for this function.', + 'http_code' => 400, + 'description' => '配置特定功能时，缺少必传参数。', + ], + [ + 'code' => 'MissingParameter.ObjectType', + 'message' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + 'http_code' => 400, + 'description' => '请填写ObjectType参数。', + ], + [ + 'code' => 'MissingParamsError', + 'message' => 'Missing required params.', + 'http_code' => 400, + 'description' => '缺少必要的参数', + ], + [ + 'code' => 'MissingSiteId', + 'message' => 'Required parameter SiteId missing. Specify SiteId and try again.', + 'http_code' => 400, + 'description' => '缺少必填参数SiteId，请指定SiteId参数后重试。', + ], + [ + 'code' => 'MissingTimeParameter', + 'message' => 'The StartTime and EndTime must be both specified.', + 'http_code' => 400, + 'description' => '请同时提供开始时间和结束时间。', + ], + [ + 'code' => 'MissingUrlList', + 'message' => 'Enter the URLs you want to prefetch.', + 'http_code' => 400, + 'description' => '预热的URL为空，请输入待预热的URL。', + ], + [ + 'code' => 'MonitorExpectedBodyInvalid', + 'message' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', + 'http_code' => 400, + 'description' => '传入的监视器预期返回值不正确，长度不能大于102400字符，请您确认返回值后重试。', + ], + [ + 'code' => 'MonitorExpectedCodesInvalid', + 'message' => 'Invalid expected status code for the probe.Make sure that you specify no more than 10 status codes in the probe settings, and each status code must be 3 to 4 characters in length.Examples: 200, 301, 3xx, 8000, and 88xx.', + 'http_code' => 400, + 'description' => '传入的监视器预期返回码不合法。请注意：返回码的数量不能超过10个，且每个返回码的长度应不少于3个字符且不超过4个字符。例如：200、301、3xx、8000、88xx。', + ], + [ + 'code' => 'MonitorHeaderInvalid', + 'message' => 'Invalid request header for the probe. You can add up to 10 request headers, each with 1 to 9 values. The combined length of all headers and values cannot exceed 6,000 characters. You cannot configure the User-Agent header.', + 'http_code' => 400, + 'description' => '传入的监视器携带的请求头非法。请确保请求头数量不超过10个，每个请求头的值长度在1到10之间，并且不得使用User-Agent请求头（该请求头保留用于内部特定场景）。此外，所有请求头及其值的总长度不得超过6000个字符。请您检查并修正请求头配置后重试。', + ], + [ + 'code' => 'MonitorMethodNotSupport', + 'message' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', + 'http_code' => 400, + 'description' => '传入的监视器请求方法不支持，只支持以下方法：GET/HEAD。', + ], + [ + 'code' => 'MonitorPathNotSupport', + 'message' => 'Invalid probe URL path.If you set the probe protocol to HTTP or HTTPS, make sure you specify a probe URL path that does not exceed 1,024 characters in length.', + 'http_code' => 400, + 'description' => '传入的监听路径不支持。当监听类型为HTTP或HTTPS时，监听路径不能为空，且路径长度不得超过1024个字符，请您检查路径后重试。', + ], + [ + 'code' => 'MonitorPortNotSupport', + 'message' => 'Invalid probe port. Specify a valid port from 1 to 65535 for the probe request. Then, try again.', + 'http_code' => 400, + 'description' => '传入的监视器监听端口不支持，端口取值范围：[1-65535]，请您确保端口在取值范围内重试。', + ], + [ + 'code' => 'MonitorRetriesInvalid', + 'message' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', + 'http_code' => 400, + 'description' => '传入的监视器重试次数参数不支持，支持的重试次数取值范围为：[0-5]，请确保设置的重试次数在此范围内。', + ], + [ + 'code' => 'MonitorTimeoutInvalid', + 'message' => 'Invalid timeout for the probe. Valid values are 1 to 10.', + 'http_code' => 400, + 'description' => '传入的监视器超时时间超出取值范围，支持以下范围：[1-10]。', + ], + [ + 'code' => 'MonitorTypeNotSupport', + 'message' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', + 'http_code' => 400, + 'description' => '传入的监视器类型不支持，监视器只支持以下类型：off/HTTP/HTTPS/TCP/UDP/ICMP Ping/SMTP。', + ], + [ + 'code' => 'NameAlreadyExists', + 'message' => 'The name already exists.', + 'http_code' => 400, + 'description' => '名称已存在。', + ], + [ + 'code' => 'NameServerNotDelete', + 'message' => 'Before deleting the site, you need to go to your domain name service provider to delete the NS record assigned by ESA for the site (to avoid that you forget to delete NS and other users steal your site).', + 'http_code' => 400, + 'description' => '删除站点前，您需要前往您的域名服务商删除ESA为该站点分配的NS记录（避免您忘记删除NS造成其他用户盗用您的站点）。', + ], + [ + 'code' => 'NestedRuleQuotaCheckFailed', + 'message' => 'The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.', + 'http_code' => 400, + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'code' => 'NoAvaliablePaymentMethod', + 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', + 'http_code' => 400, + 'description' => '没有为您的帐户指定付款方式。我们建议您添加付款方式。', + ], + [ + 'code' => 'NoPermission', + 'message' => 'You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.', + 'http_code' => 400, + 'description' => '对当前资源无权限访问或者操作。请联系您阿里云账户的管理员，以授予您 AliyunESAFullAccess 策略。', + ], + [ + 'code' => 'NoPermission', + 'message' => 'Permission denied.', + 'http_code' => 400, + 'description' => '没有权限', + ], + [ + 'code' => 'NoRealNameAuthentication', + 'message' => 'You have not completed real-name authentication.', + 'http_code' => 400, + 'description' => '您尚未进行实名认证！', + ], + [ + 'code' => 'NotExist.MigratedTask', + 'message' => 'The specified task does not exist.', + 'http_code' => 400, + 'description' => '指定的任务不存在。', + ], + [ + 'code' => 'OperationDenied.DefaultSiteEnvironmentUneditable', + 'message' => 'The rule of the default environment is not allowed to be modified.', + 'http_code' => 400, + 'description' => '默认环境的规则不允许修改。', + ], + [ + 'code' => 'OperationDenied.UnsupportPlan', + 'message' => 'The current plan does not support this operation. Use the correct plan instance to try again.', + 'http_code' => 400, + 'description' => '当前套餐不支持该操作，请使用正确的套餐实例进行重试。', + ], + [ + 'code' => 'OperationDenied.VanityNSUnavailable', + 'message' => 'Only sites in NS access type can use vanity nameservers. Convert your site to NS access type and try again.', + 'http_code' => 400, + 'description' => '仅NS方式接入的站点可以使用自定义NS，请调整您的站点接入方式后重试。', + ], + [ + 'code' => 'Order.InstanceHasUnpaidOrder', + 'message' => 'You have an unpaid order. Complete the payment or cancel the order first.', + 'http_code' => 400, + 'description' => '您购买套餐未支付，请支付或作废后再下单。', + ], + [ + 'code' => 'OriginPoolNameConflict', + 'message' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.', + 'http_code' => 400, + 'description' => '源地址池名称冲突，请确保新名称与现有源地址池及负载均衡器名称均不相同。', + ], + [ + 'code' => 'OriginPoolNotExist', + 'message' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', + 'http_code' => 400, + 'description' => '传入的源地址池不存在，或该地址池不属于当前用户和站点，请您确认后重试。', + ], + [ + 'code' => 'OriginProtectionNotExist', + 'message' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', + 'http_code' => 400, + 'description' => '站点没有配置源站防护，所以不能对其进行修改或删除。', + ], + [ + 'code' => 'Page.BeingBound', + 'message' => 'Failed to delete the custom error page because it has been associated with one or more rules.'."\n" + ."\n" + .'Dissociate all rules from the error page first.', + 'http_code' => 403, + 'description' => '指定的自定义错误页面无法删除，因为它当前正被系统中的一个或多个规则所绑定。在可以删除之前，需要先将错误页面与所有相关的规则解绑。请先审查规则配置，然后解除与错误页面的关联，再尝试删除，以确保系统的一致性和可靠的错误处理。', + ], + [ + 'code' => 'Page.BeingBound', + 'message' => 'The specified custom error page has been associated with one or more protection rules. Dissociate the protection rules and try again.', + 'http_code' => 403, + 'description' => '指定的自定义响应页面正在被一个或多个防护规则绑定，请您解除绑定后重试。', + ], + [ + 'code' => 'Page.NotExist', + 'message' => 'The specified custom error page does not exist or is not recognized by the system.Check whether the error page identifier is correct and matches an error page that has been created and registered in the system\'s error handling framework.If you want to create a new error page, make sure that the creation process is complete.', + 'http_code' => 403, + 'description' => '指定的自定义错误页面不存在，或者未被系统识别。请确保错误页面的标识符是正确的，并且该页面已经被妥善地在系统的错误处理框架中创建和注册。如果打算新增一个错误页面，请验证创建过程是否已成功完成。', + ], + [ + 'code' => 'Page.NotExist', + 'message' => 'The specified error page is not found or not registered. Check the error page identifier and make sure that the page is correctly set up.', + 'http_code' => 403, + 'description' => '指定的错误页面未找到或未注册，请检查页面标识并确认页面已正确设置。', + ], + [ + 'code' => 'ParameterAlreadyExist', + 'message' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', + 'http_code' => 400, + 'description' => '参数唯一性校验失败，请检查重复的参数值。', + ], + [ + 'code' => 'ParameterNotExist', + 'message' => 'The specified parameter does not exist. Check your configurations and try again.', + 'http_code' => 400, + 'description' => '输入参数不存在，请您核对后重试。', + ], + [ + 'code' => 'ParamNameError', + 'message' => 'The Name parameter is invalid.', + 'http_code' => 400, + 'description' => 'Name参数不合法。'."\n", + ], + [ + 'code' => 'PlanNotSupportCnDdos', + 'message' => 'The plan corresponding to the current instance does not include ddos platform protection in mainland China, so the DDOS elastic protection value cannot be set. Please upgrade the package and try again.', + 'http_code' => 400, + 'description' => '当前实例对应的套餐不包含中国大陆地区的ddos平台防护，因此不能设置DDOS弹性防护值，请升级套餐后进行重试。', + ], + [ + 'code' => 'PolicyNameExist', + 'message' => 'The policy name already exists.', + 'http_code' => 400, + 'description' => '策略名称已存在。', + ], + [ + 'code' => 'PolicyNotExist', + 'message' => 'The policy does not exist.', + 'http_code' => 400, + 'description' => '策略不存在。', + ], + [ + 'code' => 'PoolNumberExceedQuotaLimit', + 'message' => 'The number of origin pool you have added has reached the upper limit of the plan quota. Please delete the origin pool that is no longer in use or upgrade the plan and try again.', + 'http_code' => 400, + 'description' => '您添加的源站组数量已经达到套餐的配额上限，请删除不再使用的源站组或者升级套餐后，进行重试。', + ], + [ + 'code' => 'PoolReferenceExist', + 'message' => 'Failed to delete the origin pool because it has been referenced.Remove all references to the pool and try again.', + 'http_code' => 400, + 'description' => '源地址池存在引用，不允许删除。请解除引用关系后重试。', + ], + [ + 'code' => 'PreloadQueueFull', + 'message' => 'The prefetch queue is full. Try again later.', + 'http_code' => 400, + 'description' => '预热队列已满，需要等待队列消化后再重试。', + ], + [ + 'code' => 'PrivateKey.MissingParameter', + 'message' => 'The PrivateKey parameter is required.', + 'http_code' => 400, + 'description' => 'PrivateKey参数缺失。', + ], + [ + 'code' => 'ProjectExist', + 'message' => 'The SLS project has been associated with another account. Check the project name.', + 'http_code' => 200, + 'description' => '该SLS Project已被其他用户绑定，请重新检查项目名称。', + ], + [ + 'code' => 'ProjectNotExist', + 'message' => 'The project does not exist.', + 'http_code' => 404, + 'description' => '未找到对应project 信息。', + ], + [ + 'code' => 'QueryDBError', + 'message' => 'An internal exception occurred when query data, please try again later.', + 'http_code' => 500, + 'description' => '查询数据时发生内部错误，请稍后重试。', + ], + [ + 'code' => 'QueryLog.Timeout', + 'message' => 'The query for standard logs timed out. Try again later.', + 'http_code' => 500, + 'description' => '查询离线日志系统超时，请稍后重试。', + ], + [ + 'code' => 'QuotaCheckFailed', + 'message' => 'Failed to check free certificate Quota, please try again later.', + 'http_code' => 400, + 'description' => '检查免费证书Quota失败，请稍后重试。', + ], + [ + 'code' => 'QuotaCheckFailed.CustomNS', + 'message' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.', + 'http_code' => 400, + 'description' => '当前套餐不支持配置自定义NS，请查看套餐描述，并升级您的套餐。', + ], + [ + 'code' => 'QuotaCheckFailed.Function', + 'message' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', + 'http_code' => 400, + 'description' => '您的套餐不含该功能，请升级套餐或联系商务添加。', + ], + [ + 'code' => 'QuotaCheckFailed.FunctionArg', + 'message' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', + 'http_code' => 400, + 'description' => '该功能参数在当前套餐中不可用，或者数量已超出配额限制。', + ], + [ + 'code' => 'QuotaCheckFailed.Regex', + 'message' => 'Rules engine with regular expressions is not allowed in your plan. Check the plan description and upgrade the plan.', + 'http_code' => 400, + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'code' => 'QuotaCheckFailed.VersionManagement', + 'message' => 'Insufficient quota for version management. Contact technical support.', + 'http_code' => 400, + 'description' => '当前套餐的版本管理配额不足，请联系客服咨询详情。', + ], + [ + 'code' => 'QuotaCheckFailed.VersionManagement', + 'message' => 'The current plan\'s quota of version management is insufficient. Please try to upgrade the plan.', + 'http_code' => 400, + 'description' => '当前套餐的版本管理配额不足，请尝试升级套餐版本。', + ], + [ + 'code' => 'QuotaExceed.NestedConditional', + 'message' => 'The maximum number of conditions in the rule has been reached. Check the plan description and upgrade the plan.', + 'http_code' => 400, + 'description' => '规则内嵌子条件数量超过套餐上限，请查看套餐描述，并升级您的套餐。', + ], + [ + 'code' => 'QuotaExceed.RecordCount', + 'message' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', + 'http_code' => 400, + 'description' => '记录数量已达上限，请删除部分记录后重试或升级套餐。', + ], + [ + 'code' => 'QuotaExceed.SiteCount', + 'message' => 'The maximum number of websites associated with your plan has been reached.', + 'http_code' => 400, + 'description' => '站点数量超出配额限制。', + ], + [ + 'code' => 'QuotaExceed.UploadHttpCert', + 'message' => 'The maximum number of custom certificates has been reached. Delete some and try again or upgrade your plan.', + 'http_code' => 400, + 'description' => '自助上传证书数量已达上限，请删除部分证书后重试或升级套餐。', + ], + [ + 'code' => 'QuotaExceed.WildCardRecord', + 'message' => 'The maximum number of wildcard records has been reached. Delete some and try again.', + 'http_code' => 400, + 'description' => '泛域名记录数量已达上限，请删除部分泛域名记录后重试。', + ], + [ + 'code' => 'QuotaExceed.WildCardRecord', + 'message' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', + 'http_code' => 400, + 'description' => '泛域名记录的数量超限，请联系销售增加额度。', + ], + [ + 'code' => 'QuotaExceed.WildcardRecordCount', + 'message' => 'The number of wildcard records added by your current site has reached the quota limit. Please delete useless wildcard records or upgrade to the plan and try again.', + 'http_code' => 400, + 'description' => '您当前站点添加的泛记录数量已经达到配额上限，请删除无用的泛记录或者升级到套餐后进行重试。', + ], + [ + 'code' => 'QuotaExceeded', + 'message' => 'The quota is exceeded.', + 'http_code' => 403, + 'description' => '额度不足', + ], + [ + 'code' => 'QuotaExceeded', + 'message' => 'You attempts have exceeded the daily limit.', + 'http_code' => 400, + 'description' => '超出当日配额限制。今日提交数量已用完。您可以通过配额接口查询今日的可使用次数。', + ], + [ + 'code' => 'QuotaNotExist', + 'message' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', + 'http_code' => 400, + 'description' => '套餐配额项不存在或购买套餐未生效，请确认后重试。', + ], + [ + 'code' => 'RamAuthFailed', + 'message' => 'The sub-account has no operation permission.', + 'http_code' => 400, + 'description' => '子账号无操作权限.', + ], + [ + 'code' => 'RealTimeLog.BucketRegionError', + 'message' => 'Invalid OSS bucket region. Check the region and try again.', + 'http_code' => 403, + 'description' => '您选择投递的OSS Bucket区域不正确，请重新检查区域地址后重试。', + ], + [ + 'code' => 'RealTimeLog.KafkaBrokersExceedError', + 'message' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', + 'http_code' => 403, + 'description' => '您可投递的实时日志Kafka Broker服务器地址数量超过上限(最高为50个)。', + ], + [ + 'code' => 'RealTimeLog.KafkaConfigError', + 'message' => 'Invalid Kafka information for the delivery task. Check your configurations and try again.', + 'http_code' => 403, + 'description' => '您配置的Kafka投递信息不正确，请检查后重试。', + ], + [ + 'code' => 'RealTimeLog.LogstoreExist', + 'message' => 'The SLS logstore has been created within this project. Check the project name.', + 'http_code' => 403, + 'description' => '在该SLS Project下已存在同名Logstore，请检查Logstore名称。', + ], + [ + 'code' => 'RealTimeLog.NameCheckFail', + 'message' => 'Real-time log name field validity check failed.', + 'http_code' => 403, + 'description' => '您输入的实时日志配置字段包含非法字符，请删除非法字符后重试，允许的字符包含数字、字母、下划线"_"和空格" "', + ], + [ + 'code' => 'RealTimeLog.OssBucketQueryError', + 'message' => 'Failed to query the OSS bucket. Check the bucket name and try again.', + 'http_code' => 403, + 'description' => '查询OSS Bucket失败，请检查Bucket名称后重试。', + ], + [ + 'code' => 'RealTimeLog.OssRoleCheckError', + 'message' => 'You do not have permissions to create a service-linked role for OSS. Contact your Alibaba Cloud account or the permission administrator to attach the AliyunESAFullAccess policy or a custom policy that grants permissions to create a service-linked role to the current user.', + 'http_code' => 403, + 'description' => '您暂无创建OSS服务关联角色的权限，请联系主账号或权限管理员授权当前用户AliyunESA、FullAccess或创建服务关联角色的自定义权限和策略。', + ], + [ + 'code' => 'RealTimeLog.ProjectExistError', + 'message' => 'The real-time log delivery task name already exists. Check the task name and try again.', + 'http_code' => 400, + 'description' => '该实时日志任务名称已存在，请重新检查任务名称后重试。', + ], + [ + 'code' => 'RealTimeLog.RegexpCheckFail', + 'message' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.', + 'http_code' => 403, + 'description' => '您配置的参数字段中包含有非法字符，请检查后重试。', + ], + [ + 'code' => 'RealTimeLog.S3EndpointInvalidError', + 'message' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', + 'http_code' => 403, + 'description' => '您投递的S3地址不正确，请检查投递地址后重试。', + ], + [ + 'code' => 'RealTimeLog.SlrRoleCheckError', + 'message' => 'Your account does not have AliyunServiceRoleForESARealtimeLogPushSLS authorization. Please contact the main account or permission administrator to authorize the current user AliyunServiceRoleForESARealtimeLogPushSLS permission or create custom permissions and policies for service-associated roles.', + 'http_code' => 403, + 'description' => '您的账号没AliyunServiceRoleForESARealtimeLogPushSLS 授权，请联系主账号或权限管理员授权当前用户AliyunServiceRoleForESARealtimeLogPushSLS权限或创建服务关联角色的自定义权限和策略。', + ], + [ + 'code' => 'RealTimeLog.SlsClientError', + 'message' => 'Invalid SLS information. Check whether ProjectName and LogStoreName are correctly configured and whether SLS is activated. Then, try again.', + 'http_code' => 403, + 'description' => '您输入的日志服务信息无效，请检查 ProjectName 和 LogStoreName 是否正确，并确保您的账号已开通日志服务后重试。', + ], + [ + 'code' => 'RealTimeLog.SlsEndpointError', + 'message' => 'Invalid SLS parameters for the delivery task. Check your configurations and try again.', + 'http_code' => 403, + 'description' => '您投递的SLS地址不正确，请检查投递地址后重试。', + ], + [ + 'code' => 'RealTimeLog.SlsLogstoreQueryError', + 'message' => 'Failed to query the Logstore. Check the Logstore name and try again.', + 'http_code' => 403, + 'description' => '查询LogStore失败，请检查LogStore名称后重试。', + ], + [ + 'code' => 'RealTimeLog.SlsNotOpen', + 'message' => 'You have not activated Alibaba Cloud SLS. Activate SLS first.', + 'http_code' => 403, + 'description' => '您尚未开通阿里云SLS服务，请先开通对应的服务。', + ], + [ + 'code' => 'RealTimeLog.SlsProjectExistError', + 'message' => 'The SLS project already exists. Check the project name and try again.', + 'http_code' => 403, + 'description' => '该SLS日志Project已存在，请检查Project名称后重试。', + ], + [ + 'code' => 'RealTimeLog.StatusQuotaError', + 'message' => 'The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'http_code' => 403, + 'description' => '您的实时日志可投递数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多实时日志投递配额。', + ], + [ + 'code' => 'RealtimeLogProjectExistError', + 'message' => 'Realtime-log project name already exist.', + 'http_code' => 400, + 'description' => '实时日志项目名已存在', + ], + [ + 'code' => 'Record.AlreadyExist', + 'message' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'http_code' => 403, + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + [ + 'code' => 'Record.AorAAAARecordValueContainInvalidIP', + 'message' => 'The A/AAAA record value contains the invalid IP.', + 'http_code' => 400, + 'description' => '创建或编辑A/AAAA记录时，记录值包含了无效IP。', + ], + [ + 'code' => 'Record.AorAAAARecordValueContainIPInBlacklist', + 'message' => 'The A/AAAA record value contains the blacklist IP.', + 'http_code' => 400, + 'description' => '创建或编辑A/AAAA记录时，记录值包含黑名单IP。', + ], + [ + 'code' => 'Record.AorAAAARecordValueIPExceedLimit', + 'message' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', + 'http_code' => 400, + 'description' => '创建或编辑A/AAAA记录时，IP数量超限，一个主机记录仅支持8个IPv4和4个IPv6 IP，请调整后重试。', + ], + [ + 'code' => 'Record.CAARecordFlagExceedLimit', + 'message' => 'The value of the flag parameter for a CAA record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，CAA记录的flag参数值超出了范围。', + ], + [ + 'code' => 'Record.CAARecordTagExceedLimit', + 'message' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', + 'http_code' => 400, + 'description' => '创建或编辑CAA记录信息时，Tag值传入了issue、issuewild、iodef以外的非法字符。', + ], + [ + 'code' => 'Record.CERTRecordAlgorithmExceedLimit', + 'message' => 'The value of the algorithm parameter for the CERT record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，CERT记录的algorithm参数值超出了范围。', + ], + [ + 'code' => 'Record.CERTRecordKeyTagExceedLimit', + 'message' => 'The value of the keyTag parameter for a CERT record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，CERT记录的keyTag参数值超出了范围。', + ], + [ + 'code' => 'Record.CERTRecordTypeExceedLimit', + 'message' => 'The CERT record type is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，CERT记录type参数超出了范围。', + ], + [ + 'code' => 'Record.CNameRecordValueCannotEqualExistedIPASource', + 'message' => 'The CNAME record cannot be the origin of the added Layer 4 application. Check the values of other Layer 4 proxy records and try again.', + 'http_code' => 400, + 'description' => 'CNAME记录不能是已经添加的四层应用的源站，请检查其他四层代理记录的记录值并重试。', + ], + [ + 'code' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', + 'message' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', + 'http_code' => 400, + 'description' => 'CNAME记录不能是已经添加的源地址池的源站，请检查后重试。', + ], + [ + 'code' => 'Record.CNameRecordValueCannotEqualExistedRecordSource', + 'message' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.', + 'http_code' => 400, + 'description' => 'CNAME记录不能是已经添加的记录的源站，请检查其他记录的记录值并重试。', + ], + [ + 'code' => 'Record.CNameRecordValueCannotEqualHostRecord', + 'message' => 'The record value of the CNAME record cannot be exactly the same as the host record.', + 'http_code' => 400, + 'description' => 'CNAME记录的记录值不能和主机记录完全一样，请调整后重试。', + ], + [ + 'code' => 'Record.CNameRecordValueCannotEqualOtherExistedIPARecord', + 'message' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.', + 'http_code' => 400, + 'description' => 'CNAME记录的记录值不能与其他已经存在的四层代理记录名完全相同。', + ], + [ + 'code' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', + 'message' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', + 'http_code' => 400, + 'description' => 'CNAME记录的记录值不能与其他已经存在的CNAME记录名完全相同。', + ], + [ + 'code' => 'Record.CNameRecordValueContainSourceInBlacklist', + 'message' => 'The CNAME record value contains the blacklist address. For details, you can submit a work order for consultation.', + 'http_code' => 400, + 'description' => 'CNAME记录值包含黑名单地址，详情可提交工单咨询。', + ], + [ + 'code' => 'Record.CNameRecordValueExceedLimit', + 'message' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', + 'http_code' => 400, + 'description' => '记录值不能超过253个字符，请删减后重试。', + ], + [ + 'code' => 'Record.CNameRecordValueInvalidDomainUnderline', + 'message' => 'Record values (DNS-only records) generally start with an underscore, a lowercase letter a-z, and the numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.', + 'http_code' => 400, + 'description' => '记录值（仅DNS的记录）一般需以下划线 _、小写字母 a-z 、数字 0-9开头。记录中间部分可用小写字母、数字或连字符 -，长度在 0 到 61 个字符之间。', + ], + [ + 'code' => 'Record.CNameRecordValueInvalidRecordDomain', + 'message' => 'Record values (records with agent acceleration enabled) must start with a lowercase letter a-z and numbers 0-9. The middle part of the record can be lowercase letters, numbers, or hyphens, and the length is between 0 and 61 characters.', + 'http_code' => 400, + 'description' => '记录值（开启代理加速的记录）一般需以小写字母 a-z 、数字 0-9开头。记录中间部分可用小写字母、数字或连字符 -，长度在 0 到 61 个字符之间。', + ], + [ + 'code' => 'Record.Conflict', + 'message' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', + 'http_code' => 400, + 'description' => '和已有记录冲突，请根据冲突规则的产品文档调整记录内容。', + ], + [ + 'code' => 'Record.EmptyAorAAAARecordValue', + 'message' => 'The A/AAAA record value is empty, please fill it in correctly and try again.', + 'http_code' => 400, + 'description' => '记录值为空，请正确填写后重试。', + ], + [ + 'code' => 'Record.EmptyCAARecordValue', + 'message' => 'The CAA record value is empty.', + 'http_code' => 400, + 'description' => '创建或编辑CAA记录时，记录值的内为空。', + ], + [ + 'code' => 'Record.EmptyCNameRecordValue', + 'message' => 'The CNAME record value is empty.', + 'http_code' => 400, + 'description' => '创建或编辑CNAME记录时，记录值为空，请正确填写后重试。', + ], + [ + 'code' => 'Record.EmptyMXRecordValue', + 'message' => 'The MX record value cannot be empty.', + 'http_code' => 400, + 'description' => '创建或编辑MX记录时，记录值不能为空。', + ], + [ + 'code' => 'Record.EmptyNSRecordValue', + 'message' => 'The NS record value cannot be empty.', + 'http_code' => 400, + 'description' => '创建或编辑NS记录时，NS记录值不能为空。', + ], + [ + 'code' => 'Record.EmptyRecordValue', + 'message' => 'The record value is empty, please fill it in correctly and try again.', + 'http_code' => 400, + 'description' => '记录值为空，请正确填写后重试。', + ], + [ + 'code' => 'Record.EmptyTXTRecordValue', + 'message' => 'The TXT record value cannot be empty.', + 'http_code' => 400, + 'description' => '创建或编辑TXT记录时，记录值不能为空。', + ], + [ + 'code' => 'Record.InvalidCertEncodeWithCERTRecord', + 'message' => 'The certificate value of the CERT record is not base64-encoded.', + 'http_code' => 400, + 'description' => '创建或编辑CERT记录信息时，CERT记录的证书值不是base64编码后的值。', + ], + [ + 'code' => 'Record.InvalidFingerprintWithSSHFPRecord', + 'message' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', + 'http_code' => 400, + 'description' => '创建或编辑SSHFP记录信息时，指纹fingerprint值不是16进制编码的。', + ], + [ + 'code' => 'Record.InvalidHTTPURLWithCAARecordTag', + 'message' => 'The CAA record is prefixed with http:// or https://, a valid URL must be followed.', + 'http_code' => 400, + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以http://或https://为前缀时，后面必须接一个合法的url地址。', + ], + [ + 'code' => 'Record.InvalidIdoefDataWithCAARecordTag', + 'message' => 'The CAA record Tag value does not start with mailto: or http:// or https.', + 'http_code' => 400, + 'description' => '创建或编辑CAA记录信息时，Tag值不是以mailto: http:// https:// 开头。', + ], + [ + 'code' => 'Record.InvalidIodefDataWithCAARecordTag', + 'message' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', + 'http_code' => 400, + 'description' => '创建或编辑CAA记录信息时，Tag值不能以mailto: http://或者mailto: https:// 开头。', + ], + [ + 'code' => 'Record.InvalidIssueDataWithCAARecordTag', + 'message' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', + 'http_code' => 400, + 'description' => '创建或编辑CAA记录信息时，CAA记录的标签Tag，只能是分号或分号分隔的合法域名。', + ], + [ + 'code' => 'Record.InvalidMailAddressWithCAARecordTag', + 'message' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', + 'http_code' => 400, + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以mailto:为前缀时，后面必须接一个合法的email地址。', + ], + [ + 'code' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', + 'message' => 'The certificate value of the SMIMEA record is not base64-encoded.', + 'http_code' => 400, + 'description' => '创建或编辑SMIMEA记录信息时，SMIMEA记录的证书值不是base64编码后的值。', + ], + [ + 'code' => 'Record.InvalidTslaEncodeWithTSLARecord', + 'message' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', + 'http_code' => 400, + 'description' => '创建或编辑TLSA记录信息时，传入的证书值不是16进制编码的。', + ], + [ + 'code' => 'Record.InvalidURLWithURIRecord', + 'message' => 'The URI record value must be a valid URL address.', + 'http_code' => 400, + 'description' => '创建或编辑URI记录信息时，记录值必须是一个合法的URL地址。', + ], + [ + 'code' => 'Record.MXRecordPriorityExceedLimit', + 'message' => 'The MX record priority parameter value is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，填入的MX记录优先级参数值超出了范围。', + ], + [ + 'code' => 'Record.NoRecordNameConflictWithNSRecord', + 'message' => 'No record name can conflict with an NS record name.', + 'http_code' => 400, + 'description' => '任何记录名不能和NS记录名冲突。', + ], + [ + 'code' => 'Record.NoResource', + 'message' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', + 'http_code' => 400, + 'description' => '为记录分配资源失败，请提工单处理。', + ], + [ + 'code' => 'Record.NotFound', + 'message' => 'The record does not exist. Check your configurations and try again.', + 'http_code' => 404, + 'description' => '传入的请求记录不存在，请检查您的输入参数后重试。', + ], + [ + 'code' => 'Record.NotFound', + 'message' => 'The record does not exist. Modify it and try again.', + 'http_code' => 404, + 'description' => '该记录不存在，请调整后重试。', + ], + [ + 'code' => 'Record.NSRecordCannotEqualSiteName', + 'message' => 'An NS record with the exact same name as the site name is not allowed.', + 'http_code' => 400, + 'description' => '不允许添加和站点名称完全同名的NS记录。', + ], + [ + 'code' => 'Record.OSSSourceInvalidAuthType', + 'message' => 'The recorded OSS origin station authentication type is not supported.', + 'http_code' => 400, + 'description' => '记录的OSS源站鉴权类型不在支持的范围内。', + ], + [ + 'code' => 'Record.ParseJSONRecordValueFailed', + 'message' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', + 'http_code' => 400, + 'description' => '记录值的JSON格式不正确，请调整后重试。', + ], + [ + 'code' => 'Record.PoolSourceNotExistPool', + 'message' => 'If the source station type of the record is source address pool, the input source address pool does not exist.', + 'http_code' => 400, + 'description' => '记录的源站类型为源地址池的情况下，输入的源地址池不存在。', + ], + [ + 'code' => 'Record.RecordMatchingTypeExceedLimit', + 'message' => 'The matchingType parameter value filled in is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，填入的matchingType参数值超出了范围。', + ], + [ + 'code' => 'Record.RecordNameConflictForSpecifiedRecordType', + 'message' => 'The A/AAAA and CNAME records cannot have the same name.', + 'http_code' => 400, + 'description' => 'A/AAAA、CNAME记录之间不能重名。', + ], + [ + 'code' => 'Record.RecordNameConflictWithIPAName', + 'message' => 'The record name cannot have the same name as the Layer 4 proxy record.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，记录名称不能和四层代理记录重名。', + ], + [ + 'code' => 'Record.RecordNameConflictWithLBName', + 'message' => 'The record name cannot be the same as the Server Load Balancer record name.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，记录名称不能与负载均衡记录重名。', + ], + [ + 'code' => 'Record.RecordNameConflictWithNSRecord', + 'message' => 'The NS record name cannot be the same as any other type of record name.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，NS记录名不能和任何其他类型记录名重名。', + ], + [ + 'code' => 'Record.RecordNameConflictWithPoolName', + 'message' => 'The record name cannot be the same as the source address pool record name.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，记录名称不能和源地址池记录名重名。', + ], + [ + 'code' => 'Record.RecordNameConflictWithSameRecordType', + 'message' => 'Record conflict with the same record type, there is a host record with the same name with the same record value.', + 'http_code' => 400, + 'description' => '记录冲突，存在记录值相同的同名主机记录。', + ], + [ + 'code' => 'Record.RecordNameConflictWithSameRecordType', + 'message' => 'Record conflicts with an existing host record that has the same name and value.', + 'http_code' => 400, + 'description' => '记录冲突，存在记录值相同的同名主机记录。', + ], + [ + 'code' => 'Record.RecordNameInBlacklist', + 'message' => 'The record name is in blacklist.', + 'http_code' => 400, + 'description' => '记录名在黑名单中，无法添加。', + ], + [ + 'code' => 'Record.RecordPriorityExceedLimit', + 'message' => 'The record priority parameter value filled in is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，填入的记录优先级参数值超出了范围。', + ], + [ + 'code' => 'Record.RecordSelectorExceedLimit', + 'message' => 'The selector parameter value filled in is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，填入的selector参数值超出了范围。', + ], + [ + 'code' => 'Record.RecordUsageExceedLimit', + 'message' => 'The usage parameter value filled in is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，填入的usage参数值超出了范围。', + ], + [ + 'code' => 'Record.RecordValueContainSourceInBlacklist', + 'message' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', + 'http_code' => 400, + 'description' => '记录值包含黑名单地址，详情可提交工单咨询。', + ], + [ + 'code' => 'Record.RecordWeightExceedLimit', + 'message' => 'The record weight parameter value filled in is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，填入的记录权重参数值超出了范围。', + ], + [ + 'code' => 'Record.Reserved', + 'message' => 'Another operation on the record is in progress. Try again later.', + 'http_code' => 400, + 'description' => '记录操作正在进行中，请稍等重试。', + ], + [ + 'code' => 'Record.S3SourceInvalidAuthRegion', + 'message' => 'The recorded S3 origin belongs to a region that is not in the supported range.', + 'http_code' => 400, + 'description' => '记录的S3源站所属区域不在支持的范围内。', + ], + [ + 'code' => 'Record.S3SourceInvalidAuthType', + 'message' => 'The recorded S3 origin authentication type is not supported.', + 'http_code' => 400, + 'description' => '记录的S3源站鉴权类型不在支持的范围内。', + ], + [ + 'code' => 'Record.S3SourceInvalidAuthVersion', + 'message' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', + 'http_code' => 400, + 'description' => '记录的S3源站的鉴权签名算法版本不在支持的范围内。', + ], + [ + 'code' => 'Record.ServiceBusy', + 'message' => 'The record is being configured. Try again later.', + 'http_code' => 400, + 'description' => '该记录正在配置中，请稍后再试。', + ], + [ + 'code' => 'Record.SMIMEARecordMatchingTypeExceedLimit', + 'message' => 'The matchingType parameter value for a SMIMEA record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，SMIMEA记录的matchingType参数值超出了范围。', + ], + [ + 'code' => 'Record.SMIMEARecordSelectorExceedLimit', + 'message' => 'The selector parameter value for a SMIMEA record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，SMIMEA记录的selector参数值超出了范围。', + ], + [ + 'code' => 'Record.SMIMEARecordUsageExceedLimit', + 'message' => 'The value of the usage parameter for a SMIMEA record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，SMIMEA记录的usage参数值超出了范围。', + ], + [ + 'code' => 'Record.SourceAccessKeyExceedLimit', + 'message' => 'The character length of the AccessKey parameter value for the record source station is out of range.', + 'http_code' => 400, + 'description' => '记录源站的 AccessKey 参数值的字符长度超出了范围。', + ], + [ + 'code' => 'Record.SourceEmptyAK', + 'message' => 'The AccessKey of the account to which the origin site belongs is empty.', + 'http_code' => 400, + 'description' => '记录的源站所属账号的 AccessKey 为空。', + ], + [ + 'code' => 'Record.SourceEmptyAuthConf', + 'message' => 'The authentication information of the origin station is empty.', + 'http_code' => 400, + 'description' => '记录的源站的鉴权信息为空。', + ], + [ + 'code' => 'Record.SourceEmptySecretKey', + 'message' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', + 'http_code' => 400, + 'description' => '记录的源站所属账号的 SecretKey 为空。', + ], + [ + 'code' => 'Record.SourceSecretKeyExceedLimit', + 'message' => 'The character length of the SecretKey parameter value for the record source station is out of range.', + 'http_code' => 400, + 'description' => '记录源站的 SecretKey 参数值的字符长度超出了范围。', + ], + [ + 'code' => 'Record.SRVRecordInvalidRecordName', + 'message' => 'SRV host record name is not valid. The SRV host record name must begin with an underscore (-) followed by a lowercase letter (a-z), a number (0-9), and a hyphen (-), followed by 1 arbitrary character, followed by an underscore (-) and a lowercase letter, number, or hyphen.', + 'http_code' => 400, + 'description' => 'SRV主机记录名称不合法。SRV主机记录名称必须以下划线（-）开头，后跟小写字母（a-z）、数字（0-9）、连字符（-），后接1个任意字符，再跟1个下划线（-）和小写字母、数字或连字符。', + ], + [ + 'code' => 'Record.SRVRecordPortExceedLimit', + 'message' => 'The SRV record port is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，填入的SRV记录端口超出了范围。', + ], + [ + 'code' => 'Record.SRVRecordPriorityExceedLimit', + 'message' => 'The SRV record priority is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，SRV记录优先级超出了范围。', + ], + [ + 'code' => 'Record.SRVRecordWeightExceedLimit', + 'message' => 'The SRV record weight is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，填入的SRV记录权重超出了范围。', + ], + [ + 'code' => 'Record.SSHFPRecordAlgorithmExceedLimit', + 'message' => 'The algorithm parameter value for the SSHFP record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，SSHFP记录的algorithm参数值超出了范围。', + ], + [ + 'code' => 'Record.TLSARecordMatchingTypeExceedLimit', + 'message' => 'The matchingType parameter value for the TLSA record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，TLSA记录的matchingType参数值超出了范围。', + ], + [ + 'code' => 'Record.TLSARecordSelectorExceedLimit', + 'message' => 'The selector parameter value for the TLSA record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，TLSA记录的selector参数值超出了范围。', + ], + [ + 'code' => 'Record.TLSARecordUsageExceedLimit', + 'message' => 'The value of the usage parameter for the TLSA record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，TLSA记录的usage参数值超出了范围。', + ], + [ + 'code' => 'Record.TTLExceedLimit', + 'message' => 'The TTL parameter value for a record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，记录的TTL参数值超出了范围。', + ], + [ + 'code' => 'Record.TXTRecordValueExceedLimit', + 'message' => 'The TXT record value cannot exceed 450 characters.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，TXT记录值不能超过450个字符。', + ], + [ + 'code' => 'Record.TypeExceedLimitWithSSHFPRecord', + 'message' => 'The SSHFP record Type parameter value is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，SSHFP记录Type参数值超出了范围。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', + 'message' => 'Illegal host record name. The host record cannot contain consecutive dot.', + 'http_code' => 400, + 'description' => '主机记录名称非法。主机记录内不能包含连续的点号。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameForbidStarSev', + 'message' => 'Illegal host record name, SRV record name disallowed asterisk.', + 'http_code' => 400, + 'description' => '主机记录名称非法，SRV记录名称禁止使用星号。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameInvalidATChar', + 'message' => 'Illegal host record name. The at symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.', + 'http_code' => 400, + 'description' => '主机记录名称非法。@符号只能出现在主机记录的首位，且后面只能跟.符号，不允许接其他字符串。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', + 'message' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', + 'http_code' => 400, + 'description' => '主机记录名称非法。主机记录值不能以点号、中划线开头或结尾。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameInvalidStartSymbol', + 'message' => 'Illegal host record name. The asterisk is only allowed in the first place of the host record, and only the following dot is allowed after the asterisk.', + 'http_code' => 400, + 'description' => '主机记录名称非法。星号只允许在主机记录首位，并且星号后面只允许跟点。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameInvalidUnderLine', + 'message' => 'The host record name contains an illegal underscore. The underscore can only be supported at the beginning of TXT, CAA, CNAME, NS, and SRV records. Proxy acceleration cannot be enabled and records can only be added in DNS mode.', + 'http_code' => 400, + 'description' => '主机记录名称包含了非法下划线。下划线仅可在TXT、CAA、CNAME、NS、SRV的记录中的开头处支持，且不能开启代理加速，仅能以DNS方式添加记录。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameInvalidUnderLine', + 'message' => 'The host record name contains an illegal underscore. The underscore is only supported at the beginning of the TXT, CNAME, MX, SRV, and NS records. Proxy acceleration cannot be enabled, and records can only be added in the DNS mode.', + 'http_code' => 400, + 'description' => '主机记录名称包含了非法下划线。下划线仅可在TXT、CNAME、MX、SRV、NS的记录中的开头处支持，且不能开启代理加速，仅能以DNS方式添加记录。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameOnlyContainSymbol', + 'message' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.', + 'http_code' => 400, + 'description' => '主机记录值不能以各类符号单独存在，可加入任何小写字母或数字。'."\n", + ], + [ + 'code' => 'Record.UnmatchedRecordNameOnlyContainSynbol', + 'message' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.', + 'http_code' => 400, + 'description' => '主机记录值不能以各类符号单独存在，可加入任何小写字母或数字。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameOnlyRangeChar', + 'message' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, some special characters are supported as valid characters in host records.', + 'http_code' => 400, + 'description' => '主机记录字符非法。主机记录值合法字符仅支持 小写字母a-z、大写字母A-Z、数字0-9、\'-\' 、\'_\' 、\'.\'、\'*\'、\'@\'。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', + 'message' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', + 'http_code' => 400, + 'description' => '主机记录名称非法。用\'.\'号分隔的每段字符数量不能超过63个。', + ], + [ + 'code' => 'Record.UnsupportedSourceType', + 'message' => 'The recorded source station type is not in the supported range.', + 'http_code' => 400, + 'description' => '记录的源站类型不在支持的范围内。', + ], + [ + 'code' => 'Record.UnsupportedType', + 'message' => 'The record type parameter is unsupported.', + 'http_code' => 400, + 'description' => '记录类型错误，请检查记录类型参数。', + ], + [ + 'code' => 'Record.URIRecordPriorityExceedLimit', + 'message' => 'The value of the priority parameter for a URI record is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，URI记录的优先级参数值超出了范围。', + ], + [ + 'code' => 'Record.URIRecordWeightExceedLimit', + 'message' => 'The URI record weight parameter value is out of range.', + 'http_code' => 400, + 'description' => '创建或编辑DNS记录信息时，URI记录权重参数值超出了范围。', + ], + [ + 'code' => 'Record.ValidProxiedForSpecifedRecordType', + 'message' => 'Only A/AAAA and CNAME types support proxy acceleration.', + 'http_code' => 400, + 'description' => '创建或编辑记录时，代理状态开启了代理加速，仅A/AAAA、CNAME类型支持开启代理加速。', + ], + [ + 'code' => 'Record.WildcardConflictForSpecifiedRecordType', + 'message' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.', + 'http_code' => 400, + 'description' => 'A/AAAA,CNAME记录不能同时添加all和星号前缀的记录。', + ], + [ + 'code' => 'Record.WildcartConflictForSpecifiedRecordType', + 'message' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.', + 'http_code' => 400, + 'description' => 'A/AAAA,CNAME记录不能同时添加all和星号前缀的记录。', + ], + [ + 'code' => 'RecordNameInBalckList', + 'message' => 'The record name is in the blacklist.', + 'http_code' => 400, + 'description' => '记录名称在黑名单中。', + ], + [ + 'code' => 'RelatedRecordNumberExceedQuotaLimit', + 'message' => 'The maximum number of records associated with the routine has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'http_code' => 400, + 'description' => '您的函数关联记录数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多的函数关联记录配额数量。', + ], + [ + 'code' => 'RelatedRouteNumberExceedQuotaLimit', + 'message' => 'The maximum number of routes associated with the routine has been reached. Check your plan quota and upgrade the plan to request a quota increase.', + 'http_code' => 400, + 'description' => '您的关联路由数量已达到套餐上限，请查看您的套餐配额，并升级您的套餐获得更多的关联路由配额数量。', + ], + [ + 'code' => 'RelatedSiteNumberExceedQuotaLimit', + 'message' => 'The maximum number of websites that can be associated with the routine has been reached.', + 'http_code' => 400, + 'description' => '函数关联站点数量已经超过系统设定的上限。', + ], + [ + 'code' => 'RequestNotSupported', + 'message' => 'Free certificates cannot be requested for a website that is not in the active state. Activate the website first.', + 'http_code' => 400, + 'description' => '未激活的站点不支持申请免费证书，请先激活站点。', + ], + [ + 'code' => 'RiskControlRejection', + 'message' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', + 'http_code' => 400, + 'description' => '为保护您的账户安全，下单被中止，详情请联系客服。', + ], + [ + 'code' => 'RoutineAlreadyExist', + 'message' => 'The routine name already exists.', + 'http_code' => 400, + 'description' => '输入的函数名已存在，请您重新设置。', + ], + [ + 'code' => 'RoutineCodeVersionStatusNotAvailable', + 'message' => 'The routine code version status not Available. Check the routine code version status and try again.', + 'http_code' => 400, + 'description' => '输入的函数代码版本状态不是Available，不可用于部署。请您核对函数代码版本状态，再重试。', + ], + [ + 'code' => 'RoutineNotExist', + 'message' => 'The routine name does not exist. Check the routine name and try again.', + 'http_code' => 400, + 'description' => '输入的函数名不存在，请您核对函数名，再重试。', + ], + [ + 'code' => 'RoutineNumberExceedQuotaLimit', + 'message' => 'The maximum number of configuration items for the feature has been reached. Adjust your configurations and try again.', + 'http_code' => 400, + 'description' => '当前功能的配置项数量已经超过系统设定的上限，请您调整后重试。', + ], + [ + 'code' => 'RoutineUserServiceStatusHalt', + 'message' => 'Failed to update the configurations because you have overdue payments.', + 'http_code' => 400, + 'description' => '用户处于停机状态，不能进行更新操作。', + ], + [ + 'code' => 'RR307', + 'message' => 'If the credit card verification is not completed, please guide the self-service verification through the mail and in-station letter. Please place an order again after the verification is passed.', + 'http_code' => 400, + 'description' => '未完成信用卡验证，请通过邮件和站内信中引导自助完成验证，验证通过后请重新下单。', + ], + [ + 'code' => 'RR307', + 'message' => 'Credit card verification is not complete. Please follow the guidance in the email and the internal message to complete the verification. Once verified, please place your order again.', + 'http_code' => 400, + 'description' => '未完成信用卡验证，请通过邮件和站内信中引导自助完成验证，通过后请重新下单。', + ], + [ + 'code' => 'RR309', + 'message' => 'The system has detected that your payment method is at risk. Please complete the verification through the link in the email and the in-station letter. Please place the order again after the verification is passed.', + 'http_code' => 400, + 'description' => '系统检测到您的支付方式存在风险，请通过邮件和站内信中的链接完成验证，验证通过后请重新下单。', + ], + [ + 'code' => 'Rule.Config.Malformed', + 'message' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', + 'http_code' => 403, + 'description' => '指定的规则配置格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致，并予以纠正，以符合预期的配置架构。', + ], + [ + 'code' => 'Rule.Config.Noncompliance', + 'message' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', + 'http_code' => 403, + 'description' => '指定的规则配置未满足既定的合规性标准。请检查规则设置，查找任何不符合或违反预期标准的差异，并进行必要的调整，以确保所有规则均得到正确验证。', + ], + [ + 'code' => 'Rule.Name.AlreadyExists', + 'message' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', + 'http_code' => 403, + 'description' => '指定的规则名称在系统配置中已存在，不能重复使用。请选择一个不与现有规则名称冲突的独特规则名称，或在必要时考虑更改现有规则的名称，以消除任何可能的歧义，并确保每个规则标识符的唯一性。', + ], + [ + 'code' => 'Rule.NotExist', + 'message' => 'The specified rule does not exist.', + 'http_code' => 400, + 'description' => '指定的规则在当前上下文或系统配置中不存在。请确认规则标识符的存在，并确保它已被正确定义或实现。', + ], + [ + 'code' => 'Rule.Position.Invalid', + 'message' => 'The specified position for the rule is invalid.Check and adjust the configuration to make sure it meets the requirements.', + 'http_code' => 403, + 'description' => '指定的规则位置无效或超出了可接受范围。请核实规则位置参数，并作出适当更正，以确保符合既定边界或序列要求。', + ], + [ + 'code' => 'RuleCompileError', + 'message' => 'Failed to compile the rule. Check your rule configurations and make sure they are in the valid format as described in the API documentation.', + 'http_code' => 400, + 'description' => '规则编译失败，请检查传入的规则配置，请参考接口文档中描述的规则配置格式。', + ], + [ + 'code' => 'RuleRegexQuotaCheckFailed', + 'message' => 'When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.', + 'http_code' => 400, + 'description' => '当前套餐不支持配置带有正则的规则引擎，请查看套餐描述，并升级您的套餐。', + ], + [ + 'code' => 'Ruleset.Name.AlreadyExists', + 'message' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.', + 'http_code' => 403, + 'description' => '指定的规则集名称在系统的规则管理架构中已存在。请选择一个独一无二的替代名称，以避免重复和与现有规则集潜在的冲突。如果是对现有规则集进行重命名，请确保新名称是独特的，并且不侵犯其他已建立规则集的标识符。', + ], + [ + 'code' => 'Ruleset.NotExist', + 'message' => 'The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system\'s rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect.', + 'http_code' => 403, + 'description' => '指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确，并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体，请确保其创建和注册的必要步骤已经成功执行，以便其可用。', + ], + [ + 'code' => 'SameNameRecordsExceedLimit', + 'message' => 'The maximum number of records with the same name added in one batch exceeds 5. Add records with the same name in batches or reduce the number of records with the same name added in one batch.', + 'http_code' => 400, + 'description' => '您批量添加的最大同名记录数超过了5条，请分批添加同名记录，或者减少批量添加的同名记录数。', + ], + [ + 'code' => 'ScenePolicyQuotaExceedLimit', + 'message' => 'The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.', + 'http_code' => 400, + 'description' => '场景策略配置数量超过上限，每个账号最多支持创建10个场景策略。', + ], + [ + 'code' => 'ServiceInvokeFailed', + 'message' => 'The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.', + 'http_code' => 400, + 'description' => '调用服务失败，请稍后重试或联系客服咨询详情。', + ], + [ + 'code' => 'ServiceNotOpen', + 'message' => 'You have not activated Edge Routine. Activate the service and try again.', + 'http_code' => 400, + 'description' => '您尚未开通边缘函数服务，请开通服务后重试。', + ], + [ + 'code' => 'Site.AlreadyExist', + 'message' => 'The website name you specified already exists. Try with another name.', + 'http_code' => 400, + 'description' => '您输入的站点已存在，请您重新设置。', + ], + [ + 'code' => 'Site.Conflict', + 'message' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', + 'http_code' => 400, + 'description' => '站点冲突，多个账户下存在相同名称的站点，请删除或更名后重试。', + ], + [ + 'code' => 'Site.InBlacklist', + 'message' => 'The site name is in the blacklist.', + 'http_code' => 400, + 'description' => '站点名称在黑名单中。', + ], + [ + 'code' => 'Site.InvalidCoverage', + 'message' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', + 'http_code' => 400, + 'description' => '您选择的加速区域不在当前套餐支持范围内，请更换为套餐支持的加速区域后重试。', + ], + [ + 'code' => 'Site.NotExist', + 'message' => 'The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.', + 'http_code' => 403, + 'description' => '指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + [ + 'code' => 'Site.NotSupportedStatus', + 'message' => 'The current site state is not supported.', + 'http_code' => 400, + 'description' => '当前的站点状态是不支持的。', + ], + [ + 'code' => 'Site.ServiceBusy', + 'message' => 'This website is being configured. Try again later.', + 'http_code' => 400, + 'description' => '该站点正在配置中，请稍后再试。', + ], + [ + 'code' => 'Site.UpdateAccessTypeUnable', + 'message' => 'Failed to change the DNS setup for the website. Check whether the website has configurations or DNS records that are incompatible with the target DNS setup option.', + 'http_code' => 400, + 'description' => '无法更新站点的接入类型，请检查是否有目标接入类型不支持的配置或记录。', + ], + [ + 'code' => 'SiteConfigLengthExceedLimit', + 'message' => 'The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.', + 'http_code' => 400, + 'description' => '站点功能配置大小超出限制，总大小不能超过512K。', + ], + [ + 'code' => 'SiteEnvironment.Conflict', + 'message' => 'The environment name or rule conflicts with an existing environment. Try again with a different environment name or rule.', + 'http_code' => 400, + 'description' => '站点环境名称或规则与已有环境冲突，请使用不同的名称或规则重试。', + ], + [ + 'code' => 'SiteEnvironment.DeleteDenied', + 'message' => 'The default environment cannot be deleted.', + 'http_code' => 400, + 'description' => '默认站点环境无法删除。', + ], + [ + 'code' => 'SiteEnvironment.NotExist', + 'message' => 'The specified environment is invalid or version management is not enabled for your website. Make sure that you specify a valid environment name and version management is enabled. Then, try again.', + 'http_code' => 400, + 'description' => '您输入的站点版本环境无效，或者该站点还未启用版本管理功能。请确认您的版本环境设置无误，并在必要时激活版本管理功能后再试。', + ], + [ + 'code' => 'SiteEnvironment.UpdateDenied', + 'message' => 'Failed to promote a version for the environment. Check whether the current environment has the highest rank and whether the current environment and the next higher-ranked environment have the same version deployed.', + 'http_code' => 400, + 'description' => '站点环境更新被拒绝，请确认您尝试更新的环境是否为优先级最高的环境，且当前环境版本与下一级版本不同。', + ], + [ + 'code' => 'SiteHasTransportLayerApplications', + 'message' => 'The current site has an existing four-layer accelerated application, and the current operation is not allowed. If necessary, please contact customer service.', + 'http_code' => 400, + 'description' => '当前站点有已经存在的四层加速应用，不允许进行当前操作，如有需要，请联系客服。', + ], + [ + 'code' => 'SiteIdDDoSVersionCheckFailed', + 'message' => 'SiteId DDoS version check failed.', + 'http_code' => 403, + 'description' => '站点对应DDoS版本检查失败。', + ], + [ + 'code' => 'SiteNotActivated', + 'message' => 'The site is not activated, the process is not allowed.', + 'http_code' => 400, + 'description' => '站点未激活，不支持该操作。', + ], + [ + 'code' => 'SiteNotFound', + 'message' => 'The specified site is not found.', + 'http_code' => 400, + 'description' => '您指定的站点不存在，请检查输入的站点是否正确。', + ], + [ + 'code' => 'SiteNotFound', + 'message' => 'The website does not exist or does not belong to you.', + 'http_code' => 404, + 'description' => '站点不存在，或者不属于你。', + ], + [ + 'code' => 'SiteParameterNotMatch', + 'message' => 'Failed to verify website parameters.Check the parameters and try again.', + 'http_code' => 400, + 'description' => '输入的站点相关参数校验失败。请检查参数正确性后重试。', + ], + [ + 'code' => 'SiteVerify.Unpassed', + 'message' => 'Domain ownership verification failed. Complete the verification and try again.', + 'http_code' => 200, + 'description' => '站点归属校验未通过，请您确保站点归属权校验通过后重试。', + ], + [ + 'code' => 'SiteVersion.Configuring', + 'message' => 'The version is being configured. Try again later.', + 'http_code' => 400, + 'description' => '当前版本正在配置中，请稍后重试。', + ], + [ + 'code' => 'SiteVersion.DeleteDenied', + 'message' => 'Failed to delete the version because it has been deployed to an environment. Make sure that the version is not deployed to any environment and try again.', + 'http_code' => 400, + 'description' => '当前站点版本已部署在环境中无法进行删除，请您确保当前版本未部署在任何环境后重试。', + ], + [ + 'code' => 'SiteVersion.NotExist', + 'message' => 'The specified version is invalid or version management is not enabled for your website.Make sure that you specify a valid version and version management is enabled. Then, try again.', + 'http_code' => 400, + 'description' => '传入的站点版本无效或当前站点尚未开通版本管理功能。请您检查配置的版本是否正确后重试，若尚未开通版本管理功能请开通后重试。', + ], + [ + 'code' => 'SourceAddressInvalid', + 'message' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', + 'http_code' => 400, + 'description' => '源站地址无效，请检查并确保输入的是正确的IP或域名格式。', + ], + [ + 'code' => 'SourceCircleExist', + 'message' => 'The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.', + 'http_code' => 400, + 'description' => '当前要操作资源的主机记录已经是其他资源的源站，或者当前资源的源站已经被添加为主机记录，为避免回环产生，请修改主机记录或者源站后进行重试。', + ], + [ + 'code' => 'SourceInBlackList', + 'message' => 'The source is in the black list.', + 'http_code' => 400, + 'description' => '源站在黑名单中。', + ], + [ + 'code' => 'SourceNumberExceedLimit', + 'message' => 'The number of sources in the origin pool exceeds the quota limit.', + 'http_code' => 400, + 'description' => '您在源地址池中可创建的源站个数已达到套餐上限，请查看您的套餐配额，并升级套餐以获得更多配额。', + ], + [ + 'code' => 'SourceTypeNotSupport', + 'message' => 'Invalid origin type. Valid values are ip_domain, OSS, FC, and S3.', + 'http_code' => 400, + 'description' => '传入的源站类型不支持，源站类型只支持以下几种：ip_domain、OSS、FC、S3，不支持其它类型。', + ], + [ + 'code' => 'Specification.OverLimit', + 'message' => 'Specifications exceed the limit, paid version can use 50ms, 100ms, free version can only use 5ms.', + 'http_code' => 400, + 'description' => '规格超限，付费版可以使用50ms、100ms，免费版只能使用5ms', + ], + [ + 'code' => 'SpecifiedVersionReadOnly', + 'message' => 'The specified version number is read-only and cannot be modified.', + 'http_code' => 400, + 'description' => '指定的版本号为只读版本, 无法修改版本配置。', + ], + [ + 'code' => 'SubSiteUnavailable', + 'message' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', + 'http_code' => 400, + 'description' => '仅企业版支持以子域名创建站点，请升级您的套餐。', + ], + [ + 'code' => 'SYSTEM.NoSpecificCodeFailed', + 'message' => 'Invalid subscription duration. Check and try again.', + 'http_code' => 400, + 'description' => '您配置的套餐购买周期不正确，请检查后重试。', + ], + [ + 'code' => 'TooManyDimensions', + 'message' => 'Too many query dimensions specified. Delete some and try again.', + 'http_code' => 400, + 'description' => '您配置的数据查询维度过多，请您删除部分查询维度后重试。', + ], + [ + 'code' => 'TooManyRequests', + 'message' => 'Too many requests.Please try again later.', + 'http_code' => 400, + 'description' => '请求过于频繁，请稍后重试。', + ], + [ + 'code' => 'TooManyRequests', + 'message' => 'Too many requests are submitted.', + 'http_code' => 429, + 'description' => '提交太频繁，请稍候再试', + ], + [ + 'code' => 'TooManyRequests', + 'message' => 'System load fluctuates, please try again later.', + 'http_code' => 429, + 'description' => '系统负载波动，请稍候重试。', + ], + [ + 'code' => 'TooQuickRequests', + 'message' => 'Request for putting or deleting keys are frequently submitted.', + 'http_code' => 429, + 'description' => '键值对的修改或者删除操作太频繁。', + ], + [ + 'code' => 'TransportLayerApplicationConflict', + 'message' => 'The Layer -4 accelerated application conflicts with other applications. Check whether the application name and host record conflict with other applications in the site.', + 'http_code' => 400, + 'description' => '您当前操作的四层加速应用与其他应用冲突，请检查应用名、主机记录等是否与该站点下的其他应用冲突。', + ], + [ + 'code' => 'TransportLayerApplicationNotExist', + 'message' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', + 'http_code' => 400, + 'description' => '当前操作的四层加速应用不存在，请修改后重试。', + ], + [ + 'code' => 'TransportLayerRulesExceedLimit', + 'message' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', + 'http_code' => 400, + 'description' => '您配置的转发规则已经超过了最大限制，请删除无用的转发规则后进行重试。', + ], + [ + 'code' => 'TrialService.HasOpened', + 'message' => 'You have already activated the trial service.', + 'http_code' => 400, + 'description' => '您已开通试用服务，不能重复开通。', + ], + [ + 'code' => 'Unauthorized.InvalidParameters', + 'message' => 'The specified authentication parameters are invalid.', + 'http_code' => 403, + 'description' => '鉴权参数输入错误。', + ], + [ + 'code' => 'Unauthorized.InvalidTime', + 'message' => 'The specified authentication time is invalid.', + 'http_code' => 403, + 'description' => '您输入的鉴权时间参数无效，请检查参数值后重试。', + ], + [ + 'code' => 'Unauthorized.InvalidToken', + 'message' => 'Token authentication failed.', + 'http_code' => 403, + 'description' => '您输入的token无效，请检查并输入正确的token后进行重试。', + ], + [ + 'code' => 'UnprocessableEntity', + 'message' => 'Failed to handle your request due to data conflicts or incorrect parameters, such as duplicate IP addresses being specified or parameter configurations remaining unchanged in an update request. Check and adjust your configurations and try again.', + 'http_code' => 422, + 'description' => '您的请求无法处理，可能是数据冲突或参数错误，如IP地址重复、更新参数未变化等，请检查并修正后重试。', + ], + [ + 'code' => 'Unsupported.ConvertRecord', + 'message' => 'Converting site records is not supported in migration tasks.', + 'http_code' => 400, + 'description' => '在迁移任务中，不支持转换站点记录。', + ], + [ + 'code' => 'Unsupported.DomainSourceConvertToRecord', + 'message' => 'Converting the domain sources to a site record is not supported in migration tasks.', + 'http_code' => 400, + 'description' => '不支持将域名基础源站转换到站点记录。', + ], + [ + 'code' => 'UnsupportQuota', + 'message' => 'Unsupported quota is specified. Check and try again.', + 'http_code' => 404, + 'description' => '当前操作不支持该配额，请检查传入的配额是否有效。', + ], + [ + 'code' => 'UpdateErServiceError', + 'message' => 'Failed to change the plan. You are only allowed to change your plan once within 24 hours.', + 'http_code' => 400, + 'description' => '24小时内最多允许修改计费类型一次。', + ], + [ + 'code' => 'UpdateFreeCertificate.NotSupport', + 'message' => 'The free certificate does not support the update operation.', + 'http_code' => 400, + 'description' => '免费证书不支持更新操作。', + ], + [ + 'code' => 'UpdowngradeConfigNoChange', + 'message' => 'Failed to change the configuration because the new configuration you specified is the same as the current one in use. Specify a correct configuration and try again.', + 'http_code' => 400, + 'description' => '升级或降配的配置未改变。', + ], + [ + 'code' => 'UserOperationStatusIsLocked', + 'message' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', + 'http_code' => 400, + 'description' => '您正在调用其他操作函数相关的接口，请等待其他接口调用完成后重试。', + ], + [ + 'code' => 'UserQuantityExceed', + 'message' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', + 'http_code' => 400, + 'description' => '您当前购买数量超过还可购买的数量余量，请重新选择数量！', + ], + [ + 'code' => 'UserWithoutConfLabel', + 'message' => 'Required tags missing. Configure tags and try again.', + 'http_code' => 400, + 'description' => '缺少所需的标签配置，请您配置标签后重试。', + ], + [ + 'code' => 'VerifyExpressionError', + 'message' => 'Dynamic expression is invalid.', + 'http_code' => 400, + 'description' => '动态表达式不合法。', + ], + [ + 'code' => 'VerifyNameServerFailed', + 'message' => 'The NS verification failed. Please configure the NS provided by ESA on the domain name management platform and try again.', + 'http_code' => 400, + 'description' => 'NS校验失败，请您在域名管理平台配置为ESA提供的NS后，再进行重试。', + ], + [ + 'code' => 'VersionNotValid', + 'message' => 'The site does not have version management enabled, or the version number passed in does not exist.', + 'http_code' => 400, + 'description' => '站点没有开启版本管理功能，或者传入的版本号不存在。', + ], + [ + 'code' => 'WaitingRoomEventNotExist', + 'message' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', + 'http_code' => 400, + 'description' => '您要修改的等候室事件不存在，请检查并传入正确的等候室事件。', + ], + [ + 'code' => 'WaitingRoomNotExist', + 'message' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.', + 'http_code' => 400, + 'description' => '您要修改的等候室不存在或不属于您，请确认后重试。', + ], + [ + 'code' => 'WaitingRoomRuleNotExist', + 'message' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', + 'http_code' => 400, + 'description' => '您要修改的等候室绕过规则不存在，请检查并传入正确的等候室绕过规则。', + ], + [ + 'code' => 'WildcardRecordsExceedLimit', + 'message' => 'The number of pan records currently added has exceeded the system limit. If you want to add more pan records, please contact the background with a work order.', + 'http_code' => 400, + 'description' => '当前添加的泛记录的数量已经超过系统限制，若想添加更多的泛记录，请提工单联系后台。', + ], + [ + 'code' => 'GitAccountNotExist', + 'message' => 'Git account does not exist.', + 'http_code' => 400, + 'description' => 'Git账号不存在。', + ], + [ + 'code' => 'InvalidRoutineBuildTaskStatus', + 'message' => 'Routine build configuration state that does not exist.', + 'http_code' => 400, + 'description' => '不存在的Routine构建配置状态。', + ], + [ + 'code' => 'RoutineInstanceNotExist', + 'message' => 'The Routine instance does not exist.', + 'http_code' => 400, + 'description' => 'Routine的实例不存在。', + ], + [ + 'code' => 'GitAccountAuthExpired', + 'message' => 'Git account authorization expired.', + 'http_code' => 400, + 'description' => 'Git账号授权过期。', + ], + [ + 'code' => 'GitAccountAlreadyExist', + 'message' => 'The Git account already exists and cannot be created repeatedly.', + 'http_code' => 400, + 'description' => 'Git账号已经存在，不允许重复创建。', + ], + [ + 'code' => 'GitAccountNotActive', + 'message' => 'Git account is not active.', + 'http_code' => 400, + 'description' => 'Git账号不是激活状态。', + ], + [ + 'code' => 'RoutineNotExist', + 'message' => 'Routine does not exist.', + 'http_code' => 400, + 'description' => 'Routine不存在。', + ], + [ + 'code' => 'RoutineBuildTaskNotExist', + 'message' => 'Routine build task does not exist.', + 'http_code' => 400, + 'description' => 'Routine构建任务不存在。', + ], + [ + 'code' => 'IllegalNodeVersion', + 'message' => 'NodeVersion parameter is illegal.', + 'http_code' => 400, + 'description' => 'NodeVersion参数不合法。', + ], + [ + 'code' => 'RoutineBuildConfigurationNotExist', + 'message' => 'Routine build configuration does not exist.', + 'http_code' => 400, + 'description' => 'Routine构建配置不存在。', + ], + [ + 'code' => 'RoutineBuildConfigurationExist', + 'message' => 'Routine build configuration already exists.', + 'http_code' => 400, + 'description' => 'Routine构建配置已经存在。', + ], + [ + 'code' => 'RoutineBuildTaskNotBuilding', + 'message' => 'The state of the Routine build task is not building.', + 'http_code' => 400, + 'description' => 'Routine构建任务的状态不是构建中。', + ], + [ + 'code' => 'GitAccountExceedQuota', + 'message' => 'The number of Git accounts exceeds the quota limit. A user can only associate up to 20 Git accounts.', + 'http_code' => 400, + 'description' => 'Git账号个数超出quota限制，一个用户下，最多只能关联20个git账号。', + ], + [ + 'code' => 'EnvironmentVariableKeyValueTooLong', + 'message' => 'The key/value length in the EnvironmentVariable parameter exceeds the limit. The length of a single key is not greater than 100, and the length of a single value is not greater than 200.', + 'http_code' => 400, + 'description' => 'EnvironmentVariable参数里的key/value长度超出限制，单个key的长度不大于100，单个value的长度不大于200。', + ], + [ + 'code' => 'EnvironmentExceedLimit', + 'message' => 'The environment variable parameter exceeds the limit, and the number of keys and values exceeds the limit.', + 'http_code' => 400, + 'description' => '环境变量参数超出限制，key、value的个数超出了限制。', + ], + [ + 'code' => 'RepositoryExceedLimit', + 'message' => 'One code repository can only be associated with up to 10 Routine build configurations.', + 'http_code' => 400, + 'description' => '一个代码仓库最多只能关联到10个Routine构建配置里。', + ], + [ + 'code' => 'CanNotOpenCrossBorderOptimization', + 'message' => 'Can not open cross border optimization.', + 'http_code' => 400, + 'description' => '不可以开通中国大陆网络接入优化。', + ], + [ + 'code' => 'CustomHostname.ConflictWithExistingResource', + 'message' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.', + 'http_code' => 400, + 'description' => '自定义主机名和已有资源冲突，例如站点、记录、负载均衡器、源地址池、自定义主机名和四层代理等', + ], + [ + 'code' => 'QuotaExceed.CustomHostname', + 'message' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.', + 'http_code' => 400, + 'description' => '自定义主机名的数量超限，请联系销售增加额度。', + ], + [ + 'code' => 'CustomHostname.InvalidICP', + 'message' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', + 'http_code' => 400, + 'description' => '您配置的自定义主机名未备案或ICP备案信息不合法，请确保站点已完成备案后重试。', + ], + [ + 'code' => 'CustomHostname.VerifyUnpassed', + 'message' => 'The custom hostname ownership verification failed. Complete the verification and try again.', + 'http_code' => 200, + 'description' => '自定义主机名归属校验未通过，请您确保自定义主机名归属权校验通过后重试。', + ], + [ + 'code' => 'Record.SourceOfExistingCustomHostnames', + 'message' => 'Failed to delete the record because it is the source of existing custom hostnames.Remove all references to the record and try again.', + 'http_code' => 400, + 'description' => '该记录是已有自定义主机名的源站，不允许删除。请解除引用关系后重试。', + ], + [ + 'code' => 'CustomHostname.NotFound', + 'message' => 'The custom hostname does not exist. Modify it and try again.', + 'http_code' => 404, + 'description' => '该自定义主机名不存在，请调整后重试。', + ], + [ + 'code' => 'Record.ProtectedAsCustomHostnameSource', + 'message' => 'Failed to delete the record because it is the origin server of existing custom hostnames.Remove all references to the record and try again.', + 'http_code' => 400, + 'description' => '该记录是已有自定义主机名的源站，不允许删除。请移除所有对该记录的引用后重试。', + ], + [ + 'code' => 'Record.ProxiedAsCustomHostnameSource', + 'message' => 'Failed to disable proxy the record because it is the origin server of existing custom hostnames.Remove all references to the record and try again.', + 'http_code' => 400, + 'description' => '该记录是已有自定义主机名的源站，不允许关闭代理。请移除所有对该记录的引用后重试。', + ], + [ + 'code' => 'Record.TypeProtectedAsCustomHostnameSource', + 'message' => 'Failed to update the record type because it is the origin server of existing custom hostnames. The record can only be updated to CNAME or A/AAAA types. Alternatively, remove all references to the record and try again.', + 'http_code' => 400, + 'description' => '该记录是已有自定义主机名的源站，不允许修改为除CNAME和A/AAAA外的其他记录类型。请移除所有对该记录的引用后重试。', + ], + [ + 'code' => 'CustomHostname.ServiceBusy', + 'message' => 'The custom hostname is being configured. Try again later.', + 'http_code' => 400, + 'description' => '该自定义主机名正在配置中，请稍后再试。', + ], + [ + 'code' => 'InvalidParameter.Domains', + 'message' => 'The maximum number of domain names specified by parameter Domains has been reached. Adjust your configurations and try again. The upper limit of lets encrypt type domain name is 50, the upper limit of digicert single type domain name is 1, and the upper limit of digicert wildcard type domain name is 1.', + 'http_code' => 400, + 'description' => 'Domains参数中包含的域名数超过配额，请重新指定后重试。lets_encrypt类型域名上限为50，digicert_single类型域名上限为1，digicert_wildcard类型域名上限为1。', + ], + [ + 'code' => 'FunctionArgConflict.OriginProtection', + 'message' => 'The automatic enabling of the latest back-to-source IP list and the back-to-source convergence are mutually exclusive functions and cannot be enabled at the same time.', + 'http_code' => 400, + 'description' => '源站防护的自动启用最新回源 IP 列表与回源收敛是两个互斥的功能，无法同时开启。', + ], + [ + 'code' => 'ForbidUpdateSite.ConfigurationsUnclosed', + 'message' => 'If there are unclosed configurations, please close them before migrating.', + 'http_code' => 400, + 'description' => '有未关闭的配置，请关闭后再迁移。', + ], + [ + 'code' => 'ForbidUpdateSite.PlanUnallowed', + 'message' => 'Site migration between preset plans and customized enterprise plans is not supported.', + 'http_code' => 400, + 'description' => '官网套餐和企业套餐内站点暂不支持互相迁移。', + ], + [ + 'code' => 'SiteFunction.WafPageNotExist', + 'message' => 'The custom page referenced in the custom response code configuration does not exist.', + 'http_code' => 400, + 'description' => '自定义响应码配置中引用的自定义页面不存在。', + ], + [ + 'code' => 'InvalidParameter_SchemaId', + 'message' => 'The parameter SchemaId is invalid.', + 'http_code' => 400, + 'description' => '入参SchemaId不合法。', + ], + [ + 'code' => 'InvalidParameter_IdentifierId', + 'message' => 'The parameter Identified is invalid.', + 'http_code' => 400, + 'description' => '请求入参Identified不合法', + ], + [ + 'code' => 'InvalidParameter_SchemaNotFound', + 'message' => 'The parameter schemaId conf not found.', + 'http_code' => 400, + 'description' => '入参schemaId对应的schema配置未找到', + ], + [ + 'code' => 'InvalidParameter.ApiShieldQuota', + 'message' => 'This site does not have permission to manipulate API security features.', + 'http_code' => 400, + 'description' => '该站点没有操作API安全功能的权限', + ], + [ + 'code' => 'InvalidParameter.RuleName', + 'message' => 'The parameter RuleName is invalid.', + 'http_code' => 400, + 'description' => '入参RuleName不合法。', + ], + [ + 'code' => 'InvalidParameter.EndpointIds', + 'message' => 'The parameter EndpointIds is invalid.', + 'http_code' => 400, + 'description' => '入参EndpointIds不合法。', + ], + [ + 'code' => 'InvalidParameter.TokenConfigs', + 'message' => 'The parameter TokenConfigs is invalid.', + 'http_code' => 400, + 'description' => '入参TokenConfigs不合法。', + ], + [ + 'code' => 'InvalidParameter.TokenConfigs.Tag', + 'message' => 'The parameter TokenConfigs.Tag is invalid.', + 'http_code' => 400, + 'description' => '入参TokenConfigs数组内部Tag字段不合法。', + ], + [ + 'code' => 'InvalidParameter.RuleId', + 'message' => 'The parameter RuleId is invalid.', + 'http_code' => 400, + 'description' => '参数错误，规则id不合法', + ], + [ + 'code' => 'InvalidParameter.IdentifierId', + 'message' => 'The parameter IdentifierId is invalid.', + 'http_code' => 400, + 'description' => '参数IdentifierId不合法。', + ], + [ + 'code' => 'SameNameRecordExceedLimit', + 'message' => 'The number of records with the same name exceeds the upper limit.', + 'http_code' => 400, + 'description' => '同名称的记录数量超过上限。', + ], + [ + 'code' => 'InvalidParameter.RuleAction', + 'message' => 'The parameter RuleAction is invalid.', + 'http_code' => 400, + 'description' => '入参RuleAction不合法。', + ], + [ + 'code' => 'InvalidParameter.TokenValidateType', + 'message' => 'The parameter TokenValidateType is invalid.', + 'http_code' => 400, + 'description' => '入参TokenValidateType不合法。', + ], + [ + 'code' => 'InvalidParameter.TokenName', + 'message' => 'The parameter TokenName is invalid.', + 'http_code' => 400, + 'description' => '入参TokenName不合法。', + ], + [ + 'code' => 'InvalidParameter.ManagedApi.StateCanNotChanged', + 'message' => 'The status of the managed API is not allowed to be modified.', + 'http_code' => 400, + 'description' => '已管理API的状态不允许修改。', + ], + [ + 'code' => 'InvalidParameter.TokenNameExists', + 'message' => 'The parameter TokenName already exists.', + 'http_code' => 400, + 'description' => '入参TokenName已存在', + ], + [ + 'code' => 'InvalidParameter.Identifier.Quota', + 'message' => 'The session identifier quota for the corresponding tier at the request site is insufficient.', + 'http_code' => 400, + 'description' => '请求站点对应套餐的会话标识符配额不足。', + ], + [ + 'code' => 'InvalidParameter.Credentials.Alg', + 'message' => 'The internal Alg field of the input parameter Credentials is invalid.', + 'http_code' => 400, + 'description' => '入参Credentials内部Alg字段不合法。', + ], + [ + 'code' => 'InvalidParameter.TokenUsed', + 'message' => 'The parameter TokenId token configuration is in use.', + 'http_code' => 400, + 'description' => '入参TokenId令牌配置正在被使用。', + ], + [ + 'code' => 'InvalidParameter.ManagedApi.Quota', + 'message' => 'The management API quota of the corresponding package of the request site exceeds the limit.', + 'http_code' => 400, + 'description' => '请求站点对应套餐的管理API额度超限。', + ], + [ + 'code' => 'InvalidParameter.Position', + 'message' => 'The parameter Position is invalid.', + 'http_code' => 400, + 'description' => '入参Position不合法。', + ], + [ + 'code' => 'InvalidParameter.TokenId', + 'message' => 'The parameter TokenId is invalid.', + 'http_code' => 400, + 'description' => '入参TokenId不合法。', + ], + [ + 'code' => 'InvalidParameter.Credentials', + 'message' => 'The parameter Credentials is invalid.', + 'http_code' => 400, + 'description' => '入参Credentials不合法。', + ], + [ + 'code' => 'InvalidParameter.Credentials.KidRepeat', + 'message' => 'The internal field Kid of the input parameter Credentials is duplicate.', + 'http_code' => 400, + 'description' => '入参Credentials内部字段Kid重复', + ], + [ + 'code' => 'InvalidParameter.Credentials.Kid', + 'message' => 'The internal field Kid of the input parameter Credentials is configured to be empty.', + 'http_code' => 400, + 'description' => '请求入参Credentials内部字段Kid配置为空', + ], + [ + 'code' => 'InvalidParameter.TokenSources.Repeated', + 'message' => 'The input parameter TokenSources internal field configuration is duplicate.', + 'http_code' => 400, + 'description' => '请求入参TokenSources内部字段配置重复', + ], + [ + 'code' => 'InvalidParameter.TokenSources.Empty', + 'message' => 'The internal field of the input TokenSources is invalid.', + 'http_code' => 400, + 'description' => '入参TokenSources内部字段不合法。', + ], + [ + 'code' => 'InvalidParameter.TokenSources', + 'message' => 'The parameter TokenSources is invalid.', + 'http_code' => 400, + 'description' => '入参TokenSources不合法。', + ], + [ + 'code' => 'InvalidParameter.TokenType', + 'message' => 'The parameter TokenType is invalid.', + 'http_code' => 400, + 'description' => '入参TokenType不合法。', + ], + [ + 'code' => 'InvalidParameter.SourceIpInBlacklist', + 'message' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'http_code' => 400, + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'code' => 'InvalidParameter.PrivateIpAsSourceUnsupported', + 'message' => 'The provided source is an invalid private IP address. Please verify and resubmit.', + 'http_code' => 400, + 'description' => '您输入的地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'code' => 'InvalidParameter.PrivateIpAsSourceUnsupported', + 'message' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', + 'http_code' => 400, + 'description' => '您输入的源服务器地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'code' => 'InvalidParameter.SourceIpInBlacklist', + 'message' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', + 'http_code' => 400, + 'description' => '您输入的源服务器地址为无效的内网地址，请检查修改后重新提交。', + ], + [ + 'code' => 'InvalidParameter.ManagedApi.NotChanged', + 'message' => 'The status of the managed API is not allowed to be modified.', + 'http_code' => 400, + 'description' => '已管理API的状态不允许修改。', + ], + [ + 'code' => 'InvalidParameter.ManagedApi.Quota', + 'message' => 'The API management quota of the corresponding package of the request site is insufficient.', + 'http_code' => 400, + 'description' => '请求站点对应套餐的API管理数量配额不足。', + ], + [ + 'code' => 'InvalidParameter.Position', + 'message' => 'The input parameter Position is invalid.', + 'http_code' => 400, + 'description' => '请求入参Position不合法。', + ], + [ + 'code' => 'InvalidParameter.ApiActions', + 'message' => 'The input parameter ApiActions is invalid.', + 'http_code' => 400, + 'description' => '入参ApiActions不合法。', + ], + [ + 'code' => 'InvalidParameter.ApiRule.Quota', + 'message' => 'The API rule quota of the corresponding package of the request site is insufficient.', + 'http_code' => 400, + 'description' => '请求站点对应套餐的API规则配额不足。', + ], + [ + 'code' => 'InvalidParameter.RuleNameExists', + 'message' => 'The input parameter RuleName is duplicated.', + 'http_code' => 400, + 'description' => '入参RuleName名称重复', + ], + [ + 'code' => 'InvalidParameter.Token.Quota', + 'message' => 'The session token quota for the corresponding tier at the request site is insufficient.', + 'http_code' => 400, + 'description' => '请求站点对应套餐的令牌配额不足。', + ], + [ + 'code' => 'AmountExceed.Entranceplan', + 'message' => 'The parameter Amount exceeds the number of entrance plan that can be purchased.', + 'http_code' => 400, + 'description' => '参数Amount超过可购买免费版数量。', + ], + [ + 'code' => 'FreePlanOrderUnpaid', + 'message' => 'Please complete your pending order for the free plan.', + 'http_code' => 400, + 'description' => '您有未支付免费套餐订单，请支付后再新购。', + ], + [ + 'code' => 'QuotaExceed.FreePlan', + 'message' => 'Your account has reached the maximum allowed quota for free plan purchases.', + 'http_code' => 400, + 'description' => '免费套餐可购数量Quota不足。', + ], + [ + 'code' => 'Record.UnmatchedRecordNameOnlyRangeChars', + 'message' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, some special characters are supported as valid characters in host records.', + 'http_code' => 400, + 'description' => '主机记录字符非法。主机记录值合法字符仅支持小写字母a-z、大写字母A-Z、数字0-9、\'-\' 、\'_\' 、\'.\'、\'*\'、\'@\'。'."\n", + ], + [ + 'code' => 'Record.InvalidHTTPURLValueWithCAARecordTag', + 'message' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', + 'http_code' => 400, + 'description' => '创建或编辑CAA记录信息时，当Tag是iodef且Value是以http://或https://为前缀时，后面必须接一个合法的URL地址。'."\n", + ], + [ + 'code' => 'IPA.FunctionConflict', + 'message' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization are conflict, can not open at same time.', + 'http_code' => 400, + 'description' => '连接保持防护功能与静态IP和中国大陆网络接入优化功能冲突，不能同时开启。', + ], + [ + 'code' => 'IPA.CanNotEnableKeepAliveProtection', + 'message' => 'Both domestic and overseas DDoS protection must be set to a level higher than basic protection.', + 'http_code' => 400, + 'description' => '中国大陆及非中国大陆的DDoS防护规格不能为基础防护。', + ], + [ + 'code' => 'Site.HasIpaEnableKeepAliveProtection', + 'message' => 'The site has one or more IPA apps with keep-alive-protection enabled, so it cannot update the coverage or the instance.', + 'http_code' => 400, + 'description' => '站点下有四层代理应用开启了连接保持防护，不允许站点切换加速区域或切换套餐。', + ], + [ + 'code' => 'Instance.HasIpaEnableKeepAliveProtection', + 'message' => 'The site associated with this instance has one or more IPA apps with keep-alive-protection enabled. Both domestic and overseas DDoS protection cannot be disabled.', + 'http_code' => 400, + 'description' => '该DDoS实例关联的站点下有四层代理应用开启了连接保持防护，故不允许关闭中国大陆及非中国大陆的DDoS防护。', + ], + [ + 'code' => 'IPA.KeepAliveProtectionConflict', + 'message' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time.', + 'http_code' => 400, + 'description' => '连接保持防护功能与静态IP和中国大陆网络接入优化功能冲突，不能同时开启。', + ], + [ + 'code' => 'PlanOrderUnpaid', + 'message' => 'You have an unpaid ESA order. Please complete or void the order at the User Center before placing another order.', + 'http_code' => 400, + 'description' => '您有未支付的ESA订单，请在费用中心支付或作废后再下单。', + ], + [ + 'code' => 'InvalidParameter.ApiShieldSellVerison', + 'message' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', + 'http_code' => 400, + 'description' => '该站点没有操作API安全功能企业级能力相关权限。', + ], + [ + 'code' => 'SiteHasCrossBorderOptimization', + 'message' => 'Chinese Mainland Network is enabled for this site. Please disable Chinese Mainland Network and try again.', + 'http_code' => 400, + 'description' => '该站点开启了中国大陆网络加速，请关闭中国大陆网络加速后重试。', + ], + [ + 'code' => 'LoadBalancer.NameInvalid', + 'message' => 'The name of the Server Load Balancer instance is a valid domain name or belongs to the site. Check that it is correct and try again.', + 'http_code' => 400, + 'description' => '负载均衡实例的名称是合法的域名或属于站点，请检查正确后重试。', + ], + [ + 'code' => 'SiteHasCustomPorts', + 'message' => 'Custom ports is enabled for this site. Please disable custom ports and try again.', + 'http_code' => 400, + 'description' => '该站点下有记录开启了自定义端口，请关闭自定义端口后重试。', + ], + [ + 'code' => 'FunctionArgError', + 'message' => 'Failed to check the configured function parameters.', + 'http_code' => 400, + 'description' => '配置的功能参数检查失败', + ], + [ + 'code' => 'ERBuildTast.NotExist', + 'message' => 'The ER build task does not exist or does not match the user, please check that it is correct and try again.', + 'http_code' => 400, + 'description' => 'ER构建任务不存在或与用户不匹配，请检查正确后重试。', + ], + [ + 'code' => 'OriginPool.TypeNotSupport', + 'message' => 'The origin address pool type is not supported.', + 'http_code' => 400, + 'description' => '源地址池类型不支持。', + ], + [ + 'code' => 'Site.NotActive', + 'message' => 'The status of the applied site or site is not activated.', + 'http_code' => 400, + 'description' => '应用的站点或站点的状态不是已激活。', + ], + [ + 'code' => 'CustomHostname.ApplyCertFailed', + 'message' => 'Fail to apply a free cert for custom hostname. Please try again later.', + 'http_code' => 400, + 'description' => '申请自定义主机名的免费证书失败，请稍后重试。', + ], + [ + 'code' => 'CustomHostname.SetCertFailed', + 'message' => 'Fail to deploy a cert for custom hostname. Please try again later.', + 'http_code' => 400, + 'description' => '自定义主机名的证书部署失败，请稍后重试。', + ], + [ + 'code' => 'ConfigNotFound', + 'message' => 'The specified configuration does not exist.', + 'http_code' => 400, + 'description' => '指定的配置不存在。', + ], + [ + 'code' => 'ERBuildTask.NotExist', + 'message' => 'The ER build task does not exist or does not match the user, please check that it is correct and try again.', + 'http_code' => 400, + 'description' => 'ER构建任务不存在或与用户不匹配，请检查正确后重试。', + ], + [ + 'code' => 'QuotaCheckFailed.CustomPort', + 'message' => 'The current package does not support configuring custom ports. Please check the package description and upgrade your package.', + 'http_code' => 400, + 'description' => '当前套餐不支持配置自定义端口，请查看套餐描述，并升级您的套餐。', + ], + [ + 'code' => 'CustomHostname.CheckQuotaFailed', + 'message' => 'Fail to check quota for custom hostname. Please try again later.', + 'http_code' => 400, + 'description' => '检查站点的自定义主机名配额失败，请稍后重试。', + ], + [ + 'code' => 'InvalidParameter.Port', + 'message' => 'Invalid port. Enter a valid port as required by the interface documentation.', + 'http_code' => 400, + 'description' => '无效的端口，请按照接口文档的要求，传入合法的端口。', + ], + [ + 'code' => 'CustomHostname.OfflineForMultiReason', + 'message' => 'Unable to activate the custom hostname because it is offline due to multiple reasons.', + 'http_code' => 400, + 'description' => '该自定义主机名因多种原因下线，因此无法激活。', + ], + [ + 'code' => 'Site.QuotaFull', + 'message' => 'The instance site count quota is full.', + 'http_code' => 400, + 'description' => '实例站点数量配额已满。', + ], + [ + 'code' => 'InvalidParameter.RecordPortExceedLimit', + 'message' => 'The number of recorded ports exceeds the limit, including 80 or 443 ports, and supports a maximum of 21 ports. Please adjust and try again.', + 'http_code' => 400, + 'description' => '记录端口数超限，包含80或443端口，最多支持21个端口，请调整后重试。', + ], + [ + 'code' => 'CustomHostname.QueryCasCertFailed', + 'message' => 'Fail to query CAS certificate details. Please try again later.', + 'http_code' => 400, + 'description' => '查询云盾证书详情失败，请稍后重试。', + ], + [ + 'code' => 'CustomHostname.WildcardDomainRequireEnterprisePlan', + 'message' => 'Wildcard custom hostnames require an Enterprise plan.', + 'http_code' => 400, + 'description' => '只有企业版套餐才能添加泛域名SaaS域名，请升级套餐后重试。', + ], + [ + 'code' => 'SiteOrVersion.NotExist', + 'message' => 'The specified website or website version does not exist or is not recognized by the system. Check whether the specified website or website version identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website or website version, make sure that the creation and registration process is complete to integrate the website to the system.', + 'http_code' => 400, + 'description' => '指定的站点或站点版本不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点或站点版本相匹配。如果该站点或站点版本是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。', + ], + [ + 'code' => 'Ato.ApiAsset.NotExist', + 'message' => 'The specified ATO API asset does not exist.', + 'http_code' => 400, + 'description' => '指定的账号安全 API 资产在当前上下文或系统配置中不存在。请确认 API 资产标识符的存在，并确保它已被正确定义或实现。', + ], + [ + 'code' => 'Ato.ProtectionStrategy.NotExist', + 'message' => 'The specified ATO protection strategy does not exist.', + 'http_code' => 400, + 'description' => '指定的账号安全防护策略在当前上下文或系统配置中不存在。请确认防护策略标识符的存在，并确保它已被正确定义或实现。', + ], + [ + 'code' => 'Ato.ProtectionStrategy.BeingBound', + 'message' => 'The specified ATO protection strategy is being bound.', + 'http_code' => 400, + 'description' => '指定的账号安全防护策略正在被一个或多个防护规则绑定。', + ], + ], + 'changeSet' => [ + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'SetClientCertificateHostnames', + ], + ], + 'createdAt' => '2025-03-13T09:11:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'ListScheduledPreloadJobs', + ], + ], + 'createdAt' => '2025-03-13T08:02:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BlockObject', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'PreloadCaches', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'PurgeCaches', + ], + ], + 'createdAt' => '2025-03-13T07:59:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'GetClientCaCertificate', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'GetClientCertificate', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListClientCaCertificates', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListClientCertificates', + ], + ], + 'createdAt' => '2025-03-12T03:31:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdateCustomScenePolicy', + ], + ], + 'createdAt' => '2025-03-12T02:37:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'CreateSiteDeliveryTask', + ], + ], + 'createdAt' => '2025-02-28T07:45:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateOriginRule', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'GetOriginRule', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListOriginRules', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdateOriginRule', + ], + ], + 'createdAt' => '2025-02-27T09:17:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'GetWafFilter', + ], + ], + 'createdAt' => '2025-02-27T08:45:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteOriginProtection', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateOriginProtection', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateOriginProtectionIpWhiteList', + ], + ], + 'createdAt' => '2025-02-21T06:59:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdateWaitingRoomEvent', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdateWaitingRoomRule', + ], + ], + 'createdAt' => '2025-02-21T03:41:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'DeleteWaitingRoomEvent', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'DeleteWaitingRoomRule', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListCacheReserveInstances', + ], + ], + 'createdAt' => '2025-02-21T03:26:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'PurchaseRatePlan', + ], + ], + 'createdAt' => '2025-02-20T05:45:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'DescribeCustomScenePolicies', + ], + ], + 'createdAt' => '2025-02-19T08:09:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BatchCreateRecords', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateRecord', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'GetSite', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListSites', + ], + ], + 'createdAt' => '2025-02-18T05:59:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'SetCertificate', + ], + ], + 'createdAt' => '2025-02-13T01:37:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateLoadBalancer', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListLoadBalancers', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdateLoadBalancer', + ], + ], + 'createdAt' => '2025-02-13T01:35:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateCompressionRule', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'GetCompressionRule', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListCompressionRules', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdateCompressionRule', + ], + ], + 'createdAt' => '2025-02-12T02:26:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'CreateWaitingRoom', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'CreateWaitingRoomEvent', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'CreateWaitingRoomRule', + ], + [ + 'description' => '请求参数发生变更、响应参数发生变更', + 'api' => 'ListUserRatePlanInstances', + ], + ], + 'createdAt' => '2025-02-12T02:01:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'DescribePurgeTasks', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'GetPurgeQuota', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'PurgeCaches', + ], + ], + 'createdAt' => '2025-02-10T01:56:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateLoadBalancer', + ], + ], + 'createdAt' => '2025-02-10T01:26:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteSite', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListUserRatePlanInstances', + ], + ], + 'createdAt' => '2025-01-10T01:52:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'ListPages', + ], + ], + 'createdAt' => '2025-01-09T06:25:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'SetCertificate', + ], + ], + 'createdAt' => '2025-01-09T05:45:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'ListManagedRulesGroups', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdatePage', + ], + ], + 'createdAt' => '2024-12-26T15:08:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateUserDeliveryTask', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'GetUserDeliveryTask', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdateUserDeliveryTask', + ], + ], + 'createdAt' => '2024-12-26T08:22:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'GetOriginProtection', + ], + ], + 'createdAt' => '2024-12-24T01:43:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'EditSiteWafSettings', + ], + ], + 'createdAt' => '2024-12-19T09:11:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'GetSiteWafSettings', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'ListWafRules', + ], + ], + 'createdAt' => '2024-12-12T06:19:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'PurgeCaches', + ], + ], + 'createdAt' => '2024-12-06T02:12:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CommitRoutineStagingCode', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateRoutine', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateRoutineRelatedRecord', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateRoutineRelatedRoute', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'DeleteRoutine', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'DeleteRoutineCodeVersion', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'DeleteRoutineRelatedRecord', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'DeleteRoutineRelatedRoute', + ], + [ + 'description' => '请求参数发生变更、响应参数发生变更', + 'api' => 'GetRoutine', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'GetRoutineStagingCodeUploadInfo', + ], + ], + 'createdAt' => '2024-12-04T05:50:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更、响应参数发生变更', + 'api' => 'CreateSiteFunction', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListSiteFunctions', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'UpdateSiteFunction', + ], + ], + 'createdAt' => '2024-12-04T02:33:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更、响应参数发生变更', + 'api' => 'ListSites', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'ListUserRatePlanInstances', + ], + ], + 'createdAt' => '2024-11-28T06:42:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'GetKv', + ], + ], + 'createdAt' => '2024-11-26T03:44:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'DescribeDDoSAllEventList', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DescribeHttpDDoSAttackIntelligentProtection', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DescribeHttpDDoSAttackProtection', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'SetHttpDDoSAttackIntelligentProtection', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'SetHttpDDoSAttackProtection', + ], + ], + 'createdAt' => '2024-11-19T03:36:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'ListRecords', + ], + ], + 'createdAt' => '2024-11-19T01:42:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'ListWafManagedRules', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'ListWafTemplateRules', + ], + ], + 'createdAt' => '2024-11-12T07:31:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'BatchCreateRecords', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListUserRatePlanInstances', + ], + ], + 'createdAt' => '2024-11-12T05:58:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateScheduledPreloadExecutions', + ], + ], + 'createdAt' => '2024-11-12T03:12:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '响应参数发生变更', + 'api' => 'GetEdgeContainerAppVersion', + ], + [ + 'description' => '响应参数发生变更', + 'api' => 'ListEdgeContainerAppVersions', + ], + ], + 'createdAt' => '2024-11-12T02:07:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'CommitRoutineStagingCode', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateRoutine', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateRoutineRelatedRecord', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateRoutineRelatedRoute', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteRoutine', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteRoutineCodeVersion', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteRoutineRelatedRecord', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteRoutineRelatedRoute', + ], + ], + 'createdAt' => '2024-11-05T06:55:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'CreateRecord', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateSiteAccessType', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateSiteVanityNS', + ], + ], + 'createdAt' => '2024-11-05T03:28:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'CheckUserProjectName', + ], + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'CreateSiteDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateUserDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteSiteDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteUserDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetUserDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListUserDeliveryTasks', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateSiteDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateUserDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateUserDeliveryTaskStatus', + ], + ], + 'createdAt' => '2024-10-18T01:07:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'ListInstanceQuotas', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListInstanceQuotasWithUsage', + ], + ], + 'createdAt' => '2024-10-15T09:24:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateSiteCoverage', + ], + ], + 'createdAt' => '2024-10-15T05:53:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'ListEdgeContainerApps', + ], + ], + 'createdAt' => '2024-10-15T03:49:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'SetCertificate', + ], + ], + 'createdAt' => '2024-10-15T03:45:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'PreloadCaches', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'PurgeCaches', + ], + ], + 'createdAt' => '2024-10-15T01:59:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BatchCreateRecords', + ], + ], + 'createdAt' => '2024-10-11T06:14:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'CreateRecord', + ], + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'UpdateRecord', + ], + ], + 'createdAt' => '2024-10-10T12:01:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'ListInstanceQuotasWithUsage', + ], + ], + 'createdAt' => '2024-10-10T07:17:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'CreateSite', + ], + ], + 'createdAt' => '2024-10-10T02:02:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'CreateSite', + ], + ], + 'createdAt' => '2024-10-08T03:27:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'SetCertificate', + ], + ], + 'createdAt' => '2024-10-03T13:49:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更、响应参数发生变更', + 'api' => 'ListManagedRulesGroups', + ], + ], + 'createdAt' => '2024-09-29T05:47:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'CheckSiteProjectName', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CheckUserProjectName', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateSiteCustomLog', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateSiteDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateUserDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteSiteDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteUserDeliveryTask', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetRealtimeDeliveryField', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetSiteCustomLog', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetSiteDeliveryTask', + ], + ], + 'createdAt' => '2024-09-27T05:57:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BatchCreateWafRules', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'BatchGetExpressionFields', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'BatchUpdateWafRules', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateList', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreatePage', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateWafRule', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteList', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeletePage', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteWafRule', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'DeleteWafRuleset', + ], + ], + 'createdAt' => '2024-09-25T07:03:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'ListLists', + ], + ], + 'createdAt' => '2024-09-25T07:02:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateSiteCoverage', + ], + ], + 'createdAt' => '2024-09-24T09:14:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateSiteDeliveryTask', + ], + [ + 'description' => '请求参数发生变更', + 'api' => 'CreateUserDeliveryTask', + ], + ], + 'createdAt' => '2024-09-24T08:32:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BatchCreateRecords', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateRecord', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateRecord', + ], + ], + 'createdAt' => '2024-09-24T08:28:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BlockObject', + ], + ], + 'createdAt' => '2024-09-24T06:04:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'CreateRecord', + ], + [ + 'description' => '错误码发生变更、响应参数发生变更', + 'api' => 'GetRecord', + ], + [ + 'description' => '错误码发生变更、响应参数发生变更', + 'api' => 'ListRecords', + ], + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'UpdateRecord', + ], + ], + 'createdAt' => '2024-09-23T08:54:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更、请求参数发生变更', + 'api' => 'ListSites', + ], + ], + 'createdAt' => '2024-09-23T07:17:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BatchUpdateWafRules', + ], + ], + 'createdAt' => '2024-09-23T06:20:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'ActivateClientCertificate', + ], + ], + 'createdAt' => '2024-09-23T02:16:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BatchDeleteKv', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'BatchDeleteKvWithHighCapacity', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'BatchPutKv', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'BatchPutKvWithHighCapacity', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetKvNamespace', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListKvs', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'PutKv', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'PutKvAccount', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'PutKvWithHighCapacity', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateKvNamespace', + ], + ], + 'createdAt' => '2024-09-20T13:50:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'CreateList', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreateManagedRulesGroup', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'CreatePage', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'SetCertificate', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'UpdateList', + ], + ], + 'createdAt' => '2024-09-18T09:54:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'CheckSiteName', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'EditSiteWafSettings', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ExportRecords', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetList', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetManagedRulesGroup', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetSite', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetSiteCurrentNS', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetSiteWafSettings', + ], + ], + 'createdAt' => '2024-09-18T08:57:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'GetWafBotAppKey', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetWafFilter', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetWafQuota', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'GetWafRuleset', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListEdgeContainerAppRecords', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListEdgeContainerRecords', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListEdgeRoutineRecords', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListLists', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListManagedRulesGroups', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListPages', + ], + ], + 'createdAt' => '2024-09-18T08:07:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'BatchCreateRecords', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'BatchCreateWafRules', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'BatchGetExpressionFields', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'BatchUpdateWafRules', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListTagResources', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListWafPhases', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListWafRulesets', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListWafTemplateRules', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListWafUsageOfRules', + ], + [ + 'description' => '错误码发生变更', + 'api' => 'ListWaitingRoomEvents', + ], + ], + 'createdAt' => '2024-09-18T06:14:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => '错误码发生变更', + 'api' => 'SetCertificate', + ], + ], + 'createdAt' => '2024-09-06T06:59:23.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateLoadBalancer', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateEdgeContainerAppResourceReserve', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppStatus', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeRoutinePlans', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CheckUserProjectName', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PurchaseCacheReserve', + ], + [ + 'threshold' => '2', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PutKvWithHighCapacity', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListPages', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UntagResources', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerTerminal', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteImageTransform', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRedirectRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCacheReserveInstances', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateUrlObservation', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListInstanceQuotasWithUsage', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWafRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateList', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSeoBypass', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRecord', + ], + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRoutine', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRoutineRoutes', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWafRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListScheduledPreloadJobs', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWaitingRoom', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteHttpRequestHeaderModificationRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafRulesets', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListLists', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateKvNamespace', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeContainerAppRecords', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ActivateClientCertificate', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteKv', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListSites', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteCacheRule', + ], + [ + 'threshold' => '50', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PutKv', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCacheRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRatePlanSpec', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCrossBorderOptimization', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdatePage', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateHttpResponseHeaderModificationRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCertificates', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteEdgeContainerAppVersion', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCompressionRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateDevelopmentMode', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginPool', + ], + [ + 'threshold' => '50', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListESAIPInfo', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListLoadBalancerOriginStatus', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWafRuleset', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginProtection', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetHttpRequestHeaderModificationRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteCoverage', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteCustomLog', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateOriginProtection', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PurchaseRatePlan', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRecord', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCnameFlattening', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteSite', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetList', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadOriginClientCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppVersion', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginClientCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteNameExclusive', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetNetworkOptimization', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateImageTransform', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeRoutineRecords', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PurgeCaches', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetPage', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateHttpsApplicationConfiguration', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRoutineRoute', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafFilter', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BlockObject', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListNetworkOptimizations', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUserRoutines', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRoutineCodeVersion', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteClientCertificate', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRoutineRelatedRecords', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateUserDeliveryTaskStatus', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateUrlObservation', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateTieredCache', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafRuleset', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetClientCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteScheduledPreloadExecution', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetClientCaCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'TagResources', + ], + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRoutine', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ApplyCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetScheduledPreloadJob', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteNetworkOptimization', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCacheTag', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchGetExpressionFields', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'EnableCustomScenePolicy', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetTieredCache', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCertificateQuota', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListOriginPools', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCompressionRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeactivateVersionManagement', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListInstanceQuotas', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetIPv6', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWaitingRoomEvents', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUrlObservations', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteDeliveryTask', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateUserDeliveryTask', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteSiteOriginClientCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWaitingRooms', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafQuota', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerStagingDeployStatus', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCacheReserveSpec', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetKvNamespace', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StopScheduledPreloadExecution', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeKvAccountStatus', + ], + [ + 'threshold' => '10', + 'countWindow' => 10, + 'regionId' => '*', + 'api' => 'DescribeSiteTopData', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CheckSiteName', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetHttpDDoSAttackProtection', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'VerifySite', + ], + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchCreateRecords', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListHttpResponseHeaderModificationRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetUserLogDeliveryQuota', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUserRatePlanInstances', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteAccessType', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteEdgeContainerApp', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSitePause', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CheckSiteProjectName', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateHttpResponseHeaderModificationRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRewriteUrlRules', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginClientCertificateHostnames', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginCaCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateImageTransform', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUploadTasks', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListKvs', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateOriginPool', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateOriginPool', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteDeliveryTaskStatus', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginProtection', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeRatePlanInstanceStatus', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWaitingRoomEvent', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateSiteCustomLog', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginCaCertificate', + ], + [ + 'threshold' => '-1', + 'countWindow' => 1, + 'regionId' => '*', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWafRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RevokeClientCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateSite', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribePreloadTasks', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSeoBypass', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ResetScheduledPreloadJob', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCacheReserveSpecification', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSiteVanityNS', + ], + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchDeleteKvWithHighCapacity', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteList', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafManagedRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteCurrentNS', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DisableCustomScenePolicy', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWaitingRoomEvent', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteCustomLog', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteHttpsBasicConfiguration', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppResourceStatus', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCompressionRule', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetKvAccount', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListHttpsApplicationConfigurations', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeletePage', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerDeployRegions', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteHttpResponseHeaderModificationRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateNetworkOptimization', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteSiteDeliveryTask', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateLoadBalancer', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListClientCertificates', + ], + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchDeleteKv', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteWafSettings', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRealtimeDeliveryField', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateNetworkOptimization', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWaitingRoom', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateClientCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetWafBotAppKey', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRewriteUrlRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRedirectRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetHttpsApplicationConfiguration', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadSiteOriginClientCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSite', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDDoSBpsList', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteLoadBalancer', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ActivateVersionManagement', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateEdgeContainerAppLogRiver', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateHttpRequestHeaderModificationRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListSiteDeliveryTasks', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRewriteUrlRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteUserDeliveryTask', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWaitingRoomRule', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppResourceReserve', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWaitingRoomEvent', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateSiteDeliveryTask', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteScheduledPreloadJob', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeEdgeContainerAppStats', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeUrlObservationData', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteNameExclusive', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRecords', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCacheRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWaitingRoom', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetClientCertificateHostnames', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCnameFlattening', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateOriginRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteLogDeliveryQuota', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateCompressionRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetLoadBalancer', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadClientCaCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListLoadBalancerRegions', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateEdgeContainerAppVersion', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerAppLogRiver', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteKvNamespace', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDDoSL7QpsList', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetErService', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListScheduledPreloadExecutions', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetUserDeliveryTask', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteClientCaCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateHttpsBasicConfiguration', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafTemplateRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCrossBorderOptimization', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListOriginClientCertificates', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateManagedTransform', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRewriteUrlRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetPurgeQuota', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PublishEdgeContainerAppVersion', + ], + [ + 'threshold' => '50', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetKv', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListHttpsBasicConfigurations', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateHttpRequestHeaderModificationRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeHttpDDoSAttackIntelligentProtection', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetCacheTag', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRoutineRoute', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetDevelopmentMode', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteDeliveryTask', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeContainerAppVersions', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetClientCertificateHostnames', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteEdgeContainerAppRecord', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'PreloadCaches', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateEdgeContainerApp', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ExportRecords', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetHttpResponseHeaderModificationRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadFile', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeContainerApps', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateWaitingRoomRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateIPv6', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteCompressionRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateCustomScenePolicy', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRedirectRule', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginClientCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListTagResources', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRedirectRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RebuildEdgeContainerAppStagingEnv', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteCustomScenePolicy', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWaitingRoomRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCertificatesByRecord', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRoutineRoute', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetSiteOriginClientCertificate', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListOriginCaCertificates', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListUserDeliveryTasks', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateOriginProtection', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateUserDeliveryTask', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateRoutineRoute', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListHttpRequestHeaderModificationRules', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UploadOriginCaCertificate', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchUpdateWafRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeDDoSAllEventList', + ], + [ + 'threshold' => '10', + 'countWindow' => 10, + 'regionId' => '*', + 'api' => 'DescribeSiteTimeSeriesData', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListOriginRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateHttpsApplicationConfiguration', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRoutine', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetUploadTask', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCustomScenePolicy', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateWafRuleset', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteOriginRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'EditSiteWafSettings', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListClientCaCertificates', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListManagedRulesGroups', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'RollbackEdgeContainerAppVersion', + ], + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchPutKvWithHighCapacity', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateScheduledPreloadExecutions', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreatePage', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListImageTransforms', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWaitingRoomRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateEdgeContainerAppRecord', + ], + [ + 'threshold' => '10', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateRecord', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateList', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeCustomScenePolicies', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetManagedTransform', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateScheduledPreloadExecution', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteHttpsApplicationConfiguration', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafPhases', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetOriginPool', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetImageTransform', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListWafUsageOfRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerApp', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListCiphers', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetHttpDDoSAttackIntelligentProtection', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'StartScheduledPreloadExecution', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribeHttpDDoSAttackProtection', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DescribePurgeTasks', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateScheduledPreloadJob', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListLoadBalancers', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListSiteRoutes', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateSitePause', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetHttpsBasicConfiguration', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateCacheRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'OpenErService', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateCacheRule', + ], + [ + 'threshold' => '1', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchPutKv', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetEdgeContainerLogs', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListRoutineCodeVersions', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRecord', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteRedirectRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateHttpsBasicConfiguration', + ], + [ + 'threshold' => '20', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'SetOriginClientCertificateHostnames', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteUrlObservation', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateOriginRule', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'DeleteWafRuleset', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'BatchCreateWafRules', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'ListEdgeContainerRecords', + ], + [ + 'threshold' => '5', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'UpdateOriginProtectionIpWhiteList', + ], + [ + 'threshold' => '30', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'GetRewriteUrlRule', + ], + ], + ], + 'ram' => [ + 'productCode' => 'ESA', + 'productName' => '边缘安全加速', + 'ramCodes' => [ + 'esa', + ], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CreateWafRuleset', + 'description' => '创建WAF规则集', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWafRuleset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateWaitingRoomEvent', + 'description' => '创建等候室事件', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWaitingRoomEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateEdgeContainerAppRecord', + 'description' => '创建边缘容器应用的关联域名', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateEdgeContainerAppRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListTransportLayerApplications', + 'description' => '查询站点的四层加速应用列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListTransportLayerApplications', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UploadOriginClientCertificate', + 'description' => '上传域名粒度回源客户端证书', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CommitRoutineStagingCode', + 'description' => '提交边缘函数测试版本代码', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CommitRoutineStagingCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateWaitingRoomRule', + 'description' => '创建等候室绕过规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWaitingRoomRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListCacheRules', + 'description' => '查询站点缓存配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCacheRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetNetworkOptimization', + 'description' => '查询站点网络优化配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetNetworkOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHttpDDoSAttackIntelligentProtection', + 'description' => '查询HTTP DDoS深度学习和防护配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeHttpDDoSAttackIntelligentProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListHttpsApplicationConfigurations', + 'description' => '查询HTTPS应用配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListHttpsApplicationConfigurations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteOriginRule', + 'description' => '删除站点回源规则配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateHttpIncomingRequestHeaderModificationRule', + 'description' => '更新修改HTTP入站请求头配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpIncomingRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetRealtimeDeliveryField', + 'description' => '获取实时日志字段列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRealtimeDeliveryField', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSiteAccessType', + 'description' => '修改站点接入方式', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteAccessType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetCacheReserveSpecification', + 'description' => '查询可购买的缓存保持规格', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCacheReserveSpecification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeRatePlanInstanceStatus', + 'description' => '查询套餐实例状态', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:DescribeRatePlanInstanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSiteTopData', + 'description' => '查询流量分析Top数据', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeSiteTopData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateSiteDeliveryTask', + 'description' => '新建实时日志投递任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateSiteDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetSitePause', + 'description' => '查询站点暂停配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSitePause', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListUserDeliveryTasks', + 'description' => '查询用户任务投递列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUserDeliveryTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteHttpDDoSIntelligentRule', + 'description' => '删除深度学习和防护下发的规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpDDoSIntelligentRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteCertificate', + 'description' => '删除站点证书', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'RebuildEdgeContainerAppStagingEnv', + 'description' => '重建边缘容器应用的测试环境', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:RebuildEdgeContainerAppStagingEnv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerLogs', + 'description' => '获取边缘容器日志信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListCiphers', + 'description' => '查询密码套件列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCiphers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetUserLogDeliveryQuota', + 'description' => '获取实时日志投递配额', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetUserLogDeliveryQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerTerminal', + 'description' => '获取边缘容器应用终端信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerTerminal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateOriginProtectionIpWhiteList', + 'description' => '确认更新站点回源IP白名单到最新版本', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateOriginProtectionIpWhiteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListRewriteUrlRules', + 'description' => '查询站点的重写URL配置列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListRewriteUrlRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetSeoBypass', + 'description' => '查询站点放行搜索引擎爬虫配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSeoBypass', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteVideoProcessing', + 'description' => '删除站点视频处理配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteVideoProcessing', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateWaitingRoom', + 'description' => '创建等候室', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWaitingRoom', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteUrlObservation', + 'description' => '删除网页监测配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteUrlObservation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateSiteCustomLog', + 'description' => '创建站点自定义日志字段', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateSiteCustomLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteEdgeContainerAppRecord', + 'description' => '删除某个边缘容器应用的关联域名', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteEdgeContainerAppRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerAppLogRiver', + 'description' => '获取边缘容器日志采集配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppLogRiver', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CheckSiteProjectName', + 'description' => '实时日志任务投递名检查', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CheckSiteProjectName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SetHttpDDoSAttackIntelligentProtection', + 'description' => '设置HTTP DDoS深度学习和防护配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:SetHttpDDoSAttackIntelligentProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListEdgeRoutineRecords', + 'description' => '查询边缘路由记录列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListEdgeRoutineRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListPages', + 'description' => '列举自定义响应页面', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListPages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHttpDDoSAttackProtection', + 'description' => '查询HTTP DDoS攻击防护配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeHttpDDoSAttackProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateHttpsApplicationConfiguration', + 'description' => '添加站点HTTPS应用配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpsApplicationConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetOriginCaCertificate', + 'description' => '获取源服务器CA证书信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDDoSL7QpsList', + 'description' => '查询DDoS应用层时间维度聚合统计信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeDDoSL7QpsList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListUploadTasks', + 'description' => '列出文件上传任务', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUploadTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteRedirectRule', + 'description' => '删除重定向配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRedirectRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'SetOriginClientCertificateHostnames', + 'description' => '为域名粒度回源客户端证书绑定域名', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:SetOriginClientCertificateHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateList', + 'description' => '创建自定义列表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteWaitingRoomRule', + 'description' => '删除等候室绕过规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWaitingRoomRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListWafUsageOfRules', + 'description' => '列举WAF规则的使用情况', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafUsageOfRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetCrossBorderOptimization', + 'description' => '查询站点中国大陆网络接入优化配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCrossBorderOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteHttpIncomingRequestHeaderModificationRule', + 'description' => '删除修改HTTP入站请求头配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpIncomingRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ActivateVersionManagement', + 'description' => '开启站点版本管理', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:ActivateVersionManagement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteRewriteUrlRule', + 'description' => '删除重写URL配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRewriteUrlRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCustomScenePolicy', + 'description' => '修改定制场景策略', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:UpdateCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateRoutineConfigDescription', + 'description' => '修改边缘函数描述', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateRoutineConfigDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateRatePlanSpec', + 'description' => '套餐变配', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UpdateRatePlanSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteOriginClientCertificate', + 'description' => '删除域名粒度回源客户端证书', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateHttpRequestHeaderModificationRule', + 'description' => '创建修改HTTP请求头配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ActivateClientCertificate', + 'description' => '激活客户端证书', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:ActivateClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListLoadBalancerOriginStatus', + 'description' => '查询负载均衡器下源站状态', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListLoadBalancerOriginStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetHttpIncomingRequestHeaderModificationRule', + 'description' => '查询修改HTTP入站请求头配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpIncomingRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetRewriteUrlRule', + 'description' => '查询重写URL配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetRewriteUrlRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListRedirectRules', + 'description' => '查询重定向配置列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListRedirectRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeactivateVersionManagement', + 'description' => '关闭站点版本管理', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:DeactivateVersionManagement', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetHttpResponseHeaderModificationRule', + 'description' => '查询修改HTTP响应头配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListSiteOriginClientCertificates', + 'description' => 'ListSiteOriginClientCertificates', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListSiteOriginClientCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeletePage', + 'description' => '删除自定义响应页面', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeletePage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListCertificates', + 'description' => '查询站点证书列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteScheduledPreloadJob', + 'description' => '删除指定定时预热任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteScheduledPreloadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SetClientCertificateHostnames', + 'description' => '设置客户端证书域名绑定', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:SetClientCertificateHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteList', + 'description' => '删除自定义列表', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'VerifyCustomHostname', + 'description' => '校验 SaaS 域名归属', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:VerifyCustomHostname', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteUserDeliveryTask', + 'description' => '删除用户投递任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteUserDeliveryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCrossBorderOptimization', + 'description' => '修改站点中国大陆网络接入优化配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCrossBorderOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListCertificatesByRecord', + 'description' => '查询匹配记录的站点证书列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListCertificatesByRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteWaitingRoomEvent', + 'description' => '删除等候室事件', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWaitingRoomEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'PurchaseCacheReserve', + 'description' => '购买缓存保持实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:PurchaseCacheReserve', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRecord', + 'description' => '创建解析记录', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSiteCustomLog', + 'description' => '修改站点自定义日志字段', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteCustomLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetManagedTransform', + 'description' => '查询站点托管转换配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetManagedTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCacheTag', + 'description' => '修改站点缓存标签配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCacheTag', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateUserDeliveryTask', + 'description' => '创建用户粒度日志投递任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateUserDeliveryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteLoadBalancer', + 'description' => '删除负载均衡器', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteLoadBalancer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateUserWafRuleset', + 'description' => '创建用户WAF规则集', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateUserWafRuleset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetWafRule', + 'description' => '获取单个WAF规则详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateVideoProcessing', + 'description' => '新增站点视频处理配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateVideoProcessing', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListSiteDeliveryTasks', + 'description' => '列出全部实时日志任务投递', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListSiteDeliveryTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetApiSchemaUsage', + 'description' => '获取架构验证上传文件套餐配额用量信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetApiSchemaUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CheckSiteName', + 'description' => '校验站点名称是否可用', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CheckSiteName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListVideoProcessings', + 'description' => '查询站点视频处理配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListVideoProcessings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateUrlObservation', + 'description' => '更新网页监测配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateUrlObservation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'EnableCustomScenePolicy', + 'description' => '启用定制场景策略', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:EnableCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteKvNamespace', + 'description' => '删除KV存储空间', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteKvNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListClientCaCertificates', + 'description' => '获取客户端CA证书列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListClientCaCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateHttpIncomingResponseHeaderModificationRule', + 'description' => '创建修改HTTP入站响应头配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpIncomingResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateCustomResponseCodeRule', + 'description' => '创建修改响应码配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateCustomResponseCodeRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetDevelopmentMode', + 'description' => '查询站点开发模式配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetDevelopmentMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListKvs', + 'description' => '列出KV存储空间的键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListKvs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetWafBotAppKey', + 'description' => '获取WAF中BOT阶段的APP key', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafBotAppKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateHttpRequestHeaderModificationRule', + 'description' => '更新修改HTTP请求头配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteEdgeContainerAppVersion', + 'description' => '删除边缘容器应用的指定版本', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetKvDetail', + 'description' => '查询键值对的值和TTL信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetKvDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateManagedTransform', + 'description' => '修改站点托管转换配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateManagedTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetTransportLayerApplication', + 'description' => '查询四层加速应用', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetTransportLayerApplication', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSeoBypass', + 'description' => '修改站点放行搜索引擎爬虫配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateSeoBypass', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateWafRule', + 'description' => '创建WAF规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateWafRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListEdgeContainerApps', + 'description' => '获取边缘容器应用列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListWafManagedRules', + 'description' => '列举WAF托管规则', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafManagedRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'PurgeCaches', + 'description' => '刷新节点缓存', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:PurgeCaches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateOriginProtection', + 'description' => '修改源站防护功能', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateOriginProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateEdgeContainerApp', + 'description' => '创建边缘容器的应用', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateEdgeContainerApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetRoutineStagingCodeUploadInfo', + 'description' => '获取上传边缘函数测试代码上传信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRoutineStagingCodeUploadInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'BatchPutKv', + 'description' => '批量设置KV存储空间的键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:BatchPutKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListImageTransforms', + 'description' => '查询多条站点图片转换配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListImageTransforms', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateHttpResponseHeaderModificationRule', + 'description' => '创建修改HTTP响应头配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateTransportLayerApplication', + 'description' => '更新四层加速应用', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateTransportLayerApplication', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCnameFlattening', + 'description' => '修改站点CNAME拉平配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCnameFlattening', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateDevelopmentMode', + 'description' => '修改站点开发模式配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateDevelopmentMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetUserWafRuleset', + 'description' => '获取用户WAF规则集', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetUserWafRuleset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListUrlObservations', + 'description' => '查询网页监测配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUrlObservations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSiteTimeSeriesData', + 'description' => '查询流量分析时序数据', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeSiteTimeSeriesData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHttpDDoSIntelligentRateLimitRules', + 'description' => '查询深度学习和防护下发的频率控制规则', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeHttpDDoSIntelligentRateLimitRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomHostname', + 'description' => '删除 SaaS 域名', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCustomHostname', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateRecord', + 'description' => '更新解析记录', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetUploadTask', + 'description' => '查询文件上传任务状态', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetUploadTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListEdgeRoutinePlans', + 'description' => '查询边缘函数套餐列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListEdgeRoutinePlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListManagedRulesGroups', + 'description' => '列举WAF托管规则组', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListManagedRulesGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListWaitingRoomEvents', + 'description' => '查询等候室事件列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListWaitingRoomEvents', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetCustomHostname', + 'description' => '查询 SaaS 域名详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCustomHostname', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetWafQuota', + 'description' => '获取WAF资源相关配额', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetKvAccount', + 'description' => '查询账户的KV服务使用信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetKvAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetHttpsApplicationConfiguration', + 'description' => '查询站点HTTPS应用配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpsApplicationConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetUserDeliveryTask', + 'description' => '获取用户任务投递详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetUserDeliveryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDdosMaxBurstGbps', + 'description' => '查询DDoS实例的国内最大防护带宽', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeDdosMaxBurstGbps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetRoutineRoute', + 'description' => '查询单条边缘函数路由配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetRoutineRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomResponseCodeRule', + 'description' => '删除修改响应码配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCustomResponseCodeRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteCompressionRule', + 'description' => '删除压缩规则配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCompressionRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRewriteUrlRule', + 'description' => '添加重写URL配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRewriteUrlRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateEdgeContainerAppResourceReserve', + 'description' => '更新边缘容器应用资源预留配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateEdgeContainerAppResourceReserve', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteRoutineCodeVersion', + 'description' => '删除边缘函数版本代码', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteRoutineCodeVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListEdgeContainerAppRecords', + 'description' => '获取边缘容器应用的关联域名列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerAppRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListOriginRules', + 'description' => '查询站点回源规则配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListOriginRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetOriginPool', + 'description' => '查询单个源地址池', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'BatchDeleteKvWithHighCapacity', + 'description' => '批量删除KV存储空间的大容量的键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:BatchDeleteKvWithHighCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListUserRoutines', + 'description' => '查询用户Routine列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUserRoutines', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateNetworkOptimization', + 'description' => '修改站点网络优化配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateNetworkOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetClientCaCertificate', + 'description' => '获取客户端CA证书', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetClientCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UploadSiteOriginClientCertificate', + 'description' => '上传站点粒度回源客户端证书', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadSiteOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'BatchPutKvWithHighCapacity', + 'description' => '批量设置KV存储空间的大容量键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:BatchPutKvWithHighCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SetHttpDDoSAttackRuleStatus', + 'description' => '设置HTTP DDoS攻击防护指定规则防护状态', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:SetHttpDDoSAttackRuleStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListEdgeContainerAppVersions', + 'description' => '获取边缘容器应用的版本列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerAppVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetRedirectRule', + 'description' => '查询重定向配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetRedirectRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteTransportLayerApplication', + 'description' => '删除四层加速应用', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteTransportLayerApplication', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListLoadBalancers', + 'description' => '查询站点下负载均衡器', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListLoadBalancers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'StartScheduledPreloadExecution', + 'description' => '开始单个定时预热计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:StartScheduledPreloadExecution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateWafRuleset', + 'description' => '更新WAF规则集', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWafRuleset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateRedirectRule', + 'description' => '更新重定向配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateRedirectRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'BatchUpdateWafRules', + 'description' => '批量修改WAF规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:BatchUpdateWafRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteScheduledPreloadExecution', + 'description' => '删除单个定时预热计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:DeleteScheduledPreloadExecution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetClientCertificateHostnames', + 'description' => '获取客户端证书的域名绑定', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetClientCertificateHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetCacheRule', + 'description' => '查询站点缓存配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCacheRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteUserWafRuleset', + 'description' => '删除用户WAF规则集', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteUserWafRuleset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetCertificateQuota', + 'description' => '查询免费证书配额和用量', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:GetCertificateQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetOriginRule', + 'description' => '查询站点回源规则配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteRecord', + 'description' => '删除DNS记录', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteClientCertificate', + 'description' => '删除客户端证书', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListScheduledPreloadJobs', + 'description' => '列出定时预热任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListScheduledPreloadJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSiteCoverage', + 'description' => '修改站点加速区域', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteCoverage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteOriginCaCertificate', + 'description' => '删除源服务器CA证书', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteRoutineRoute', + 'description' => '删除边缘函数路由配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRoutineRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'OpenErService', + 'description' => '开通边缘函数服务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:OpenErService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListRecords', + 'description' => '查询解析记录列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateIPv6', + 'description' => '修改站点IPv6配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateIPv6', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeSiteLogs', + 'description' => '查询站点离线日志下载地址', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeSiteLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHttpDDoSIntelligentAclRules', + 'description' => '查询深度学习和防护下发的精准访问控制规则', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeHttpDDoSIntelligentAclRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteWafRuleset', + 'description' => '删除WAF规则集', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWafRuleset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListWafRulesets', + 'description' => '列举WAF规则集', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListWafRulesets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetTieredCache', + 'description' => '查询站点多级缓存配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetTieredCache', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetImageTransform', + 'description' => '查询单条站点图片转换配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetImageTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListHttpResponseHeaderModificationRules', + 'description' => '查询修改HTTP响应头的配置列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListHttpResponseHeaderModificationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListEdgeContainerRecords', + 'description' => '查询边缘容器记录列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetVideoProcessing', + 'description' => '查询站点视频处理配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetVideoProcessing', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateList', + 'description' => '更新自定义列表', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteHttpResponseHeaderModificationRule', + 'description' => '删除修改HTTP响应头配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListUserWafRulesets', + 'description' => '列出用户WAF规则集', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListUserWafRulesets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ExportRecords', + 'description' => '导出记录', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ExportRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSiteVanityNS', + 'description' => '修改站点的自定义NS服务器', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteVanityNS', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListHttpRequestHeaderModificationRules', + 'description' => '查询修改HTTP请求头配置列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListHttpRequestHeaderModificationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UploadFile', + 'description' => '上传刷新或者预热文件', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadFile', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListOriginClientCertificates', + 'description' => '查询域名粒度回源客户端证书列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListOriginClientCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateUrlObservation', + 'description' => '创建网页监测配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateUrlObservation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'RevokeClientCertificate', + 'description' => '吊销客户端证书', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:RevokeClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListCacheReserveInstances', + 'description' => '查询缓存保持实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCacheReserveInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteWafRule', + 'description' => '删除WAF规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWafRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetErService', + 'description' => '查询边缘函数服务状态', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetErService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'PutKv', + 'description' => '设置KV存储空间的单个键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:PutKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSiteDeliveryTask', + 'description' => '修改实时日志任务投递', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateEdgeContainerAppVersion', + 'description' => '创建边缘容器应用版本', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateKvNamespace', + 'description' => '创建KV存储空间', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateKvNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetRoutineCodeVersion', + 'description' => '查询边缘函数某版本代码信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRoutineCodeVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCacheReserveSpec', + 'description' => '缓存保持变配', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UpdateCacheReserveSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerAppResourceReserve', + 'description' => '获取边缘容器应用资源预留配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppResourceReserve', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteSiteDeliveryTask', + 'description' => '删除实时日志任务投递', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteSiteDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListCompressionRules', + 'description' => '查询压缩规则配置列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListCompressionRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'VerifySite', + 'description' => '校验站点归属', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:VerifySite', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListWafPhases', + 'description' => '列举WAF运行阶段', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafPhases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListWaitingRooms', + 'description' => '查询等候室列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWaitingRooms', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListUserRatePlanInstances', + 'description' => '查询用户套餐实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListUserRatePlanInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSiteNameExclusive', + 'description' => '修改站点名称独占配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteNameExclusive', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListOriginPools', + 'description' => '查询源地址池列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListOriginPools', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetKv', + 'description' => '查询KV存储空间的某个键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetPurgeQuota', + 'description' => '获取刷新配额', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetPurgeQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListInstanceQuotas', + 'description' => '查询实例的配额详情', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListInstanceQuotas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListRoutineRoutes', + 'description' => '查询边缘程序的函数路由列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListRoutineRoutes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomScenePolicy', + 'description' => '删除定制场景策略', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '删除资源标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateRoutineRoute', + 'description' => '修改边缘函数路由配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateRoutineRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribePurgeTasks', + 'description' => '查询刷新任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribePurgeTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'EditSiteWafSettings', + 'description' => '编辑站点的WAF配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:EditSiteWafSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeCustomScenePolicies', + 'description' => '查询定制场景策略', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeCustomScenePolicies', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetIPv6', + 'description' => '查询站点IPv6配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetIPv6', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteWaitingRoom', + 'description' => '删除等候室', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteWaitingRoom', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteNetworkOptimization', + 'description' => '删除站点网络优化配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteNetworkOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListLists', + 'description' => '列举自定义列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListLists', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetCompressionRule', + 'description' => '查询压缩规则配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCompressionRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeHttpDDoSAttackRules', + 'description' => '查询HTTP DDoS攻击防护规则', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeHttpDDoSAttackRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSiteDeliveryTaskStatus', + 'description' => '实时日志任务投递状态修改', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteDeliveryTaskStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerDeployRegions', + 'description' => '获取边缘容器应用部署区域', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerDeployRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ResetScheduledPreloadJob', + 'description' => '重置定时预热任务的进度', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:ResetScheduledPreloadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteOriginPool', + 'description' => '删除源地址池', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateOriginPool', + 'description' => '创建源地址池', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateOriginPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateEdgeContainerAppLogRiver', + 'description' => '更新边缘容器日志采集配置信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateEdgeContainerAppLogRiver', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DisableCustomScenePolicy', + 'description' => '禁用定制场景策略', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DisableCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRedirectRule', + 'description' => '创建重定向配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRedirectRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'SetHttpDDoSAttackRuleAction', + 'description' => '设置HTTP DDoS攻击防护指定规则防护动作', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:SetHttpDDoSAttackRuleAction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteHttpsApplicationConfiguration', + 'description' => '删除站点HTTPS应用配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpsApplicationConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateImageTransform', + 'description' => '修改站点图片转换配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateImageTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteCacheRule', + 'description' => '删除站点缓存配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCacheRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRoutineRoute', + 'description' => '新增边缘函数路由配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRoutineRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetCacheTag', + 'description' => '查询站点缓存标签配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCacheTag', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListHttpIncomingRequestHeaderModificationRules', + 'description' => '查询修改HTTP入站请求头配置列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListHttpIncomingRequestHeaderModificationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateScheduledPreloadJob', + 'description' => '新增定时预热任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateScheduledPreloadJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListCustomHostnames', + 'description' => '查询 SaaS 域名列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCustomHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateNetworkOptimization', + 'description' => '添加站点网络优化配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateNetworkOptimization', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateCompressionRule', + 'description' => '创建压缩规则配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateCompressionRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteRoutine', + 'description' => '删除边缘函数', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteRoutine', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SetDdosMaxBurstGbps', + 'description' => '设置DDoS实例的国内最大防护带宽', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:SetDdosMaxBurstGbps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerApp', + 'description' => '获取边缘容器的应用信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteImageTransform', + 'description' => '删除站点图片转换配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteImageTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListSites', + 'description' => '查询站点列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListSites', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteOriginProtection', + 'description' => '关闭源站防护', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteOriginProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'StopScheduledPreloadExecution', + 'description' => '停止单个定时预热计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:StopScheduledPreloadExecution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateScheduledPreloadExecution', + 'description' => '更新单个定时预热计划', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateScheduledPreloadExecution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetHttpIncomingResponseHeaderModificationRule', + 'description' => '查询修改HTTP入站响应头配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpIncomingResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListHttpIncomingResponseHeaderModificationRules', + 'description' => '查询修改HTTP入站响应头的配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListHttpIncomingResponseHeaderModificationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerAppResourceStatus', + 'description' => '获取边缘容器应用资源分布', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppResourceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetSiteOriginClientCertificate', + 'description' => '获取站点粒度回源客户端证书信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSiteOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteHttpRequestHeaderModificationRule', + 'description' => '删除修改HTTP请求头配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateOriginPool', + 'description' => '修改单个源地址池', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateOriginPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateWafRule', + 'description' => '更新WAF规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWafRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListNetworkOptimizations', + 'description' => '查询网络优化配置列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListNetworkOptimizations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'PurchaseRatePlan', + 'description' => '套餐新购', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:PurchaseRatePlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'PreloadCaches', + 'description' => '预热URL', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:PreloadCaches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateVideoProcessing', + 'description' => '修改站点视频处理配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateVideoProcessing', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCacheRule', + 'description' => '修改站点缓存配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCacheRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetCustomResponseCodeRule', + 'description' => '查询修改响应码配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCustomResponseCodeRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeUrlObservationData', + 'description' => '查询网页观测质量数据', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeUrlObservationData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerAppVersion', + 'description' => '获取边缘容器应用的版本信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteHttpIncomingResponseHeaderModificationRule', + 'description' => '删除修改HTTP入站响应头配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpIncomingResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListOriginCaCertificates', + 'description' => 'ListOriginCaCertificates', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListOriginCaCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateSite', + 'description' => '创建站点', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateSite', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetWafFilter', + 'description' => '获取WAF匹配引擎信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafFilter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListInstanceQuotasWithUsage', + 'description' => '查询实例的配额以及用量', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListInstanceQuotasWithUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateHttpIncomingResponseHeaderModificationRule', + 'description' => '更新修改HTTP入站响应头配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpIncomingResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'BatchDeleteKv', + 'description' => '批量删除KV存储空间的键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:BatchDeleteKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteClientCaCertificate', + 'description' => '删除客户端CA证书', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteClientCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRoutineRelatedRecord', + 'description' => '创建边缘函数关联记录', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateRoutineRelatedRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'SetCertificate', + 'description' => '配置站点证书', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:SetCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerStagingDeployStatus', + 'description' => '获取应用测试环境部署状态', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerStagingDeployStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListClientCertificates', + 'description' => '获取客户端证书列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListClientCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetWafRuleset', + 'description' => '获取单个WAF规则集详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetWafRuleset', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetOriginClientCertificate', + 'description' => '获取域名粒度回源客户端证书信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetOriginProtection', + 'description' => '获取源站防护信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UploadOriginCaCertificate', + 'description' => '上传源服务器CA证书', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadOriginCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'SetHttpDDoSAttackProtection', + 'description' => '设置HTTP DDoS攻击防护配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:SetHttpDDoSAttackProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'RollbackEdgeContainerAppVersion', + 'description' => '回滚边缘容器应用', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:RollbackEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRoutine', + 'description' => '创建边缘函数', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRoutine', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetSiteNameExclusive', + 'description' => '查询站点名称独占配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSiteNameExclusive', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetKvNamespace', + 'description' => '查询KV存储空间信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetKvNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetRecord', + 'description' => '查询解析记录详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListLoadBalancerRegions', + 'description' => '查询负载均衡器区域信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListLoadBalancerRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetEdgeContainerAppStatus', + 'description' => '获取边缘容器的应用状态信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerAppStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDDoSAllEventList', + 'description' => '查询DDoS攻击事件列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeDDoSAllEventList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetSiteCurrentNS', + 'description' => '查询站点的名称服务器', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSiteCurrentNS', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateCustomHostname', + 'description' => '创建 SaaS 域名', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateCustomHostname', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateCacheRule', + 'description' => '添加站点缓存配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateCacheRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'BlockObject', + 'description' => 'URL封禁', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:BlockObject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateRoutineCodeDeployment', + 'description' => '创建边缘函数代码版本部署', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CreateRoutineCodeDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CheckUserProjectName', + 'description' => '检查实时日志用户投递项目名', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:CheckUserProjectName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetCertificate', + 'description' => '获取指定证书信息', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:GetCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetHttpsBasicConfiguration', + 'description' => '查询站点HTTPS基础配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpsBasicConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetScheduledPreloadJob', + 'description' => '查询单个定时预热任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetScheduledPreloadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCompressionRule', + 'description' => '修改压缩规则配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCompressionRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'PutKvWithHighCapacity', + 'description' => '设置KV存储空间的单个大容量键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:PutKvWithHighCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateHttpsBasicConfiguration', + 'description' => '添加站点HTTPS基础配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpsBasicConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetRoutine', + 'description' => '查询边缘函数配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRoutine', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ApplyCertificate', + 'description' => '申请免费证书', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:ApplyCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetCnameFlattening', + 'description' => '查询站点CNAME拉平配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCnameFlattening', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteSite', + 'description' => '删除单个站点', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteSite', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetSiteLogDeliveryQuota', + 'description' => '获取站点日志投递配额', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetSiteLogDeliveryQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateHttpResponseHeaderModificationRule', + 'description' => '更新修改HTTP响应头配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateLoadBalancer', + 'description' => '修改已有负载均衡器信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateLoadBalancer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateWaitingRoomRule', + 'description' => '修改等候室绕过规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWaitingRoomRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListRoutineCodeVersions', + 'description' => '查询Routine代码版本列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListRoutineCodeVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateOriginProtection', + 'description' => '开启源站防护', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateOriginProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListSiteRoutes', + 'description' => '查询站点的函数路由列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListSiteRoutes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetSite', + 'description' => '查询单个站点信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSite', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetHttpRequestHeaderModificationRule', + 'description' => '查询修改HTTP请求头配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetHttpRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateHttpsApplicationConfiguration', + 'description' => '修改站点HTTPS应用配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpsApplicationConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteKv', + 'description' => '删除KV存储空间的单个键值对', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteKv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListHttpsBasicConfigurations', + 'description' => '查询HTTPS基础配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListHttpsBasicConfigurations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateClientCertificate', + 'description' => '创建客户端证书', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ApplyCustomHostnameCertificate', + 'description' => '重新申请 SaaS 域名的免费证书', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:ApplyCustomHostnameCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'BatchCreateWafRules', + 'description' => '批量创建WAF规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:BatchCreateWafRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'TagResources', + 'description' => '添加资源标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateUserDeliveryTaskStatus', + 'description' => '上下线任务投递状态', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateUserDeliveryTaskStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetLoadBalancer', + 'description' => '查询单个负载均衡器', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetLoadBalancer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateTieredCache', + 'description' => '修改站点多级缓存配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateTieredCache', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UploadClientCaCertificate', + 'description' => '上传客户端CA证书', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:UploadClientCaCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateLoadBalancer', + 'description' => '创建负载均衡器', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateLoadBalancer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetSiteDeliveryTask', + 'description' => '获取投递任务的配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetSiteDeliveryTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetSiteWafSettings', + 'description' => '获取站点的WAF配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetSiteWafSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteSiteOriginClientCertificate', + 'description' => '删除站点粒度回源客户端证书', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteSiteOriginClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetList', + 'description' => '获取单个自定义列表详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateCustomResponseCodeRule', + 'description' => '更新修改响应码配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCustomResponseCodeRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateWaitingRoom', + 'description' => '更新等候室', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWaitingRoom', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'BatchCreateRecords', + 'description' => '批量创建解析记录', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:BatchCreateRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListESAIPInfo', + 'description' => 'ListESAIPInfo', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListESAIPInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeKvAccountStatus', + 'description' => '查询账户的KV状态信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeKvAccountStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdatePage', + 'description' => '更新自定义响应页面', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdatePage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateSitePause', + 'description' => '修改站点暂停配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateSitePause', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateOriginRule', + 'description' => '添加站点回源规则配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateOriginRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribePreloadTasks', + 'description' => '查询预热任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribePreloadTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'GetPage', + 'description' => '获取单个自定义响应页面详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateUserDeliveryTask', + 'description' => '修改用户任务投递配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateUserDeliveryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListRoutineRelatedRecords', + 'description' => '查询边缘函数关联记录列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListRoutineRelatedRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateWaitingRoomEvent', + 'description' => '更新等候室事件', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateWaitingRoomEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDDoSBpsList', + 'description' => '查询DDoS网络层数据', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:DescribeDDoSBpsList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateTransportLayerApplication', + 'description' => '创建四层加速应用', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateTransportLayerApplication', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListWaitingRoomRules', + 'description' => '查询等候室绕过规则列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListWaitingRoomRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListScheduledPreloadExecutions', + 'description' => '列出指定定时预热任务下的执行计划', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListScheduledPreloadExecutions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetClientCertificate', + 'description' => '获取客户端证书信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetClientCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListTagResources', + 'description' => '查询标签', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListWafRules', + 'description' => '列举WAF规则', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListEdgeContainerAppImageSecrets', + 'description' => '获取边缘容器应用镜像秘钥列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListEdgeContainerAppImageSecrets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeEdgeContainerAppStats', + 'description' => '提供ESA边缘容器的各项指标监控数据', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DescribeEdgeContainerAppStats', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetOriginClientCertificateHostnames', + 'description' => '获取域名粒度回源客户端证书绑定的域名列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetOriginClientCertificateHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteEdgeContainerApp', + 'description' => '删除边缘容器应用', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteEdgeContainerApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateUserWafRuleset', + 'description' => '更新用户WAF规则集', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateUserWafRuleset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateRewriteUrlRule', + 'description' => '修改重写URL配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateRewriteUrlRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateCustomScenePolicy', + 'description' => '创建定制场景策略', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateCustomScenePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListCustomResponseCodeRules', + 'description' => '查询修改响应码配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCustomResponseCodeRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreatePage', + 'description' => '创建自定义响应页面', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreatePage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetSiteCustomLog', + 'description' => '获取自定义日志字段', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetSiteCustomLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateImageTransform', + 'description' => '新增站点图片转换配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateImageTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'PublishEdgeContainerAppVersion', + 'description' => '发布边缘容器的指定版本', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:PublishEdgeContainerAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateHttpIncomingRequestHeaderModificationRule', + 'description' => '创建修改HTTP入站请求头配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpIncomingRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'BatchGetExpressionFields', + 'description' => '批量获取表达式的匹配域', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:BatchGetExpressionFields', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'ListWafTemplateRules', + 'description' => '列举WAF模板规则', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListWafTemplateRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteRoutineRelatedRecord', + 'description' => '删除边缘函数关联记录', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:DeleteRoutineRelatedRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'CreateScheduledPreloadExecutions', + 'description' => '批量新增定时预热任务的计划', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateScheduledPreloadExecutions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteHttpsBasicConfiguration', + 'description' => '删除站点HTTPS基础配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteHttpsBasicConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateHttpsBasicConfiguration', + 'description' => '修改站点HTTPS基础配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpsBasicConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateOriginRule', + 'description' => '修改站点回源规则配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateOriginRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'ESA', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + ], + ], + ], + ], + 'resourceTypes' => [ + [ + 'validationType' => 'always', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'List', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Site', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/*', + ], + [ + 'validationType' => 'always', + 'resourceType' => 'Page', + 'arn' => 'acs:esa:{#regionId}:{#accountId}:', + ], + ], + ], +]; -- cgit v1.2.3